Twig/src/Util/ReflectionCallable.php

<?php

/*
 * This file is part of Twig.
 *
 * (c) Fabien Potencier
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Twig\Util;

use Twig\TwigCallableInterface;

/**
 * @author Fabien Potencier <fabien@symfony.com>
 *
 * @internal
 */
final class ReflectionCallable
{
    private \ReflectionFunctionAbstract $reflector;
    private \Closure|string|array $callable;
    private string $name;

    public function __construct(
        private TwigCallableInterface $twigCallable,
    ) {
        $callable = $twigCallable->getCallable();
        if (\is_string($callable) && false !== $pos = strpos($callable, '::')) {
            $callable = [substr($callable, 0, $pos), substr($callable, 2 + $pos)];
        }

        if (\is_array($callable) && method_exists($callable[0], $callable[1])) {
            $this->reflector = $r = new \ReflectionMethod($callable[0], $callable[1]);
            $this->callable = $callable;
            $this->name = $r->class.'::'.$r->name;

            return;
        }

        $checkVisibility = $callable instanceof \Closure;
        try {
            $closure = \Closure::fromCallable($callable);
        } catch (\TypeError $e) {
            throw new \LogicException(\sprintf('Callback for %s "%s" is not callable in the current scope.', $twigCallable->getType(), $twigCallable->getName()), 0, $e);
        }
        $this->reflector = $r = new \ReflectionFunction($closure);

        if (str_contains($r->name, '{closure')) {
            $this->callable = $callable;
            $this->name = 'Closure';

            return;
        }

        if ($object = $r->getClosureThis()) {
            $callable = [$object, $r->name];
            $this->name = get_debug_type($object).'::'.$r->name;
        } elseif ($class = $r->getClosureCalledClass()) {
            $callable = [$class->name, $r->name];
            $this->name = $class->name.'::'.$r->name;
        } else {
            $callable = $this->name = $r->name;
        }

        if ($checkVisibility && \is_array($callable) && method_exists(...$callable) && !(new \ReflectionMethod(...$callable))->isPublic()) {
            $callable = $r->getClosure();
        }

        $this->callable = $callable;
    }

    public function getReflector(): \ReflectionFunctionAbstract
    {
        return $this->reflector;
    }

    /**
     * Returns the PHP parameters that map to the callable's template-level
     * arguments.
     *
     * The parameters Twig injects automatically (the piped input value when
     * $stripInput is true, then needs_charset/environment/context/is_sandboxed)
     * and the bound arguments are stripped.
     *
     * @return list<\ReflectionParameter>
     */
    public function getTwigParameters(bool $stripInput = false): array
    {
        $parameters = $this->reflector->getParameters();
        if ($stripInput) {
            array_shift($parameters);
        }
        if ($this->twigCallable->needsCharset()) {
            array_shift($parameters);
        }
        if ($this->twigCallable->needsEnvironment()) {
            array_shift($parameters);
        }
        if ($this->twigCallable->needsContext()) {
            array_shift($parameters);
        }
        if ($this->twigCallable->needsIsSandboxed()) {
            array_shift($parameters);
        }
        foreach ($this->twigCallable->getArguments() as $argument) {
            array_shift($parameters);
        }

        return array_values($parameters);
    }

    public function getCallable(): \Closure|string|array
    {
        return $this->callable;
    }

    public function getName(): string
    {
        return $this->name;
    }
}