Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of Psy Shell.
Chris@0:  *
Chris@0:  * (c) 2012-2017 Justin Hileman
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace Psy\Formatter;
Chris@0: 
Chris@0: use Psy\Reflection\ReflectionConstant;
Chris@0: use Psy\Reflection\ReflectionLanguageConstruct;
Chris@0: use Psy\Util\Json;
Chris@0: use Symfony\Component\Console\Formatter\OutputFormatter;
Chris@0: 
Chris@0: /**
Chris@0:  * An abstract representation of a function, class or property signature.
Chris@0:  */
Chris@0: class SignatureFormatter implements Formatter
Chris@0: {
Chris@0:     /**
Chris@0:      * Format a signature for the given reflector.
Chris@0:      *
Chris@0:      * Defers to subclasses to do the actual formatting.
Chris@0:      *
Chris@0:      * @param \Reflector $reflector
Chris@0:      *
Chris@0:      * @return string Formatted signature
Chris@0:      */
Chris@0:     public static function format(\Reflector $reflector)
Chris@0:     {
Chris@0:         switch (true) {
Chris@0:             case $reflector instanceof \ReflectionFunction:
Chris@0:             case $reflector instanceof ReflectionLanguageConstruct:
Chris@0:                 return self::formatFunction($reflector);
Chris@0: 
Chris@0:             // this case also covers \ReflectionObject:
Chris@0:             case $reflector instanceof \ReflectionClass:
Chris@0:                 return self::formatClass($reflector);
Chris@0: 
Chris@0:             case $reflector instanceof ReflectionConstant:
Chris@0:                 return self::formatConstant($reflector);
Chris@0: 
Chris@0:             case $reflector instanceof \ReflectionMethod:
Chris@0:                 return self::formatMethod($reflector);
Chris@0: 
Chris@0:             case $reflector instanceof \ReflectionProperty:
Chris@0:                 return self::formatProperty($reflector);
Chris@0: 
Chris@0:             default:
Chris@0:                 throw new \InvalidArgumentException('Unexpected Reflector class: ' . get_class($reflector));
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Print the signature name.
Chris@0:      *
Chris@0:      * @param \Reflector $reflector
Chris@0:      *
Chris@0:      * @return string Formatted name
Chris@0:      */
Chris@0:     public static function formatName(\Reflector $reflector)
Chris@0:     {
Chris@0:         return $reflector->getName();
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Print the method, property or class modifiers.
Chris@0:      *
Chris@0:      * Technically this should be a trait. Can't wait for 5.4 :)
Chris@0:      *
Chris@0:      * @param \Reflector $reflector
Chris@0:      *
Chris@0:      * @return string Formatted modifiers
Chris@0:      */
Chris@0:     private static function formatModifiers(\Reflector $reflector)
Chris@0:     {
Chris@0:         return implode(' ', array_map(function ($modifier) {
Chris@0:             return sprintf('<keyword>%s</keyword>', $modifier);
Chris@0:         }, \Reflection::getModifierNames($reflector->getModifiers())));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Format a class signature.
Chris@0:      *
Chris@0:      * @param \ReflectionClass $reflector
Chris@0:      *
Chris@0:      * @return string Formatted signature
Chris@0:      */
Chris@0:     private static function formatClass(\ReflectionClass $reflector)
Chris@0:     {
Chris@0:         $chunks = array();
Chris@0: 
Chris@0:         if ($modifiers = self::formatModifiers($reflector)) {
Chris@0:             $chunks[] = $modifiers;
Chris@0:         }
Chris@0: 
Chris@0:         if (version_compare(PHP_VERSION, '5.4', '>=') && $reflector->isTrait()) {
Chris@0:             $chunks[] = 'trait';
Chris@0:         } else {
Chris@0:             $chunks[] = $reflector->isInterface() ? 'interface' : 'class';
Chris@0:         }
Chris@0: 
Chris@0:         $chunks[] = sprintf('<class>%s</class>', self::formatName($reflector));
Chris@0: 
Chris@0:         if ($parent = $reflector->getParentClass()) {
Chris@0:             $chunks[] = 'extends';
Chris@0:             $chunks[] = sprintf('<class>%s</class>', $parent->getName());
Chris@0:         }
Chris@0: 
Chris@0:         $interfaces = $reflector->getInterfaceNames();
Chris@0:         if (!empty($interfaces)) {
Chris@0:             sort($interfaces);
Chris@0: 
Chris@0:             $chunks[] = 'implements';
Chris@0:             $chunks[] = implode(', ', array_map(function ($name) {
Chris@0:                 return sprintf('<class>%s</class>', $name);
Chris@0:             }, $interfaces));
Chris@0:         }
Chris@0: 
Chris@0:         return implode(' ', $chunks);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Format a constant signature.
Chris@0:      *
Chris@0:      * @param ReflectionConstant $reflector
Chris@0:      *
Chris@0:      * @return string Formatted signature
Chris@0:      */
Chris@0:     private static function formatConstant(ReflectionConstant $reflector)
Chris@0:     {
Chris@0:         $value = $reflector->getValue();
Chris@0:         $style = self::getTypeStyle($value);
Chris@0: 
Chris@0:         return sprintf(
Chris@0:             '<keyword>const</keyword> <const>%s</const> = <%s>%s</%s>',
Chris@0:             self::formatName($reflector),
Chris@0:             $style,
Chris@0:             OutputFormatter::escape(Json::encode($value)),
Chris@0:             $style
Chris@0:         );
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Helper for getting output style for a given value's type.
Chris@0:      *
Chris@0:      * @param mixed $value
Chris@0:      *
Chris@0:      * @return string
Chris@0:      */
Chris@0:     private static function getTypeStyle($value)
Chris@0:     {
Chris@0:         if (is_int($value) || is_float($value)) {
Chris@0:             return 'number';
Chris@0:         } elseif (is_string($value)) {
Chris@0:             return 'string';
Chris@0:         } elseif (is_bool($value) || is_null($value)) {
Chris@0:             return 'bool';
Chris@0:         } else {
Chris@0:             return 'strong';
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Format a property signature.
Chris@0:      *
Chris@0:      * @param \ReflectionProperty $reflector
Chris@0:      *
Chris@0:      * @return string Formatted signature
Chris@0:      */
Chris@0:     private static function formatProperty(\ReflectionProperty $reflector)
Chris@0:     {
Chris@0:         return sprintf(
Chris@0:             '%s <strong>$%s</strong>',
Chris@0:             self::formatModifiers($reflector),
Chris@0:             $reflector->getName()
Chris@0:         );
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Format a function signature.
Chris@0:      *
Chris@0:      * @param \ReflectionFunction $reflector
Chris@0:      *
Chris@0:      * @return string Formatted signature
Chris@0:      */
Chris@0:     private static function formatFunction(\ReflectionFunctionAbstract $reflector)
Chris@0:     {
Chris@0:         return sprintf(
Chris@0:             '<keyword>function</keyword> %s<function>%s</function>(%s)',
Chris@0:             $reflector->returnsReference() ? '&' : '',
Chris@0:             self::formatName($reflector),
Chris@0:             implode(', ', self::formatFunctionParams($reflector))
Chris@0:         );
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Format a method signature.
Chris@0:      *
Chris@0:      * @param \ReflectionMethod $reflector
Chris@0:      *
Chris@0:      * @return string Formatted signature
Chris@0:      */
Chris@0:     private static function formatMethod(\ReflectionMethod $reflector)
Chris@0:     {
Chris@0:         return sprintf(
Chris@0:             '%s %s',
Chris@0:             self::formatModifiers($reflector),
Chris@0:             self::formatFunction($reflector)
Chris@0:         );
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Print the function params.
Chris@0:      *
Chris@0:      * @param \ReflectionFunctionAbstract $reflector
Chris@0:      *
Chris@0:      * @return string
Chris@0:      */
Chris@0:     private static function formatFunctionParams(\ReflectionFunctionAbstract $reflector)
Chris@0:     {
Chris@0:         $params = array();
Chris@0:         foreach ($reflector->getParameters() as $param) {
Chris@0:             $hint = '';
Chris@0:             try {
Chris@0:                 if ($param->isArray()) {
Chris@0:                     $hint = '<keyword>array</keyword> ';
Chris@0:                 } elseif ($class = $param->getClass()) {
Chris@0:                     $hint = sprintf('<class>%s</class> ', $class->getName());
Chris@0:                 }
Chris@0:             } catch (\Exception $e) {
Chris@0:                 // sometimes we just don't know...
Chris@0:                 // bad class names, or autoloaded classes that haven't been loaded yet, or whathaveyou.
Chris@0:                 // come to think of it, the only time I've seen this is with the intl extension.
Chris@0: 
Chris@0:                 // Hax: we'll try to extract it :P
Chris@0:                 $chunks = explode('$' . $param->getName(), (string) $param);
Chris@0:                 $chunks = explode(' ', trim($chunks[0]));
Chris@0:                 $guess  = end($chunks);
Chris@0: 
Chris@0:                 $hint = sprintf('<urgent>%s</urgent> ', $guess);
Chris@0:             }
Chris@0: 
Chris@0:             if ($param->isOptional()) {
Chris@0:                 if (!$param->isDefaultValueAvailable()) {
Chris@0:                     $value     = 'unknown';
Chris@0:                     $typeStyle = 'urgent';
Chris@0:                 } else {
Chris@0:                     $value     = $param->getDefaultValue();
Chris@0:                     $typeStyle = self::getTypeStyle($value);
Chris@0:                     $value     = is_array($value) ? 'array()' : is_null($value) ? 'null' : var_export($value, true);
Chris@0:                 }
Chris@0:                 $default   = sprintf(' = <%s>%s</%s>', $typeStyle, OutputFormatter::escape($value), $typeStyle);
Chris@0:             } else {
Chris@0:                 $default = '';
Chris@0:             }
Chris@0: 
Chris@0:             $params[] = sprintf(
Chris@0:                 '%s%s<strong>$%s</strong>%s',
Chris@0:                 $param->isPassedByReference() ? '&' : '',
Chris@0:                 $hint,
Chris@0:                 $param->getName(),
Chris@0:                 $default
Chris@0:             );
Chris@0:         }
Chris@0: 
Chris@0:         return $params;
Chris@0:     }
Chris@0: }