vendor/twig/twig/src/Extension/CoreExtension.php line 1909

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\Extension;
  14. use Twig\DeprecatedCallableInfo;
  15. use Twig\Environment;
  16. use Twig\Error\LoaderError;
  17. use Twig\Error\RuntimeError;
  18. use Twig\Error\SyntaxError;
  19. use Twig\ExpressionParser\Infix\ArrowExpressionParser;
  20. use Twig\ExpressionParser\Infix\BinaryOperatorExpressionParser;
  21. use Twig\ExpressionParser\Infix\ConditionalTernaryExpressionParser;
  22. use Twig\ExpressionParser\Infix\DotExpressionParser;
  23. use Twig\ExpressionParser\Infix\FilterExpressionParser;
  24. use Twig\ExpressionParser\Infix\FunctionExpressionParser;
  25. use Twig\ExpressionParser\Infix\IsExpressionParser;
  26. use Twig\ExpressionParser\Infix\IsNotExpressionParser;
  27. use Twig\ExpressionParser\Infix\SquareBracketExpressionParser;
  28. use Twig\ExpressionParser\InfixAssociativity;
  29. use Twig\ExpressionParser\PrecedenceChange;
  30. use Twig\ExpressionParser\Prefix\GroupingExpressionParser;
  31. use Twig\ExpressionParser\Prefix\LiteralExpressionParser;
  32. use Twig\ExpressionParser\Prefix\UnaryOperatorExpressionParser;
  33. use Twig\Markup;
  34. use Twig\Node\Expression\AbstractExpression;
  35. use Twig\Node\Expression\Binary\AddBinary;
  36. use Twig\Node\Expression\Binary\AndBinary;
  37. use Twig\Node\Expression\Binary\BitwiseAndBinary;
  38. use Twig\Node\Expression\Binary\BitwiseOrBinary;
  39. use Twig\Node\Expression\Binary\BitwiseXorBinary;
  40. use Twig\Node\Expression\Binary\ConcatBinary;
  41. use Twig\Node\Expression\Binary\DivBinary;
  42. use Twig\Node\Expression\Binary\ElvisBinary;
  43. use Twig\Node\Expression\Binary\EndsWithBinary;
  44. use Twig\Node\Expression\Binary\EqualBinary;
  45. use Twig\Node\Expression\Binary\FloorDivBinary;
  46. use Twig\Node\Expression\Binary\GreaterBinary;
  47. use Twig\Node\Expression\Binary\GreaterEqualBinary;
  48. use Twig\Node\Expression\Binary\HasEveryBinary;
  49. use Twig\Node\Expression\Binary\HasSomeBinary;
  50. use Twig\Node\Expression\Binary\InBinary;
  51. use Twig\Node\Expression\Binary\LessBinary;
  52. use Twig\Node\Expression\Binary\LessEqualBinary;
  53. use Twig\Node\Expression\Binary\MatchesBinary;
  54. use Twig\Node\Expression\Binary\ModBinary;
  55. use Twig\Node\Expression\Binary\MulBinary;
  56. use Twig\Node\Expression\Binary\NotEqualBinary;
  57. use Twig\Node\Expression\Binary\NotInBinary;
  58. use Twig\Node\Expression\Binary\NullCoalesceBinary;
  59. use Twig\Node\Expression\Binary\OrBinary;
  60. use Twig\Node\Expression\Binary\PowerBinary;
  61. use Twig\Node\Expression\Binary\RangeBinary;
  62. use Twig\Node\Expression\Binary\SpaceshipBinary;
  63. use Twig\Node\Expression\Binary\StartsWithBinary;
  64. use Twig\Node\Expression\Binary\SubBinary;
  65. use Twig\Node\Expression\Binary\XorBinary;
  66. use Twig\Node\Expression\BlockReferenceExpression;
  67. use Twig\Node\Expression\Filter\DefaultFilter;
  68. use Twig\Node\Expression\FunctionNode\EnumCasesFunction;
  69. use Twig\Node\Expression\FunctionNode\EnumFunction;
  70. use Twig\Node\Expression\GetAttrExpression;
  71. use Twig\Node\Expression\ParentExpression;
  72. use Twig\Node\Expression\Test\ConstantTest;
  73. use Twig\Node\Expression\Test\DefinedTest;
  74. use Twig\Node\Expression\Test\DivisiblebyTest;
  75. use Twig\Node\Expression\Test\EvenTest;
  76. use Twig\Node\Expression\Test\NullTest;
  77. use Twig\Node\Expression\Test\OddTest;
  78. use Twig\Node\Expression\Test\SameasTest;
  79. use Twig\Node\Expression\Test\TrueTest;
  80. use Twig\Node\Expression\Unary\NegUnary;
  81. use Twig\Node\Expression\Unary\NotUnary;
  82. use Twig\Node\Expression\Unary\PosUnary;
  83. use Twig\Node\Expression\Unary\SpreadUnary;
  84. use Twig\Node\Node;
  85. use Twig\Parser;
  86. use Twig\Sandbox\SecurityNotAllowedMethodError;
  87. use Twig\Sandbox\SecurityNotAllowedPropertyError;
  88. use Twig\Source;
  89. use Twig\Template;
  90. use Twig\TemplateWrapper;
  91. use Twig\TokenParser\ApplyTokenParser;
  92. use Twig\TokenParser\BlockTokenParser;
  93. use Twig\TokenParser\DeprecatedTokenParser;
  94. use Twig\TokenParser\DoTokenParser;
  95. use Twig\TokenParser\EmbedTokenParser;
  96. use Twig\TokenParser\ExtendsTokenParser;
  97. use Twig\TokenParser\FlushTokenParser;
  98. use Twig\TokenParser\ForTokenParser;
  99. use Twig\TokenParser\FromTokenParser;
  100. use Twig\TokenParser\GuardTokenParser;
  101. use Twig\TokenParser\IfTokenParser;
  102. use Twig\TokenParser\ImportTokenParser;
  103. use Twig\TokenParser\IncludeTokenParser;
  104. use Twig\TokenParser\MacroTokenParser;
  105. use Twig\TokenParser\SetTokenParser;
  106. use Twig\TokenParser\TypesTokenParser;
  107. use Twig\TokenParser\UseTokenParser;
  108. use Twig\TokenParser\WithTokenParser;
  109. use Twig\TwigFilter;
  110. use Twig\TwigFunction;
  111. use Twig\TwigTest;
  112. use Twig\Util\CallableArgumentsExtractor;
  114. final class CoreExtension extends AbstractExtension
  115. {
  116.     public const ARRAY_LIKE_CLASSES = [
  117.         'ArrayIterator',
  118.         'ArrayObject',
  119.         'CachingIterator',
  120.         'RecursiveArrayIterator',
  121.         'RecursiveCachingIterator',
  122.         'SplDoublyLinkedList',
  123.         'SplFixedArray',
  124.         'SplObjectStorage',
  125.         'SplQueue',
  126.         'SplStack',
  127.         'WeakMap',
  128.     ];
  130.     private const DEFAULT_TRIM_CHARS = " \t\n\r\0\x0B";
  132.     private $dateFormats = ['F j, Y H:i', '%d days'];
  133.     private $numberFormat = [0, '.', ','];
  134.     private $timezone = null;
  136.     /**
  137.      * Sets the default format to be used by the date filter.
  138.      *
  139.      * @param string|null $format             The default date format string
  140.      * @param string|null $dateIntervalFormat The default date interval format string
  141.      */
  142.     public function setDateFormat($format = null, $dateIntervalFormat = null)
  143.     {
  144.         if (null !== $format) {
  145.             $this->dateFormats[0] = $format;
  146.         }
  148.         if (null !== $dateIntervalFormat) {
  149.             $this->dateFormats[1] = $dateIntervalFormat;
  150.         }
  151.     }
  153.     /**
  154.      * Gets the default format to be used by the date filter.
  155.      *
  156.      * @return array The default date format string and the default date interval format string
  157.      */
  158.     public function getDateFormat()
  159.     {
  160.         return $this->dateFormats;
  161.     }
  163.     /**
  164.      * Sets the default timezone to be used by the date filter.
  165.      *
  166.      * @param \DateTimeZone|string $timezone The default timezone string or a \DateTimeZone object
  167.      */
  168.     public function setTimezone($timezone)
  169.     {
  170.         $this->timezone = $timezone instanceof \DateTimeZone ? $timezone : new \DateTimeZone($timezone);
  171.     }
  173.     /**
  174.      * Gets the default timezone to be used by the date filter.
  175.      *
  176.      * @return \DateTimeZone The default timezone currently in use
  177.      */
  178.     public function getTimezone()
  179.     {
  180.         if (null === $this->timezone) {
  181.             $this->timezone = new \DateTimeZone(date_default_timezone_get());
  182.         }
  184.         return $this->timezone;
  185.     }
  187.     /**
  188.      * Sets the default format to be used by the number_format filter.
  189.      *
  190.      * @param int    $decimal      the number of decimal places to use
  191.      * @param string $decimalPoint the character(s) to use for the decimal point
  192.      * @param string $thousandSep  the character(s) to use for the thousands separator
  193.      */
  194.     public function setNumberFormat($decimal, $decimalPoint, $thousandSep)
  195.     {
  196.         $this->numberFormat = [$decimal, $decimalPoint, $thousandSep];
  197.     }
  199.     /**
  200.      * Get the default format used by the number_format filter.
  201.      *
  202.      * @return array The arguments for number_format()
  203.      */
  204.     public function getNumberFormat()
  205.     {
  206.         return $this->numberFormat;
  207.     }
  209.     public function getTokenParsers(): array
  210.     {
  211.         return [
  212.             new ApplyTokenParser(),
  213.             new ForTokenParser(),
  214.             new IfTokenParser(),
  215.             new ExtendsTokenParser(),
  216.             new IncludeTokenParser(),
  217.             new BlockTokenParser(),
  218.             new UseTokenParser(),
  219.             new MacroTokenParser(),
  220.             new ImportTokenParser(),
  221.             new FromTokenParser(),
  222.             new SetTokenParser(),
  223.             new TypesTokenParser(),
  224.             new FlushTokenParser(),
  225.             new DoTokenParser(),
  226.             new EmbedTokenParser(),
  227.             new WithTokenParser(),
  228.             new DeprecatedTokenParser(),
  229.             new GuardTokenParser(),
  230.         ];
  231.     }
  233.     public function getFilters(): array
  234.     {
  235.         return [
  236.             // formatting filters
  237.             new TwigFilter('date', [$this, 'formatDate']),
  238.             new TwigFilter('date_modify', [$this, 'modifyDate']),
  239.             new TwigFilter('format', [self::class, 'sprintf']),
  240.             new TwigFilter('replace', [self::class, 'replace']),
  241.             new TwigFilter('number_format', [$this, 'formatNumber']),
  242.             new TwigFilter('abs', 'abs'),
  243.             new TwigFilter('round', [self::class, 'round']),
  245.             // encoding
  246.             new TwigFilter('url_encode', [self::class, 'urlencode']),
  247.             new TwigFilter('json_encode', 'json_encode'),
  248.             new TwigFilter('convert_encoding', [self::class, 'convertEncoding']),
  250.             // string filters
  251.             new TwigFilter('title', [self::class, 'titleCase'], ['needs_charset' => true]),
  252.             new TwigFilter('capitalize', [self::class, 'capitalize'], ['needs_charset' => true]),
  253.             new TwigFilter('upper', [self::class, 'upper'], ['needs_charset' => true]),
  254.             new TwigFilter('lower', [self::class, 'lower'], ['needs_charset' => true]),
  255.             new TwigFilter('striptags', [self::class, 'striptags']),
  256.             new TwigFilter('trim', [self::class, 'trim']),
  257.             new TwigFilter('nl2br', [self::class, 'nl2br'], ['pre_escape' => 'html', 'is_safe' => ['html']]),
  258.             new TwigFilter('spaceless', [self::class, 'spaceless'], ['is_safe' => ['html'], 'deprecation_info' => new DeprecatedCallableInfo('twig/twig', '3.12')]),
  260.             // array helpers
  261.             new TwigFilter('join', [self::class, 'join']),
  262.             new TwigFilter('split', [self::class, 'split'], ['needs_charset' => true]),
  263.             new TwigFilter('sort', [self::class, 'sort'], ['needs_environment' => true]),
  264.             new TwigFilter('merge', [self::class, 'merge']),
  265.             new TwigFilter('batch', [self::class, 'batch']),
  266.             new TwigFilter('column', [self::class, 'column']),
  267.             new TwigFilter('filter', [self::class, 'filter'], ['needs_environment' => true]),
  268.             new TwigFilter('map', [self::class, 'map'], ['needs_environment' => true]),
  269.             new TwigFilter('reduce', [self::class, 'reduce'], ['needs_environment' => true]),
  270.             new TwigFilter('find', [self::class, 'find'], ['needs_environment' => true]),
  272.             // string/array filters
  273.             new TwigFilter('reverse', [self::class, 'reverse'], ['needs_charset' => true]),
  274.             new TwigFilter('shuffle', [self::class, 'shuffle'], ['needs_charset' => true]),
  275.             new TwigFilter('length', [self::class, 'length'], ['needs_charset' => true]),
  276.             new TwigFilter('slice', [self::class, 'slice'], ['needs_charset' => true]),
  277.             new TwigFilter('first', [self::class, 'first'], ['needs_charset' => true]),
  278.             new TwigFilter('last', [self::class, 'last'], ['needs_charset' => true]),
  280.             // iteration and runtime
  281.             new TwigFilter('default', [self::class, 'default'], ['node_class' => DefaultFilter::class]),
  282.             new TwigFilter('keys', [self::class, 'keys']),
  283.             new TwigFilter('invoke', [self::class, 'invoke']),
  284.         ];
  285.     }
  287.     public function getFunctions(): array
  288.     {
  289.         return [
  290.             new TwigFunction('parent', null, ['parser_callable' => [self::class, 'parseParentFunction']]),
  291.             new TwigFunction('block', null, ['parser_callable' => [self::class, 'parseBlockFunction']]),
  292.             new TwigFunction('attribute', null, ['parser_callable' => [self::class, 'parseAttributeFunction']]),
  293.             new TwigFunction('max', 'max'),
  294.             new TwigFunction('min', 'min'),
  295.             new TwigFunction('range', 'range'),
  296.             new TwigFunction('constant', [self::class, 'constant']),
  297.             new TwigFunction('cycle', [self::class, 'cycle']),
  298.             new TwigFunction('random', [self::class, 'random'], ['needs_charset' => true]),
  299.             new TwigFunction('date', [$this, 'convertDate']),
  300.             new TwigFunction('include', [self::class, 'include'], ['needs_environment' => true, 'needs_context' => true, 'is_safe' => ['all']]),
  301.             new TwigFunction('source', [self::class, 'source'], ['needs_environment' => true, 'is_safe' => ['all']]),
  302.             new TwigFunction('enum_cases', [self::class, 'enumCases'], ['node_class' => EnumCasesFunction::class]),
  303.             new TwigFunction('enum', [self::class, 'enum'], ['node_class' => EnumFunction::class]),
  304.         ];
  305.     }
  307.     public function getTests(): array
  308.     {
  309.         return [
  310.             new TwigTest('even', null, ['node_class' => EvenTest::class]),
  311.             new TwigTest('odd', null, ['node_class' => OddTest::class]),
  312.             new TwigTest('defined', null, ['node_class' => DefinedTest::class]),
  313.             new TwigTest('same as', null, ['node_class' => SameasTest::class, 'one_mandatory_argument' => true]),
  314.             new TwigTest('none', null, ['node_class' => NullTest::class]),
  315.             new TwigTest('null', null, ['node_class' => NullTest::class]),
  316.             new TwigTest('divisible by', null, ['node_class' => DivisiblebyTest::class, 'one_mandatory_argument' => true]),
  317.             new TwigTest('constant', null, ['node_class' => ConstantTest::class]),
  318.             new TwigTest('empty', [self::class, 'testEmpty']),
  319.             new TwigTest('iterable', 'is_iterable'),
  320.             new TwigTest('sequence', [self::class, 'testSequence']),
  321.             new TwigTest('mapping', [self::class, 'testMapping']),
  322.             new TwigTest('true', null, ['node_class' => TrueTest::class]),
  323.         ];
  324.     }
  326.     public function getNodeVisitors(): array
  327.     {
  328.         return [];
  329.     }
  331.     public function getExpressionParsers(): array
  332.     {
  333.         return [
  334.             // unary operators
  335.             new UnaryOperatorExpressionParser(NotUnary::class, 'not', 50, new PrecedenceChange('twig/twig', '3.15', 70)),
  336.             new UnaryOperatorExpressionParser(SpreadUnary::class, '...', 512, description: 'Spread operator'),
  337.             new UnaryOperatorExpressionParser(NegUnary::class, '-', 500),
  338.             new UnaryOperatorExpressionParser(PosUnary::class, '+', 500),
  340.             // binary operators
  341.             new BinaryOperatorExpressionParser(ElvisBinary::class, '?:', 5, InfixAssociativity::Right, description: 'Elvis operator (a ?: b)', aliases: ['? :']),
  342.             new BinaryOperatorExpressionParser(NullCoalesceBinary::class, '??', 300, InfixAssociativity::Right, new PrecedenceChange('twig/twig', '3.15', 5), description: 'Null coalescing operator (a ?? b)'),
  343.             new BinaryOperatorExpressionParser(OrBinary::class, 'or', 10),
  344.             new BinaryOperatorExpressionParser(XorBinary::class, 'xor', 12),
  345.             new BinaryOperatorExpressionParser(AndBinary::class, 'and', 15),
  346.             new BinaryOperatorExpressionParser(BitwiseOrBinary::class, 'b-or', 16),
  347.             new BinaryOperatorExpressionParser(BitwiseXorBinary::class, 'b-xor', 17),
  348.             new BinaryOperatorExpressionParser(BitwiseAndBinary::class, 'b-and', 18),
  349.             new BinaryOperatorExpressionParser(EqualBinary::class, '==', 20),
  350.             new BinaryOperatorExpressionParser(NotEqualBinary::class, '!=', 20),
  351.             new BinaryOperatorExpressionParser(SpaceshipBinary::class, '<=>', 20),
  352.             new BinaryOperatorExpressionParser(LessBinary::class, '<', 20),
  353.             new BinaryOperatorExpressionParser(GreaterBinary::class, '>', 20),
  354.             new BinaryOperatorExpressionParser(GreaterEqualBinary::class, '>=', 20),
  355.             new BinaryOperatorExpressionParser(LessEqualBinary::class, '<=', 20),
  356.             new BinaryOperatorExpressionParser(NotInBinary::class, 'not in', 20),
  357.             new BinaryOperatorExpressionParser(InBinary::class, 'in', 20),
  358.             new BinaryOperatorExpressionParser(MatchesBinary::class, 'matches', 20),
  359.             new BinaryOperatorExpressionParser(StartsWithBinary::class, 'starts with', 20),
  360.             new BinaryOperatorExpressionParser(EndsWithBinary::class, 'ends with', 20),
  361.             new BinaryOperatorExpressionParser(HasSomeBinary::class, 'has some', 20),
  362.             new BinaryOperatorExpressionParser(HasEveryBinary::class, 'has every', 20),
  363.             new BinaryOperatorExpressionParser(RangeBinary::class, '..', 25),
  364.             new BinaryOperatorExpressionParser(AddBinary::class, '+', 30),
  365.             new BinaryOperatorExpressionParser(SubBinary::class, '-', 30),
  366.             new BinaryOperatorExpressionParser(ConcatBinary::class, '~', 40, precedenceChange: new PrecedenceChange('twig/twig', '3.15', 27)),
  367.             new BinaryOperatorExpressionParser(MulBinary::class, '*', 60),
  368.             new BinaryOperatorExpressionParser(DivBinary::class, '/', 60),
  369.             new BinaryOperatorExpressionParser(FloorDivBinary::class, '//', 60, description: 'Floor division'),
  370.             new BinaryOperatorExpressionParser(ModBinary::class, '%', 60),
  371.             new BinaryOperatorExpressionParser(PowerBinary::class, '**', 200, InfixAssociativity::Right, description: 'Exponentiation operator'),
  373.             // ternary operator
  374.             new ConditionalTernaryExpressionParser(),
  376.             // Twig callables
  377.             new IsExpressionParser(),
  378.             new IsNotExpressionParser(),
  379.             new FilterExpressionParser(),
  380.             new FunctionExpressionParser(),
  382.             // get attribute operators
  383.             new DotExpressionParser(),
  384.             new SquareBracketExpressionParser(),
  386.             // group expression
  387.             new GroupingExpressionParser(),
  389.             // arrow function
  390.             new ArrowExpressionParser(),
  392.             // all literals
  393.             new LiteralExpressionParser(),
  394.         ];
  395.     }
  397.     /**
  398.      * Cycles over a sequence.
  399.      *
  400.      * @param array|\ArrayAccess $values   A non-empty sequence of values
  401.      * @param int<0, max>        $position The position of the value to return in the cycle
  402.      *
  403.      * @return mixed The value at the given position in the sequence, wrapping around as needed
  404.      *
  405.      * @internal
  406.      */
  407.     public static function cycle($values, $position): mixed
  408.     {
  409.         if (!\is_array($values)) {
  410.             if (!$values instanceof \ArrayAccess) {
  411.                 throw new RuntimeError('The "cycle" function expects an array or "ArrayAccess" as first argument.');
  412.             }
  414.             if (!is_countable($values)) {
  415.                 // To be uncommented in 4.0
  416.                 // throw new RuntimeError('The "cycle" function expects a countable sequence as first argument.');
  418.                 trigger_deprecation('twig/twig', '3.12', 'Passing a non-countable sequence of values to "%s()" is deprecated.', __METHOD__);
  420.                 return $values;
  421.             }
  423.             $values = self::toArray($values, false);
  424.         }
  426.         if (!$count = \count($values)) {
  427.             throw new RuntimeError('The "cycle" function expects a non-empty sequence.');
  428.         }
  430.         return $values[$position % $count];
  431.     }
  433.     /**
  434.      * Returns a random value depending on the supplied parameter type:
  435.      * - a random item from a \Traversable or array
  436.      * - a random character from a string
  437.      * - a random integer between 0 and the integer parameter.
  438.      *
  439.      * @param \Traversable|array|int|float|string $values The values to pick a random item from
  440.      * @param int|null                            $max    Maximum value used when $values is an int
  441.      *
  442.      * @return mixed A random value from the given sequence
  443.      *
  444.      * @throws RuntimeError when $values is an empty array (does not apply to an empty string which is returned as is)
  445.      *
  446.      * @internal
  447.      */
  448.     public static function random(string $charset, $values = null, $max = null)
  449.     {
  450.         if (null === $values) {
  451.             return null === $max ? mt_rand() : mt_rand(0, (int) $max);
  452.         }
  454.         if (\is_int($values) || \is_float($values)) {
  455.             if (null === $max) {
  456.                 if ($values < 0) {
  457.                     $max = 0;
  458.                     $min = $values;
  459.                 } else {
  460.                     $max = $values;
  461.                     $min = 0;
  462.                 }
  463.             } else {
  464.                 $min = $values;
  465.             }
  467.             return mt_rand((int) $min, (int) $max);
  468.         }
  470.         if (\is_string($values)) {
  471.             if ('' === $values) {
  472.                 return '';
  473.             }
  475.             if ('UTF-8' !== $charset) {
  476.                 $values = self::convertEncoding($values, 'UTF-8', $charset);
  477.             }
  479.             // unicode version of str_split()
  480.             // split at all positions, but not after the start and not before the end
  481.             $values = preg_split('/(?<!^)(?!$)/u', $values);
  483.             if ('UTF-8' !== $charset) {
  484.                 foreach ($values as $i => $value) {
  485.                     $values[$i] = self::convertEncoding($value, $charset, 'UTF-8');
  486.                 }
  487.             }
  488.         }
  490.         if (!is_iterable($values)) {
  491.             return $values;
  492.         }
  494.         $values = self::toArray($values);
  496.         if (0 === \count($values)) {
  497.             throw new RuntimeError('The "random" function cannot pick from an empty sequence or mapping.');
  498.         }
  500.         return $values[array_rand($values, 1)];
  501.     }
  503.     /**
  504.      * Formats a date.
  505.      *
  506.      *   {{ post.published_at|date("m/d/Y") }}
  507.      *
  508.      * @param \DateTimeInterface|\DateInterval|string|int|null $date     A date, a timestamp or null to use the current time
  509.      * @param string|null                                      $format   The target format, null to use the default
  510.      * @param \DateTimeZone|string|false|null                  $timezone The target timezone, null to use the default, false to leave unchanged
  511.      */
  512.     public function formatDate($date, $format = null, $timezone = null): string
  513.     {
  514.         if (null === $format) {
  515.             $formats = $this->getDateFormat();
  516.             $format = $date instanceof \DateInterval ? $formats[1] : $formats[0];
  517.         }
  519.         if ($date instanceof \DateInterval) {
  520.             return $date->format($format);
  521.         }
  523.         return $this->convertDate($date, $timezone)->format($format);
  524.     }
  526.     /**
  527.      * Returns a new date object modified.
  528.      *
  529.      *   {{ post.published_at|date_modify("-1day")|date("m/d/Y") }}
  530.      *
  531.      * @param \DateTimeInterface|string|int|null $date     A date, a timestamp or null to use the current time
  532.      * @param string                             $modifier A modifier string
  533.      *
  534.      * @return \DateTime|\DateTimeImmutable
  535.      *
  536.      * @internal
  537.      */
  538.     public function modifyDate($date, $modifier)
  539.     {
  540.         return $this->convertDate($date, false)->modify($modifier);
  541.     }
  543.     /**
  544.      * Returns a formatted string.
  545.      *
  546.      * @param string|null $format
  547.      *
  548.      * @internal
  549.      */
  550.     public static function sprintf($format, ...$values): string
  551.     {
  552.         return \sprintf($format ?? '', ...$values);
  553.     }
  555.     /**
  556.      * @internal
  557.      */
  558.     public static function dateConverter(Environment $env, $date, $format = null, $timezone = null): string
  559.     {
  560.         return $env->getExtension(self::class)->formatDate($date, $format, $timezone);
  561.     }
  563.     /**
  564.      * Converts an input to a \DateTime instance.
  565.      *
  566.      *    {% if date(user.created_at) < date('+2days') %}
  567.      *      {# do something #}
  568.      *    {% endif %}
  569.      *
  570.      * @param \DateTimeInterface|string|int|null $date     A date, a timestamp or null to use the current time
  571.      * @param \DateTimeZone|string|false|null    $timezone The target timezone, null to use the default, false to leave unchanged
  572.      *
  573.      * @return \DateTime|\DateTimeImmutable
  574.      */
  575.     public function convertDate($date = null, $timezone = null)
  576.     {
  577.         // determine the timezone
  578.         if (false !== $timezone) {
  579.             if (null === $timezone) {
  580.                 $timezone = $this->getTimezone();
  581.             } elseif (!$timezone instanceof \DateTimeZone) {
  582.                 $timezone = new \DateTimeZone($timezone);
  583.             }
  584.         }
  586.         // immutable dates
  587.         if ($date instanceof \DateTimeImmutable) {
  588.             return false !== $timezone ? $date->setTimezone($timezone) : $date;
  589.         }
  591.         if ($date instanceof \DateTime) {
  592.             $date = clone $date;
  593.             if (false !== $timezone) {
  594.                 $date->setTimezone($timezone);
  595.             }
  597.             return $date;
  598.         }
  600.         if (null === $date || 'now' === $date) {
  601.             if (null === $date) {
  602.                 $date = 'now';
  603.             }
  605.             return new \DateTime($date, false !== $timezone ? $timezone : $this->getTimezone());
  606.         }
  608.         $asString = (string) $date;
  609.         if (ctype_digit($asString) || ('' !== $asString && '-' === $asString[0] && ctype_digit(substr($asString, 1)))) {
  610.             $date = new \DateTime('@'.$date);
  611.         } else {
  612.             $date = new \DateTime($date);
  613.         }
  615.         if (false !== $timezone) {
  616.             $date->setTimezone($timezone);
  617.         }
  619.         return $date;
  620.     }
  622.     /**
  623.      * Replaces strings within a string.
  624.      *
  625.      * @param string|null        $str  String to replace in
  626.      * @param array|\Traversable $from Replace values
  627.      *
  628.      * @internal
  629.      */
  630.     public static function replace($str, $from): string
  631.     {
  632.         if (!is_iterable($from)) {
  633.             throw new RuntimeError(\sprintf('The "replace" filter expects a sequence or a mapping, got "%s".', get_debug_type($from)));
  634.         }
  636.         return strtr($str ?? '', self::toArray($from));
  637.     }
  639.     /**
  640.      * Rounds a number.
  641.      *
  642.      * @param int|float|string|null   $value     The value to round
  643.      * @param int|float               $precision The rounding precision
  644.      * @param 'common'|'ceil'|'floor' $method    The method to use for rounding
  645.      *
  646.      * @return float The rounded number
  647.      *
  648.      * @internal
  649.      */
  650.     public static function round($value, $precision = 0, $method = 'common')
  651.     {
  652.         $value = (float) $value;
  654.         if ('common' === $method) {
  655.             return round($value, $precision);
  656.         }
  658.         if ('ceil' !== $method && 'floor' !== $method) {
  659.             throw new RuntimeError('The "round" filter only supports the "common", "ceil", and "floor" methods.');
  660.         }
  662.         return $method($value * 10 ** $precision) / 10 ** $precision;
  663.     }
  665.     /**
  666.      * Formats a number.
  667.      *
  668.      * All of the formatting options can be left null, in that case the defaults will
  669.      * be used. Supplying any of the parameters will override the defaults set in the
  670.      * environment object.
  671.      *
  672.      * @param mixed       $number       A float/int/string of the number to format
  673.      * @param int|null    $decimal      the number of decimal points to display
  674.      * @param string|null $decimalPoint the character(s) to use for the decimal point
  675.      * @param string|null $thousandSep  the character(s) to use for the thousands separator
  676.      */
  677.     public function formatNumber($number, $decimal = null, $decimalPoint = null, $thousandSep = null): string
  678.     {
  679.         $defaults = $this->getNumberFormat();
  680.         if (null === $decimal) {
  681.             $decimal = $defaults[0];
  682.         }
  684.         if (null === $decimalPoint) {
  685.             $decimalPoint = $defaults[1];
  686.         }
  688.         if (null === $thousandSep) {
  689.             $thousandSep = $defaults[2];
  690.         }
  692.         return number_format((float) $number, $decimal, $decimalPoint, $thousandSep);
  693.     }
  695.     /**
  696.      * URL encodes (RFC 3986) a string as a path segment or an array as a query string.
  697.      *
  698.      * @param string|array|null $url A URL or an array of query parameters
  699.      *
  700.      * @internal
  701.      */
  702.     public static function urlencode($url): string
  703.     {
  704.         if (\is_array($url)) {
  705.             return http_build_query($url, '', '&', \PHP_QUERY_RFC3986);
  706.         }
  708.         return rawurlencode($url ?? '');
  709.     }
  711.     /**
  712.      * Merges any number of arrays or Traversable objects.
  713.      *
  714.      *  {% set items = { 'apple': 'fruit', 'orange': 'fruit' } %}
  715.      *
  716.      *  {% set items = items|merge({ 'peugeot': 'car' }, { 'banana': 'fruit' }) %}
  717.      *
  718.      *  {# items now contains { 'apple': 'fruit', 'orange': 'fruit', 'peugeot': 'car', 'banana': 'fruit' } #}
  719.      *
  720.      * @param array|\Traversable ...$arrays Any number of arrays or Traversable objects to merge
  721.      *
  722.      * @internal
  723.      */
  724.     public static function merge(...$arrays): array
  725.     {
  726.         $result = [];
  728.         foreach ($arrays as $argNumber => $array) {
  729.             if (!is_iterable($array)) {
  730.                 throw new RuntimeError(\sprintf('The "merge" filter expects a sequence or a mapping, got "%s" for argument %d.', get_debug_type($array), $argNumber + 1));
  731.             }
  733.             $result = array_merge($result, self::toArray($array));
  734.         }
  736.         return $result;
  737.     }
  739.     /**
  740.      * Slices a variable.
  741.      *
  742.      * @param mixed $item         A variable
  743.      * @param int   $start        Start of the slice
  744.      * @param int   $length       Size of the slice
  745.      * @param bool  $preserveKeys Whether to preserve key or not (when the input is an array)
  746.      *
  747.      * @return mixed The sliced variable
  748.      *
  749.      * @internal
  750.      */
  751.     public static function slice(string $charset, $item, $start, $length = null, $preserveKeys = false)
  752.     {
  753.         if ($item instanceof \Traversable) {
  754.             while ($item instanceof \IteratorAggregate) {
  755.                 $item = $item->getIterator();
  756.             }
  758.             if ($start >= 0 && $length >= 0 && $item instanceof \Iterator) {
  759.                 try {
  760.                     return iterator_to_array(new \LimitIterator($item, $start, $length ?? -1), $preserveKeys);
  761.                 } catch (\OutOfBoundsException $e) {
  762.                     return [];
  763.                 }
  764.             }
  766.             $item = iterator_to_array($item, $preserveKeys);
  767.         }
  769.         if (\is_array($item)) {
  770.             return \array_slice($item, $start, $length, $preserveKeys);
  771.         }
  773.         return mb_substr((string) $item, $start, $length, $charset);
  774.     }
  776.     /**
  777.      * Returns the first element of the item.
  778.      *
  779.      * @param mixed $item A variable
  780.      *
  781.      * @return mixed The first element of the item
  782.      *
  783.      * @internal
  784.      */
  785.     public static function first(string $charset, $item)
  786.     {
  787.         $elements = self::slice($charset, $item, 0, 1, false);
  789.         return \is_string($elements) ? $elements : current($elements);
  790.     }
  792.     /**
  793.      * Returns the last element of the item.
  794.      *
  795.      * @param mixed $item A variable
  796.      *
  797.      * @return mixed The last element of the item
  798.      *
  799.      * @internal
  800.      */
  801.     public static function last(string $charset, $item)
  802.     {
  803.         $elements = self::slice($charset, $item, -1, 1, false);
  805.         return \is_string($elements) ? $elements : current($elements);
  806.     }
  808.     /**
  809.      * Joins the values to a string.
  810.      *
  811.      * The separators between elements are empty strings per default, you can define them with the optional parameters.
  812.      *
  813.      *  {{ [1, 2, 3]|join(', ', ' and ') }}
  814.      *  {# returns 1, 2 and 3 #}
  815.      *
  816.      *  {{ [1, 2, 3]|join('|') }}
  817.      *  {# returns 1|2|3 #}
  818.      *
  819.      *  {{ [1, 2, 3]|join }}
  820.      *  {# returns 123 #}
  821.      *
  822.      * @param iterable|array|string|float|int|bool|null $value An array
  823.      * @param string                                    $glue  The separator
  824.      * @param string|null                               $and   The separator for the last pair
  825.      *
  826.      * @internal
  827.      */
  828.     public static function join($value, $glue = '', $and = null): string
  829.     {
  830.         if (!is_iterable($value)) {
  831.             $value = (array) $value;
  832.         }
  834.         $value = self::toArray($value, false);
  836.         if (0 === \count($value)) {
  837.             return '';
  838.         }
  840.         if (null === $and || $and === $glue) {
  841.             return implode($glue, $value);
  842.         }
  844.         if (1 === \count($value)) {
  845.             return $value[0];
  846.         }
  848.         return implode($glue, \array_slice($value, 0, -1)).$and.$value[\count($value) - 1];
  849.     }
  851.     /**
  852.      * Splits the string into an array.
  853.      *
  854.      *  {{ "one,two,three"|split(',') }}
  855.      *  {# returns [one, two, three] #}
  856.      *
  857.      *  {{ "one,two,three,four,five"|split(',', 3) }}
  858.      *  {# returns [one, two, "three,four,five"] #}
  859.      *
  860.      *  {{ "123"|split('') }}
  861.      *  {# returns [1, 2, 3] #}
  862.      *
  863.      *  {{ "aabbcc"|split('', 2) }}
  864.      *  {# returns [aa, bb, cc] #}
  865.      *
  866.      * @param string|null $value     A string
  867.      * @param string      $delimiter The delimiter
  868.      * @param int|null    $limit     The limit
  869.      *
  870.      * @internal
  871.      */
  872.     public static function split(string $charset, $value, $delimiter, $limit = null): array
  873.     {
  874.         $value = $value ?? '';
  876.         if ('' !== $delimiter) {
  877.             return null === $limit ? explode($delimiter, $value) : explode($delimiter, $value, $limit);
  878.         }
  880.         if ($limit <= 1) {
  881.             return preg_split('/(?<!^)(?!$)/u', $value);
  882.         }
  884.         $length = mb_strlen($value, $charset);
  885.         if ($length < $limit) {
  886.             return [$value];
  887.         }
  889.         $r = [];
  890.         for ($i = 0; $i < $length; $i += $limit) {
  891.             $r[] = mb_substr($value, $i, $limit, $charset);
  892.         }
  894.         return $r;
  895.     }
  897.     /**
  898.      * @internal
  899.      */
  900.     public static function default($value, $default = '')
  901.     {
  902.         if (self::testEmpty($value)) {
  903.             return $default;
  904.         }
  906.         return $value;
  907.     }
  909.     /**
  910.      * Returns the keys for the given array.
  911.      *
  912.      * It is useful when you want to iterate over the keys of an array:
  913.      *
  914.      *  {% for key in array|keys %}
  915.      *      {# ... #}
  916.      *  {% endfor %}
  917.      *
  918.      * @internal
  919.      */
  920.     public static function keys($array): array
  921.     {
  922.         if ($array instanceof \Traversable) {
  923.             while ($array instanceof \IteratorAggregate) {
  924.                 $array = $array->getIterator();
  925.             }
  927.             $keys = [];
  928.             if ($array instanceof \Iterator) {
  929.                 $array->rewind();
  930.                 while ($array->valid()) {
  931.                     $keys[] = $array->key();
  932.                     $array->next();
  933.                 }
  935.                 return $keys;
  936.             }
  938.             foreach ($array as $key => $item) {
  939.                 $keys[] = $key;
  940.             }
  942.             return $keys;
  943.         }
  945.         if (!\is_array($array)) {
  946.             return [];
  947.         }
  949.         return array_keys($array);
  950.     }
  952.     /**
  953.      * Invokes a callable.
  954.      *
  955.      * @internal
  956.      */
  957.     public static function invoke(\Closure $arrow, ...$arguments): mixed
  958.     {
  959.         return $arrow(...$arguments);
  960.     }
  962.     /**
  963.      * Reverses a variable.
  964.      *
  965.      * @param array|\Traversable|string|null $item         An array, a \Traversable instance, or a string
  966.      * @param bool                           $preserveKeys Whether to preserve key or not
  967.      *
  968.      * @return mixed The reversed input
  969.      *
  970.      * @internal
  971.      */
  972.     public static function reverse(string $charset, $item, $preserveKeys = false)
  973.     {
  974.         if ($item instanceof \Traversable) {
  975.             return array_reverse(iterator_to_array($item), $preserveKeys);
  976.         }
  978.         if (\is_array($item)) {
  979.             return array_reverse($item, $preserveKeys);
  980.         }
  982.         $string = (string) $item;
  984.         if ('UTF-8' !== $charset) {
  985.             $string = self::convertEncoding($string, 'UTF-8', $charset);
  986.         }
  988.         preg_match_all('/./us', $string, $matches);
  990.         $string = implode('', array_reverse($matches[0]));
  992.         if ('UTF-8' !== $charset) {
  993.             $string = self::convertEncoding($string, $charset, 'UTF-8');
  994.         }
  996.         return $string;
  997.     }
  999.     /**
  1000.      * Shuffles an array, a \Traversable instance, or a string.
  1001.      * The function does not preserve keys.
  1002.      *
  1003.      * @param array|\Traversable|string|null $item
  1004.      *
  1005.      * @internal
  1006.      */
  1007.     public static function shuffle(string $charset, $item)
  1008.     {
  1009.         if (\is_string($item)) {
  1010.             if ('UTF-8' !== $charset) {
  1011.                 $item = self::convertEncoding($item, 'UTF-8', $charset);
  1012.             }
  1014.             $item = preg_split('/(?<!^)(?!$)/u', $item, -1);
  1015.             shuffle($item);
  1016.             $item = implode('', $item);
  1018.             if ('UTF-8' !== $charset) {
  1019.                 $item = self::convertEncoding($item, $charset, 'UTF-8');
  1020.             }
  1022.             return $item;
  1023.         }
  1025.         if (is_iterable($item)) {
  1026.             $item = self::toArray($item, false);
  1027.             shuffle($item);
  1028.         }
  1030.         return $item;
  1031.     }
  1033.     /**
  1034.      * Sorts an array.
  1035.      *
  1036.      * @param array|\Traversable $array
  1037.      * @param ?\Closure          $arrow
  1038.      *
  1039.      * @internal
  1040.      */
  1041.     public static function sort(Environment $env, $array, $arrow = null): array
  1042.     {
  1043.         if ($array instanceof \Traversable) {
  1044.             $array = iterator_to_array($array);
  1045.         } elseif (!\is_array($array)) {
  1046.             throw new RuntimeError(\sprintf('The "sort" filter expects a sequence or a mapping, got "%s".', get_debug_type($array)));
  1047.         }
  1049.         if (null !== $arrow) {
  1050.             self::checkArrow($env, $arrow, 'sort', 'filter');
  1052.             uasort($array, $arrow);
  1053.         } else {
  1054.             asort($array);
  1055.         }
  1057.         return $array;
  1058.     }
  1060.     /**
  1061.      * @internal
  1062.      */
  1063.     public static function inFilter($value, $compare)
  1064.     {
  1065.         if ($value instanceof Markup) {
  1066.             $value = (string) $value;
  1067.         }
  1068.         if ($compare instanceof Markup) {
  1069.             $compare = (string) $compare;
  1070.         }
  1072.         if (\is_string($compare)) {
  1073.             if (\is_string($value) || \is_int($value) || \is_float($value)) {
  1074.                 return '' === $value || str_contains($compare, (string) $value);
  1075.             }
  1077.             return false;
  1078.         }
  1080.         if (!is_iterable($compare)) {
  1081.             return false;
  1082.         }
  1084.         if (\is_object($value) || \is_resource($value)) {
  1085.             if (!\is_array($compare)) {
  1086.                 foreach ($compare as $item) {
  1087.                     if ($item === $value) {
  1088.                         return true;
  1089.                     }
  1090.                 }
  1092.                 return false;
  1093.             }
  1095.             return \in_array($value, $compare, true);
  1096.         }
  1098.         foreach ($compare as $item) {
  1099.             if (0 === self::compare($value, $item)) {
  1100.                 return true;
  1101.             }
  1102.         }
  1104.         return false;
  1105.     }
  1107.     /**
  1108.      * Compares two values using a more strict version of the PHP non-strict comparison operator.
  1109.      *
  1110.      * @see https://wiki.php.net/rfc/string_to_number_comparison
  1111.      * @see https://wiki.php.net/rfc/trailing_whitespace_numerics
  1112.      *
  1113.      * @internal
  1114.      */
  1115.     public static function compare($a, $b)
  1116.     {
  1117.         // int <=> string
  1118.         if (\is_int($a) && \is_string($b)) {
  1119.             $bTrim = trim($b, " \t\n\r\v\f");
  1120.             if (!is_numeric($bTrim)) {
  1121.                 return (string) $a <=> $b;
  1122.             }
  1123.             if ((int) $bTrim == $bTrim) {
  1124.                 return $a <=> (int) $bTrim;
  1125.             } else {
  1126.                 return (float) $a <=> (float) $bTrim;
  1127.             }
  1128.         }
  1129.         if (\is_string($a) && \is_int($b)) {
  1130.             $aTrim = trim($a, " \t\n\r\v\f");
  1131.             if (!is_numeric($aTrim)) {
  1132.                 return $a <=> (string) $b;
  1133.             }
  1134.             if ((int) $aTrim == $aTrim) {
  1135.                 return (int) $aTrim <=> $b;
  1136.             } else {
  1137.                 return (float) $aTrim <=> (float) $b;
  1138.             }
  1139.         }
  1141.         // float <=> string
  1142.         if (\is_float($a) && \is_string($b)) {
  1143.             if (is_nan($a)) {
  1144.                 return 1;
  1145.             }
  1146.             $bTrim = trim($b, " \t\n\r\v\f");
  1147.             if (!is_numeric($bTrim)) {
  1148.                 return (string) $a <=> $b;
  1149.             }
  1151.             return $a <=> (float) $bTrim;
  1152.         }
  1153.         if (\is_string($a) && \is_float($b)) {
  1154.             if (is_nan($b)) {
  1155.                 return 1;
  1156.             }
  1157.             $aTrim = trim($a, " \t\n\r\v\f");
  1158.             if (!is_numeric($aTrim)) {
  1159.                 return $a <=> (string) $b;
  1160.             }
  1162.             return (float) $aTrim <=> $b;
  1163.         }
  1165.         // fallback to <=>
  1166.         return $a <=> $b;
  1167.     }
  1169.     /**
  1170.      * @throws RuntimeError When an invalid pattern is used
  1171.      *
  1172.      * @internal
  1173.      */
  1174.     public static function matches(string $regexp, ?string $str): int
  1175.     {
  1176.         set_error_handler(function ($t, $m) use ($regexp) {
  1177.             throw new RuntimeError(\sprintf('Regexp "%s" passed to "matches" is not valid', $regexp).substr($m, 12));
  1178.         });
  1179.         try {
  1180.             return preg_match($regexp, $str ?? '');
  1181.         } finally {
  1182.             restore_error_handler();
  1183.         }
  1184.     }
  1186.     /**
  1187.      * Returns a trimmed string.
  1188.      *
  1189.      * @param string|\Stringable|null $string
  1190.      * @param string|null             $characterMask
  1191.      * @param string                  $side          left, right, or both
  1192.      *
  1193.      * @throws RuntimeError When an invalid trimming side is used
  1194.      *
  1195.      * @internal
  1196.      */
  1197.     public static function trim($string, $characterMask = null, $side = 'both'): string|\Stringable
  1198.     {
  1199.         if (null === $characterMask) {
  1200.             $characterMask = self::DEFAULT_TRIM_CHARS;
  1201.         }
  1203.         $trimmed = match ($side) {
  1204.             'both' => trim($string ?? '', $characterMask),
  1205.             'left' => ltrim($string ?? '', $characterMask),
  1206.             'right' => rtrim($string ?? '', $characterMask),
  1207.             default => throw new RuntimeError('Trimming side must be "left", "right" or "both".'),
  1208.         };
  1210.         // trimming a safe string with the default character mask always returns a safe string (independently of the context)
  1211.         return $string instanceof Markup && self::DEFAULT_TRIM_CHARS === $characterMask ? new Markup($trimmed, $string->getCharset()) : $trimmed;
  1212.     }
  1214.     /**
  1215.      * Inserts HTML line breaks before all newlines in a string.
  1216.      *
  1217.      * @param string|null $string
  1218.      *
  1219.      * @internal
  1220.      */
  1221.     public static function nl2br($string): string
  1222.     {
  1223.         return nl2br($string ?? '');
  1224.     }
  1226.     /**
  1227.      * Removes whitespaces between HTML tags.
  1228.      *
  1229.      * @param string|null $content
  1230.      *
  1231.      * @internal
  1232.      */
  1233.     public static function spaceless($content): string
  1234.     {
  1235.         return trim(preg_replace('/>\s+</', '><', $content ?? ''));
  1236.     }
  1238.     /**
  1239.      * @param string|null $string
  1240.      * @param string      $to
  1241.      * @param string      $from
  1242.      *
  1243.      * @internal
  1244.      */
  1245.     public static function convertEncoding($string, $to, $from): string
  1246.     {
  1247.         if (!\function_exists('iconv')) {
  1248.             throw new RuntimeError('Unable to convert encoding: required function iconv() does not exist. You should install ext-iconv or symfony/polyfill-iconv.');
  1249.         }
  1251.         return iconv($from, $to, $string ?? '');
  1252.     }
  1254.     /**
  1255.      * Returns the length of a variable.
  1256.      *
  1257.      * @param mixed $thing A variable
  1258.      *
  1259.      * @internal
  1260.      */
  1261.     public static function length(string $charset, $thing): int
  1262.     {
  1263.         if (null === $thing) {
  1264.             return 0;
  1265.         }
  1267.         if (\is_scalar($thing)) {
  1268.             return mb_strlen($thing, $charset);
  1269.         }
  1271.         if ($thing instanceof \Countable || \is_array($thing) || $thing instanceof \SimpleXMLElement) {
  1272.             return \count($thing);
  1273.         }
  1275.         if ($thing instanceof \Traversable) {
  1276.             return iterator_count($thing);
  1277.         }
  1279.         if ($thing instanceof \Stringable) {
  1280.             return mb_strlen((string) $thing, $charset);
  1281.         }
  1283.         return 1;
  1284.     }
  1286.     /**
  1287.      * Converts a string to uppercase.
  1288.      *
  1289.      * @param string|null $string A string
  1290.      *
  1291.      * @internal
  1292.      */
  1293.     public static function upper(string $charset, $string): string
  1294.     {
  1295.         return mb_strtoupper($string ?? '', $charset);
  1296.     }
  1298.     /**
  1299.      * Converts a string to lowercase.
  1300.      *
  1301.      * @param string|null $string A string
  1302.      *
  1303.      * @internal
  1304.      */
  1305.     public static function lower(string $charset, $string): string
  1306.     {
  1307.         return mb_strtolower($string ?? '', $charset);
  1308.     }
  1310.     /**
  1311.      * Strips HTML and PHP tags from a string.
  1312.      *
  1313.      * @param string|null          $string
  1314.      * @param string[]|string|null $allowable_tags
  1315.      *
  1316.      * @internal
  1317.      */
  1318.     public static function striptags($string, $allowable_tags = null): string
  1319.     {
  1320.         return strip_tags($string ?? '', $allowable_tags);
  1321.     }
  1323.     /**
  1324.      * Returns a titlecased string.
  1325.      *
  1326.      * @param string|null $string A string
  1327.      *
  1328.      * @internal
  1329.      */
  1330.     public static function titleCase(string $charset, $string): string
  1331.     {
  1332.         return mb_convert_case($string ?? '', \MB_CASE_TITLE, $charset);
  1333.     }
  1335.     /**
  1336.      * Returns a capitalized string.
  1337.      *
  1338.      * @param string|null $string A string
  1339.      *
  1340.      * @internal
  1341.      */
  1342.     public static function capitalize(string $charset, $string): string
  1343.     {
  1344.         return mb_strtoupper(mb_substr($string ?? '', 0, 1, $charset), $charset).mb_strtolower(mb_substr($string ?? '', 1, null, $charset), $charset);
  1345.     }
  1347.     /**
  1348.      * @internal
  1349.      *
  1350.      * to be removed in 4.0
  1351.      */
  1352.     public static function callMacro(Template $template, string $method, array $args, int $lineno, array $context, Source $source)
  1353.     {
  1354.         if (!method_exists($template, $method)) {
  1355.             $parent = $template;
  1356.             while ($parent = $parent->getParent($context)) {
  1357.                 if (method_exists($parent, $method)) {
  1358.                     return $parent->$method(...$args);
  1359.                 }
  1360.             }
  1362.             throw new RuntimeError(\sprintf('Macro "%s" is not defined in template "%s".', substr($method, \strlen('macro_')), $template->getTemplateName()), $lineno, $source);
  1363.         }
  1365.         return $template->$method(...$args);
  1366.     }
  1368.     /**
  1369.      * @template TSequence
  1370.      *
  1371.      * @param TSequence $seq
  1372.      *
  1373.      * @return ($seq is iterable ? TSequence : array{})
  1374.      *
  1375.      * @internal
  1376.      */
  1377.     public static function ensureTraversable($seq)
  1378.     {
  1379.         if (is_iterable($seq)) {
  1380.             return $seq;
  1381.         }
  1383.         return [];
  1384.     }
  1386.     /**
  1387.      * @internal
  1388.      */
  1389.     public static function toArray($seq, $preserveKeys = true)
  1390.     {
  1391.         if ($seq instanceof \Traversable) {
  1392.             return iterator_to_array($seq, $preserveKeys);
  1393.         }
  1395.         if (!\is_array($seq)) {
  1396.             return $seq;
  1397.         }
  1399.         return $preserveKeys ? $seq : array_values($seq);
  1400.     }
  1402.     /**
  1403.      * Checks if a variable is empty.
  1404.      *
  1405.      *    {# evaluates to true if the foo variable is null, false, or the empty string #}
  1406.      *    {% if foo is empty %}
  1407.      *        {# ... #}
  1408.      *    {% endif %}
  1409.      *
  1410.      * @param mixed $value A variable
  1411.      *
  1412.      * @internal
  1413.      */
  1414.     public static function testEmpty($value): bool
  1415.     {
  1416.         if ($value instanceof \Countable) {
  1417.             return 0 === \count($value);
  1418.         }
  1420.         if ($value instanceof \Traversable) {
  1421.             return !iterator_count($value);
  1422.         }
  1424.         if ($value instanceof \Stringable) {
  1425.             return '' === (string) $value;
  1426.         }
  1428.         return '' === $value || false === $value || null === $value || [] === $value;
  1429.     }
  1431.     /**
  1432.      * Checks if a variable is a sequence.
  1433.      *
  1434.      *    {# evaluates to true if the foo variable is a sequence #}
  1435.      *    {% if foo is sequence %}
  1436.      *        {# ... #}
  1437.      *    {% endif %}
  1438.      *
  1439.      * @internal
  1440.      */
  1441.     public static function testSequence($value): bool
  1442.     {
  1443.         if ($value instanceof \ArrayObject) {
  1444.             $value = $value->getArrayCopy();
  1445.         }
  1447.         if ($value instanceof \Traversable) {
  1448.             $value = iterator_to_array($value);
  1449.         }
  1451.         return \is_array($value) && array_is_list($value);
  1452.     }
  1454.     /**
  1455.      * Checks if a variable is a mapping.
  1456.      *
  1457.      *    {# evaluates to true if the foo variable is a mapping #}
  1458.      *    {% if foo is mapping %}
  1459.      *        {# ... #}
  1460.      *    {% endif %}
  1461.      *
  1462.      * @internal
  1463.      */
  1464.     public static function testMapping($value): bool
  1465.     {
  1466.         if ($value instanceof \ArrayObject) {
  1467.             $value = $value->getArrayCopy();
  1468.         }
  1470.         if ($value instanceof \Traversable) {
  1471.             $value = iterator_to_array($value);
  1472.         }
  1474.         return (\is_array($value) && !array_is_list($value)) || \is_object($value);
  1475.     }
  1477.     /**
  1478.      * Renders a template.
  1479.      *
  1480.      * @param array                        $context
  1481.      * @param string|array|TemplateWrapper $template      The template to render or an array of templates to try consecutively
  1482.      * @param array                        $variables     The variables to pass to the template
  1483.      * @param bool                         $withContext
  1484.      * @param bool                         $ignoreMissing Whether to ignore missing templates or not
  1485.      * @param bool                         $sandboxed     Whether to sandbox the template or not
  1486.      *
  1487.      * @internal
  1488.      */
  1489.     public static function include(Environment $env, $context, $template, $variables = [], $withContext = true, $ignoreMissing = false, $sandboxed = false): string
  1490.     {
  1491.         $alreadySandboxed = false;
  1492.         $sandbox = null;
  1493.         if ($withContext) {
  1494.             $variables = array_merge($context, $variables);
  1495.         }
  1497.         if ($isSandboxed = $sandboxed && $env->hasExtension(SandboxExtension::class)) {
  1498.             $sandbox = $env->getExtension(SandboxExtension::class);
  1499.             if (!$alreadySandboxed = $sandbox->isSandboxed()) {
  1500.                 $sandbox->enableSandbox();
  1501.             }
  1502.         }
  1504.         try {
  1505.             $loaded = null;
  1506.             try {
  1507.                 $loaded = $env->resolveTemplate($template);
  1508.             } catch (LoaderError $e) {
  1509.                 if (!$ignoreMissing) {
  1510.                     throw $e;
  1511.                 }
  1513.                 return '';
  1514.             }
  1516.             if ($isSandboxed) {
  1517.                 $loaded->unwrap()->checkSecurity();
  1518.             }
  1520.             return $loaded->render($variables);
  1521.         } finally {
  1522.             if ($isSandboxed && !$alreadySandboxed) {
  1523.                 $sandbox->disableSandbox();
  1524.             }
  1525.         }
  1526.     }
  1528.     /**
  1529.      * Returns a template content without rendering it.
  1530.      *
  1531.      * @param string $name          The template name
  1532.      * @param bool   $ignoreMissing Whether to ignore missing templates or not
  1533.      *
  1534.      * @internal
  1535.      */
  1536.     public static function source(Environment $env, $name, $ignoreMissing = false): string
  1537.     {
  1538.         $loader = $env->getLoader();
  1539.         try {
  1540.             return $loader->getSourceContext($name)->getCode();
  1541.         } catch (LoaderError $e) {
  1542.             if (!$ignoreMissing) {
  1543.                 throw $e;
  1544.             }
  1546.             return '';
  1547.         }
  1548.     }
  1550.     /**
  1551.      * Returns the list of cases of the enum.
  1552.      *
  1553.      * @template T of \UnitEnum
  1554.      *
  1555.      * @param class-string<T> $enum
  1556.      *
  1557.      * @return list<T>
  1558.      *
  1559.      * @internal
  1560.      */
  1561.     public static function enumCases(string $enum): array
  1562.     {
  1563.         if (!enum_exists($enum)) {
  1564.             throw new RuntimeError(\sprintf('Enum "%s" does not exist.', $enum));
  1565.         }
  1567.         return $enum::cases();
  1568.     }
  1570.     /**
  1571.      * Provides the ability to access enums by their class names.
  1572.      *
  1573.      * @template T of \UnitEnum
  1574.      *
  1575.      * @param class-string<T> $enum
  1576.      *
  1577.      * @return T
  1578.      *
  1579.      * @internal
  1580.      */
  1581.     public static function enum(string $enum): \UnitEnum
  1582.     {
  1583.         if (!enum_exists($enum)) {
  1584.             throw new RuntimeError(\sprintf('"%s" is not an enum.', $enum));
  1585.         }
  1587.         if (!$cases = $enum::cases()) {
  1588.             throw new RuntimeError(\sprintf('"%s" is an empty enum.', $enum));
  1589.         }
  1591.         return $cases[0];
  1592.     }
  1594.     /**
  1595.      * Provides the ability to get constants from instances as well as class/global constants.
  1596.      *
  1597.      * @param string      $constant     The name of the constant
  1598.      * @param object|null $object       The object to get the constant from
  1599.      * @param bool        $checkDefined Whether to check if the constant is defined or not
  1600.      *
  1601.      * @return mixed Class constants can return many types like scalars, arrays, and
  1602.      *               objects depending on the PHP version (\BackedEnum, \UnitEnum, etc.)
  1603.      *               When $checkDefined is true, returns true when the constant is defined, false otherwise
  1604.      *
  1605.      * @internal
  1606.      */
  1607.     public static function constant($constant, $object = null, bool $checkDefined = false)
  1608.     {
  1609.         if (null !== $object) {
  1610.             if ('class' === $constant) {
  1611.                 return $checkDefined ? true : $object::class;
  1612.             }
  1614.             $constant = $object::class.'::'.$constant;
  1615.         }
  1617.         if (!\defined($constant)) {
  1618.             if ($checkDefined) {
  1619.                 return false;
  1620.             }
  1622.             if ('::class' === strtolower(substr($constant, -7))) {
  1623.                 throw new RuntimeError(\sprintf('You cannot use the Twig function "constant" to access "%s". You could provide an object and call constant("class", $object) or use the class name directly as a string.', $constant));
  1624.             }
  1626.             throw new RuntimeError(\sprintf('Constant "%s" is undefined.', $constant));
  1627.         }
  1629.         return $checkDefined ? true : \constant($constant);
  1630.     }
  1632.     /**
  1633.      * Batches item.
  1634.      *
  1635.      * @param array $items An array of items
  1636.      * @param int   $size  The size of the batch
  1637.      * @param mixed $fill  A value used to fill missing items
  1638.      *
  1639.      * @internal
  1640.      */
  1641.     public static function batch($items, $size, $fill = null, $preserveKeys = true): array
  1642.     {
  1643.         if (!is_iterable($items)) {
  1644.             throw new RuntimeError(\sprintf('The "batch" filter expects a sequence or a mapping, got "%s".', get_debug_type($items)));
  1645.         }
  1647.         $size = (int) ceil($size);
  1649.         $result = array_chunk(self::toArray($items, $preserveKeys), $size, $preserveKeys);
  1651.         if (null !== $fill && $result) {
  1652.             $last = \count($result) - 1;
  1653.             if ($fillCount = $size - \count($result[$last])) {
  1654.                 for ($i = 0; $i < $fillCount; ++$i) {
  1655.                     $result[$last][] = $fill;
  1656.                 }
  1657.             }
  1658.         }
  1660.         return $result;
  1661.     }
  1663.     /**
  1664.      * Returns the attribute value for a given array/object.
  1665.      *
  1666.      * @param mixed  $object            The object or array from where to get the item
  1667.      * @param mixed  $item              The item to get from the array or object
  1668.      * @param array  $arguments         An array of arguments to pass if the item is an object method
  1669.      * @param string $type              The type of attribute (@see \Twig\Template constants)
  1670.      * @param bool   $isDefinedTest     Whether this is only a defined check
  1671.      * @param bool   $ignoreStrictCheck Whether to ignore the strict attribute check or not
  1672.      * @param int    $lineno            The template line where the attribute was called
  1673.      *
  1674.      * @return mixed The attribute value, or a Boolean when $isDefinedTest is true, or null when the attribute is not set and $ignoreStrictCheck is true
  1675.      *
  1676.      * @throws RuntimeError if the attribute does not exist and Twig is running in strict mode and $isDefinedTest is false
  1677.      *
  1678.      * @internal
  1679.      */
  1680.     public static function getAttribute(Environment $env, Source $source, $object, $item, array $arguments = [], $type = Template::ANY_CALL, $isDefinedTest = false, $ignoreStrictCheck = false, $sandboxed = false, int $lineno = -1)
  1681.     {
  1682.         $propertyNotAllowedError = null;
  1684.         // array
  1685.         if (Template::METHOD_CALL !== $type) {
  1686.             $arrayItem = \is_bool($item) || \is_float($item) ? (int) $item : $item;
  1688.             if ($sandboxed && $object instanceof \ArrayAccess && !\in_array($object::class, self::ARRAY_LIKE_CLASSES, true)) {
  1689.                 try {
  1690.                     $env->getExtension(SandboxExtension::class)->checkPropertyAllowed($object, $arrayItem, $lineno, $source);
  1691.                 } catch (SecurityNotAllowedPropertyError $propertyNotAllowedError) {
  1692.                     goto methodCheck;
  1693.                 }
  1694.             }
  1696.             if (match (true) {
  1697.                 \is_array($object) => \array_key_exists($arrayItem, $object),
  1698.                 $object instanceof \ArrayAccess => $object->offsetExists($arrayItem),
  1699.                 default => false,
  1700.             }) {
  1701.                 if ($isDefinedTest) {
  1702.                     return true;
  1703.                 }
  1705.                 return $object[$arrayItem];
  1706.             }
  1708.             if (Template::ARRAY_CALL === $type || !\is_object($object)) {
  1709.                 if ($isDefinedTest) {
  1710.                     return false;
  1711.                 }
  1713.                 if ($ignoreStrictCheck || !$env->isStrictVariables()) {
  1714.                     return;
  1715.                 }
  1717.                 if ($object instanceof \ArrayAccess) {
  1718.                     $message = \sprintf('Key "%s" in object with ArrayAccess of class "%s" does not exist.', $arrayItem, $object::class);
  1719.                 } elseif (\is_object($object)) {
  1720.                     $message = \sprintf('Impossible to access a key "%s" on an object of class "%s" that does not implement ArrayAccess interface.', $item, $object::class);
  1721.                 } elseif (\is_array($object)) {
  1722.                     if (!$object) {
  1723.                         $message = \sprintf('Key "%s" does not exist as the sequence/mapping is empty.', $arrayItem);
  1724.                     } else {
  1725.                         $message = \sprintf('Key "%s" for sequence/mapping with keys "%s" does not exist.', $arrayItem, implode(', ', array_keys($object)));
  1726.                     }
  1727.                 } elseif (Template::ARRAY_CALL === $type) {
  1728.                     if (null === $object) {
  1729.                         $message = \sprintf('Impossible to access a key ("%s") on a null variable.', $item);
  1730.                     } else {
  1731.                         $message = \sprintf('Impossible to access a key ("%s") on a %s variable ("%s").', $item, get_debug_type($object), $object);
  1732.                     }
  1733.                 } elseif (null === $object) {
  1734.                     $message = \sprintf('Impossible to access an attribute ("%s") on a null variable.', $item);
  1735.                 } else {
  1736.                     $message = \sprintf('Impossible to access an attribute ("%s") on a %s variable ("%s").', $item, get_debug_type($object), $object);
  1737.                 }
  1739.                 throw new RuntimeError($message, $lineno, $source);
  1740.             }
  1741.         }
  1743.         $item = (string) $item;
  1745.         if (!\is_object($object)) {
  1746.             if ($isDefinedTest) {
  1747.                 return false;
  1748.             }
  1750.             if ($ignoreStrictCheck || !$env->isStrictVariables()) {
  1751.                 return;
  1752.             }
  1754.             if (null === $object) {
  1755.                 $message = \sprintf('Impossible to invoke a method ("%s") on a null variable.', $item);
  1756.             } elseif (\is_array($object)) {
  1757.                 $message = \sprintf('Impossible to invoke a method ("%s") on a sequence/mapping.', $item);
  1758.             } else {
  1759.                 $message = \sprintf('Impossible to invoke a method ("%s") on a %s variable ("%s").', $item, get_debug_type($object), $object);
  1760.             }
  1762.             throw new RuntimeError($message, $lineno, $source);
  1763.         }
  1765.         if ($object instanceof Template) {
  1766.             throw new RuntimeError('Accessing \Twig\Template attributes is forbidden.', $lineno, $source);
  1767.         }
  1769.         // object property
  1770.         if (Template::METHOD_CALL !== $type) {
  1771.             if ($sandboxed) {
  1772.                 try {
  1773.                     $env->getExtension(SandboxExtension::class)->checkPropertyAllowed($object, $item, $lineno, $source);
  1774.                 } catch (SecurityNotAllowedPropertyError $propertyNotAllowedError) {
  1775.                     goto methodCheck;
  1776.                 }
  1777.             }
  1779.             static $propertyCheckers = [];
  1781.             if ($object instanceof \Closure && '__invoke' === $item) {
  1782.                 return $isDefinedTest ? true : $object();
  1783.             }
  1785.             if (isset($object->$item)
  1786.                 || ($propertyCheckers[$object::class][$item] ??= self::getPropertyChecker($object::class, $item))($object, $item)
  1787.             ) {
  1788.                 if ($isDefinedTest) {
  1789.                     return true;
  1790.                 }
  1792.                 return $object->$item;
  1793.             }
  1795.             if ($object instanceof \DateTimeInterface && \in_array($item, ['date', 'timezone', 'timezone_type'], true)) {
  1796.                 if ($isDefinedTest) {
  1797.                     return true;
  1798.                 }
  1800.                 return ((array) $object)[$item];
  1801.             }
  1803.             if (\defined($object::class.'::'.$item)) {
  1804.                 if ($isDefinedTest) {
  1805.                     return true;
  1806.                 }
  1808.                 return \constant($object::class.'::'.$item);
  1809.             }
  1810.         }
  1812.         methodCheck:
  1814.         static $cache = [];
  1816.         $class = $object::class;
  1818.         // object method
  1819.         // precedence: getXxx() > isXxx() > hasXxx()
  1820.         if (!isset($cache[$class])) {
  1821.             $methods = get_class_methods($object);
  1822.             if ($object instanceof \Closure) {
  1823.                 $methods[] = '__invoke';
  1824.             }
  1825.             sort($methods);
  1826.             $lcMethods = array_map('strtolower', $methods);
  1827.             $classCache = [];
  1828.             foreach ($methods as $i => $method) {
  1829.                 $classCache[$method] = $method;
  1830.                 $classCache[$lcName = $lcMethods[$i]] = $method;
  1832.                 if ('g' === $lcName[0] && str_starts_with($lcName, 'get')) {
  1833.                     $name = substr($method, 3);
  1834.                     $lcName = substr($lcName, 3);
  1835.                 } elseif ('i' === $lcName[0] && str_starts_with($lcName, 'is')) {
  1836.                     $name = substr($method, 2);
  1837.                     $lcName = substr($lcName, 2);
  1838.                 } elseif ('h' === $lcName[0] && str_starts_with($lcName, 'has')) {
  1839.                     $name = substr($method, 3);
  1840.                     $lcName = substr($lcName, 3);
  1841.                     if (\in_array('is'.$lcName, $lcMethods, true)) {
  1842.                         continue;
  1843.                     }
  1844.                 } else {
  1845.                     continue;
  1846.                 }
  1848.                 // skip get() and is() methods (in which case, $name is empty)
  1849.                 if ($name) {
  1850.                     if (!isset($classCache[$name])) {
  1851.                         $classCache[$name] = $method;
  1852.                     }
  1854.                     if (!isset($classCache[$lcName])) {
  1855.                         $classCache[$lcName] = $method;
  1856.                     }
  1857.                 }
  1858.             }
  1859.             $cache[$class] = $classCache;
  1860.         }
  1862.         $call = false;
  1863.         if (isset($cache[$class][$item])) {
  1864.             $method = $cache[$class][$item];
  1865.         } elseif (isset($cache[$class][$lcItem = strtolower($item)])) {
  1866.             $method = $cache[$class][$lcItem];
  1867.         } elseif (isset($cache[$class]['__call'])) {
  1868.             $method = $item;
  1869.             $call = true;
  1870.         } else {
  1871.             if ($isDefinedTest) {
  1872.                 return false;
  1873.             }
  1875.             if ($propertyNotAllowedError) {
  1876.                 throw $propertyNotAllowedError;
  1877.             }
  1879.             if ($ignoreStrictCheck || !$env->isStrictVariables()) {
  1880.                 return;
  1881.             }
  1883.             throw new RuntimeError(\sprintf('Neither the property "%1$s" nor one of the methods "%1$s()", "get%1$s()"/"is%1$s()"/"has%1$s()" or "__call()" exist and have public access in class "%2$s".', $item, $class), $lineno, $source);
  1884.         }
  1886.         if ($sandboxed) {
  1887.             try {
  1888.                 $env->getExtension(SandboxExtension::class)->checkMethodAllowed($object, $method, $lineno, $source);
  1889.             } catch (SecurityNotAllowedMethodError $e) {
  1890.                 if ($isDefinedTest) {
  1891.                     return false;
  1892.                 }
  1894.                 if ($propertyNotAllowedError) {
  1895.                     throw $propertyNotAllowedError;
  1896.                 }
  1898.                 throw $e;
  1899.             }
  1900.         }
  1902.         if ($isDefinedTest) {
  1903.             return true;
  1904.         }
  1906.         // Some objects throw exceptions when they have __call, and the method we try
  1907.         // to call is not supported. If ignoreStrictCheck is true, we should return null.
  1908.         try {
  1909.             $ret = $object->$method(...$arguments);
  1910.         } catch (\BadMethodCallException $e) {
  1911.             if ($call && ($ignoreStrictCheck || !$env->isStrictVariables())) {
  1912.                 return;
  1913.             }
  1914.             throw $e;
  1915.         }
  1917.         return $ret;
  1918.     }
  1920.     /**
  1921.      * Returns the values from a single column in the input array.
  1922.      *
  1923.      * <pre>
  1924.      *  {% set items = [{ 'fruit' : 'apple'}, {'fruit' : 'orange' }] %}
  1925.      *
  1926.      *  {% set fruits = items|column('fruit') %}
  1927.      *
  1928.      *  {# fruits now contains ['apple', 'orange'] #}
  1929.      * </pre>
  1930.      *
  1931.      * @param array|\Traversable $array An array
  1932.      * @param int|string         $name  The column name
  1933.      * @param int|string|null    $index The column to use as the index/keys for the returned array
  1934.      *
  1935.      * @return array The array of values
  1936.      *
  1937.      * @internal
  1938.      */
  1939.     public static function column($array, $name, $index = null): array
  1940.     {
  1941.         if (!is_iterable($array)) {
  1942.             throw new RuntimeError(\sprintf('The "column" filter expects a sequence or a mapping, got "%s".', get_debug_type($array)));
  1943.         }
  1945.         if ($array instanceof \Traversable) {
  1946.             $array = iterator_to_array($array);
  1947.         }
  1949.         return array_column($array, $name, $index);
  1950.     }
  1952.     /**
  1953.      * @param \Closure $arrow
  1954.      *
  1955.      * @internal
  1956.      */
  1957.     public static function filter(Environment $env, $array, $arrow)
  1958.     {
  1959.         if (!is_iterable($array)) {
  1960.             throw new RuntimeError(\sprintf('The "filter" filter expects a sequence/mapping or "Traversable", got "%s".', get_debug_type($array)));
  1961.         }
  1963.         self::checkArrow($env, $arrow, 'filter', 'filter');
  1965.         if (\is_array($array)) {
  1966.             return array_filter($array, $arrow, \ARRAY_FILTER_USE_BOTH);
  1967.         }
  1969.         // the IteratorIterator wrapping is needed as some internal PHP classes are \Traversable but do not implement \Iterator
  1970.         return new \CallbackFilterIterator(new \IteratorIterator($array), $arrow);
  1971.     }
  1973.     /**
  1974.      * @param \Closure $arrow
  1975.      *
  1976.      * @internal
  1977.      */
  1978.     public static function find(Environment $env, $array, $arrow)
  1979.     {
  1980.         if (!is_iterable($array)) {
  1981.             throw new RuntimeError(\sprintf('The "find" filter expects a sequence or a mapping, got "%s".', get_debug_type($array)));
  1982.         }
  1984.         self::checkArrow($env, $arrow, 'find', 'filter');
  1986.         foreach ($array as $k => $v) {
  1987.             if ($arrow($v, $k)) {
  1988.                 return $v;
  1989.             }
  1990.         }
  1992.         return null;
  1993.     }
  1995.     /**
  1996.      * @param \Closure $arrow
  1997.      *
  1998.      * @internal
  1999.      */
  2000.     public static function map(Environment $env, $array, $arrow)
  2001.     {
  2002.         if (!is_iterable($array)) {
  2003.             throw new RuntimeError(\sprintf('The "map" filter expects a sequence or a mapping, got "%s".', get_debug_type($array)));
  2004.         }
  2006.         self::checkArrow($env, $arrow, 'map', 'filter');
  2008.         $r = [];
  2009.         foreach ($array as $k => $v) {
  2010.             $r[$k] = $arrow($v, $k);
  2011.         }
  2013.         return $r;
  2014.     }
  2016.     /**
  2017.      * @param \Closure $arrow
  2018.      *
  2019.      * @internal
  2020.      */
  2021.     public static function reduce(Environment $env, $array, $arrow, $initial = null)
  2022.     {
  2023.         if (!is_iterable($array)) {
  2024.             throw new RuntimeError(\sprintf('The "reduce" filter expects a sequence or a mapping, got "%s".', get_debug_type($array)));
  2025.         }
  2027.         self::checkArrow($env, $arrow, 'reduce', 'filter');
  2029.         $accumulator = $initial;
  2030.         foreach ($array as $key => $value) {
  2031.             $accumulator = $arrow($accumulator, $value, $key);
  2032.         }
  2034.         return $accumulator;
  2035.     }
  2037.     /**
  2038.      * @param \Closure $arrow
  2039.      *
  2040.      * @internal
  2041.      */
  2042.     public static function arraySome(Environment $env, $array, $arrow)
  2043.     {
  2044.         if (!is_iterable($array)) {
  2045.             throw new RuntimeError(\sprintf('The "has some" test expects a sequence or a mapping, got "%s".', get_debug_type($array)));
  2046.         }
  2048.         self::checkArrow($env, $arrow, 'has some', 'operator');
  2050.         foreach ($array as $k => $v) {
  2051.             if ($arrow($v, $k)) {
  2052.                 return true;
  2053.             }
  2054.         }
  2056.         return false;
  2057.     }
  2059.     /**
  2060.      * @param \Closure $arrow
  2061.      *
  2062.      * @internal
  2063.      */
  2064.     public static function arrayEvery(Environment $env, $array, $arrow)
  2065.     {
  2066.         if (!is_iterable($array)) {
  2067.             throw new RuntimeError(\sprintf('The "has every" test expects a sequence or a mapping, got "%s".', get_debug_type($array)));
  2068.         }
  2070.         self::checkArrow($env, $arrow, 'has every', 'operator');
  2072.         foreach ($array as $k => $v) {
  2073.             if (!$arrow($v, $k)) {
  2074.                 return false;
  2075.             }
  2076.         }
  2078.         return true;
  2079.     }
  2081.     /**
  2082.      * @internal
  2083.      */
  2084.     public static function checkArrow(Environment $env, $arrow, $thing, $type)
  2085.     {
  2086.         if ($arrow instanceof \Closure) {
  2087.             return;
  2088.         }
  2090.         if ($env->hasExtension(SandboxExtension::class) && $env->getExtension(SandboxExtension::class)->isSandboxed()) {
  2091.             throw new RuntimeError(\sprintf('The callable passed to the "%s" %s must be a Closure in sandbox mode.', $thing, $type));
  2092.         }
  2094.         trigger_deprecation('twig/twig', '3.15', 'Passing a callable that is not a PHP \Closure as an argument to the "%s" %s is deprecated.', $thing, $type);
  2095.     }
  2097.     /**
  2098.      * @internal to be removed in Twig 4
  2099.      */
  2100.     public static function captureOutput(iterable $body): string
  2101.     {
  2102.         $level = ob_get_level();
  2103.         ob_start();
  2105.         try {
  2106.             foreach ($body as $data) {
  2107.                 echo $data;
  2108.             }
  2109.         } catch (\Throwable $e) {
  2110.             while (ob_get_level() > $level) {
  2111.                 ob_end_clean();
  2112.             }
  2114.             throw $e;
  2115.         }
  2117.         return ob_get_clean();
  2118.     }
  2120.     /**
  2121.      * @internal
  2122.      */
  2123.     public static function parseParentFunction(Parser $parser, Node $fakeNode, $args, int $line): AbstractExpression
  2124.     {
  2125.         if (!$blockName = $parser->peekBlockStack()) {
  2126.             throw new SyntaxError('Calling the "parent" function outside of a block is forbidden.', $line, $parser->getStream()->getSourceContext());
  2127.         }
  2129.         if (!$parser->hasInheritance()) {
  2130.             throw new SyntaxError('Calling the "parent" function on a template that does not call "extends" or "use" is forbidden.', $line, $parser->getStream()->getSourceContext());
  2131.         }
  2133.         return new ParentExpression($blockName, $line);
  2134.     }
  2136.     /**
  2137.      * @internal
  2138.      */
  2139.     public static function parseBlockFunction(Parser $parser, Node $fakeNode, $args, int $line): AbstractExpression
  2140.     {
  2141.         $fakeFunction = new TwigFunction('block', fn ($name, $template = null) => null);
  2142.         $args = (new CallableArgumentsExtractor($fakeNode, $fakeFunction))->extractArguments($args);
  2144.         return new BlockReferenceExpression($args[0], $args[1] ?? null, $line);
  2145.     }
  2147.     /**
  2148.      * @internal
  2149.      */
  2150.     public static function parseAttributeFunction(Parser $parser, Node $fakeNode, $args, int $line): AbstractExpression
  2151.     {
  2152.         $fakeFunction = new TwigFunction('attribute', fn ($variable, $attribute, $arguments = null) => null);
  2153.         $args = (new CallableArgumentsExtractor($fakeNode, $fakeFunction))->extractArguments($args);
  2155.         /*
  2156.         Deprecation to uncomment sometimes during the lifetime of the 4.x branch
  2157.         $src = $parser->getStream()->getSourceContext();
  2158.         $dep = new DeprecatedCallableInfo('twig/twig', '3.15', 'The "attribute" function is deprecated, use the "." notation instead.');
  2159.         $dep->setName('attribute');
  2160.         $dep->setType('function');
  2161.         $dep->triggerDeprecation($src->getPath() ?: $src->getName(), $line);
  2162.         */
  2164.         return new GetAttrExpression($args[0], $args[1], $args[2] ?? null, Template::ANY_CALL, $line);
  2165.     }
  2167.     private static function getPropertyChecker(string $class, string $property): \Closure
  2168.     {
  2169.         static $classReflectors = [];
  2171.         $class = $classReflectors[$class] ??= new \ReflectionClass($class);
  2173.         if (!$class->hasProperty($property)) {
  2174.             static $propertyExists;
  2176.             return $propertyExists ??= \Closure::fromCallable('property_exists');
  2177.         }
  2179.         $property = $class->getProperty($property);
  2181.         if (!$property->isPublic() || $property->isStatic()) {
  2182.             static $false;
  2184.             return $false ??= static fn () => false;
  2185.         }
  2187.         return static fn ($object) => $property->isInitialized($object);
  2188.     }
  2189. }