vendor/twig/twig/src/TwigFunction.php line 31

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. use Twig\Node\Expression\FunctionExpression;
  15. use Twig\Node\Node;
  17. /**
  18. * Represents a template function.
  19. *
  20. * @author Fabien Potencier <fabien@symfony.com>
  21. *
  22. * @see https://twig.symfony.com/doc/templates.html#functions
  23. */
  24. final class TwigFunction extends AbstractTwigCallable
  25. {
  26. /**
  27. * @param callable|array{class-string, string}|null $callable A callable implementing the function. If null, you need to overwrite the "node_class" option to customize compilation.
  28. */
  29. public function __construct(string $name, $callable = null, array $options = [])
  30. {
  31. parent::__construct($name, $callable, $options);
  33. $this->options = array_merge([
  34. 'is_safe' => null,
  35. 'is_safe_callback' => null,
  36. 'node_class' => FunctionExpression::class,
  37. 'parser_callable' => null,
  38. ], $this->options);
  39. }
  41. public function getType(): string
  42. {
  43. return 'function';
  44. }
  46. public function getParserCallable(): ?callable
  47. {
  48. return $this->options['parser_callable'];
  49. }
  51. public function getSafe(Node $functionArgs): ?array
  52. {
  53. if (null !== $this->options['is_safe']) {
  54. return $this->options['is_safe'];
  55. }
  57. if (null !== $this->options['is_safe_callback']) {
  58. return $this->options['is_safe_callback']($functionArgs);
  59. }
  61. return [];
  62. }
  63. }