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

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