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

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. 'needs_is_sandboxed' => false,
  36. 'is_variadic' => false,
  37. 'always_allowed_in_sandbox' => false,
  38. 'deprecation_info' => null,
  39. 'deprecated' => false,
  40. 'deprecating_package' => '',
  41. 'alternative' => null,
  42. ], $options);
  44. if ($this->options['deprecation_info'] && !$this->options['deprecation_info'] instanceof DeprecatedCallableInfo) {
  45. throw new \LogicException(\sprintf('The "deprecation_info" option must be an instance of "%s".', DeprecatedCallableInfo::class));
  46. }
  48. if ($this->options['deprecated']) {
  49. if ($this->options['deprecation_info']) {
  50. throw new \LogicException('When setting the "deprecation_info" option, you need to remove the obsolete deprecated options.');
  51. }
  53. trigger_deprecation('twig/twig', '3.15', 'Using the "deprecated", "deprecating_package", and "alternative" options is deprecated, pass a "deprecation_info" one instead.');
  55. $this->options['deprecation_info'] = new DeprecatedCallableInfo(
  56. $this->options['deprecating_package'],
  57. $this->options['deprecated'],
  58. null,
  59. $this->options['alternative'],
  60. );
  61. }
  63. if ($this->options['deprecation_info']) {
  64. $this->options['deprecation_info']->setName($name);
  65. $this->options['deprecation_info']->setType($this->getType());
  66. }
  67. }
  69. public function __toString(): string
  70. {
  71. return \sprintf('%s(%s)', static::class, $this->name);
  72. }
  74. public function getName(): string
  75. {
  76. return $this->name;
  77. }
  79. public function getDynamicName(): string
  80. {
  81. return $this->dynamicName;
  82. }
  84. /**
  85. * @return callable|array{class-string, string}|null
  86. */
  87. public function getCallable()
  88. {
  89. return $this->callable;
  90. }
  92. public function getNodeClass(): string
  93. {
  94. return $this->options['node_class'];
  95. }
  97. public function needsCharset(): bool
  98. {
  99. return $this->options['needs_charset'];
  100. }
  102. public function needsEnvironment(): bool
  103. {
  104. return $this->options['needs_environment'];
  105. }
  107. public function needsContext(): bool
  108. {
  109. return $this->options['needs_context'];
  110. }
  112. public function needsIsSandboxed(): bool
  113. {
  114. return $this->options['needs_is_sandboxed'];
  115. }
  117. public function isAlwaysAllowedInSandbox(): bool
  118. {
  119. return $this->options['always_allowed_in_sandbox'];
  120. }
  122. /**
  123. * @return static
  124. */
  125. public function withDynamicArguments(string $name, string $dynamicName, array $arguments): self
  126. {
  127. $new = clone $this;
  128. $new->name = $name;
  129. $new->dynamicName = $dynamicName;
  130. $new->arguments = $arguments;
  132. return $new;
  133. }
  135. /**
  136. * @deprecated since Twig 3.12, use withDynamicArguments() instead
  137. */
  138. public function setArguments(array $arguments): void
  139. {
  140. trigger_deprecation('twig/twig', '3.12', 'The "%s::setArguments()" method is deprecated, use "%s::withDynamicArguments()" instead.', static::class, static::class);
  142. $this->arguments = $arguments;
  143. }
  145. public function getArguments(): array
  146. {
  147. return $this->arguments;
  148. }
  150. public function isVariadic(): bool
  151. {
  152. return $this->options['is_variadic'];
  153. }
  155. public function isDeprecated(): bool
  156. {
  157. return (bool) $this->options['deprecation_info'];
  158. }
  160. public function triggerDeprecation(?string $file = null, ?int $line = null): void
  161. {
  162. $this->options['deprecation_info']->triggerDeprecation($file, $line);
  163. }
  165. /**
  166. * @deprecated since Twig 3.15
  167. */
  168. public function getDeprecatingPackage(): string
  169. {
  170. trigger_deprecation('twig/twig', '3.15', 'The "%s" method is deprecated, use "%s::triggerDeprecation()" instead.', __METHOD__, static::class);
  172. return $this->options['deprecating_package'];
  173. }
  175. /**
  176. * @deprecated since Twig 3.15
  177. */
  178. public function getDeprecatedVersion(): string
  179. {
  180. trigger_deprecation('twig/twig', '3.15', 'The "%s" method is deprecated, use "%s::triggerDeprecation()" instead.', __METHOD__, static::class);
  182. return \is_bool($this->options['deprecated']) ? '' : $this->options['deprecated'];
  183. }
  185. /**
  186. * @deprecated since Twig 3.15
  187. */
  188. public function getAlternative(): ?string
  189. {
  190. trigger_deprecation('twig/twig', '3.15', 'The "%s" method is deprecated, use "%s::triggerDeprecation()" instead.', __METHOD__, static::class);
  192. return $this->options['alternative'];
  193. }
  195. public function getMinimalNumberOfRequiredArguments(): int
  196. {
  197. return ($this->options['needs_charset'] ? 1 : 0) + ($this->options['needs_environment'] ? 1 : 0) + ($this->options['needs_context'] ? 1 : 0) + ($this->options['needs_is_sandboxed'] ? 1 : 0) + \count($this->arguments);
  198. }
  199. }