Removed the Namespace dependency. GetUsed can now be used on every PHP script.

Author: eypsilon

Filesystem.php

@@ -8,11 +8,7 @@
 
     'config' => [
         'args' => [
-            'project_dir',
-            'autoload',
-            'include',
             'file',
-            'class',
             'return',
             'comment_out',
         ],
@@ -25,11 +21,7 @@
 
     'help' => [
         'args' => [
-            'project_dir' => 'Path to project',
-            'autoload' => "Path to './vendor/autoload.php' file",
-            'include' => 'Comma separated paths to include additionally files',
             'file' => 'File to get the use keywords for',
-            'class' => 'Set a Namespace to select a Class from availables',
             'return' => 'Set return content type',
             'comment_out' => 'Avoid commenting out already defined use keywords found in the Class',
         ],

GetUsed.config.php

@@ -6,124 +6,53 @@
 $base = dirname(__FILE__);
 require_once "{$base}/src/Used.php";
 $getCnf = require_once "{$base}/GetUsed.config.php";
-if (is_file($usrCnf = "{$base}/user.config.php"))
-    $getCnf = array_replace_recursive($getCnf, require_once $usrCnf);
 
 /** @var mixed parsed arguments */
 parse_str(implode('&', $argv), $argv);
 
-/**
- * @var array check if shell options are called and execute if ['-h', ...]
- */
-foreach($getCnf['config']['options'] as $key => $shortOpt)
-    if (isset($argv[$shortOpt]) AND isset($getCnf[$key]))
-        exit(json_encode([$key => $getCnf[$key]], JSON_PRETTY_PRINT) . PHP_EOL);
-
 /**
  * @var mixed If "file=" is left out in command
  */
 if (!isset($argv['file']) AND $pFilename = ($_SERVER['argv'][1] ?? false))
-    if (file_exists($pFilename))
+    if (is_file($pFilename))
         $argv['file'] = $pFilename;
 
 /**
- * @var mixed sets & args
+ * @var mixed set args
  */
-$autoloadFile = '/vendor/autoload.php';
-$projectDir = $argv['project_dir'] ?? null;
-$argv['include'] = $argv['include'] ?? null;
-$argv['file'] = $argv['file'] ?? null ? "{$projectDir}{$argv['file']}" : null;
+$argv['file'] = $argv['file'] ?? null;
 $argv['comment_out'] = ('false' === ($argv['comment_out'] ?? false)) ? false : true;
-$classes = get_declared_classes();
-$isIncluded = [];
-
-/**
- * @var array Set config
- */
-Used::setConfig(['comment_out_existing' => $argv['comment_out'] ? true : false]);
-
-/**
- * @var mixed Search path to "/vendor/autoload.php" in the file environment iteratively. Sets "/vendor/autoload.php" as first file to include
- */
-if ($argv['file'] AND $getAutoloader = Used::getAutoloadPath($argv['file']))
-    $argv['include'] = "{$getAutoloader},{$argv['include']},{$argv['file']}";
 
 /**
- * @var mixed Set all files to include
+ * @var array check if shell options are called and execute if ['-c', ...]
  */
-if ($argv['include'] ?? null)
-    $argv['include'] = trim($argv['include'], ',') . ",{$argv['file']}";
-else $argv['include'] = $argv['file'];
-
-/**
- * @var mixed include all
- */
-if ($includeAll = ($argv['include'] ?? null))
-    foreach(explode(',', $includeAll) as $inc)
-        if ($inc AND !in_array($inc, $isIncluded) AND is_file($inc) AND $isIncluded[] = $inc)
-            include_once $inc;
-
-/**
- * @var mixed check included files
- */
-if ($isIncluded AND $diff = array_diff(get_declared_classes(), $classes))
-    $class = end($diff);
-else $diff = false;
-
-/**
- * @var string get Used-Statements for a specific class through the "class"-parameter
- */
-$class = $argv['class'] ?? $class ?? null;
-
-/**
- * @var mixed Set the right class to load, if nothing is specified
- */
-if ($diff AND !($argv['class'] ?? null)) {
-    foreach($diff as $id => $namespace) {
-        $namespace = str_replace('\\', '/', $namespace);
-        if (str_contains($argv['file'], $namespace)) {
-            $class = $diff[$id];
-            break;
-        }
-    }
-}
+foreach($getCnf['config']['options'] as $key => $shortOpt)
+    if (isset($argv[$shortOpt]) AND isset($getCnf[$key]))
+        exit(json_encode([$key => $getCnf[$key]], JSON_PRETTY_PRINT) . PHP_EOL);
 
 /**
- * @var mixed Fix class if the given class still don't match with available
+ * @var string get use Keywords
  */
-if ($diff AND !in_array($class, $diff)) {
-    foreach($diff as $id => $namespace) {
-        $namespace = str_replace('\\', '/', $namespace);
-        if ($checkIterate = Used::searchPathLeftToRight($argv['file'], $namespace, '/')) {
-            $class = str_replace('/', '\\', $checkIterate);
-            break;
-        }
-    }
-}
+$getUsed = (new Used)->get($argv['file'], $argv);
 
 /**
- * @var string print Used-Statements or Error
+ * @var string response
  */
-if ($class) {
-    if ($getUsed = ((new Used)->getClassUseList($class))) {
-        $r = [
-            'file' => $getUsed['filename'] ?? $argv['file'] ?? null,
-            'use_for_class' => $class,
-            'start' => $_SERVER['REQUEST_TIME_FLOAT'] ?? null,
-            'end' => microtime(true),
-            'print' => $getUsed['print'] ?? null,
-        ];
-        if ('json' === ($argv['return'] ?? null)) {
-            $r = json_encode(array_merge($r, ['included' => $diff, 'response' => $getUsed,]), JSON_PRETTY_PRINT);
-        } else {
-            $rPrint = [];
-            foreach($r as $k => $v)
+if ($argv['file'] AND $getUsed) {
+    $r = [
+        'file' => trim($argv['file']),
+        'start' => $_SERVER['REQUEST_TIME_FLOAT'] ?? null,
+        'end' => microtime(true),
+        'print' => $getUsed['print'] ?? null,
+    ];
+    if ('json' === ($argv['return'] ?? null)) {
+        $r = json_encode($r, JSON_PRETTY_PRINT);
+    } else {
+        $rPrint = [];
+        foreach($r as $k => $v)
+            if (!in_array($k, ['class', 'function', 'constant', 'file_content']))
                 $rPrint[] = 'print' === $k ? "\n{$v}" : "// {$k} = {$v}";
-            $r = PHP_EOL . implode(PHP_EOL, $rPrint) . PHP_EOL . PHP_EOL;
-        }
-        exit($r);
-    } else exit("Error processing the Class: {$class}");
-}
-
-// if script somehow ends up here, exit anyway
-exit("No file defined, set ?file=/path/to/file.php\n");
+        $r = sprintf('%1$s%2$s%1$s%1$s', PHP_EOL, implode(PHP_EOL, $rPrint));
+    }
+    exit($r);
+} else exit(sprintf('Error processing the file: %s', $argv['file']));

GetUsed.php

@@ -1,19 +1,24 @@
-# Namespace helper - get use Namespace\Keywords;
+# Namespace helper - use Namespace\Keywords;
 
-This package can create `use Keywords;` with all the names of Classes, Functions and Constants used within a Class. It can be used from the Terminal or alternatively from a simple [Web interface](./www/used/).
+This package can parse PHP scripts to extract the names of PHPs internal Classes, Functions and Constants used within a Class. The parsed Names can then be used to define `use Namespace\Keywords;` in namespaced Classes.
 
-The `use` keyword can be used within Classes to tell PHP, which Classes, Functions and Constants to use internally for Functions used in your Class. It also can boost your scripts by pointing PHP to the right Namespace to use. For example, if you call `json_encode()` within a Class, PHP searches in the calling Class for a Function with the name `json_encode()` first, before searching it in the global Namespace (if at all). You can speed up the process with a Backslash before the function name, like: `\json_encode()`, but IDK, it looks awful. To make it a bit prettier, you can define any used Functions, Classes and Constants at the very top of your Class with the 'use'-keyword and continue programming like a Boss.
 
-It also allows you to Alias your scripts quick and easy.
+__VSCode Screenshot__
+
+It's pretty hard to talk about this Topic, because it's just called "Namespace" ...
+
+![Visual Studio Code Example Response](/www/used/assets/screenshot-vscode.png)
+
+The `use` keyword can be used within Classes to tell PHP, which Classes, Functions and Constants to use internally for Functions used in your Class. It also can boost your scripts by pointing PHP to the right Namespace to use. For example, if you call `json_encode()` within a Class, PHP searches in the calling Class for a Function with the name `json_encode()` first, before searching it in the global Namespace (if at all). You can speed up the process with a Backslash before the function name, like: `\json_encode()`, but IDK, it looks awful. An alternate is to define any used Function, Class and Constant at the very top of your Class with the 'use'-keyword. And that's for what this Package is meant to be.
+
+The `use` keyword also allows you to Alias and change your scripts quick and easy.
 
 ```php
-use function needToChangeHtmlspecialchars as htmlspecialchars;
-# if you now call "htmlspecialchars()" in your class, PHP will
-# use "needToChangeHtmlspecialchars()" to execute it.
+use function myOwnJsonEcode as json_encode;
+# if you now call "json_encode()" in your class,
+# PHP will use "myOwnJsonEcode()" to execute it.
 ```
 
-This Package searches in the parent directory of the given file for `./vendor/autoload.php` iteratively and includes it, if found. It's required, if the Environment is namespaced and Classes are depending on other Classes within the Project.
-
 ## Install Many\Dev\Used
 
 ```sh
@@ -30,56 +35,46 @@ git clone https://github.com/eypsilon/get-used.git .
 chmod -v 770 ~/bin/many/get-used/GetUsed.php
 ```
 
-Set an Alias (feel free to set one you feel comfortable with)
+__Usage from Terminal__
 
 ```sh
-~$ sudo gedit ~/.bash_aliases
-# put
-alias GetUsed='~/bin/many/get-used/GetUsed.php'
-# refresh aliases
-~$ source ~/.bash_aliases
+~/bin/many/get-used/GetUsed.php  file="/path/to/src/AnyClass.php"
 ```
 
-and use it from the Terminal
+__Via [Web interface](./www/used/) using PHPs dev-server__
 
 ```sh
-GetUsed file="/path/to/src/AnyClass.php"
-# or
-GetUsed /path/to/src/AnyClass.php
-# Get help -h | info -i | config -c
-GetUsed -h
+cd ~/bin/many/get-used/www/used
+php -S localhost:8000
 ```
 
+and open [localhost:8000](http://localhost:8000)
+
 ---
 
-### Via Browser as a Web Service
+## Set an Alias (optional)
 
-You can use PHPs dev-server for temporary usage or configure a vhost and point the __DocumentRoot__ to `~/bin/many/get-used/www/used`.
+Feel free to set one you feel comfortable with.
 
 ```sh
-# using PHPs dev-server
-cd ~/bin/many/get-used/www/used
-php -S localhost:8000
+~$ sudo gedit ~/.bash_aliases
+# put
+alias GetUsed='~/bin/many/get-used/GetUsed.php'
+# refresh aliases
+~$ source ~/.bash_aliases
 ```
-
-and open [localhost:8000](http://localhost:8000)
-
-Or, set an Alias, that can start the dev-server and a Browser with the dev-url at once. You can still feel free to set any Alias you feel comfortable with, always.
-
 ```sh
-# set alias in ~/.bash_aliases
-alias phpserver='firefox http://localhost:8000; php -S localhost:8000'
-
-# and whenever you need a dev-server
-cd ~/any/dir/app/public
-phpserver
+GetUsed file="/path/to/src/AnyClass.php"
+# or
+GetUsed /path/to/src/AnyClass.php
+# Get help -h | info -i | config -c
+GetUsed -h
 ```
-
 ---
 
-### Used in Visual Studio Code
+### Used Keywords in Visual Studio Code
 
-You can use this Lib also in VSCode. Set a key combination in `~/.config/Code/User/keybindings.json`
+You can use this Package also in VSCode. Set a key combination in `~/.config/Code/User/keybindings.json`
 
 ```json
 {
@@ -103,9 +98,10 @@ GetUsed /path/to/src/Http/Curler.php
 
 ```php
 // file = /path/to/src/Http/Curler.php
-// use_for_class = Many\Http\Curler
+// start = 1661266197.6779
+// end = 1661266197.7762
 
-/** class(2), function(2), constant(2) */
+/** lines(-), defined(0), taken(0), constant(2), class(2), function(2), total(6) */
 
 use DateTime;
 use DateTimeZone;
@@ -117,8 +113,8 @@ use const JSON_UNESCAPED_SLASHES;
 
 #### Screenshots
 
-__Web Interface__
-A Web-based GUI for `GetUsed`, because Terminal. It burns in my eyes when i look at it ...
+__Web Interface for `GetUsed`__
+
 
 ![Web Interface Example Response](/www/used/assets/screenshot-sw.png)