diff --git a/.vscode/.htaccess b/.vscode/.htaccess new file mode 100644 index 0000000..3a42882 --- /dev/null +++ b/.vscode/.htaccess @@ -0,0 +1 @@ +Deny from all diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 0000000..542060d --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,14 @@ +{ + // Use IntelliSense to learn about possible attributes. + // Hover to view descriptions of existing attributes. + // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 + "version": "0.2.0", + "configurations": [ + { + "name": "Listen for Xdebug", + "type": "php", + "request": "launch", + "port": 9003 + } + ] +} \ No newline at end of file diff --git a/README.md b/README.md index 2c20475..2a4cfbb 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,47 @@ # php-xout -A more readable implementation of PHP´s var_dump() function +A more readable, syntax highlighted implementation of PHPs `var_dump()` or `print_r()` function. +*Compatible with all PHP versions **back to 5.4*** + +## Installation +### Via Composer +`composer require alddesign/php-xout` +### Manual +Downlaod the package and load `xout.php`: +```php +require_once 'xout.php' +``` ## Usage ```php -require('xout.php'); +//code before... +$array = +[ + 'cars' => ['audi','bmw','volkswagen'], + 'settings' => (object) + [ + 'drive' => true, + 'disable_car' => + function(){} + ], + 'value' => 220.25, + 'active' => null +]; -$var = ['cars' => ['audi','bmw'], 'nothing' => (object)['name' => 'Mario', 'age' => 34]]; +//Call xout +Xout::xout($array); + +//Or use the shorthand function: xout($var); ``` -This will output the contents of $var to the browser and call die(); (Unless you specify $dontDie = true) -The output will look like: +The output will look like this: +![output]() + +## Remarks +### Parameters +- **value**: The expression to output +- **return** (bool): If set to `true` the resulting html is being returned insted of echoing it. Default: `false` +- **dontDie** (bool): If set to `true` the script will not terminated. When `return` is set to `true`, this parameter has no effect. Default: `false` -![output]() +### Customization +In `xout.php` you can change many options like font, color, brace style,... \ No newline at end of file diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..8e8e40b --- /dev/null +++ b/composer.json @@ -0,0 +1,20 @@ +{ + "name": "alddesign/php-xout", + "description": "A more readable implementation of PHPs var_dump() function", + "version": "1.0.0", + "support": { + "issues": "https://github.com/ankane/alddesign/php-xout/issues", + "source": "https://github.com/ankane/alddesign/php-xout" + }, + "authors": [ + { + "name": "alddesign" + } + ], + "autoload": { + "files": ["xout.php"] + }, + "require": { + "php": ">= 5.4" + } +} diff --git a/composer.lock b/composer.lock new file mode 100644 index 0000000..d223038 --- /dev/null +++ b/composer.lock @@ -0,0 +1,20 @@ +{ + "_readme": [ + "This file locks the dependencies of your project to a known state", + "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", + "This file is @generated automatically" + ], + "content-hash": "0ea57707cf328774930a8944662deffc", + "packages": [], + "packages-dev": [], + "aliases": [], + "minimum-stability": "stable", + "stability-flags": [], + "prefer-stable": false, + "prefer-lowest": false, + "platform": { + "php": ">= 5.6" + }, + "platform-dev": [], + "plugin-api-version": "2.6.0" +} diff --git a/out.png b/out.png deleted file mode 100644 index 734c8cd..0000000 Binary files a/out.png and /dev/null differ diff --git a/test.php b/test.php deleted file mode 100644 index 619e15a..0000000 --- a/test.php +++ /dev/null @@ -1,40 +0,0 @@ - - [ - 'audi', - 'bmw' - ], - 'nothing' => (object) - [ - 'name' => 'Mario', - 'age' => 34 - ], - 'even more' => (object) - [ - 'price' => 25.99, - 'discount' => -5.25, - 'currentDatetime' => new DateTime(), - 'someObject' => new stdClass(), - 'empty' => null, - 'emptyText' => '', - 'isOkay' => TRUE, - 'isNotOkay' => FALSE, - 'fileHandle' => $handle, - 'fileHandleClosed' => $handleClosed - ] -]; - -//Calling xout() -xout($var, true); - -fclose($handle); \ No newline at end of file diff --git a/test/output.png b/test/output.png new file mode 100644 index 0000000..2c7d6ca Binary files /dev/null and b/test/output.png differ diff --git a/test/test.php b/test/test.php new file mode 100644 index 0000000..da5b316 --- /dev/null +++ b/test/test.php @@ -0,0 +1,33 @@ + ['apple', 'banana', 'strawberry'], + 'person' => + [ + 'name' => 'Mario', + 'age' => 34, + 'rating' => 7.34, + 'registered' => false, + 'picture' => null + ], + 'car' => (object) + [ + 'brand' => 'BWM', + 'hp' => 220.25, + 'drive' => function(){} + ], + 'train object' => new Train(), + 'emtpy array' => [], + 'empty object' => (object)[], + 'nested array' => [[[[]]]], +]; + +xout($something); \ No newline at end of file diff --git a/vendor/autoload.php b/vendor/autoload.php new file mode 100644 index 0000000..c779166 --- /dev/null +++ b/vendor/autoload.php @@ -0,0 +1,25 @@ + + * Jordi Boggiano + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Composer\Autoload; + +/** + * ClassLoader implements a PSR-0, PSR-4 and classmap class loader. + * + * $loader = new \Composer\Autoload\ClassLoader(); + * + * // register classes with namespaces + * $loader->add('Symfony\Component', __DIR__.'/component'); + * $loader->add('Symfony', __DIR__.'/framework'); + * + * // activate the autoloader + * $loader->register(); + * + * // to enable searching the include path (eg. for PEAR packages) + * $loader->setUseIncludePath(true); + * + * In this example, if you try to use a class in the Symfony\Component + * namespace or one of its children (Symfony\Component\Console for instance), + * the autoloader will first look for the class under the component/ + * directory, and it will then fallback to the framework/ directory if not + * found before giving up. + * + * This class is loosely based on the Symfony UniversalClassLoader. + * + * @author Fabien Potencier + * @author Jordi Boggiano + * @see https://www.php-fig.org/psr/psr-0/ + * @see https://www.php-fig.org/psr/psr-4/ + */ +class ClassLoader +{ + /** @var \Closure(string):void */ + private static $includeFile; + + /** @var string|null */ + private $vendorDir; + + // PSR-4 + /** + * @var array> + */ + private $prefixLengthsPsr4 = array(); + /** + * @var array> + */ + private $prefixDirsPsr4 = array(); + /** + * @var list + */ + private $fallbackDirsPsr4 = array(); + + // PSR-0 + /** + * List of PSR-0 prefixes + * + * Structured as array('F (first letter)' => array('Foo\Bar (full prefix)' => array('path', 'path2'))) + * + * @var array>> + */ + private $prefixesPsr0 = array(); + /** + * @var list + */ + private $fallbackDirsPsr0 = array(); + + /** @var bool */ + private $useIncludePath = false; + + /** + * @var array + */ + private $classMap = array(); + + /** @var bool */ + private $classMapAuthoritative = false; + + /** + * @var array + */ + private $missingClasses = array(); + + /** @var string|null */ + private $apcuPrefix; + + /** + * @var array + */ + private static $registeredLoaders = array(); + + /** + * @param string|null $vendorDir + */ + public function __construct($vendorDir = null) + { + $this->vendorDir = $vendorDir; + self::initializeIncludeClosure(); + } + + /** + * @return array> + */ + public function getPrefixes() + { + if (!empty($this->prefixesPsr0)) { + return call_user_func_array('array_merge', array_values($this->prefixesPsr0)); + } + + return array(); + } + + /** + * @return array> + */ + public function getPrefixesPsr4() + { + return $this->prefixDirsPsr4; + } + + /** + * @return list + */ + public function getFallbackDirs() + { + return $this->fallbackDirsPsr0; + } + + /** + * @return list + */ + public function getFallbackDirsPsr4() + { + return $this->fallbackDirsPsr4; + } + + /** + * @return array Array of classname => path + */ + public function getClassMap() + { + return $this->classMap; + } + + /** + * @param array $classMap Class to filename map + * + * @return void + */ + public function addClassMap(array $classMap) + { + if ($this->classMap) { + $this->classMap = array_merge($this->classMap, $classMap); + } else { + $this->classMap = $classMap; + } + } + + /** + * Registers a set of PSR-0 directories for a given prefix, either + * appending or prepending to the ones previously set for this prefix. + * + * @param string $prefix The prefix + * @param list|string $paths The PSR-0 root directories + * @param bool $prepend Whether to prepend the directories + * + * @return void + */ + public function add($prefix, $paths, $prepend = false) + { + $paths = (array) $paths; + if (!$prefix) { + if ($prepend) { + $this->fallbackDirsPsr0 = array_merge( + $paths, + $this->fallbackDirsPsr0 + ); + } else { + $this->fallbackDirsPsr0 = array_merge( + $this->fallbackDirsPsr0, + $paths + ); + } + + return; + } + + $first = $prefix[0]; + if (!isset($this->prefixesPsr0[$first][$prefix])) { + $this->prefixesPsr0[$first][$prefix] = $paths; + + return; + } + if ($prepend) { + $this->prefixesPsr0[$first][$prefix] = array_merge( + $paths, + $this->prefixesPsr0[$first][$prefix] + ); + } else { + $this->prefixesPsr0[$first][$prefix] = array_merge( + $this->prefixesPsr0[$first][$prefix], + $paths + ); + } + } + + /** + * Registers a set of PSR-4 directories for a given namespace, either + * appending or prepending to the ones previously set for this namespace. + * + * @param string $prefix The prefix/namespace, with trailing '\\' + * @param list|string $paths The PSR-4 base directories + * @param bool $prepend Whether to prepend the directories + * + * @throws \InvalidArgumentException + * + * @return void + */ + public function addPsr4($prefix, $paths, $prepend = false) + { + $paths = (array) $paths; + if (!$prefix) { + // Register directories for the root namespace. + if ($prepend) { + $this->fallbackDirsPsr4 = array_merge( + $paths, + $this->fallbackDirsPsr4 + ); + } else { + $this->fallbackDirsPsr4 = array_merge( + $this->fallbackDirsPsr4, + $paths + ); + } + } elseif (!isset($this->prefixDirsPsr4[$prefix])) { + // Register directories for a new namespace. + $length = strlen($prefix); + if ('\\' !== $prefix[$length - 1]) { + throw new \InvalidArgumentException("A non-empty PSR-4 prefix must end with a namespace separator."); + } + $this->prefixLengthsPsr4[$prefix[0]][$prefix] = $length; + $this->prefixDirsPsr4[$prefix] = $paths; + } elseif ($prepend) { + // Prepend directories for an already registered namespace. + $this->prefixDirsPsr4[$prefix] = array_merge( + $paths, + $this->prefixDirsPsr4[$prefix] + ); + } else { + // Append directories for an already registered namespace. + $this->prefixDirsPsr4[$prefix] = array_merge( + $this->prefixDirsPsr4[$prefix], + $paths + ); + } + } + + /** + * Registers a set of PSR-0 directories for a given prefix, + * replacing any others previously set for this prefix. + * + * @param string $prefix The prefix + * @param list|string $paths The PSR-0 base directories + * + * @return void + */ + public function set($prefix, $paths) + { + if (!$prefix) { + $this->fallbackDirsPsr0 = (array) $paths; + } else { + $this->prefixesPsr0[$prefix[0]][$prefix] = (array) $paths; + } + } + + /** + * Registers a set of PSR-4 directories for a given namespace, + * replacing any others previously set for this namespace. + * + * @param string $prefix The prefix/namespace, with trailing '\\' + * @param list|string $paths The PSR-4 base directories + * + * @throws \InvalidArgumentException + * + * @return void + */ + public function setPsr4($prefix, $paths) + { + if (!$prefix) { + $this->fallbackDirsPsr4 = (array) $paths; + } else { + $length = strlen($prefix); + if ('\\' !== $prefix[$length - 1]) { + throw new \InvalidArgumentException("A non-empty PSR-4 prefix must end with a namespace separator."); + } + $this->prefixLengthsPsr4[$prefix[0]][$prefix] = $length; + $this->prefixDirsPsr4[$prefix] = (array) $paths; + } + } + + /** + * Turns on searching the include path for class files. + * + * @param bool $useIncludePath + * + * @return void + */ + public function setUseIncludePath($useIncludePath) + { + $this->useIncludePath = $useIncludePath; + } + + /** + * Can be used to check if the autoloader uses the include path to check + * for classes. + * + * @return bool + */ + public function getUseIncludePath() + { + return $this->useIncludePath; + } + + /** + * Turns off searching the prefix and fallback directories for classes + * that have not been registered with the class map. + * + * @param bool $classMapAuthoritative + * + * @return void + */ + public function setClassMapAuthoritative($classMapAuthoritative) + { + $this->classMapAuthoritative = $classMapAuthoritative; + } + + /** + * Should class lookup fail if not found in the current class map? + * + * @return bool + */ + public function isClassMapAuthoritative() + { + return $this->classMapAuthoritative; + } + + /** + * APCu prefix to use to cache found/not-found classes, if the extension is enabled. + * + * @param string|null $apcuPrefix + * + * @return void + */ + public function setApcuPrefix($apcuPrefix) + { + $this->apcuPrefix = function_exists('apcu_fetch') && filter_var(ini_get('apc.enabled'), FILTER_VALIDATE_BOOLEAN) ? $apcuPrefix : null; + } + + /** + * The APCu prefix in use, or null if APCu caching is not enabled. + * + * @return string|null + */ + public function getApcuPrefix() + { + return $this->apcuPrefix; + } + + /** + * Registers this instance as an autoloader. + * + * @param bool $prepend Whether to prepend the autoloader or not + * + * @return void + */ + public function register($prepend = false) + { + spl_autoload_register(array($this, 'loadClass'), true, $prepend); + + if (null === $this->vendorDir) { + return; + } + + if ($prepend) { + self::$registeredLoaders = array($this->vendorDir => $this) + self::$registeredLoaders; + } else { + unset(self::$registeredLoaders[$this->vendorDir]); + self::$registeredLoaders[$this->vendorDir] = $this; + } + } + + /** + * Unregisters this instance as an autoloader. + * + * @return void + */ + public function unregister() + { + spl_autoload_unregister(array($this, 'loadClass')); + + if (null !== $this->vendorDir) { + unset(self::$registeredLoaders[$this->vendorDir]); + } + } + + /** + * Loads the given class or interface. + * + * @param string $class The name of the class + * @return true|null True if loaded, null otherwise + */ + public function loadClass($class) + { + if ($file = $this->findFile($class)) { + $includeFile = self::$includeFile; + $includeFile($file); + + return true; + } + + return null; + } + + /** + * Finds the path to the file where the class is defined. + * + * @param string $class The name of the class + * + * @return string|false The path if found, false otherwise + */ + public function findFile($class) + { + // class map lookup + if (isset($this->classMap[$class])) { + return $this->classMap[$class]; + } + if ($this->classMapAuthoritative || isset($this->missingClasses[$class])) { + return false; + } + if (null !== $this->apcuPrefix) { + $file = apcu_fetch($this->apcuPrefix.$class, $hit); + if ($hit) { + return $file; + } + } + + $file = $this->findFileWithExtension($class, '.php'); + + // Search for Hack files if we are running on HHVM + if (false === $file && defined('HHVM_VERSION')) { + $file = $this->findFileWithExtension($class, '.hh'); + } + + if (null !== $this->apcuPrefix) { + apcu_add($this->apcuPrefix.$class, $file); + } + + if (false === $file) { + // Remember that this class does not exist. + $this->missingClasses[$class] = true; + } + + return $file; + } + + /** + * Returns the currently registered loaders keyed by their corresponding vendor directories. + * + * @return array + */ + public static function getRegisteredLoaders() + { + return self::$registeredLoaders; + } + + /** + * @param string $class + * @param string $ext + * @return string|false + */ + private function findFileWithExtension($class, $ext) + { + // PSR-4 lookup + $logicalPathPsr4 = strtr($class, '\\', DIRECTORY_SEPARATOR) . $ext; + + $first = $class[0]; + if (isset($this->prefixLengthsPsr4[$first])) { + $subPath = $class; + while (false !== $lastPos = strrpos($subPath, '\\')) { + $subPath = substr($subPath, 0, $lastPos); + $search = $subPath . '\\'; + if (isset($this->prefixDirsPsr4[$search])) { + $pathEnd = DIRECTORY_SEPARATOR . substr($logicalPathPsr4, $lastPos + 1); + foreach ($this->prefixDirsPsr4[$search] as $dir) { + if (file_exists($file = $dir . $pathEnd)) { + return $file; + } + } + } + } + } + + // PSR-4 fallback dirs + foreach ($this->fallbackDirsPsr4 as $dir) { + if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr4)) { + return $file; + } + } + + // PSR-0 lookup + if (false !== $pos = strrpos($class, '\\')) { + // namespaced class name + $logicalPathPsr0 = substr($logicalPathPsr4, 0, $pos + 1) + . strtr(substr($logicalPathPsr4, $pos + 1), '_', DIRECTORY_SEPARATOR); + } else { + // PEAR-like class name + $logicalPathPsr0 = strtr($class, '_', DIRECTORY_SEPARATOR) . $ext; + } + + if (isset($this->prefixesPsr0[$first])) { + foreach ($this->prefixesPsr0[$first] as $prefix => $dirs) { + if (0 === strpos($class, $prefix)) { + foreach ($dirs as $dir) { + if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) { + return $file; + } + } + } + } + } + + // PSR-0 fallback dirs + foreach ($this->fallbackDirsPsr0 as $dir) { + if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) { + return $file; + } + } + + // PSR-0 include paths. + if ($this->useIncludePath && $file = stream_resolve_include_path($logicalPathPsr0)) { + return $file; + } + + return false; + } + + /** + * @return void + */ + private static function initializeIncludeClosure() + { + if (self::$includeFile !== null) { + return; + } + + /** + * Scope isolated include. + * + * Prevents access to $this/self from included files. + * + * @param string $file + * @return void + */ + self::$includeFile = \Closure::bind(static function($file) { + include $file; + }, null, null); + } +} diff --git a/vendor/composer/InstalledVersions.php b/vendor/composer/InstalledVersions.php new file mode 100644 index 0000000..51e734a --- /dev/null +++ b/vendor/composer/InstalledVersions.php @@ -0,0 +1,359 @@ + + * Jordi Boggiano + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Composer; + +use Composer\Autoload\ClassLoader; +use Composer\Semver\VersionParser; + +/** + * This class is copied in every Composer installed project and available to all + * + * See also https://getcomposer.org/doc/07-runtime.md#installed-versions + * + * To require its presence, you can require `composer-runtime-api ^2.0` + * + * @final + */ +class InstalledVersions +{ + /** + * @var mixed[]|null + * @psalm-var array{root: array{name: string, pretty_version: string, version: string, reference: string|null, type: string, install_path: string, aliases: string[], dev: bool}, versions: array}|array{}|null + */ + private static $installed; + + /** + * @var bool|null + */ + private static $canGetVendors; + + /** + * @var array[] + * @psalm-var array}> + */ + private static $installedByVendor = array(); + + /** + * Returns a list of all package names which are present, either by being installed, replaced or provided + * + * @return string[] + * @psalm-return list + */ + public static function getInstalledPackages() + { + $packages = array(); + foreach (self::getInstalled() as $installed) { + $packages[] = array_keys($installed['versions']); + } + + if (1 === \count($packages)) { + return $packages[0]; + } + + return array_keys(array_flip(\call_user_func_array('array_merge', $packages))); + } + + /** + * Returns a list of all package names with a specific type e.g. 'library' + * + * @param string $type + * @return string[] + * @psalm-return list + */ + public static function getInstalledPackagesByType($type) + { + $packagesByType = array(); + + foreach (self::getInstalled() as $installed) { + foreach ($installed['versions'] as $name => $package) { + if (isset($package['type']) && $package['type'] === $type) { + $packagesByType[] = $name; + } + } + } + + return $packagesByType; + } + + /** + * Checks whether the given package is installed + * + * This also returns true if the package name is provided or replaced by another package + * + * @param string $packageName + * @param bool $includeDevRequirements + * @return bool + */ + public static function isInstalled($packageName, $includeDevRequirements = true) + { + foreach (self::getInstalled() as $installed) { + if (isset($installed['versions'][$packageName])) { + return $includeDevRequirements || !isset($installed['versions'][$packageName]['dev_requirement']) || $installed['versions'][$packageName]['dev_requirement'] === false; + } + } + + return false; + } + + /** + * Checks whether the given package satisfies a version constraint + * + * e.g. If you want to know whether version 2.3+ of package foo/bar is installed, you would call: + * + * Composer\InstalledVersions::satisfies(new VersionParser, 'foo/bar', '^2.3') + * + * @param VersionParser $parser Install composer/semver to have access to this class and functionality + * @param string $packageName + * @param string|null $constraint A version constraint to check for, if you pass one you have to make sure composer/semver is required by your package + * @return bool + */ + public static function satisfies(VersionParser $parser, $packageName, $constraint) + { + $constraint = $parser->parseConstraints((string) $constraint); + $provided = $parser->parseConstraints(self::getVersionRanges($packageName)); + + return $provided->matches($constraint); + } + + /** + * Returns a version constraint representing all the range(s) which are installed for a given package + * + * It is easier to use this via isInstalled() with the $constraint argument if you need to check + * whether a given version of a package is installed, and not just whether it exists + * + * @param string $packageName + * @return string Version constraint usable with composer/semver + */ + public static function getVersionRanges($packageName) + { + foreach (self::getInstalled() as $installed) { + if (!isset($installed['versions'][$packageName])) { + continue; + } + + $ranges = array(); + if (isset($installed['versions'][$packageName]['pretty_version'])) { + $ranges[] = $installed['versions'][$packageName]['pretty_version']; + } + if (array_key_exists('aliases', $installed['versions'][$packageName])) { + $ranges = array_merge($ranges, $installed['versions'][$packageName]['aliases']); + } + if (array_key_exists('replaced', $installed['versions'][$packageName])) { + $ranges = array_merge($ranges, $installed['versions'][$packageName]['replaced']); + } + if (array_key_exists('provided', $installed['versions'][$packageName])) { + $ranges = array_merge($ranges, $installed['versions'][$packageName]['provided']); + } + + return implode(' || ', $ranges); + } + + throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed'); + } + + /** + * @param string $packageName + * @return string|null If the package is being replaced or provided but is not really installed, null will be returned as version, use satisfies or getVersionRanges if you need to know if a given version is present + */ + public static function getVersion($packageName) + { + foreach (self::getInstalled() as $installed) { + if (!isset($installed['versions'][$packageName])) { + continue; + } + + if (!isset($installed['versions'][$packageName]['version'])) { + return null; + } + + return $installed['versions'][$packageName]['version']; + } + + throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed'); + } + + /** + * @param string $packageName + * @return string|null If the package is being replaced or provided but is not really installed, null will be returned as version, use satisfies or getVersionRanges if you need to know if a given version is present + */ + public static function getPrettyVersion($packageName) + { + foreach (self::getInstalled() as $installed) { + if (!isset($installed['versions'][$packageName])) { + continue; + } + + if (!isset($installed['versions'][$packageName]['pretty_version'])) { + return null; + } + + return $installed['versions'][$packageName]['pretty_version']; + } + + throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed'); + } + + /** + * @param string $packageName + * @return string|null If the package is being replaced or provided but is not really installed, null will be returned as reference + */ + public static function getReference($packageName) + { + foreach (self::getInstalled() as $installed) { + if (!isset($installed['versions'][$packageName])) { + continue; + } + + if (!isset($installed['versions'][$packageName]['reference'])) { + return null; + } + + return $installed['versions'][$packageName]['reference']; + } + + throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed'); + } + + /** + * @param string $packageName + * @return string|null If the package is being replaced or provided but is not really installed, null will be returned as install path. Packages of type metapackages also have a null install path. + */ + public static function getInstallPath($packageName) + { + foreach (self::getInstalled() as $installed) { + if (!isset($installed['versions'][$packageName])) { + continue; + } + + return isset($installed['versions'][$packageName]['install_path']) ? $installed['versions'][$packageName]['install_path'] : null; + } + + throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed'); + } + + /** + * @return array + * @psalm-return array{name: string, pretty_version: string, version: string, reference: string|null, type: string, install_path: string, aliases: string[], dev: bool} + */ + public static function getRootPackage() + { + $installed = self::getInstalled(); + + return $installed[0]['root']; + } + + /** + * Returns the raw installed.php data for custom implementations + * + * @deprecated Use getAllRawData() instead which returns all datasets for all autoloaders present in the process. getRawData only returns the first dataset loaded, which may not be what you expect. + * @return array[] + * @psalm-return array{root: array{name: string, pretty_version: string, version: string, reference: string|null, type: string, install_path: string, aliases: string[], dev: bool}, versions: array} + */ + public static function getRawData() + { + @trigger_error('getRawData only returns the first dataset loaded, which may not be what you expect. Use getAllRawData() instead which returns all datasets for all autoloaders present in the process.', E_USER_DEPRECATED); + + if (null === self::$installed) { + // only require the installed.php file if this file is loaded from its dumped location, + // and not from its source location in the composer/composer package, see https://github.com/composer/composer/issues/9937 + if (substr(__DIR__, -8, 1) !== 'C') { + self::$installed = include __DIR__ . '/installed.php'; + } else { + self::$installed = array(); + } + } + + return self::$installed; + } + + /** + * Returns the raw data of all installed.php which are currently loaded for custom implementations + * + * @return array[] + * @psalm-return list}> + */ + public static function getAllRawData() + { + return self::getInstalled(); + } + + /** + * Lets you reload the static array from another file + * + * This is only useful for complex integrations in which a project needs to use + * this class but then also needs to execute another project's autoloader in process, + * and wants to ensure both projects have access to their version of installed.php. + * + * A typical case would be PHPUnit, where it would need to make sure it reads all + * the data it needs from this class, then call reload() with + * `require $CWD/vendor/composer/installed.php` (or similar) as input to make sure + * the project in which it runs can then also use this class safely, without + * interference between PHPUnit's dependencies and the project's dependencies. + * + * @param array[] $data A vendor/composer/installed.php data set + * @return void + * + * @psalm-param array{root: array{name: string, pretty_version: string, version: string, reference: string|null, type: string, install_path: string, aliases: string[], dev: bool}, versions: array} $data + */ + public static function reload($data) + { + self::$installed = $data; + self::$installedByVendor = array(); + } + + /** + * @return array[] + * @psalm-return list}> + */ + private static function getInstalled() + { + if (null === self::$canGetVendors) { + self::$canGetVendors = method_exists('Composer\Autoload\ClassLoader', 'getRegisteredLoaders'); + } + + $installed = array(); + + if (self::$canGetVendors) { + foreach (ClassLoader::getRegisteredLoaders() as $vendorDir => $loader) { + if (isset(self::$installedByVendor[$vendorDir])) { + $installed[] = self::$installedByVendor[$vendorDir]; + } elseif (is_file($vendorDir.'/composer/installed.php')) { + /** @var array{root: array{name: string, pretty_version: string, version: string, reference: string|null, type: string, install_path: string, aliases: string[], dev: bool}, versions: array} $required */ + $required = require $vendorDir.'/composer/installed.php'; + $installed[] = self::$installedByVendor[$vendorDir] = $required; + if (null === self::$installed && strtr($vendorDir.'/composer', '\\', '/') === strtr(__DIR__, '\\', '/')) { + self::$installed = $installed[count($installed) - 1]; + } + } + } + } + + if (null === self::$installed) { + // only require the installed.php file if this file is loaded from its dumped location, + // and not from its source location in the composer/composer package, see https://github.com/composer/composer/issues/9937 + if (substr(__DIR__, -8, 1) !== 'C') { + /** @var array{root: array{name: string, pretty_version: string, version: string, reference: string|null, type: string, install_path: string, aliases: string[], dev: bool}, versions: array} $required */ + $required = require __DIR__ . '/installed.php'; + self::$installed = $required; + } else { + self::$installed = array(); + } + } + + if (self::$installed !== array()) { + $installed[] = self::$installed; + } + + return $installed; + } +} diff --git a/vendor/composer/LICENSE b/vendor/composer/LICENSE new file mode 100644 index 0000000..f27399a --- /dev/null +++ b/vendor/composer/LICENSE @@ -0,0 +1,21 @@ + +Copyright (c) Nils Adermann, Jordi Boggiano + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is furnished +to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + diff --git a/vendor/composer/autoload_classmap.php b/vendor/composer/autoload_classmap.php new file mode 100644 index 0000000..0fb0a2c --- /dev/null +++ b/vendor/composer/autoload_classmap.php @@ -0,0 +1,10 @@ + $vendorDir . '/composer/InstalledVersions.php', +); diff --git a/vendor/composer/autoload_files.php b/vendor/composer/autoload_files.php new file mode 100644 index 0000000..bf281e8 --- /dev/null +++ b/vendor/composer/autoload_files.php @@ -0,0 +1,10 @@ + $baseDir . '/xout.php', +); diff --git a/vendor/composer/autoload_namespaces.php b/vendor/composer/autoload_namespaces.php new file mode 100644 index 0000000..15a2ff3 --- /dev/null +++ b/vendor/composer/autoload_namespaces.php @@ -0,0 +1,9 @@ +register(true); + + $filesToLoad = \Composer\Autoload\ComposerStaticInit0ea57707cf328774930a8944662deffc::$files; + $requireFile = \Closure::bind(static function ($fileIdentifier, $file) { + if (empty($GLOBALS['__composer_autoload_files'][$fileIdentifier])) { + $GLOBALS['__composer_autoload_files'][$fileIdentifier] = true; + + require $file; + } + }, null, null); + foreach ($filesToLoad as $fileIdentifier => $file) { + $requireFile($fileIdentifier, $file); + } + + return $loader; + } +} diff --git a/vendor/composer/autoload_static.php b/vendor/composer/autoload_static.php new file mode 100644 index 0000000..0558666 --- /dev/null +++ b/vendor/composer/autoload_static.php @@ -0,0 +1,24 @@ + __DIR__ . '/../..' . '/xout.php', + ); + + public static $classMap = array ( + 'Composer\\InstalledVersions' => __DIR__ . '/..' . '/composer/InstalledVersions.php', + ); + + public static function getInitializer(ClassLoader $loader) + { + return \Closure::bind(function () use ($loader) { + $loader->classMap = ComposerStaticInit0ea57707cf328774930a8944662deffc::$classMap; + + }, null, ClassLoader::class); + } +} diff --git a/vendor/composer/installed.json b/vendor/composer/installed.json new file mode 100644 index 0000000..87fda74 --- /dev/null +++ b/vendor/composer/installed.json @@ -0,0 +1,5 @@ +{ + "packages": [], + "dev": true, + "dev-package-names": [] +} diff --git a/vendor/composer/installed.php b/vendor/composer/installed.php new file mode 100644 index 0000000..a70974a --- /dev/null +++ b/vendor/composer/installed.php @@ -0,0 +1,23 @@ + array( + 'name' => 'alddesign/php-xout', + 'pretty_version' => '1.0.0', + 'version' => '1.0.0.0', + 'reference' => null, + 'type' => 'library', + 'install_path' => __DIR__ . '/../../', + 'aliases' => array(), + 'dev' => true, + ), + 'versions' => array( + 'alddesign/php-xout' => array( + 'pretty_version' => '1.0.0', + 'version' => '1.0.0.0', + 'reference' => null, + 'type' => 'library', + 'install_path' => __DIR__ . '/../../', + 'aliases' => array(), + 'dev_requirement' => false, + ), + ), +); diff --git a/vendor/composer/platform_check.php b/vendor/composer/platform_check.php new file mode 100644 index 0000000..8b379f4 --- /dev/null +++ b/vendor/composer/platform_check.php @@ -0,0 +1,26 @@ += 50600)) { + $issues[] = 'Your Composer dependencies require a PHP version ">= 5.6.0". You are running ' . PHP_VERSION . '.'; +} + +if ($issues) { + if (!headers_sent()) { + header('HTTP/1.1 500 Internal Server Error'); + } + if (!ini_get('display_errors')) { + if (PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg') { + fwrite(STDERR, 'Composer detected issues in your platform:' . PHP_EOL.PHP_EOL . implode(PHP_EOL, $issues) . PHP_EOL.PHP_EOL); + } elseif (!headers_sent()) { + echo 'Composer detected issues in your platform:' . PHP_EOL.PHP_EOL . str_replace('You are running '.PHP_VERSION.'.', '', implode(PHP_EOL, $issues)) . PHP_EOL.PHP_EOL; + } + } + trigger_error( + 'Composer detected issues in your platform: ' . implode(' ', $issues), + E_USER_ERROR + ); +} diff --git a/xout.php b/xout.php index bf3be64..7d5c0f4 100644 --- a/xout.php +++ b/xout.php @@ -1,114 +1,234 @@ ['audi','bmw'], 'nothing' => (object)['name' => 'Mario', 'age' => 34]]; - * xout($var); - * ``` - */ -function xout($value, bool $dontDie = false, bool $initCall = true) +class Xout { - //You can define your own syntax coloring here. - $baseColor = 'black'; - $objectClassColor = 'gray'; - $arrayTypeColor = 'blue'; - $objectTypeColor = 'blue'; - $stringTypeColor = 'red'; - $integerTypeColor = 'orange'; - $doubleTypeColor = 'teal'; - $resourceTypeColor = 'purple'; - $resourceClosedTypeColor = 'plum'; - $booleanTypeColor = 'green'; - $nullTypeColor = 'gray'; - - $result = $initCall ? '
' : ''; - - $isSimpleVar = false; - $valueType = gettype($value); - switch($valueType) - { - case 'array' : $result .= 'ARRAY
'.htmlspecialchars('['); break; - case 'object' : $result .= 'OBJECT ' . get_class($value) . '
'.htmlspecialchars('('); break; - default : $value = [$value]; $isSimpleVar = true; break; - } - - $result .= '
    '; - - foreach ($value as $key => $val) - { - $valType = gettype($val); - if ($valType === 'array' || $valType === 'object') - { - if ($valueType === 'array') - { - $result .= '
  • [' . htmlspecialchars(strval($key)) . '] '.htmlspecialchars('=>').' ' . xout($val, $dontDie, false) . '
    • '; - } - if ($valueType === 'object') - { - $result .= '
  • ' . htmlspecialchars(strval($key)) . ' '.htmlspecialchars('->').' ' . xout($val, $dontDie, false) . '
    • '; - } - } - else - { - $color = 'black'; - switch($valType) - { - case 'string' : $color = $stringTypeColor; $val = htmlspecialchars('\'').$val.htmlspecialchars('\''); break; - case 'integer' : $color = $integerTypeColor; $val = strval($val); break; - case 'double' : $color = $doubleTypeColor; $val = strval($val); break; - case 'resource' : $color = $resourceTypeColor; $val = 'resource ('.get_resource_type($val).')'; break; - case 'resource (closed)' : $color = $resourceClosedTypeColor; $val = 'resource (closed)'; break; - case 'boolean' : $color = $booleanTypeColor; $val = ($val === true) ? 'TRUE' : 'FALSE'; break; - case 'NULL' : $color = $nullTypeColor; $val = 'NULL'; break; - } - - $result .= '
  • '; - if(!$isSimpleVar) - { - if($valueType === 'array') - { - $result .= '[' . htmlspecialchars(strval($key)) . '] '.htmlspecialchars('=>').' '; - } - if($valueType === 'object') - { - $result .= '' . htmlspecialchars(strval($key)) . ' '.htmlspecialchars('->').' '; - } - } - $result .= '' . htmlspecialchars($val) . '
    • '; - } - } - - $result .= '
'; - - if(!$isSimpleVar) - { - switch($valueType) - { - case 'array' : $result .= htmlspecialchars(']'); break; - case 'object' : $result .= htmlspecialchars(')'); break; - } - } - - $result .= $initCall ? '
' : ''; - - if($initCall) //Finished - { - echo($result); - if(!$dontDie) - { - die(); - } - } - else //End of recursive call - { - return $result; - } + private function __construct(){} + + const FONT_FAMILY = 'Courier New'; + const FONT_WEIGHT = 'normal'; + const FONT_SIZE = '16px'; + const INDENT_SIZE = '2rem'; + + const BASE_COLOR = '#333'; + const CLASS_COLOR = '#267f99'; + + const ARRAY_COLOR = '#777'; + const OBJ_PROP_COLOR = '#333'; + + const OBJ_COLOR = '#777'; + const STRING_COLOR = '#a31515'; + const INT_COLOR = '#098658'; + const DOUBLE_COLOR = '#098658'; + const RES_COLOR = 'purple'; + const RES_CLOSED_COLOR = 'plum'; + const BOOL_COLOR = '#00f'; + const NULL_COLOR = '#00f'; + const FUNCTION_COLOR = '#00f'; + + private static $braceColors = ['#00f', '#319331', '#7b3814']; //PHP 5.4 does not support array constants + const BRACE_STYLE_ALLMAN = true; + + + /** + * A more readable implementation of PHPs `var_dump()` or `print_r()` function. + * Provides syntax-highlighted insight into nested objects, arrays, etc. + * + * @param mixed $value The variable to print out + * @param bool $return Return the resulting HTML insted of sending it with echo() + * @param bool $dontDie If set to `TRUE` the script will not be aborted. This parameter has no effect if `$return` is set to `TRUE` + * @return void|string If `$return` is set to `TRUE` the resulting HTML is returned as string + * + * ``` + * //Example usage: + * $something = ['cars' => ['audi','bmw'], 'nothing' => (object)['name' => 'Mario', 'age' => 34]]; + * xout($something); + * ``` + */ + public static function xout($value, $return = false, $dontDie = false) + { + self::$res = sprintf('
', self::FONT_FAMILY, self::FONT_SIZE, self::BASE_COLOR, self::FONT_WEIGHT); + self::_xout($value, true); + self::$res .= '
'; + + if($return) + { + return self::$res; + } + + echo self::$res; + + if($dontDie == false) + { + die; + } + } + + private static function _xout($value) + { + /** @var string Value Type */ + $t = self::get_type($value); + /** @var string Value Class Name */ + $cn = $t === 'object' ? self::get_classname($value) : ''; + //We define closure as a separate type, i think its ok, after all it IS a function + $t = $cn === 'Closure' ? 'closure' : $t; + /** @var bool Value is Simple/Scalar Type */ + $s = !($t === 'array' || $t === 'object'); + /** @var bool Value is an empty object or array */ + $eo = !$s && self::is_e($value); + + + self::pre($t,$eo,$cn); + + $value = $s ? [$value] : $value; + foreach($value as $key => $val) + { + $t2 = self::get_type($val); + switch($t2) + { + case 'array' : self::main($t, $t2, $key, $val, ''); break; + case 'object' : self::main($t, $t2, $key, $val, ''); break; + case 'closure' : self::main($t, $t2, $key, sprintf('function()', self::FUNCTION_COLOR), self::BASE_COLOR); break; + case 'string' : self::main($t, $t2, $key, sprintf('%s%s%s', '"', htmlspecialchars($val), '"'), self::STRING_COLOR); break; + case 'integer' : self::main($t, $t2, $key, (string)$val, self::INT_COLOR); break; + case 'double' : self::main($t, $t2, $key, (string)$val, self::DOUBLE_COLOR); break; + case 'resource' : self::main($t, $t2, $key, sprintf('resouce (%s)', get_resource_type($val)), self::RES_COLOR); break; + case 'resource (closed)' : self::main($t, $t2, $key, 'resource (closed)', self::RES_CLOSED_COLOR); break; + case 'boolean' : self::main($t, $t2, $key, $val === true ? 'TRUE' : 'FALSE', self::BOOL_COLOR); break; + case 'NULL' : self::main($t, $t2, $key, 'NULL', self::NULL_COLOR); break; + } + } + + self::post($t,$eo); + + } + + private static function main($t, $t2, $key, $val, $color) + { + self::$res .= '
  • '; + switch($t) + { + case 'array' : self::$res .= self::format_array_key($key); break; + case 'object' : self::$res .= self::format_obj_prop($key); break; + } + + switch($t2) + { + case 'array' : + case 'object' : self::_xout($val); break; + default : self::$res .= sprintf('%s', $color, $val); break; + } + + self::$res .= '
    • '; + } + + private static function format_obj_prop($prop) + { + return sprintf('%s -> ', htmlspecialchars((string)$prop)); + } + + private static function format_array_key($key) + { + return sprintf('%s%s%s => ', self::square_brace(true), self::format_value($key, gettype($key)) , self::square_brace(false)); + } + + private static function square_brace($open) + { + self::$squareBraceLvl += $open ? 1 : -1; + $i = (self::$squareBraceLvl - (int)$open) % count(self::$braceColors); + + return sprintf('%s', self::$braceColors[$i], $open ? '[' : ']'); + } + + private static function curly_brace($open) + { + self::$curlyBraceLvl += $open ? 1 : -1; + $i = (self::$curlyBraceLvl - (int)$open) % count(self::$braceColors); + + return sprintf('%s', self::$braceColors[$i], $open ? '{' : '}'); + } + + private static function format_value($v, $t) + { + switch($t) + { + case 'closure' : return sprintf('function()', self::FUNCTION_COLOR); + case 'string' : return sprintf('%s%s%s', self::STRING_COLOR, '"', htmlspecialchars($v), '"'); + case 'integer' : return sprintf('%s', self::INT_COLOR, $v); + case 'double' : return sprintf('%s', self::DOUBLE_COLOR, $v); + case 'resource' : return sprintf('resource (%s)', self::RES_COLOR, get_resource_type($v)); + case 'resource (closed)' : return sprintf('resource (closed)', self::RES_CLOSED_COLOR); + case 'boolean' : return sprintf('%s', self::BOOL_COLOR, $v ? 'TRUE' : 'FALSE'); + case 'NULL' : return sprintf('NULL', self::NULL_COLOR); + } + + return ''; + } + + private static function post($t, $eo) + { + if($eo) + { + return; + } + + self::$res .= ''; + self::$res .= $t === 'array' ? self::square_brace(false) : ''; + self::$res .= $t === 'object' ? self::curly_brace(false) : ''; + } + + private static function pre($t, $eo, $cn) + { + self::$res .= $t === 'array' ? self::format_array($eo) : ''; + self::$res .= $t === 'object' ? self::format_object($eo, $cn) : ''; + self::$res .= $eo ? '' : sprintf('
      ', self::INDENT_SIZE); + } + + private static function format_object($eo, $cn) + { + $s = sprintf('OBJECT %s', self::OBJ_COLOR, self::CLASS_COLOR, $cn); + $s .= $eo ? '' : sprintf('%s%s', self::BRACE_STYLE_ALLMAN ? '
      ' : '', self::curly_brace(true)); + return $s; + } + + private static function format_array($eo) + { + $s = sprintf('ARRAY ', self::ARRAY_COLOR); + $s .= $eo ? 'empty' : sprintf('%s%s', self::BRACE_STYLE_ALLMAN ? '
      ' : '', self::square_brace(true)); + return $s; + } + + private static function is_e($value) + { + foreach($value as $k => $v) + { + return false; + } + + return true; + } + + private static function get_type($value) + { + $type = gettype($value); + + return $type === 'object' && get_class($value) === 'Closure' ? 'closure' : $type; + } + + private static function get_classname($value) + { + $type = self::get_type($value); + return $type === 'object' ? get_class($value) : ''; + } + + /** @var string The result */ + private static $res = ''; + /** @var int Monitor level of nested [ ] brackts */ + private static $squareBraceLvl = 0; + /** @var int Monitor level of nested { } brackts */ + private static $curlyBraceLvl = 0; } + +/** @see Xout::xout() */ +function xout($value, $return = false, $dontDie = false) +{ + return Xout::xout($value, $return, $dontDie); +} \ No newline at end of file