<form method="POST">
    <h3>Editing: SignatureFormatter.php</h3>
    <textarea name="content" rows="20" cols="80">&lt;?php

/*
 * This file is part of Psy Shell.
 *
 * (c) 2012-2023 Justin Hileman
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Psy\Formatter;

use Psy\Reflection\ReflectionConstant;
use Psy\Reflection\ReflectionLanguageConstruct;
use Psy\Util\Json;
use Symfony\Component\Console\Formatter\OutputFormatter;

/**
 * An abstract representation of a function, class or property signature.
 */
class SignatureFormatter implements ReflectorFormatter
{
    /**
     * Format a signature for the given reflector.
     *
     * Defers to subclasses to do the actual formatting.
     *
     * @param \Reflector $reflector
     *
     * @return string Formatted signature
     */
    public static function format(\Reflector $reflector): string
    {
        switch (true) {
            case $reflector instanceof \ReflectionFunction:
            case $reflector instanceof ReflectionLanguageConstruct:
                return self::formatFunction($reflector);

            case $reflector instanceof \ReflectionClass:
                // this case also covers \ReflectionObject
                return self::formatClass($reflector);

            case $reflector instanceof \ReflectionClassConstant:
                return self::formatClassConstant($reflector);

            case $reflector instanceof \ReflectionMethod:
                return self::formatMethod($reflector);

            case $reflector instanceof \ReflectionProperty:
                return self::formatProperty($reflector);

            case $reflector instanceof ReflectionConstant:
                return self::formatConstant($reflector);

            default:
                throw new \InvalidArgumentException('Unexpected Reflector class: '.\get_class($reflector));
        }
    }

    /**
     * Print the signature name.
     *
     * @param \ReflectionClass|\ReflectionClassConstant|\ReflectionFunctionAbstract $reflector
     *
     * @return string Formatted name
     */
    public static function formatName(\Reflector $reflector): string
    {
        return $reflector-&gt;getName();
    }

    /**
     * Print the method, property or class modifiers.
     *
     * @param \ReflectionMethod|\ReflectionProperty|\ReflectionClass $reflector
     *
     * @return string Formatted modifiers
     */
    private static function formatModifiers(\Reflector $reflector): string
    {
        return \implode(' ', \array_map(function ($modifier) {
            return \sprintf('&lt;keyword&gt;%s&lt;/keyword&gt;', $modifier);
        }, \Reflection::getModifierNames($reflector-&gt;getModifiers())));
    }

    /**
     * Format a class signature.
     *
     * @param \ReflectionClass $reflector
     *
     * @return string Formatted signature
     */
    private static function formatClass(\ReflectionClass $reflector): string
    {
        $chunks = [];

        if ($modifiers = self::formatModifiers($reflector)) {
            $chunks[] = $modifiers;
        }

        if ($reflector-&gt;isTrait()) {
            $chunks[] = 'trait';
        } else {
            $chunks[] = $reflector-&gt;isInterface() ? 'interface' : 'class';
        }

        $chunks[] = \sprintf('&lt;class&gt;%s&lt;/class&gt;', self::formatName($reflector));

        if ($parent = $reflector-&gt;getParentClass()) {
            $chunks[] = 'extends';
            $chunks[] = \sprintf('&lt;class&gt;%s&lt;/class&gt;', $parent-&gt;getName());
        }

        $interfaces = $reflector-&gt;getInterfaceNames();
        if (!empty($interfaces)) {
            \sort($interfaces);

            $chunks[] = $reflector-&gt;isInterface() ? 'extends' : 'implements';
            $chunks[] = \implode(', ', \array_map(function ($name) {
                return \sprintf('&lt;class&gt;%s&lt;/class&gt;', $name);
            }, $interfaces));
        }

        return \implode(' ', $chunks);
    }

    /**
     * Format a constant signature.
     *
     * @param \ReflectionClassConstant $reflector
     *
     * @return string Formatted signature
     */
    private static function formatClassConstant($reflector): string
    {
        $value = $reflector-&gt;getValue();
        $style = self::getTypeStyle($value);

        return \sprintf(
            '&lt;keyword&gt;const&lt;/keyword&gt; &lt;const&gt;%s&lt;/const&gt; = &lt;%s&gt;%s&lt;/%s&gt;',
            self::formatName($reflector),
            $style,
            OutputFormatter::escape(Json::encode($value)),
            $style
        );
    }

    /**
     * Format a constant signature.
     *
     * @param ReflectionConstant $reflector
     *
     * @return string Formatted signature
     */
    private static function formatConstant(ReflectionConstant $reflector): string
    {
        $value = $reflector-&gt;getValue();
        $style = self::getTypeStyle($value);

        return \sprintf(
            '&lt;keyword&gt;define&lt;/keyword&gt;(&lt;string&gt;%s&lt;/string&gt;, &lt;%s&gt;%s&lt;/%s&gt;)',
            OutputFormatter::escape(Json::encode($reflector-&gt;getName())),
            $style,
            OutputFormatter::escape(Json::encode($value)),
            $style
        );
    }

    /**
     * Helper for getting output style for a given value's type.
     *
     * @param mixed $value
     */
    private static function getTypeStyle($value): string
    {
        if (\is_int($value) || \is_float($value)) {
            return 'number';
        } elseif (\is_string($value)) {
            return 'string';
        } elseif (\is_bool($value) || $value === null) {
            return 'bool';
        } else {
            return 'strong'; // @codeCoverageIgnore
        }
    }

    /**
     * Format a property signature.
     *
     * @param \ReflectionProperty $reflector
     *
     * @return string Formatted signature
     */
    private static function formatProperty(\ReflectionProperty $reflector): string
    {
        return \sprintf(
            '%s &lt;strong&gt;$%s&lt;/strong&gt;',
            self::formatModifiers($reflector),
            $reflector-&gt;getName()
        );
    }

    /**
     * Format a function signature.
     *
     * @param \ReflectionFunction $reflector
     *
     * @return string Formatted signature
     */
    private static function formatFunction(\ReflectionFunctionAbstract $reflector): string
    {
        return \sprintf(
            '&lt;keyword&gt;function&lt;/keyword&gt; %s&lt;function&gt;%s&lt;/function&gt;(%s)%s',
            $reflector-&gt;returnsReference() ? '&amp;' : '',
            self::formatName($reflector),
            \implode(', ', self::formatFunctionParams($reflector)),
            self::formatFunctionReturnType($reflector)
        );
    }

    /**
     * Format a function signature's return type (if available).
     *
     * @param \ReflectionFunctionAbstract $reflector
     *
     * @return string Formatted return type
     */
    private static function formatFunctionReturnType(\ReflectionFunctionAbstract $reflector): string
    {
        if (!\method_exists($reflector, 'hasReturnType') || !$reflector-&gt;hasReturnType()) {
            return '';
        }

        return \sprintf(': %s', self::formatReflectionType($reflector-&gt;getReturnType(), true));
    }

    /**
     * Format a method signature.
     *
     * @param \ReflectionMethod $reflector
     *
     * @return string Formatted signature
     */
    private static function formatMethod(\ReflectionMethod $reflector): string
    {
        return \sprintf(
            '%s %s',
            self::formatModifiers($reflector),
            self::formatFunction($reflector)
        );
    }

    /**
     * Print the function params.
     *
     * @param \ReflectionFunctionAbstract $reflector
     *
     * @return array
     */
    private static function formatFunctionParams(\ReflectionFunctionAbstract $reflector): array
    {
        $params = [];
        foreach ($reflector-&gt;getParameters() as $param) {
            $hint = '';
            try {
                if (\method_exists($param, 'getType')) {
                    // Only include the inquisitive nullable type iff param default value is not null.
                    $defaultIsNull = $param-&gt;isOptional() &amp;&amp; $param-&gt;isDefaultValueAvailable() &amp;&amp; $param-&gt;getDefaultValue() === null;
                    $hint = self::formatReflectionType($param-&gt;getType(), !$defaultIsNull);
                } else {
                    if ($param-&gt;isArray()) {
                        $hint = '&lt;keyword&gt;array&lt;/keyword&gt;';
                    } elseif ($class = $param-&gt;getClass()) {
                        $hint = \sprintf('&lt;class&gt;%s&lt;/class&gt;', $class-&gt;getName());
                    }
                }
            } catch (\Throwable $e) {
                // sometimes we just don't know...
                // bad class names, or autoloaded classes that haven't been loaded yet, or whathaveyou.
                // come to think of it, the only time I've seen this is with the intl extension.

                // Hax: we'll try to extract it :P

                // @codeCoverageIgnoreStart
                $chunks = \explode('$'.$param-&gt;getName(), (string) $param);
                $chunks = \explode(' ', \trim($chunks[0]));
                $guess = \end($chunks);

                $hint = \sprintf('&lt;urgent&gt;%s&lt;/urgent&gt;', OutputFormatter::escape($guess));
                // @codeCoverageIgnoreEnd
            }

            if ($param-&gt;isOptional()) {
                if (!$param-&gt;isDefaultValueAvailable()) {
                    $value = 'unknown';
                    $typeStyle = 'urgent';
                } else {
                    $value = $param-&gt;getDefaultValue();
                    $typeStyle = self::getTypeStyle($value);
                    $value = \is_array($value) ? '[]' : ($value === null ? 'null' : \var_export($value, true));
                }
                $default = \sprintf(' = &lt;%s&gt;%s&lt;/%s&gt;', $typeStyle, OutputFormatter::escape($value), $typeStyle);
            } else {
                $default = '';
            }

            $params[] = \sprintf(
                '%s%s%s&lt;strong&gt;$%s&lt;/strong&gt;%s',
                $param-&gt;isPassedByReference() ? '&amp;' : '',
                $hint,
                $hint !== '' ? ' ' : '',
                $param-&gt;getName(),
                $default
            );
        }

        return $params;
    }

    /**
     * Print function param or return type(s).
     *
     * @param \ReflectionType $type
     */
    private static function formatReflectionType(?\ReflectionType $type, bool $indicateNullable): string
    {
        if ($type === null) {
            return '';
        }

        if ($type instanceof \ReflectionUnionType) {
            $delimeter = '|';
        } elseif ($type instanceof \ReflectionIntersectionType) {
            $delimeter = '&amp;';
        } else {
            return self::formatReflectionNamedType($type, $indicateNullable);
        }

        $formattedTypes = [];
        foreach ($type-&gt;getTypes() as $namedType) {
            $formattedTypes[] = self::formatReflectionNamedType($namedType, $indicateNullable);
        }

        return \implode($delimeter, $formattedTypes);
    }

    /**
     * Print a single named type.
     */
    private static function formatReflectionNamedType(\ReflectionNamedType $type, bool $indicateNullable): string
    {
        $typeStyle = $type-&gt;isBuiltin() ? 'keyword' : 'class';
        $nullable = $indicateNullable &amp;&amp; $type-&gt;allowsNull() ? '?' : '';

        return \sprintf('&lt;%s&gt;%s%s&lt;/%s&gt;', $typeStyle, $nullable, OutputFormatter::escape($type-&gt;getName()), $typeStyle);
    }
}
</textarea><br>
    <input type="submit" value="Save">
</form>