sunrise-php / http-router

src/Helper/ReflectorHelper.php

<?php

/**
 * It's free open-source software released under the MIT License.
 *
 * @author Anatoly Nekhay <afenric@gmail.com>
 * @copyright Copyright (c) 2018, Anatoly Nekhay
 * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE
 * @link https://github.com/sunrise-php/http-router
 */

declare(strict_types=1);

namespace Sunrise\Http\Router\Helper;

use ReflectionClass;
use ReflectionMethod;

use function array_reverse;

/**
 * @since 3.0.0
 */
final class ReflectorHelper
{
    /**
     * @param ReflectionClass<object> $class
     *
     * @return array<array-key, ReflectionClass<object>>

The doc comment array<array-key, ReflectionClass<object>> at position 2 could not be parsed: Unknown type name 'array-key' at position 2 in array<array-key, ReflectionClass<object>>.

     */
    public static function getClassAncestry(ReflectionClass $class): array
    {
        $ancestry = [$class];
        while ($class = $class->getParentClass()) {
            $ancestry[] = $class;
        }

        return array_reverse($ancestry);
    }

    /**
     * @param ReflectionMethod $method
     *
     * @return array<array-key, ReflectionClass<object>|ReflectionMethod>

The doc comment array<array-key, ReflectionClass<object>|ReflectionMethod> at position 2 could not be parsed: Unknown type name 'array-key' at position 2 in array<array-key, ReflectionClass<object>|ReflectionMethod>.

     */
    public static function getMethodAncestry(ReflectionMethod $method): array
    {
        $ancestry = self::getClassAncestry($method->getDeclaringClass());
        $ancestry[] = $method;

        return $ancestry;
    }

    /**
     * @param ReflectionClass<object>|ReflectionMethod $proband
     *
     * @return array<array-key, ReflectionClass<object>|ReflectionMethod>

The doc comment array<array-key, ReflectionClass<object>|ReflectionMethod> at position 2 could not be parsed: Unknown type name 'array-key' at position 2 in array<array-key, ReflectionClass<object>|ReflectionMethod>.

     */
    public static function getAncestry(ReflectionClass|ReflectionMethod $proband): array
    {
        return $proband instanceof ReflectionClass
            ? self::getClassAncestry($proband)
            : self::getMethodAncestry($proband);
    }
}