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. /**
  83. * @return callable|array{class-string, string}|null
  84. */
  85. public function getCallable()
  86. {
  87. return $this->callable;
  88. }
  90. public function getNodeClass(): string
  91. {
  92. return $this->options['node_class'];
  93. }
  95. public function needsCharset(): bool
  96. {
  97. return $this->options['needs_charset'];
  98. }
  100. public function needsEnvironment(): bool
  101. {
  102. return $this->options['needs_environment'];
  103. }
  105. public function needsContext(): bool
  106. {
  107. return $this->options['needs_context'];
  108. }
  110. /**
  111. * @return static
  112. */
  113. public function withDynamicArguments(string $name, string $dynamicName, array $arguments): self
  114. {
  115. $new = clone $this;
  116. $new->name = $name;
  117. $new->dynamicName = $dynamicName;
  118. $new->arguments = $arguments;
  120. return $new;
  121. }
  123. /**
  124. * @deprecated since Twig 3.12, use withDynamicArguments() instead
  125. */
  126. public function setArguments(array $arguments): void
  127. {
  128. trigger_deprecation('twig/twig', '3.12', 'The "%s::setArguments()" method is deprecated, use "%s::withDynamicArguments()" instead.', static::class, static::class);
  130. $this->arguments = $arguments;
  131. }
  133. public function getArguments(): array
  134. {
  135. return $this->arguments;
  136. }
  138. public function isVariadic(): bool
  139. {
  140. return $this->options['is_variadic'];
  141. }
  143. public function isDeprecated(): bool
  144. {
  145. return (bool) $this->options['deprecation_info'];
  146. }
  148. public function triggerDeprecation(?string $file = null, ?int $line = null): void
  149. {
  150. $this->options['deprecation_info']->triggerDeprecation($file, $line);
  151. }
  153. /**
  154. * @deprecated since Twig 3.15
  155. */
  156. public function getDeprecatingPackage(): string
  157. {
  158. trigger_deprecation('twig/twig', '3.15', 'The "%s" method is deprecated, use "%s::triggerDeprecation()" instead.', __METHOD__, static::class);
  160. return $this->options['deprecating_package'];
  161. }
  163. /**
  164. * @deprecated since Twig 3.15
  165. */
  166. public function getDeprecatedVersion(): string
  167. {
  168. trigger_deprecation('twig/twig', '3.15', 'The "%s" method is deprecated, use "%s::triggerDeprecation()" instead.', __METHOD__, static::class);
  170. return \is_bool($this->options['deprecated']) ? '' : $this->options['deprecated'];
  171. }
  173. /**
  174. * @deprecated since Twig 3.15
  175. */
  176. public function getAlternative(): ?string
  177. {
  178. trigger_deprecation('twig/twig', '3.15', 'The "%s" method is deprecated, use "%s::triggerDeprecation()" instead.', __METHOD__, static::class);
  180. return $this->options['alternative'];
  181. }
  183. public function getMinimalNumberOfRequiredArguments(): int
  184. {
  185. return ($this->options['needs_charset'] ? 1 : 0) + ($this->options['needs_environment'] ? 1 : 0) + ($this->options['needs_context'] ? 1 : 0) + \count($this->arguments);
  186. }
  187. }