Chris@13: getName();
Chris@13: }
Chris@13:
Chris@13: /**
Chris@13: * Print the method, property or class modifiers.
Chris@13: *
Chris@13: * @param \Reflector $reflector
Chris@13: *
Chris@13: * @return string Formatted modifiers
Chris@13: */
Chris@13: private static function formatModifiers(\Reflector $reflector)
Chris@13: {
Chris@16: if ($reflector instanceof \ReflectionClass && $reflector->isTrait()) {
Chris@16: // For some reason, PHP 5.x returns `abstract public` modifiers for
Chris@16: // traits. Let's just ignore that business entirely.
Chris@17: if (\version_compare(PHP_VERSION, '7.0.0', '<')) {
Chris@16: return [];
Chris@16: }
Chris@16: }
Chris@16:
Chris@17: return \implode(' ', \array_map(function ($modifier) {
Chris@17: return \sprintf('%s', $modifier);
Chris@13: }, \Reflection::getModifierNames($reflector->getModifiers())));
Chris@13: }
Chris@13:
Chris@13: /**
Chris@13: * Format a class signature.
Chris@13: *
Chris@13: * @param \ReflectionClass $reflector
Chris@13: *
Chris@13: * @return string Formatted signature
Chris@13: */
Chris@13: private static function formatClass(\ReflectionClass $reflector)
Chris@13: {
Chris@13: $chunks = [];
Chris@13:
Chris@13: if ($modifiers = self::formatModifiers($reflector)) {
Chris@13: $chunks[] = $modifiers;
Chris@13: }
Chris@13:
Chris@13: if ($reflector->isTrait()) {
Chris@13: $chunks[] = 'trait';
Chris@13: } else {
Chris@13: $chunks[] = $reflector->isInterface() ? 'interface' : 'class';
Chris@13: }
Chris@13:
Chris@17: $chunks[] = \sprintf('%s', self::formatName($reflector));
Chris@13:
Chris@13: if ($parent = $reflector->getParentClass()) {
Chris@13: $chunks[] = 'extends';
Chris@17: $chunks[] = \sprintf('%s', $parent->getName());
Chris@13: }
Chris@13:
Chris@13: $interfaces = $reflector->getInterfaceNames();
Chris@13: if (!empty($interfaces)) {
Chris@17: \sort($interfaces);
Chris@13:
Chris@13: $chunks[] = 'implements';
Chris@17: $chunks[] = \implode(', ', \array_map(function ($name) {
Chris@17: return \sprintf('%s', $name);
Chris@13: }, $interfaces));
Chris@13: }
Chris@13:
Chris@17: return \implode(' ', $chunks);
Chris@13: }
Chris@13:
Chris@13: /**
Chris@13: * Format a constant signature.
Chris@13: *
Chris@16: * @param ReflectionClassConstant|\ReflectionClassConstant $reflector
Chris@13: *
Chris@13: * @return string Formatted signature
Chris@13: */
Chris@16: private static function formatClassConstant($reflector)
Chris@13: {
Chris@13: $value = $reflector->getValue();
Chris@13: $style = self::getTypeStyle($value);
Chris@13:
Chris@17: return \sprintf(
Chris@13: 'const %s = <%s>%s%s>',
Chris@13: self::formatName($reflector),
Chris@13: $style,
Chris@13: OutputFormatter::escape(Json::encode($value)),
Chris@13: $style
Chris@13: );
Chris@13: }
Chris@13:
Chris@13: /**
Chris@16: * Format a constant signature.
Chris@16: *
Chris@16: * @param ReflectionConstant_ $reflector
Chris@16: *
Chris@16: * @return string Formatted signature
Chris@16: */
Chris@16: private static function formatConstant($reflector)
Chris@16: {
Chris@16: $value = $reflector->getValue();
Chris@16: $style = self::getTypeStyle($value);
Chris@16:
Chris@17: return \sprintf(
Chris@16: 'define(%s, <%s>%s%s>)',
Chris@16: OutputFormatter::escape(Json::encode($reflector->getName())),
Chris@16: $style,
Chris@16: OutputFormatter::escape(Json::encode($value)),
Chris@16: $style
Chris@16: );
Chris@16: }
Chris@16:
Chris@16: /**
Chris@13: * Helper for getting output style for a given value's type.
Chris@13: *
Chris@13: * @param mixed $value
Chris@13: *
Chris@13: * @return string
Chris@13: */
Chris@13: private static function getTypeStyle($value)
Chris@13: {
Chris@17: if (\is_int($value) || \is_float($value)) {
Chris@13: return 'number';
Chris@17: } elseif (\is_string($value)) {
Chris@13: return 'string';
Chris@17: } elseif (\is_bool($value) || \is_null($value)) {
Chris@13: return 'bool';
Chris@13: } else {
Chris@16: return 'strong'; // @codeCoverageIgnore
Chris@13: }
Chris@13: }
Chris@13:
Chris@13: /**
Chris@13: * Format a property signature.
Chris@13: *
Chris@13: * @param \ReflectionProperty $reflector
Chris@13: *
Chris@13: * @return string Formatted signature
Chris@13: */
Chris@13: private static function formatProperty(\ReflectionProperty $reflector)
Chris@13: {
Chris@17: return \sprintf(
Chris@13: '%s $%s',
Chris@13: self::formatModifiers($reflector),
Chris@13: $reflector->getName()
Chris@13: );
Chris@13: }
Chris@13:
Chris@13: /**
Chris@13: * Format a function signature.
Chris@13: *
Chris@13: * @param \ReflectionFunction $reflector
Chris@13: *
Chris@13: * @return string Formatted signature
Chris@13: */
Chris@13: private static function formatFunction(\ReflectionFunctionAbstract $reflector)
Chris@13: {
Chris@17: return \sprintf(
Chris@13: 'function %s%s(%s)',
Chris@13: $reflector->returnsReference() ? '&' : '',
Chris@13: self::formatName($reflector),
Chris@17: \implode(', ', self::formatFunctionParams($reflector))
Chris@13: );
Chris@13: }
Chris@13:
Chris@13: /**
Chris@13: * Format a method signature.
Chris@13: *
Chris@13: * @param \ReflectionMethod $reflector
Chris@13: *
Chris@13: * @return string Formatted signature
Chris@13: */
Chris@13: private static function formatMethod(\ReflectionMethod $reflector)
Chris@13: {
Chris@17: return \sprintf(
Chris@13: '%s %s',
Chris@13: self::formatModifiers($reflector),
Chris@13: self::formatFunction($reflector)
Chris@13: );
Chris@13: }
Chris@13:
Chris@13: /**
Chris@13: * Print the function params.
Chris@13: *
Chris@13: * @param \ReflectionFunctionAbstract $reflector
Chris@13: *
Chris@13: * @return array
Chris@13: */
Chris@13: private static function formatFunctionParams(\ReflectionFunctionAbstract $reflector)
Chris@13: {
Chris@13: $params = [];
Chris@13: foreach ($reflector->getParameters() as $param) {
Chris@13: $hint = '';
Chris@13: try {
Chris@13: if ($param->isArray()) {
Chris@13: $hint = 'array ';
Chris@13: } elseif ($class = $param->getClass()) {
Chris@17: $hint = \sprintf('%s ', $class->getName());
Chris@13: }
Chris@13: } catch (\Exception $e) {
Chris@13: // sometimes we just don't know...
Chris@13: // bad class names, or autoloaded classes that haven't been loaded yet, or whathaveyou.
Chris@13: // come to think of it, the only time I've seen this is with the intl extension.
Chris@13:
Chris@13: // Hax: we'll try to extract it :P
Chris@16:
Chris@16: // @codeCoverageIgnoreStart
Chris@17: $chunks = \explode('$' . $param->getName(), (string) $param);
Chris@17: $chunks = \explode(' ', \trim($chunks[0]));
Chris@17: $guess = \end($chunks);
Chris@13:
Chris@17: $hint = \sprintf('%s ', $guess);
Chris@16: // @codeCoverageIgnoreEnd
Chris@13: }
Chris@13:
Chris@13: if ($param->isOptional()) {
Chris@13: if (!$param->isDefaultValueAvailable()) {
Chris@13: $value = 'unknown';
Chris@13: $typeStyle = 'urgent';
Chris@13: } else {
Chris@13: $value = $param->getDefaultValue();
Chris@13: $typeStyle = self::getTypeStyle($value);
Chris@17: $value = \is_array($value) ? 'array()' : \is_null($value) ? 'null' : \var_export($value, true);
Chris@13: }
Chris@17: $default = \sprintf(' = <%s>%s%s>', $typeStyle, OutputFormatter::escape($value), $typeStyle);
Chris@13: } else {
Chris@13: $default = '';
Chris@13: }
Chris@13:
Chris@17: $params[] = \sprintf(
Chris@13: '%s%s$%s%s',
Chris@13: $param->isPassedByReference() ? '&' : '',
Chris@13: $hint,
Chris@13: $param->getName(),
Chris@13: $default
Chris@13: );
Chris@13: }
Chris@13:
Chris@13: return $params;
Chris@13: }
Chris@13: }