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

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\Environment;
  15. use Twig\Error\LoaderError;
  16. use Twig\Error\RuntimeError;
  17. use Twig\ExpressionParser;
  18. use Twig\Markup;
  19. use Twig\Node\Expression\Binary\AddBinary;
  20. use Twig\Node\Expression\Binary\AndBinary;
  21. use Twig\Node\Expression\Binary\BitwiseAndBinary;
  22. use Twig\Node\Expression\Binary\BitwiseOrBinary;
  23. use Twig\Node\Expression\Binary\BitwiseXorBinary;
  24. use Twig\Node\Expression\Binary\ConcatBinary;
  25. use Twig\Node\Expression\Binary\DivBinary;
  26. use Twig\Node\Expression\Binary\EndsWithBinary;
  27. use Twig\Node\Expression\Binary\EqualBinary;
  28. use Twig\Node\Expression\Binary\FloorDivBinary;
  29. use Twig\Node\Expression\Binary\GreaterBinary;
  30. use Twig\Node\Expression\Binary\GreaterEqualBinary;
  31. use Twig\Node\Expression\Binary\HasEveryBinary;
  32. use Twig\Node\Expression\Binary\HasSomeBinary;
  33. use Twig\Node\Expression\Binary\InBinary;
  34. use Twig\Node\Expression\Binary\LessBinary;
  35. use Twig\Node\Expression\Binary\LessEqualBinary;
  36. use Twig\Node\Expression\Binary\MatchesBinary;
  37. use Twig\Node\Expression\Binary\ModBinary;
  38. use Twig\Node\Expression\Binary\MulBinary;
  39. use Twig\Node\Expression\Binary\NotEqualBinary;
  40. use Twig\Node\Expression\Binary\NotInBinary;
  41. use Twig\Node\Expression\Binary\OrBinary;
  42. use Twig\Node\Expression\Binary\PowerBinary;
  43. use Twig\Node\Expression\Binary\RangeBinary;
  44. use Twig\Node\Expression\Binary\SpaceshipBinary;
  45. use Twig\Node\Expression\Binary\StartsWithBinary;
  46. use Twig\Node\Expression\Binary\SubBinary;
  47. use Twig\Node\Expression\Filter\DefaultFilter;
  48. use Twig\Node\Expression\NullCoalesceExpression;
  49. use Twig\Node\Expression\Test\ConstantTest;
  50. use Twig\Node\Expression\Test\DefinedTest;
  51. use Twig\Node\Expression\Test\DivisiblebyTest;
  52. use Twig\Node\Expression\Test\EvenTest;
  53. use Twig\Node\Expression\Test\NullTest;
  54. use Twig\Node\Expression\Test\OddTest;
  55. use Twig\Node\Expression\Test\SameasTest;
  56. use Twig\Node\Expression\Unary\NegUnary;
  57. use Twig\Node\Expression\Unary\NotUnary;
  58. use Twig\Node\Expression\Unary\PosUnary;
  59. use Twig\NodeVisitor\MacroAutoImportNodeVisitor;
  60. use Twig\Source;
  61. use Twig\Template;
  62. use Twig\TemplateWrapper;
  63. use Twig\TokenParser\ApplyTokenParser;
  64. use Twig\TokenParser\BlockTokenParser;
  65. use Twig\TokenParser\DeprecatedTokenParser;
  66. use Twig\TokenParser\DoTokenParser;
  67. use Twig\TokenParser\EmbedTokenParser;
  68. use Twig\TokenParser\ExtendsTokenParser;
  69. use Twig\TokenParser\FlushTokenParser;
  70. use Twig\TokenParser\ForTokenParser;
  71. use Twig\TokenParser\FromTokenParser;
  72. use Twig\TokenParser\IfTokenParser;
  73. use Twig\TokenParser\ImportTokenParser;
  74. use Twig\TokenParser\IncludeTokenParser;
  75. use Twig\TokenParser\MacroTokenParser;
  76. use Twig\TokenParser\SetTokenParser;
  77. use Twig\TokenParser\UseTokenParser;
  78. use Twig\TokenParser\WithTokenParser;
  79. use Twig\TwigFilter;
  80. use Twig\TwigFunction;
  81. use Twig\TwigTest;
  83. final class CoreExtension extends AbstractExtension
  84. {
  85.     private $dateFormats = ['F j, Y H:i', '%d days'];
  86.     private $numberFormat = [0, '.', ','];
  87.     private $timezone = null;
  89.     /**
  90.      * Sets the default format to be used by the date filter.
  91.      *
  92.      * @param string|null $format             The default date format string
  93.      * @param string|null $dateIntervalFormat The default date interval format string
  94.      */
  95.     public function setDateFormat($format = null, $dateIntervalFormat = null)
  96.     {
  97.         if (null !== $format) {
  98.             $this->dateFormats[0] = $format;
  99.         }
  101.         if (null !== $dateIntervalFormat) {
  102.             $this->dateFormats[1] = $dateIntervalFormat;
  103.         }
  104.     }
  106.     /**
  107.      * Gets the default format to be used by the date filter.
  108.      *
  109.      * @return array The default date format string and the default date interval format string
  110.      */
  111.     public function getDateFormat()
  112.     {
  113.         return $this->dateFormats;
  114.     }
  116.     /**
  117.      * Sets the default timezone to be used by the date filter.
  118.      *
  119.      * @param \DateTimeZone|string $timezone The default timezone string or a \DateTimeZone object
  120.      */
  121.     public function setTimezone($timezone)
  122.     {
  123.         $this->timezone = $timezone instanceof \DateTimeZone ? $timezone : new \DateTimeZone($timezone);
  124.     }
  126.     /**
  127.      * Gets the default timezone to be used by the date filter.
  128.      *
  129.      * @return \DateTimeZone The default timezone currently in use
  130.      */
  131.     public function getTimezone()
  132.     {
  133.         if (null === $this->timezone) {
  134.             $this->timezone = new \DateTimeZone(date_default_timezone_get());
  135.         }
  137.         return $this->timezone;
  138.     }
  140.     /**
  141.      * Sets the default format to be used by the number_format filter.
  142.      *
  143.      * @param int    $decimal      the number of decimal places to use
  144.      * @param string $decimalPoint the character(s) to use for the decimal point
  145.      * @param string $thousandSep  the character(s) to use for the thousands separator
  146.      */
  147.     public function setNumberFormat($decimal, $decimalPoint, $thousandSep)
  148.     {
  149.         $this->numberFormat = [$decimal, $decimalPoint, $thousandSep];
  150.     }
  152.     /**
  153.      * Get the default format used by the number_format filter.
  154.      *
  155.      * @return array The arguments for number_format()
  156.      */
  157.     public function getNumberFormat()
  158.     {
  159.         return $this->numberFormat;
  160.     }
  162.     public function getTokenParsers(): array
  163.     {
  164.         return [
  165.             new ApplyTokenParser(),
  166.             new ForTokenParser(),
  167.             new IfTokenParser(),
  168.             new ExtendsTokenParser(),
  169.             new IncludeTokenParser(),
  170.             new BlockTokenParser(),
  171.             new UseTokenParser(),
  172.             new MacroTokenParser(),
  173.             new ImportTokenParser(),
  174.             new FromTokenParser(),
  175.             new SetTokenParser(),
  176.             new FlushTokenParser(),
  177.             new DoTokenParser(),
  178.             new EmbedTokenParser(),
  179.             new WithTokenParser(),
  180.             new DeprecatedTokenParser(),
  181.         ];
  182.     }
  184.     public function getFilters(): array
  185.     {
  186.         return [
  187.             // formatting filters
  188.             new TwigFilter('date', [$this, 'formatDate']),
  189.             new TwigFilter('date_modify', [$this, 'modifyDate']),
  190.             new TwigFilter('format', [self::class, 'sprintf']),
  191.             new TwigFilter('replace', [self::class, 'replace']),
  192.             new TwigFilter('number_format', [$this, 'formatNumber']),
  193.             new TwigFilter('abs', 'abs'),
  194.             new TwigFilter('round', [self::class, 'round']),
  196.             // encoding
  197.             new TwigFilter('url_encode', [self::class, 'urlencode']),
  198.             new TwigFilter('json_encode', 'json_encode'),
  199.             new TwigFilter('convert_encoding', [self::class, 'convertEncoding']),
  201.             // string filters
  202.             new TwigFilter('title', [self::class, 'titleCase'], ['needs_charset' => true]),
  203.             new TwigFilter('capitalize', [self::class, 'capitalize'], ['needs_charset' => true]),
  204.             new TwigFilter('upper', [self::class, 'upper'], ['needs_charset' => true]),
  205.             new TwigFilter('lower', [self::class, 'lower'], ['needs_charset' => true]),
  206.             new TwigFilter('striptags', [self::class, 'striptags']),
  207.             new TwigFilter('trim', [self::class, 'trim']),
  208.             new TwigFilter('nl2br', [self::class, 'nl2br'], ['pre_escape' => 'html', 'is_safe' => ['html']]),
  209.             new TwigFilter('spaceless', [self::class, 'spaceless'], ['is_safe' => ['html']]),
  211.             // array helpers
  212.             new TwigFilter('join', [self::class, 'join']),
  213.             new TwigFilter('split', [self::class, 'split'], ['needs_charset' => true]),
  214.             new TwigFilter('sort', [self::class, 'sort'], ['needs_environment' => true]),
  215.             new TwigFilter('merge', [self::class, 'merge']),
  216.             new TwigFilter('batch', [self::class, 'batch']),
  217.             new TwigFilter('column', [self::class, 'column']),
  218.             new TwigFilter('filter', [self::class, 'filter'], ['needs_environment' => true]),
  219.             new TwigFilter('map', [self::class, 'map'], ['needs_environment' => true]),
  220.             new TwigFilter('reduce', [self::class, 'reduce'], ['needs_environment' => true]),
  221.             new TwigFilter('find', [self::class, 'find'], ['needs_environment' => true]),
  223.             // string/array filters
  224.             new TwigFilter('reverse', [self::class, 'reverse'], ['needs_charset' => true]),
  225.             new TwigFilter('shuffle', [self::class, 'shuffle'], ['needs_charset' => true]),
  226.             new TwigFilter('length', [self::class, 'length'], ['needs_charset' => true]),
  227.             new TwigFilter('slice', [self::class, 'slice'], ['needs_charset' => true]),
  228.             new TwigFilter('first', [self::class, 'first'], ['needs_charset' => true]),
  229.             new TwigFilter('last', [self::class, 'last'], ['needs_charset' => true]),
  231.             // iteration and runtime
  232.             new TwigFilter('default', [self::class, 'default'], ['node_class' => DefaultFilter::class]),
  233.             new TwigFilter('keys', [self::class, 'keys']),
  234.         ];
  235.     }
  237.     public function getFunctions(): array
  238.     {
  239.         return [
  240.             new TwigFunction('max', 'max'),
  241.             new TwigFunction('min', 'min'),
  242.             new TwigFunction('range', 'range'),
  243.             new TwigFunction('constant', [self::class, 'constant']),
  244.             new TwigFunction('cycle', [self::class, 'cycle']),
  245.             new TwigFunction('random', [self::class, 'random'], ['needs_charset' => true]),
  246.             new TwigFunction('date', [$this, 'convertDate']),
  247.             new TwigFunction('include', [self::class, 'include'], ['needs_environment' => true, 'needs_context' => true, 'is_safe' => ['all']]),
  248.             new TwigFunction('source', [self::class, 'source'], ['needs_environment' => true, 'is_safe' => ['all']]),
  249.         ];
  250.     }
  252.     public function getTests(): array
  253.     {
  254.         return [
  255.             new TwigTest('even', null, ['node_class' => EvenTest::class]),
  256.             new TwigTest('odd', null, ['node_class' => OddTest::class]),
  257.             new TwigTest('defined', null, ['node_class' => DefinedTest::class]),
  258.             new TwigTest('same as', null, ['node_class' => SameasTest::class, 'one_mandatory_argument' => true]),
  259.             new TwigTest('none', null, ['node_class' => NullTest::class]),
  260.             new TwigTest('null', null, ['node_class' => NullTest::class]),
  261.             new TwigTest('divisible by', null, ['node_class' => DivisiblebyTest::class, 'one_mandatory_argument' => true]),
  262.             new TwigTest('constant', null, ['node_class' => ConstantTest::class]),
  263.             new TwigTest('empty', [self::class, 'testEmpty']),
  264.             new TwigTest('iterable', 'is_iterable'),
  265.             new TwigTest('sequence', [self::class, 'testSequence']),
  266.             new TwigTest('mapping', [self::class, 'testMapping']),
  267.         ];
  268.     }
  270.     public function getNodeVisitors(): array
  271.     {
  272.         return [new MacroAutoImportNodeVisitor()];
  273.     }
  275.     public function getOperators(): array
  276.     {
  277.         return [
  278.             [
  279.                 'not' => ['precedence' => 50, 'class' => NotUnary::class],
  280.                 '-' => ['precedence' => 500, 'class' => NegUnary::class],
  281.                 '+' => ['precedence' => 500, 'class' => PosUnary::class],
  282.             ],
  283.             [
  284.                 'or' => ['precedence' => 10, 'class' => OrBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  285.                 'and' => ['precedence' => 15, 'class' => AndBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  286.                 'b-or' => ['precedence' => 16, 'class' => BitwiseOrBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  287.                 'b-xor' => ['precedence' => 17, 'class' => BitwiseXorBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  288.                 'b-and' => ['precedence' => 18, 'class' => BitwiseAndBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  289.                 '==' => ['precedence' => 20, 'class' => EqualBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  290.                 '!=' => ['precedence' => 20, 'class' => NotEqualBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  291.                 '<=>' => ['precedence' => 20, 'class' => SpaceshipBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  292.                 '<' => ['precedence' => 20, 'class' => LessBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  293.                 '>' => ['precedence' => 20, 'class' => GreaterBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  294.                 '>=' => ['precedence' => 20, 'class' => GreaterEqualBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  295.                 '<=' => ['precedence' => 20, 'class' => LessEqualBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  296.                 'not in' => ['precedence' => 20, 'class' => NotInBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  297.                 'in' => ['precedence' => 20, 'class' => InBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  298.                 'matches' => ['precedence' => 20, 'class' => MatchesBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  299.                 'starts with' => ['precedence' => 20, 'class' => StartsWithBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  300.                 'ends with' => ['precedence' => 20, 'class' => EndsWithBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  301.                 'has some' => ['precedence' => 20, 'class' => HasSomeBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  302.                 'has every' => ['precedence' => 20, 'class' => HasEveryBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  303.                 '..' => ['precedence' => 25, 'class' => RangeBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  304.                 '+' => ['precedence' => 30, 'class' => AddBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  305.                 '-' => ['precedence' => 30, 'class' => SubBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  306.                 '~' => ['precedence' => 40, 'class' => ConcatBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  307.                 '*' => ['precedence' => 60, 'class' => MulBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  308.                 '/' => ['precedence' => 60, 'class' => DivBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  309.                 '//' => ['precedence' => 60, 'class' => FloorDivBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  310.                 '%' => ['precedence' => 60, 'class' => ModBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  311.                 'is' => ['precedence' => 100, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  312.                 'is not' => ['precedence' => 100, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  313.                 '**' => ['precedence' => 200, 'class' => PowerBinary::class, 'associativity' => ExpressionParser::OPERATOR_RIGHT],
  314.                 '??' => ['precedence' => 300, 'class' => NullCoalesceExpression::class, 'associativity' => ExpressionParser::OPERATOR_RIGHT],
  315.             ],
  316.         ];
  317.     }
  319.     /**
  320.      * Cycles over a value.
  321.      *
  322.      * @param \ArrayAccess|array $values
  323.      * @param int                $position The cycle position
  324.      *
  325.      * @return string The next value in the cycle
  326.      *
  327.      * @internal
  328.      */
  329.     public static function cycle($values, $position): string
  330.     {
  331.         if (!\is_array($values) && !$values instanceof \ArrayAccess) {
  332.             return $values;
  333.         }
  335.         if (!\count($values)) {
  336.             throw new RuntimeError('The "cycle" function does not work on empty sequences/mappings.');
  337.         }
  339.         return $values[$position % \count($values)];
  340.     }
  342.     /**
  343.      * Returns a random value depending on the supplied parameter type:
  344.      * - a random item from a \Traversable or array
  345.      * - a random character from a string
  346.      * - a random integer between 0 and the integer parameter.
  347.      *
  348.      * @param \Traversable|array|int|float|string $values The values to pick a random item from
  349.      * @param int|null                            $max    Maximum value used when $values is an int
  350.      *
  351.      * @return mixed A random value from the given sequence
  352.      *
  353.      * @throws RuntimeError when $values is an empty array (does not apply to an empty string which is returned as is)
  354.      *
  355.      * @internal
  356.      */
  357.     public static function random(string $charset, $values = null, $max = null)
  358.     {
  359.         if (null === $values) {
  360.             return null === $max ? mt_rand() : mt_rand(0, (int) $max);
  361.         }
  363.         if (\is_int($values) || \is_float($values)) {
  364.             if (null === $max) {
  365.                 if ($values < 0) {
  366.                     $max = 0;
  367.                     $min = $values;
  368.                 } else {
  369.                     $max = $values;
  370.                     $min = 0;
  371.                 }
  372.             } else {
  373.                 $min = $values;
  374.             }
  376.             return mt_rand((int) $min, (int) $max);
  377.         }
  379.         if (\is_string($values)) {
  380.             if ('' === $values) {
  381.                 return '';
  382.             }
  384.             if ('UTF-8' !== $charset) {
  385.                 $values = self::convertEncoding($values, 'UTF-8', $charset);
  386.             }
  388.             // unicode version of str_split()
  389.             // split at all positions, but not after the start and not before the end
  390.             $values = preg_split('/(?<!^)(?!$)/u', $values);
  392.             if ('UTF-8' !== $charset) {
  393.                 foreach ($values as $i => $value) {
  394.                     $values[$i] = self::convertEncoding($value, $charset, 'UTF-8');
  395.                 }
  396.             }
  397.         }
  399.         if (!is_iterable($values)) {
  400.             return $values;
  401.         }
  403.         $values = self::toArray($values);
  405.         if (0 === \count($values)) {
  406.             throw new RuntimeError('The random function cannot pick from an empty sequence/mapping.');
  407.         }
  409.         return $values[array_rand($values, 1)];
  410.     }
  412.     /**
  413.      * Formats a date.
  414.      *
  415.      *   {{ post.published_at|date("m/d/Y") }}
  416.      *
  417.      * @param \DateTimeInterface|\DateInterval|string $date     A date
  418.      * @param string|null                             $format   The target format, null to use the default
  419.      * @param \DateTimeZone|string|false|null         $timezone The target timezone, null to use the default, false to leave unchanged
  420.      */
  421.     public function formatDate($date, $format = null, $timezone = null): string
  422.     {
  423.         if (null === $format) {
  424.             $formats = $this->getDateFormat();
  425.             $format = $date instanceof \DateInterval ? $formats[1] : $formats[0];
  426.         }
  428.         if ($date instanceof \DateInterval) {
  429.             return $date->format($format);
  430.         }
  432.         return $this->convertDate($date, $timezone)->format($format);
  433.     }
  435.     /**
  436.      * Returns a new date object modified.
  437.      *
  438.      *   {{ post.published_at|date_modify("-1day")|date("m/d/Y") }}
  439.      *
  440.      * @param \DateTimeInterface|string $date     A date
  441.      * @param string                    $modifier A modifier string
  442.      *
  443.      * @return \DateTime|\DateTimeImmutable
  444.      *
  445.      * @internal
  446.      */
  447.     public function modifyDate($date, $modifier)
  448.     {
  449.         return $this->convertDate($date, false)->modify($modifier);
  450.     }
  452.     /**
  453.      * Returns a formatted string.
  454.      *
  455.      * @param string|null $format
  456.      * @param ...$values
  457.      *
  458.      * @internal
  459.      */
  460.     public static function sprintf($format, ...$values): string
  461.     {
  462.         return \sprintf($format ?? '', ...$values);
  463.     }
  465.     /**
  466.      * @internal
  467.      */
  468.     public static function dateConverter(Environment $env, $date, $format = null, $timezone = null): string
  469.     {
  470.         return $env->getExtension(self::class)->formatDate($date, $format, $timezone);
  471.     }
  473.     /**
  474.      * Converts an input to a \DateTime instance.
  475.      *
  476.      *    {% if date(user.created_at) < date('+2days') %}
  477.      *      {# do something #}
  478.      *    {% endif %}
  479.      *
  480.      * @param \DateTimeInterface|string|null  $date     A date or null to use the current time
  481.      * @param \DateTimeZone|string|false|null $timezone The target timezone, null to use the default, false to leave unchanged
  482.      *
  483.      * @return \DateTime|\DateTimeImmutable
  484.      */
  485.     public function convertDate($date = null, $timezone = null)
  486.     {
  487.         // determine the timezone
  488.         if (false !== $timezone) {
  489.             if (null === $timezone) {
  490.                 $timezone = $this->getTimezone();
  491.             } elseif (!$timezone instanceof \DateTimeZone) {
  492.                 $timezone = new \DateTimeZone($timezone);
  493.             }
  494.         }
  496.         // immutable dates
  497.         if ($date instanceof \DateTimeImmutable) {
  498.             return false !== $timezone ? $date->setTimezone($timezone) : $date;
  499.         }
  501.         if ($date instanceof \DateTime) {
  502.             $date = clone $date;
  503.             if (false !== $timezone) {
  504.                 $date->setTimezone($timezone);
  505.             }
  507.             return $date;
  508.         }
  510.         if (null === $date || 'now' === $date) {
  511.             if (null === $date) {
  512.                 $date = 'now';
  513.             }
  515.             return new \DateTime($date, false !== $timezone ? $timezone : $this->getTimezone());
  516.         }
  518.         $asString = (string) $date;
  519.         if (ctype_digit($asString) || (!empty($asString) && '-' === $asString[0] && ctype_digit(substr($asString, 1)))) {
  520.             $date = new \DateTime('@'.$date);
  521.         } else {
  522.             $date = new \DateTime($date, $this->getTimezone());
  523.         }
  525.         if (false !== $timezone) {
  526.             $date->setTimezone($timezone);
  527.         }
  529.         return $date;
  530.     }
  532.     /**
  533.      * Replaces strings within a string.
  534.      *
  535.      * @param string|null        $str  String to replace in
  536.      * @param array|\Traversable $from Replace values
  537.      *
  538.      * @internal
  539.      */
  540.     public static function replace($str, $from): string
  541.     {
  542.         if (!is_iterable($from)) {
  543.             throw new RuntimeError(\sprintf('The "replace" filter expects a sequence/mapping or "Traversable" as replace values, got "%s".', \is_object($from) ? \get_class($from) : \gettype($from)));
  544.         }
  546.         return strtr($str ?? '', self::toArray($from));
  547.     }
  549.     /**
  550.      * Rounds a number.
  551.      *
  552.      * @param int|float|string|null $value     The value to round
  553.      * @param int|float             $precision The rounding precision
  554.      * @param string                $method    The method to use for rounding
  555.      *
  556.      * @return int|float The rounded number
  557.      *
  558.      * @internal
  559.      */
  560.     public static function round($value, $precision = 0, $method = 'common')
  561.     {
  562.         $value = (float) $value;
  564.         if ('common' === $method) {
  565.             return round($value, $precision);
  566.         }
  568.         if ('ceil' !== $method && 'floor' !== $method) {
  569.             throw new RuntimeError('The round filter only supports the "common", "ceil", and "floor" methods.');
  570.         }
  572.         return $method($value * 10 ** $precision) / 10 ** $precision;
  573.     }
  575.     /**
  576.      * Formats a number.
  577.      *
  578.      * All of the formatting options can be left null, in that case the defaults will
  579.      * be used. Supplying any of the parameters will override the defaults set in the
  580.      * environment object.
  581.      *
  582.      * @param mixed       $number       A float/int/string of the number to format
  583.      * @param int|null    $decimal      the number of decimal points to display
  584.      * @param string|null $decimalPoint the character(s) to use for the decimal point
  585.      * @param string|null $thousandSep  the character(s) to use for the thousands separator
  586.      */
  587.     public function formatNumber($number, $decimal = null, $decimalPoint = null, $thousandSep = null): string
  588.     {
  589.         $defaults = $this->getNumberFormat();
  590.         if (null === $decimal) {
  591.             $decimal = $defaults[0];
  592.         }
  594.         if (null === $decimalPoint) {
  595.             $decimalPoint = $defaults[1];
  596.         }
  598.         if (null === $thousandSep) {
  599.             $thousandSep = $defaults[2];
  600.         }
  602.         return number_format((float) $number, $decimal, $decimalPoint, $thousandSep);
  603.     }
  605.     /**
  606.      * URL encodes (RFC 3986) a string as a path segment or an array as a query string.
  607.      *
  608.      * @param string|array|null $url A URL or an array of query parameters
  609.      *
  610.      * @internal
  611.      */
  612.     public static function urlencode($url): string
  613.     {
  614.         if (\is_array($url)) {
  615.             return http_build_query($url, '', '&', \PHP_QUERY_RFC3986);
  616.         }
  618.         return rawurlencode($url ?? '');
  619.     }
  621.     /**
  622.      * Merges any number of arrays or Traversable objects.
  623.      *
  624.      *  {% set items = { 'apple': 'fruit', 'orange': 'fruit' } %}
  625.      *
  626.      *  {% set items = items|merge({ 'peugeot': 'car' }, { 'banana': 'fruit' }) %}
  627.      *
  628.      *  {# items now contains { 'apple': 'fruit', 'orange': 'fruit', 'peugeot': 'car', 'banana': 'fruit' } #}
  629.      *
  630.      * @param array|\Traversable ...$arrays Any number of arrays or Traversable objects to merge
  631.      *
  632.      * @internal
  633.      */
  634.     public static function merge(...$arrays): array
  635.     {
  636.         $result = [];
  638.         foreach ($arrays as $argNumber => $array) {
  639.             if (!is_iterable($array)) {
  640.                 throw new RuntimeError(\sprintf('The merge filter only works with sequences/mappings or "Traversable", got "%s" for argument %d.', \gettype($array), $argNumber + 1));
  641.             }
  643.             $result = array_merge($result, self::toArray($array));
  644.         }
  646.         return $result;
  647.     }
  649.     /**
  650.      * Slices a variable.
  651.      *
  652.      * @param mixed $item         A variable
  653.      * @param int   $start        Start of the slice
  654.      * @param int   $length       Size of the slice
  655.      * @param bool  $preserveKeys Whether to preserve key or not (when the input is an array)
  656.      *
  657.      * @return mixed The sliced variable
  658.      *
  659.      * @internal
  660.      */
  661.     public static function slice(string $charset, $item, $start, $length = null, $preserveKeys = false)
  662.     {
  663.         if ($item instanceof \Traversable) {
  664.             while ($item instanceof \IteratorAggregate) {
  665.                 $item = $item->getIterator();
  666.             }
  668.             if ($start >= 0 && $length >= 0 && $item instanceof \Iterator) {
  669.                 try {
  670.                     return iterator_to_array(new \LimitIterator($item, $start, $length ?? -1), $preserveKeys);
  671.                 } catch (\OutOfBoundsException $e) {
  672.                     return [];
  673.                 }
  674.             }
  676.             $item = iterator_to_array($item, $preserveKeys);
  677.         }
  679.         if (\is_array($item)) {
  680.             return \array_slice($item, $start, $length, $preserveKeys);
  681.         }
  683.         return mb_substr((string) $item, $start, $length, $charset);
  684.     }
  686.     /**
  687.      * Returns the first element of the item.
  688.      *
  689.      * @param mixed $item A variable
  690.      *
  691.      * @return mixed The first element of the item
  692.      *
  693.      * @internal
  694.      */
  695.     public static function first(string $charset, $item)
  696.     {
  697.         $elements = self::slice($charset, $item, 0, 1, false);
  699.         return \is_string($elements) ? $elements : current($elements);
  700.     }
  702.     /**
  703.      * Returns the last element of the item.
  704.      *
  705.      * @param mixed $item A variable
  706.      *
  707.      * @return mixed The last element of the item
  708.      *
  709.      * @internal
  710.      */
  711.     public static function last(string $charset, $item)
  712.     {
  713.         $elements = self::slice($charset, $item, -1, 1, false);
  715.         return \is_string($elements) ? $elements : current($elements);
  716.     }
  718.     /**
  719.      * Joins the values to a string.
  720.      *
  721.      * The separators between elements are empty strings per default, you can define them with the optional parameters.
  722.      *
  723.      *  {{ [1, 2, 3]|join(', ', ' and ') }}
  724.      *  {# returns 1, 2 and 3 #}
  725.      *
  726.      *  {{ [1, 2, 3]|join('|') }}
  727.      *  {# returns 1|2|3 #}
  728.      *
  729.      *  {{ [1, 2, 3]|join }}
  730.      *  {# returns 123 #}
  731.      *
  732.      * @param array       $value An array
  733.      * @param string      $glue  The separator
  734.      * @param string|null $and   The separator for the last pair
  735.      *
  736.      * @internal
  737.      */
  738.     public static function join($value, $glue = '', $and = null): string
  739.     {
  740.         if (!is_iterable($value)) {
  741.             $value = (array) $value;
  742.         }
  744.         $value = self::toArray($value, false);
  746.         if (0 === \count($value)) {
  747.             return '';
  748.         }
  750.         if (null === $and || $and === $glue) {
  751.             return implode($glue, $value);
  752.         }
  754.         if (1 === \count($value)) {
  755.             return $value[0];
  756.         }
  758.         return implode($glue, \array_slice($value, 0, -1)).$and.$value[\count($value) - 1];
  759.     }
  761.     /**
  762.      * Splits the string into an array.
  763.      *
  764.      *  {{ "one,two,three"|split(',') }}
  765.      *  {# returns [one, two, three] #}
  766.      *
  767.      *  {{ "one,two,three,four,five"|split(',', 3) }}
  768.      *  {# returns [one, two, "three,four,five"] #}
  769.      *
  770.      *  {{ "123"|split('') }}
  771.      *  {# returns [1, 2, 3] #}
  772.      *
  773.      *  {{ "aabbcc"|split('', 2) }}
  774.      *  {# returns [aa, bb, cc] #}
  775.      *
  776.      * @param string|null $value     A string
  777.      * @param string      $delimiter The delimiter
  778.      * @param int|null    $limit     The limit
  779.      *
  780.      * @internal
  781.      */
  782.     public static function split(string $charset, $value, $delimiter, $limit = null): array
  783.     {
  784.         $value = $value ?? '';
  786.         if ('' !== $delimiter) {
  787.             return null === $limit ? explode($delimiter, $value) : explode($delimiter, $value, $limit);
  788.         }
  790.         if ($limit <= 1) {
  791.             return preg_split('/(?<!^)(?!$)/u', $value);
  792.         }
  794.         $length = mb_strlen($value, $charset);
  795.         if ($length < $limit) {
  796.             return [$value];
  797.         }
  799.         $r = [];
  800.         for ($i = 0; $i < $length; $i += $limit) {
  801.             $r[] = mb_substr($value, $i, $limit, $charset);
  802.         }
  804.         return $r;
  805.     }
  807.     // The '_default' filter is used internally to avoid using the ternary operator
  808.     // which costs a lot for big contexts (before PHP 5.4). So, on average,
  809.     // a function call is cheaper.
  810.     /**
  811.      * @internal
  812.      */
  813.     public static function default($value, $default = '')
  814.     {
  815.         if (self::testEmpty($value)) {
  816.             return $default;
  817.         }
  819.         return $value;
  820.     }
  822.     /**
  823.      * Returns the keys for the given array.
  824.      *
  825.      * It is useful when you want to iterate over the keys of an array:
  826.      *
  827.      *  {% for key in array|keys %}
  828.      *      {# ... #}
  829.      *  {% endfor %}
  830.      *
  831.      * @internal
  832.      */
  833.     public static function keys($array): array
  834.     {
  835.         if ($array instanceof \Traversable) {
  836.             while ($array instanceof \IteratorAggregate) {
  837.                 $array = $array->getIterator();
  838.             }
  840.             $keys = [];
  841.             if ($array instanceof \Iterator) {
  842.                 $array->rewind();
  843.                 while ($array->valid()) {
  844.                     $keys[] = $array->key();
  845.                     $array->next();
  846.                 }
  848.                 return $keys;
  849.             }
  851.             foreach ($array as $key => $item) {
  852.                 $keys[] = $key;
  853.             }
  855.             return $keys;
  856.         }
  858.         if (!\is_array($array)) {
  859.             return [];
  860.         }
  862.         return array_keys($array);
  863.     }
  865.     /**
  866.      * Reverses a variable.
  867.      *
  868.      * @param array|\Traversable|string|null $item         An array, a \Traversable instance, or a string
  869.      * @param bool                           $preserveKeys Whether to preserve key or not
  870.      *
  871.      * @return mixed The reversed input
  872.      *
  873.      * @internal
  874.      */
  875.     public static function reverse(string $charset, $item, $preserveKeys = false)
  876.     {
  877.         if ($item instanceof \Traversable) {
  878.             return array_reverse(iterator_to_array($item), $preserveKeys);
  879.         }
  881.         if (\is_array($item)) {
  882.             return array_reverse($item, $preserveKeys);
  883.         }
  885.         $string = (string) $item;
  887.         if ('UTF-8' !== $charset) {
  888.             $string = self::convertEncoding($string, 'UTF-8', $charset);
  889.         }
  891.         preg_match_all('/./us', $string, $matches);
  893.         $string = implode('', array_reverse($matches[0]));
  895.         if ('UTF-8' !== $charset) {
  896.             $string = self::convertEncoding($string, $charset, 'UTF-8');
  897.         }
  899.         return $string;
  900.     }
  902.     /**
  903.      * Shuffles an array, a \Traversable instance, or a string.
  904.      * The function does not preserve keys.
  905.      *
  906.      * @param array|\Traversable|string|null $item
  907.      *
  908.      * @return mixed
  909.      *
  910.      * @internal
  911.      */
  912.     public static function shuffle(string $charset, $item)
  913.     {
  914.         if (\is_string($item)) {
  915.             if ('UTF-8' !== $charset) {
  916.                 $item = self::convertEncoding($item, 'UTF-8', $charset);
  917.             }
  919.             $item = preg_split('/(?<!^)(?!$)/u', $item, -1);
  920.             shuffle($item);
  921.             $item = implode('', $item);
  923.             if ('UTF-8' !== $charset) {
  924.                 $item = self::convertEncoding($item, $charset, 'UTF-8');
  925.             }
  927.             return $item;
  928.         }
  930.         if (is_iterable($item)) {
  931.             $item = self::toArray($item, false);
  932.             shuffle($item);
  933.         }
  935.         return $item;
  936.     }
  938.     /**
  939.      * Sorts an array.
  940.      *
  941.      * @param array|\Traversable $array
  942.      *
  943.      * @internal
  944.      */
  945.     public static function sort(Environment $env, $array, $arrow = null): array
  946.     {
  947.         if ($array instanceof \Traversable) {
  948.             $array = iterator_to_array($array);
  949.         } elseif (!\is_array($array)) {
  950.             throw new RuntimeError(\sprintf('The sort filter only works with sequences/mappings or "Traversable", got "%s".', \gettype($array)));
  951.         }
  953.         if (null !== $arrow) {
  954.             self::checkArrowInSandbox($env, $arrow, 'sort', 'filter');
  956.             uasort($array, $arrow);
  957.         } else {
  958.             asort($array);
  959.         }
  961.         return $array;
  962.     }
  964.     /**
  965.      * @internal
  966.      */
  967.     public static function inFilter($value, $compare)
  968.     {
  969.         if ($value instanceof Markup) {
  970.             $value = (string) $value;
  971.         }
  972.         if ($compare instanceof Markup) {
  973.             $compare = (string) $compare;
  974.         }
  976.         if (\is_string($compare)) {
  977.             if (\is_string($value) || \is_int($value) || \is_float($value)) {
  978.                 return '' === $value || str_contains($compare, (string) $value);
  979.             }
  981.             return false;
  982.         }
  984.         if (!is_iterable($compare)) {
  985.             return false;
  986.         }
  988.         if (\is_object($value) || \is_resource($value)) {
  989.             if (!\is_array($compare)) {
  990.                 foreach ($compare as $item) {
  991.                     if ($item === $value) {
  992.                         return true;
  993.                     }
  994.                 }
  996.                 return false;
  997.             }
  999.             return \in_array($value, $compare, true);
  1000.         }
  1002.         foreach ($compare as $item) {
  1003.             if (0 === self::compare($value, $item)) {
  1004.                 return true;
  1005.             }
  1006.         }
  1008.         return false;
  1009.     }
  1011.     /**
  1012.      * Compares two values using a more strict version of the PHP non-strict comparison operator.
  1013.      *
  1014.      * @see https://wiki.php.net/rfc/string_to_number_comparison
  1015.      * @see https://wiki.php.net/rfc/trailing_whitespace_numerics
  1016.      *
  1017.      * @internal
  1018.      */
  1019.     public static function compare($a, $b)
  1020.     {
  1021.         // int <=> string
  1022.         if (\is_int($a) && \is_string($b)) {
  1023.             $bTrim = trim($b, " \t\n\r\v\f");
  1024.             if (!is_numeric($bTrim)) {
  1025.                 return (string) $a <=> $b;
  1026.             }
  1027.             if ((int) $bTrim == $bTrim) {
  1028.                 return $a <=> (int) $bTrim;
  1029.             } else {
  1030.                 return (float) $a <=> (float) $bTrim;
  1031.             }
  1032.         }
  1033.         if (\is_string($a) && \is_int($b)) {
  1034.             $aTrim = trim($a, " \t\n\r\v\f");
  1035.             if (!is_numeric($aTrim)) {
  1036.                 return $a <=> (string) $b;
  1037.             }
  1038.             if ((int) $aTrim == $aTrim) {
  1039.                 return (int) $aTrim <=> $b;
  1040.             } else {
  1041.                 return (float) $aTrim <=> (float) $b;
  1042.             }
  1043.         }
  1045.         // float <=> string
  1046.         if (\is_float($a) && \is_string($b)) {
  1047.             if (is_nan($a)) {
  1048.                 return 1;
  1049.             }
  1050.             $bTrim = trim($b, " \t\n\r\v\f");
  1051.             if (!is_numeric($bTrim)) {
  1052.                 return (string) $a <=> $b;
  1053.             }
  1055.             return $a <=> (float) $bTrim;
  1056.         }
  1057.         if (\is_string($a) && \is_float($b)) {
  1058.             if (is_nan($b)) {
  1059.                 return 1;
  1060.             }
  1061.             $aTrim = trim($a, " \t\n\r\v\f");
  1062.             if (!is_numeric($aTrim)) {
  1063.                 return $a <=> (string) $b;
  1064.             }
  1066.             return (float) $aTrim <=> $b;
  1067.         }
  1069.         // fallback to <=>
  1070.         return $a <=> $b;
  1071.     }
  1073.     /**
  1074.      * @throws RuntimeError When an invalid pattern is used
  1075.      *
  1076.      * @internal
  1077.      */
  1078.     public static function matches(string $regexp, ?string $str): int
  1079.     {
  1080.         set_error_handler(function ($t, $m) use ($regexp) {
  1081.             throw new RuntimeError(\sprintf('Regexp "%s" passed to "matches" is not valid', $regexp).substr($m, 12));
  1082.         });
  1083.         try {
  1084.             return preg_match($regexp, $str ?? '');
  1085.         } finally {
  1086.             restore_error_handler();
  1087.         }
  1088.     }
  1090.     /**
  1091.      * Returns a trimmed string.
  1092.      *
  1093.      * @param string|null $string
  1094.      * @param string|null $characterMask
  1095.      * @param string      $side
  1096.      *
  1097.      * @throws RuntimeError When an invalid trimming side is used (not a string or not 'left', 'right', or 'both')
  1098.      *
  1099.      * @internal
  1100.      */
  1101.     public static function trim($string, $characterMask = null, $side = 'both'): string
  1102.     {
  1103.         if (null === $characterMask) {
  1104.             $characterMask = " \t\n\r\0\x0B";
  1105.         }
  1107.         switch ($side) {
  1108.             case 'both':
  1109.                 return trim($string ?? '', $characterMask);
  1110.             case 'left':
  1111.                 return ltrim($string ?? '', $characterMask);
  1112.             case 'right':
  1113.                 return rtrim($string ?? '', $characterMask);
  1114.             default:
  1115.                 throw new RuntimeError('Trimming side must be "left", "right" or "both".');
  1116.         }
  1117.     }
  1119.     /**
  1120.      * Inserts HTML line breaks before all newlines in a string.
  1121.      *
  1122.      * @param string|null $string
  1123.      *
  1124.      * @internal
  1125.      */
  1126.     public static function nl2br($string): string
  1127.     {
  1128.         return nl2br($string ?? '');
  1129.     }
  1131.     /**
  1132.      * Removes whitespaces between HTML tags.
  1133.      *
  1134.      * @param string|null $content
  1135.      *
  1136.      * @internal
  1137.      */
  1138.     public static function spaceless($content): string
  1139.     {
  1140.         return trim(preg_replace('/>\s+</', '><', $content ?? ''));
  1141.     }
  1143.     /**
  1144.      * @param string|null $string
  1145.      * @param string      $to
  1146.      * @param string      $from
  1147.      *
  1148.      * @internal
  1149.      */
  1150.     public static function convertEncoding($string, $to, $from): string
  1151.     {
  1152.         if (!\function_exists('iconv')) {
  1153.             throw new RuntimeError('Unable to convert encoding: required function iconv() does not exist. You should install ext-iconv or symfony/polyfill-iconv.');
  1154.         }
  1156.         return iconv($from, $to, $string ?? '');
  1157.     }
  1159.     /**
  1160.      * Returns the length of a variable.
  1161.      *
  1162.      * @param mixed $thing A variable
  1163.      *
  1164.      * @internal
  1165.      */
  1166.     public static function length(string $charset, $thing): int
  1167.     {
  1168.         if (null === $thing) {
  1169.             return 0;
  1170.         }
  1172.         if (\is_scalar($thing)) {
  1173.             return mb_strlen($thing, $charset);
  1174.         }
  1176.         if ($thing instanceof \Countable || \is_array($thing) || $thing instanceof \SimpleXMLElement) {
  1177.             return \count($thing);
  1178.         }
  1180.         if ($thing instanceof \Traversable) {
  1181.             return iterator_count($thing);
  1182.         }
  1184.         if (method_exists($thing, '__toString')) {
  1185.             return mb_strlen((string) $thing, $charset);
  1186.         }
  1188.         return 1;
  1189.     }
  1191.     /**
  1192.      * Converts a string to uppercase.
  1193.      *
  1194.      * @param string|null $string A string
  1195.      *
  1196.      * @internal
  1197.      */
  1198.     public static function upper(string $charset, $string): string
  1199.     {
  1200.         return mb_strtoupper($string ?? '', $charset);
  1201.     }
  1203.     /**
  1204.      * Converts a string to lowercase.
  1205.      *
  1206.      * @param string|null $string A string
  1207.      *
  1208.      * @internal
  1209.      */
  1210.     public static function lower(string $charset, $string): string
  1211.     {
  1212.         return mb_strtolower($string ?? '', $charset);
  1213.     }
  1215.     /**
  1216.      * Strips HTML and PHP tags from a string.
  1217.      *
  1218.      * @param string|null          $string
  1219.      * @param string[]|string|null $allowable_tags
  1220.      *
  1221.      * @internal
  1222.      */
  1223.     public static function striptags($string, $allowable_tags = null): string
  1224.     {
  1225.         return strip_tags($string ?? '', $allowable_tags);
  1226.     }
  1228.     /**
  1229.      * Returns a titlecased string.
  1230.      *
  1231.      * @param string|null $string A string
  1232.      *
  1233.      * @internal
  1234.      */
  1235.     public static function titleCase(string $charset, $string): string
  1236.     {
  1237.         return mb_convert_case($string ?? '', \MB_CASE_TITLE, $charset);
  1238.     }
  1240.     /**
  1241.      * Returns a capitalized string.
  1242.      *
  1243.      * @param string|null $string A string
  1244.      *
  1245.      * @internal
  1246.      */
  1247.     public static function capitalize(string $charset, $string): string
  1248.     {
  1249.         return mb_strtoupper(mb_substr($string ?? '', 0, 1, $charset), $charset).mb_strtolower(mb_substr($string ?? '', 1, null, $charset), $charset);
  1250.     }
  1252.     /**
  1253.      * @internal
  1254.      */
  1255.     public static function callMacro(Template $template, string $method, array $args, int $lineno, array $context, Source $source)
  1256.     {
  1257.         if (!method_exists($template, $method)) {
  1258.             $parent = $template;
  1259.             while ($parent = $parent->getParent($context)) {
  1260.                 if (method_exists($parent, $method)) {
  1261.                     return $parent->$method(...$args);
  1262.                 }
  1263.             }
  1265.             throw new RuntimeError(\sprintf('Macro "%s" is not defined in template "%s".', substr($method, \strlen('macro_')), $template->getTemplateName()), $lineno, $source);
  1266.         }
  1268.         return $template->$method(...$args);
  1269.     }
  1271.     /**
  1272.      * @internal
  1273.      */
  1274.     public static function ensureTraversable($seq)
  1275.     {
  1276.         if (is_iterable($seq)) {
  1277.             return $seq;
  1278.         }
  1280.         return [];
  1281.     }
  1283.     /**
  1284.      * @internal
  1285.      */
  1286.     public static function toArray($seq, $preserveKeys = true)
  1287.     {
  1288.         if ($seq instanceof \Traversable) {
  1289.             return iterator_to_array($seq, $preserveKeys);
  1290.         }
  1292.         if (!\is_array($seq)) {
  1293.             return $seq;
  1294.         }
  1296.         return $preserveKeys ? $seq : array_values($seq);
  1297.     }
  1299.     /**
  1300.      * Checks if a variable is empty.
  1301.      *
  1302.      *    {# evaluates to true if the foo variable is null, false, or the empty string #}
  1303.      *    {% if foo is empty %}
  1304.      *        {# ... #}
  1305.      *    {% endif %}
  1306.      *
  1307.      * @param mixed $value A variable
  1308.      *
  1309.      * @internal
  1310.      */
  1311.     public static function testEmpty($value): bool
  1312.     {
  1313.         if ($value instanceof \Countable) {
  1314.             return 0 === \count($value);
  1315.         }
  1317.         if ($value instanceof \Traversable) {
  1318.             return !iterator_count($value);
  1319.         }
  1321.         if (\is_object($value) && method_exists($value, '__toString')) {
  1322.             return '' === (string) $value;
  1323.         }
  1325.         return '' === $value || false === $value || null === $value || [] === $value;
  1326.     }
  1328.     /**
  1329.      * Checks if a variable is a sequence.
  1330.      *
  1331.      *    {# evaluates to true if the foo variable is a sequence #}
  1332.      *    {% if foo is sequence %}
  1333.      *        {# ... #}
  1334.      *    {% endif %}
  1335.      *
  1336.      * @param mixed $value
  1337.      *
  1338.      * @internal
  1339.      */
  1340.     public static function testSequence($value): bool
  1341.     {
  1342.         if ($value instanceof \ArrayObject) {
  1343.             $value = $value->getArrayCopy();
  1344.         }
  1346.         if ($value instanceof \Traversable) {
  1347.             $value = iterator_to_array($value);
  1348.         }
  1350.         return \is_array($value) && array_is_list($value);
  1351.     }
  1353.     /**
  1354.      * Checks if a variable is a mapping.
  1355.      *
  1356.      *    {# evaluates to true if the foo variable is a mapping #}
  1357.      *    {% if foo is mapping %}
  1358.      *        {# ... #}
  1359.      *    {% endif %}
  1360.      *
  1361.      * @param mixed $value
  1362.      *
  1363.      * @internal
  1364.      */
  1365.     public static function testMapping($value): bool
  1366.     {
  1367.         if ($value instanceof \ArrayObject) {
  1368.             $value = $value->getArrayCopy();
  1369.         }
  1371.         if ($value instanceof \Traversable) {
  1372.             $value = iterator_to_array($value);
  1373.         }
  1375.         return (\is_array($value) && !array_is_list($value)) || \is_object($value);
  1376.     }
  1378.     /**
  1379.      * Renders a template.
  1380.      *
  1381.      * @param array                        $context
  1382.      * @param string|array|TemplateWrapper $template      The template to render or an array of templates to try consecutively
  1383.      * @param array                        $variables     The variables to pass to the template
  1384.      * @param bool                         $withContext
  1385.      * @param bool                         $ignoreMissing Whether to ignore missing templates or not
  1386.      * @param bool                         $sandboxed     Whether to sandbox the template or not
  1387.      *
  1388.      * @internal
  1389.      */
  1390.     public static function include(Environment $env, $context, $template, $variables = [], $withContext = true, $ignoreMissing = false, $sandboxed = false): string
  1391.     {
  1392.         $alreadySandboxed = false;
  1393.         $sandbox = null;
  1394.         if ($withContext) {
  1395.             $variables = array_merge($context, $variables);
  1396.         }
  1398.         if ($isSandboxed = $sandboxed && $env->hasExtension(SandboxExtension::class)) {
  1399.             $sandbox = $env->getExtension(SandboxExtension::class);
  1400.             if (!$alreadySandboxed = $sandbox->isSandboxed()) {
  1401.                 $sandbox->enableSandbox();
  1402.             }
  1404.             foreach ((\is_array($template) ? $template : [$template]) as $name) {
  1405.                 // if a Template instance is passed, it might have been instantiated outside of a sandbox, check security
  1406.                 if ($name instanceof TemplateWrapper || $name instanceof Template) {
  1407.                     $name->unwrap()->checkSecurity();
  1408.                 }
  1409.             }
  1410.         }
  1412.         try {
  1413.             $loaded = null;
  1414.             try {
  1415.                 $loaded = $env->resolveTemplate($template);
  1416.             } catch (LoaderError $e) {
  1417.                 if (!$ignoreMissing) {
  1418.                     throw $e;
  1419.                 }
  1420.             }
  1422.             return $loaded ? $loaded->render($variables) : '';
  1423.         } finally {
  1424.             if ($isSandboxed && !$alreadySandboxed) {
  1425.                 $sandbox->disableSandbox();
  1426.             }
  1427.         }
  1428.     }
  1430.     /**
  1431.      * Returns a template content without rendering it.
  1432.      *
  1433.      * @param string $name          The template name
  1434.      * @param bool   $ignoreMissing Whether to ignore missing templates or not
  1435.      *
  1436.      * @internal
  1437.      */
  1438.     public static function source(Environment $env, $name, $ignoreMissing = false): string
  1439.     {
  1440.         $loader = $env->getLoader();
  1441.         try {
  1442.             return $loader->getSourceContext($name)->getCode();
  1443.         } catch (LoaderError $e) {
  1444.             if (!$ignoreMissing) {
  1445.                 throw $e;
  1446.             }
  1448.             return '';
  1449.         }
  1450.     }
  1452.     /**
  1453.      * Provides the ability to get constants from instances as well as class/global constants.
  1454.      *
  1455.      * @param string      $constant The name of the constant
  1456.      * @param object|null $object   The object to get the constant from
  1457.      *
  1458.      * @return mixed Class constants can return many types like scalars, arrays, and
  1459.      *               objects depending on the PHP version (\BackedEnum, \UnitEnum, etc.)
  1460.      *
  1461.      * @internal
  1462.      */
  1463.     public static function constant($constant, $object = null)
  1464.     {
  1465.         if (null !== $object) {
  1466.             if ('class' === $constant) {
  1467.                 return \get_class($object);
  1468.             }
  1470.             $constant = \get_class($object).'::'.$constant;
  1471.         }
  1473.         if (!\defined($constant)) {
  1474.             if ('::class' === strtolower(substr($constant, -7))) {
  1475.                 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));
  1476.             }
  1478.             throw new RuntimeError(\sprintf('Constant "%s" is undefined.', $constant));
  1479.         }
  1481.         return \constant($constant);
  1482.     }
  1484.     /**
  1485.      * Checks if a constant exists.
  1486.      *
  1487.      * @param string      $constant The name of the constant
  1488.      * @param object|null $object   The object to get the constant from
  1489.      *
  1490.      * @internal
  1491.      */
  1492.     public static function constantIsDefined($constant, $object = null): bool
  1493.     {
  1494.         if (null !== $object) {
  1495.             if ('class' === $constant) {
  1496.                 return true;
  1497.             }
  1499.             $constant = \get_class($object).'::'.$constant;
  1500.         }
  1502.         return \defined($constant);
  1503.     }
  1505.     /**
  1506.      * Batches item.
  1507.      *
  1508.      * @param array $items An array of items
  1509.      * @param int   $size  The size of the batch
  1510.      * @param mixed $fill  A value used to fill missing items
  1511.      *
  1512.      * @internal
  1513.      */
  1514.     public static function batch($items, $size, $fill = null, $preserveKeys = true): array
  1515.     {
  1516.         if (!is_iterable($items)) {
  1517.             throw new RuntimeError(\sprintf('The "batch" filter expects a sequence/mapping or "Traversable", got "%s".', \is_object($items) ? \get_class($items) : \gettype($items)));
  1518.         }
  1520.         $size = (int) ceil($size);
  1522.         $result = array_chunk(self::toArray($items, $preserveKeys), $size, $preserveKeys);
  1524.         if (null !== $fill && $result) {
  1525.             $last = \count($result) - 1;
  1526.             if ($fillCount = $size - \count($result[$last])) {
  1527.                 for ($i = 0; $i < $fillCount; ++$i) {
  1528.                     $result[$last][] = $fill;
  1529.                 }
  1530.             }
  1531.         }
  1533.         return $result;
  1534.     }
  1536.     /**
  1537.      * Returns the attribute value for a given array/object.
  1538.      *
  1539.      * @param mixed  $object            The object or array from where to get the item
  1540.      * @param mixed  $item              The item to get from the array or object
  1541.      * @param array  $arguments         An array of arguments to pass if the item is an object method
  1542.      * @param string $type              The type of attribute (@see \Twig\Template constants)
  1543.      * @param bool   $isDefinedTest     Whether this is only a defined check
  1544.      * @param bool   $ignoreStrictCheck Whether to ignore the strict attribute check or not
  1545.      * @param int    $lineno            The template line where the attribute was called
  1546.      *
  1547.      * @return mixed The attribute value, or a Boolean when $isDefinedTest is true, or null when the attribute is not set and $ignoreStrictCheck is true
  1548.      *
  1549.      * @throws RuntimeError if the attribute does not exist and Twig is running in strict mode and $isDefinedTest is false
  1550.      *
  1551.      * @internal
  1552.      */
  1553.     public static function getAttribute(Environment $env, Source $source, $object, $item, array $arguments = [], $type = /* Template::ANY_CALL */ 'any', $isDefinedTest = false, $ignoreStrictCheck = false, $sandboxed = false, int $lineno = -1)
  1554.     {
  1555.         // array
  1556.         if (/* Template::METHOD_CALL */ 'method' !== $type) {
  1557.             $arrayItem = \is_bool($item) || \is_float($item) ? (int) $item : $item;
  1559.             if (((\is_array($object) || $object instanceof \ArrayObject) && (isset($object[$arrayItem]) || \array_key_exists($arrayItem, (array) $object)))
  1560.                 || ($object instanceof \ArrayAccess && isset($object[$arrayItem]))
  1561.             ) {
  1562.                 if ($isDefinedTest) {
  1563.                     return true;
  1564.                 }
  1566.                 return $object[$arrayItem];
  1567.             }
  1569.             if (/* Template::ARRAY_CALL */ 'array' === $type || !\is_object($object)) {
  1570.                 if ($isDefinedTest) {
  1571.                     return false;
  1572.                 }
  1574.                 if ($ignoreStrictCheck || !$env->isStrictVariables()) {
  1575.                     return;
  1576.                 }
  1578.                 if ($object instanceof \ArrayAccess) {
  1579.                     $message = \sprintf('Key "%s" in object with ArrayAccess of class "%s" does not exist.', $arrayItem, \get_class($object));
  1580.                 } elseif (\is_object($object)) {
  1581.                     $message = \sprintf('Impossible to access a key "%s" on an object of class "%s" that does not implement ArrayAccess interface.', $item, \get_class($object));
  1582.                 } elseif (\is_array($object)) {
  1583.                     if (empty($object)) {
  1584.                         $message = \sprintf('Key "%s" does not exist as the sequence/mapping is empty.', $arrayItem);
  1585.                     } else {
  1586.                         $message = \sprintf('Key "%s" for sequence/mapping with keys "%s" does not exist.', $arrayItem, implode(', ', array_keys($object)));
  1587.                     }
  1588.                 } elseif (/* Template::ARRAY_CALL */ 'array' === $type) {
  1589.                     if (null === $object) {
  1590.                         $message = \sprintf('Impossible to access a key ("%s") on a null variable.', $item);
  1591.                     } else {
  1592.                         $message = \sprintf('Impossible to access a key ("%s") on a %s variable ("%s").', $item, \gettype($object), $object);
  1593.                     }
  1594.                 } elseif (null === $object) {
  1595.                     $message = \sprintf('Impossible to access an attribute ("%s") on a null variable.', $item);
  1596.                 } else {
  1597.                     $message = \sprintf('Impossible to access an attribute ("%s") on a %s variable ("%s").', $item, \gettype($object), $object);
  1598.                 }
  1600.                 throw new RuntimeError($message, $lineno, $source);
  1601.             }
  1602.         }
  1604.         if (!\is_object($object)) {
  1605.             if ($isDefinedTest) {
  1606.                 return false;
  1607.             }
  1609.             if ($ignoreStrictCheck || !$env->isStrictVariables()) {
  1610.                 return;
  1611.             }
  1613.             if (null === $object) {
  1614.                 $message = \sprintf('Impossible to invoke a method ("%s") on a null variable.', $item);
  1615.             } elseif (\is_array($object)) {
  1616.                 $message = \sprintf('Impossible to invoke a method ("%s") on a sequence/mapping.', $item);
  1617.             } else {
  1618.                 $message = \sprintf('Impossible to invoke a method ("%s") on a %s variable ("%s").', $item, \gettype($object), $object);
  1619.             }
  1621.             throw new RuntimeError($message, $lineno, $source);
  1622.         }
  1624.         if ($object instanceof Template) {
  1625.             throw new RuntimeError('Accessing \Twig\Template attributes is forbidden.', $lineno, $source);
  1626.         }
  1628.         // object property
  1629.         if (/* Template::METHOD_CALL */ 'method' !== $type) {
  1630.             if (isset($object->$item) || \array_key_exists((string) $item, (array) $object)) {
  1631.                 if ($isDefinedTest) {
  1632.                     return true;
  1633.                 }
  1635.                 if ($sandboxed) {
  1636.                     $env->getExtension(SandboxExtension::class)->checkPropertyAllowed($object, $item, $lineno, $source);
  1637.                 }
  1639.                 return $object->$item;
  1640.             }
  1641.         }
  1643.         static $cache = [];
  1645.         $class = \get_class($object);
  1647.         // object method
  1648.         // precedence: getXxx() > isXxx() > hasXxx()
  1649.         if (!isset($cache[$class])) {
  1650.             $methods = get_class_methods($object);
  1651.             sort($methods);
  1652.             $lcMethods = array_map(function ($value) { return strtr($value, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz'); }, $methods);
  1653.             $classCache = [];
  1654.             foreach ($methods as $i => $method) {
  1655.                 $classCache[$method] = $method;
  1656.                 $classCache[$lcName = $lcMethods[$i]] = $method;
  1658.                 if ('g' === $lcName[0] && str_starts_with($lcName, 'get')) {
  1659.                     $name = substr($method, 3);
  1660.                     $lcName = substr($lcName, 3);
  1661.                 } elseif ('i' === $lcName[0] && str_starts_with($lcName, 'is')) {
  1662.                     $name = substr($method, 2);
  1663.                     $lcName = substr($lcName, 2);
  1664.                 } elseif ('h' === $lcName[0] && str_starts_with($lcName, 'has')) {
  1665.                     $name = substr($method, 3);
  1666.                     $lcName = substr($lcName, 3);
  1667.                     if (\in_array('is'.$lcName, $lcMethods)) {
  1668.                         continue;
  1669.                     }
  1670.                 } else {
  1671.                     continue;
  1672.                 }
  1674.                 // skip get() and is() methods (in which case, $name is empty)
  1675.                 if ($name) {
  1676.                     if (!isset($classCache[$name])) {
  1677.                         $classCache[$name] = $method;
  1678.                     }
  1680.                     if (!isset($classCache[$lcName])) {
  1681.                         $classCache[$lcName] = $method;
  1682.                     }
  1683.                 }
  1684.             }
  1685.             $cache[$class] = $classCache;
  1686.         }
  1688.         $call = false;
  1689.         if (isset($cache[$class][$item])) {
  1690.             $method = $cache[$class][$item];
  1691.         } elseif (isset($cache[$class][$lcItem = strtr($item, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz')])) {
  1692.             $method = $cache[$class][$lcItem];
  1693.         } elseif (isset($cache[$class]['__call'])) {
  1694.             $method = $item;
  1695.             $call = true;
  1696.         } else {
  1697.             if ($isDefinedTest) {
  1698.                 return false;
  1699.             }
  1701.             if ($ignoreStrictCheck || !$env->isStrictVariables()) {
  1702.                 return;
  1703.             }
  1705.             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);
  1706.         }
  1708.         if ($isDefinedTest) {
  1709.             return true;
  1710.         }
  1712.         if ($sandboxed) {
  1713.             $env->getExtension(SandboxExtension::class)->checkMethodAllowed($object, $method, $lineno, $source);
  1714.         }
  1716.         // Some objects throw exceptions when they have __call, and the method we try
  1717.         // to call is not supported. If ignoreStrictCheck is true, we should return null.
  1718.         try {
  1719.             $ret = $object->$method(...$arguments);
  1720.         } catch (\BadMethodCallException $e) {
  1721.             if ($call && ($ignoreStrictCheck || !$env->isStrictVariables())) {
  1722.                 return;
  1723.             }
  1724.             throw $e;
  1725.         }
  1727.         return $ret;
  1728.     }
  1730.     /**
  1731.      * Returns the values from a single column in the input array.
  1732.      *
  1733.      * <pre>
  1734.      *  {% set items = [{ 'fruit' : 'apple'}, {'fruit' : 'orange' }] %}
  1735.      *
  1736.      *  {% set fruits = items|column('fruit') %}
  1737.      *
  1738.      *  {# fruits now contains ['apple', 'orange'] #}
  1739.      * </pre>
  1740.      *
  1741.      * @param array|\Traversable $array An array
  1742.      * @param int|string         $name  The column name
  1743.      * @param int|string|null    $index The column to use as the index/keys for the returned array
  1744.      *
  1745.      * @return array The array of values
  1746.      *
  1747.      * @internal
  1748.      */
  1749.     public static function column($array, $name, $index = null): array
  1750.     {
  1751.         if ($array instanceof \Traversable) {
  1752.             $array = iterator_to_array($array);
  1753.         } elseif (!\is_array($array)) {
  1754.             throw new RuntimeError(\sprintf('The column filter only works with sequences/mappings or "Traversable", got "%s" as first argument.', \gettype($array)));
  1755.         }
  1757.         return array_column($array, $name, $index);
  1758.     }
  1760.     /**
  1761.      * @internal
  1762.      */
  1763.     public static function filter(Environment $env, $array, $arrow)
  1764.     {
  1765.         if (!is_iterable($array)) {
  1766.             throw new RuntimeError(\sprintf('The "filter" filter expects a sequence/mapping or "Traversable", got "%s".', \is_object($array) ? \get_class($array) : \gettype($array)));
  1767.         }
  1769.         self::checkArrowInSandbox($env, $arrow, 'filter', 'filter');
  1771.         if (\is_array($array)) {
  1772.             return array_filter($array, $arrow, \ARRAY_FILTER_USE_BOTH);
  1773.         }
  1775.         // the IteratorIterator wrapping is needed as some internal PHP classes are \Traversable but do not implement \Iterator
  1776.         return new \CallbackFilterIterator(new \IteratorIterator($array), $arrow);
  1777.     }
  1779.     /**
  1780.      * @internal
  1781.      */
  1782.     public static function find(Environment $env, $array, $arrow)
  1783.     {
  1784.         self::checkArrowInSandbox($env, $arrow, 'find', 'filter');
  1786.         foreach ($array as $k => $v) {
  1787.             if ($arrow($v, $k)) {
  1788.                 return $v;
  1789.             }
  1790.         }
  1792.         return null;
  1793.     }
  1795.     /**
  1796.      * @internal
  1797.      */
  1798.     public static function map(Environment $env, $array, $arrow)
  1799.     {
  1800.         self::checkArrowInSandbox($env, $arrow, 'map', 'filter');
  1802.         $r = [];
  1803.         foreach ($array as $k => $v) {
  1804.             $r[$k] = $arrow($v, $k);
  1805.         }
  1807.         return $r;
  1808.     }
  1810.     /**
  1811.      * @internal
  1812.      */
  1813.     public static function reduce(Environment $env, $array, $arrow, $initial = null)
  1814.     {
  1815.         self::checkArrowInSandbox($env, $arrow, 'reduce', 'filter');
  1817.         if (!\is_array($array) && !$array instanceof \Traversable) {
  1818.             throw new RuntimeError(\sprintf('The "reduce" filter only works with sequences/mappings or "Traversable", got "%s" as first argument.', \gettype($array)));
  1819.         }
  1821.         $accumulator = $initial;
  1822.         foreach ($array as $key => $value) {
  1823.             $accumulator = $arrow($accumulator, $value, $key);
  1824.         }
  1826.         return $accumulator;
  1827.     }
  1829.     /**
  1830.      * @internal
  1831.      */
  1832.     public static function arraySome(Environment $env, $array, $arrow)
  1833.     {
  1834.         self::checkArrowInSandbox($env, $arrow, 'has some', 'operator');
  1836.         foreach ($array as $k => $v) {
  1837.             if ($arrow($v, $k)) {
  1838.                 return true;
  1839.             }
  1840.         }
  1842.         return false;
  1843.     }
  1845.     /**
  1846.      * @internal
  1847.      */
  1848.     public static function arrayEvery(Environment $env, $array, $arrow)
  1849.     {
  1850.         self::checkArrowInSandbox($env, $arrow, 'has every', 'operator');
  1852.         foreach ($array as $k => $v) {
  1853.             if (!$arrow($v, $k)) {
  1854.                 return false;
  1855.             }
  1856.         }
  1858.         return true;
  1859.     }
  1861.     /**
  1862.      * @internal
  1863.      */
  1864.     public static function checkArrowInSandbox(Environment $env, $arrow, $thing, $type)
  1865.     {
  1866.         if (!$arrow instanceof \Closure && $env->hasExtension(SandboxExtension::class) && $env->getExtension(SandboxExtension::class)->isSandboxed()) {
  1867.             throw new RuntimeError(\sprintf('The callable passed to the "%s" %s must be a Closure in sandbox mode.', $thing, $type));
  1868.         }
  1869.     }
  1871.     /**
  1872.      * @internal to be removed in Twig 4
  1873.      */
  1874.     public static function captureOutput(iterable $body): string
  1875.     {
  1876.         $output = '';
  1877.         $level = ob_get_level();
  1878.         ob_start();
  1880.         try {
  1881.             foreach ($body as $data) {
  1882.                 if (ob_get_length()) {
  1883.                     $output .= ob_get_clean();
  1884.                     ob_start();
  1885.                 }
  1887.                 $output .= $data;
  1888.             }
  1890.             if (ob_get_length()) {
  1891.                 $output .= ob_get_clean();
  1892.             }
  1893.         } finally {
  1894.             while (ob_get_level() > $level) {
  1895.                 ob_end_clean();
  1896.             }
  1897.         }
  1899.         return $output;
  1900.     }
  1901. }