vendor/twig/twig/src/AbstractTwigCallable.php line 51

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of Twig.
  5.  *
  6.  * (c) Fabien Potencier
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Twig;
  14. /**
  15.  * @author Fabien Potencier <fabien@symfony.com>
  16.  */
  17. abstract class AbstractTwigCallable implements TwigCallableInterface
  18. {
  19.     protected $options;
  21.     private $name;
  22.     private $dynamicName;
  23.     private $callable;
  24.     private $arguments;
  26.     public function __construct(string $name, $callable = null, array $options = [])
  27.     {
  28.         $this->name = $this->dynamicName = $name;
  29.         $this->callable = $callable;
  30.         $this->arguments = [];
  31.         $this->options = array_merge([
  32.             'needs_environment' => false,
  33.             'needs_context' => false,
  34.             'needs_charset' => false,
  35.             'is_variadic' => false,
  36.             'deprecation_info' => null,
  37.             'deprecated' => false,
  38.             'deprecating_package' => '',
  39.             'alternative' => null,
  40.         ], $options);
  42.         if ($this->options['deprecation_info'] && !$this->options['deprecation_info'] instanceof DeprecatedCallableInfo) {
  43.             throw new \LogicException(\sprintf('The "deprecation_info" option must be an instance of "%s".', DeprecatedCallableInfo::class));
  44.         }
  46.         if ($this->options['deprecated']) {
  47.             if ($this->options['deprecation_info']) {
  48.                 throw new \LogicException('When setting the "deprecation_info" option, you need to remove the obsolete deprecated options.');
  49.             }
  51.             trigger_deprecation('twig/twig', '3.15', 'Using the "deprecated", "deprecating_package", and "alternative" options is deprecated, pass a "deprecation_info" one instead.');
  53.             $this->options['deprecation_info'] = new DeprecatedCallableInfo(
  54.                 $this->options['deprecating_package'],
  55.                 $this->options['deprecated'],
  56.                 null,
  57.                 $this->options['alternative'],
  58.             );
  59.         }
  61.         if ($this->options['deprecation_info']) {
  62.             $this->options['deprecation_info']->setName($name);
  63.             $this->options['deprecation_info']->setType($this->getType());
  64.         }
  65.     }
  67.     public function __toString(): string
  68.     {
  69.         return \sprintf('%s(%s)', static::class, $this->name);
  70.     }
  72.     public function getName(): string
  73.     {
  74.         return $this->name;
  75.     }
  77.     public function getDynamicName(): string
  78.     {
  79.         return $this->dynamicName;
  80.     }
  82.     public function getCallable()
  83.     {
  84.         return $this->callable;
  85.     }
  87.     public function getNodeClass(): string
  88.     {
  89.         return $this->options['node_class'];
  90.     }
  92.     public function needsCharset(): bool
  93.     {
  94.         return $this->options['needs_charset'];
  95.     }
  97.     public function needsEnvironment(): bool
  98.     {
  99.         return $this->options['needs_environment'];
  100.     }
  102.     public function needsContext(): bool
  103.     {
  104.         return $this->options['needs_context'];
  105.     }
  107.     /**
  108.      * @return static
  109.      */
  110.     public function withDynamicArguments(string $name, string $dynamicName, array $arguments): self
  111.     {
  112.         $new = clone $this;
  113.         $new->name = $name;
  114.         $new->dynamicName = $dynamicName;
  115.         $new->arguments = $arguments;
  117.         return $new;
  118.     }
  120.     /**
  121.      * @deprecated since Twig 3.12, use withDynamicArguments() instead
  122.      */
  123.     public function setArguments(array $arguments): void
  124.     {
  125.         trigger_deprecation('twig/twig', '3.12', 'The "%s::setArguments()" method is deprecated, use "%s::withDynamicArguments()" instead.', static::class, static::class);
  127.         $this->arguments = $arguments;
  128.     }
  130.     public function getArguments(): array
  131.     {
  132.         return $this->arguments;
  133.     }
  135.     public function isVariadic(): bool
  136.     {
  137.         return $this->options['is_variadic'];
  138.     }
  140.     public function isDeprecated(): bool
  141.     {
  142.         return (bool) $this->options['deprecation_info'];
  143.     }
  145.     public function triggerDeprecation(?string $file = null, ?int $line = null): void
  146.     {
  147.         $this->options['deprecation_info']->triggerDeprecation($file, $line);
  148.     }
  150.     /**
  151.      * @deprecated since Twig 3.15
  152.      */
  153.     public function getDeprecatingPackage(): string
  154.     {
  155.         trigger_deprecation('twig/twig', '3.15', 'The "%s" method is deprecated, use "%s::triggerDeprecation()" instead.', __METHOD__, static::class);
  157.         return $this->options['deprecating_package'];
  158.     }
  160.     /**
  161.      * @deprecated since Twig 3.15
  162.      */
  163.     public function getDeprecatedVersion(): string
  164.     {
  165.         trigger_deprecation('twig/twig', '3.15', 'The "%s" method is deprecated, use "%s::triggerDeprecation()" instead.', __METHOD__, static::class);
  167.         return \is_bool($this->options['deprecated']) ? '' : $this->options['deprecated'];
  168.     }
  170.     /**
  171.      * @deprecated since Twig 3.15
  172.      */
  173.     public function getAlternative(): ?string
  174.     {
  175.         trigger_deprecation('twig/twig', '3.15', 'The "%s" method is deprecated, use "%s::triggerDeprecation()" instead.', __METHOD__, static::class);
  177.         return $this->options['alternative'];
  178.     }
  180.     public function getMinimalNumberOfRequiredArguments(): int
  181.     {
  182.         return ($this->options['needs_charset'] ? 1 : 0) + ($this->options['needs_environment'] ? 1 : 0) + ($this->options['needs_context'] ? 1 : 0) + \count($this->arguments);
  183.     }
  184. }