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

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]),
  222.             // string/array filters
  223.             new TwigFilter('reverse', [self::class, 'reverse'], ['needs_charset' => true]),
  224.             new TwigFilter('length', [self::class, 'length'], ['needs_charset' => true]),
  225.             new TwigFilter('slice', [self::class, 'slice'], ['needs_charset' => true]),
  226.             new TwigFilter('first', [self::class, 'first'], ['needs_charset' => true]),
  227.             new TwigFilter('last', [self::class, 'last'], ['needs_charset' => true]),
  229.             // iteration and runtime
  230.             new TwigFilter('default', [self::class, 'default'], ['node_class' => DefaultFilter::class]),
  231.             new TwigFilter('keys', [self::class, 'keys']),
  232.         ];
  233.     }
  235.     public function getFunctions(): array
  236.     {
  237.         return [
  238.             new TwigFunction('max', 'max'),
  239.             new TwigFunction('min', 'min'),
  240.             new TwigFunction('range', 'range'),
  241.             new TwigFunction('constant', [self::class, 'constant']),
  242.             new TwigFunction('cycle', [self::class, 'cycle']),
  243.             new TwigFunction('random', [self::class, 'random'], ['needs_charset' => true]),
  244.             new TwigFunction('date', [$this, 'convertDate']),
  245.             new TwigFunction('include', [self::class, 'include'], ['needs_environment' => true, 'needs_context' => true, 'is_safe' => ['all']]),
  246.             new TwigFunction('source', [self::class, 'source'], ['needs_environment' => true, 'is_safe' => ['all']]),
  247.         ];
  248.     }
  250.     public function getTests(): array
  251.     {
  252.         return [
  253.             new TwigTest('even', null, ['node_class' => EvenTest::class]),
  254.             new TwigTest('odd', null, ['node_class' => OddTest::class]),
  255.             new TwigTest('defined', null, ['node_class' => DefinedTest::class]),
  256.             new TwigTest('same as', null, ['node_class' => SameasTest::class, 'one_mandatory_argument' => true]),
  257.             new TwigTest('none', null, ['node_class' => NullTest::class]),
  258.             new TwigTest('null', null, ['node_class' => NullTest::class]),
  259.             new TwigTest('divisible by', null, ['node_class' => DivisiblebyTest::class, 'one_mandatory_argument' => true]),
  260.             new TwigTest('constant', null, ['node_class' => ConstantTest::class]),
  261.             new TwigTest('empty', [self::class, 'testEmpty']),
  262.             new TwigTest('iterable', 'is_iterable'),
  263.         ];
  264.     }
  266.     public function getNodeVisitors(): array
  267.     {
  268.         return [new MacroAutoImportNodeVisitor()];
  269.     }
  271.     public function getOperators(): array
  272.     {
  273.         return [
  274.             [
  275.                 'not' => ['precedence' => 50, 'class' => NotUnary::class],
  276.                 '-' => ['precedence' => 500, 'class' => NegUnary::class],
  277.                 '+' => ['precedence' => 500, 'class' => PosUnary::class],
  278.             ],
  279.             [
  280.                 'or' => ['precedence' => 10, 'class' => OrBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  281.                 'and' => ['precedence' => 15, 'class' => AndBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  282.                 'b-or' => ['precedence' => 16, 'class' => BitwiseOrBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  283.                 'b-xor' => ['precedence' => 17, 'class' => BitwiseXorBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  284.                 'b-and' => ['precedence' => 18, 'class' => BitwiseAndBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  285.                 '==' => ['precedence' => 20, 'class' => EqualBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  286.                 '!=' => ['precedence' => 20, 'class' => NotEqualBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  287.                 '<=>' => ['precedence' => 20, 'class' => SpaceshipBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  288.                 '<' => ['precedence' => 20, 'class' => LessBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  289.                 '>' => ['precedence' => 20, 'class' => GreaterBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  290.                 '>=' => ['precedence' => 20, 'class' => GreaterEqualBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  291.                 '<=' => ['precedence' => 20, 'class' => LessEqualBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  292.                 'not in' => ['precedence' => 20, 'class' => NotInBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  293.                 'in' => ['precedence' => 20, 'class' => InBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  294.                 'matches' => ['precedence' => 20, 'class' => MatchesBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  295.                 'starts with' => ['precedence' => 20, 'class' => StartsWithBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  296.                 'ends with' => ['precedence' => 20, 'class' => EndsWithBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  297.                 'has some' => ['precedence' => 20, 'class' => HasSomeBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  298.                 'has every' => ['precedence' => 20, 'class' => HasEveryBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  299.                 '..' => ['precedence' => 25, 'class' => RangeBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  300.                 '+' => ['precedence' => 30, 'class' => AddBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  301.                 '-' => ['precedence' => 30, 'class' => SubBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  302.                 '~' => ['precedence' => 40, 'class' => ConcatBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  303.                 '*' => ['precedence' => 60, 'class' => MulBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  304.                 '/' => ['precedence' => 60, 'class' => DivBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  305.                 '//' => ['precedence' => 60, 'class' => FloorDivBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  306.                 '%' => ['precedence' => 60, 'class' => ModBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  307.                 'is' => ['precedence' => 100, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  308.                 'is not' => ['precedence' => 100, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  309.                 '**' => ['precedence' => 200, 'class' => PowerBinary::class, 'associativity' => ExpressionParser::OPERATOR_RIGHT],
  310.                 '??' => ['precedence' => 300, 'class' => NullCoalesceExpression::class, 'associativity' => ExpressionParser::OPERATOR_RIGHT],
  311.             ],
  312.         ];
  313.     }
  315.     /**
  316.      * Cycles over a value.
  317.      *
  318.      * @param \ArrayAccess|array $values
  319.      * @param int                $position The cycle position
  320.      *
  321.      * @return string The next value in the cycle
  322.      *
  323.      * @internal
  324.      */
  325.     public static function cycle($values, $position): string
  326.     {
  327.         if (!\is_array($values) && !$values instanceof \ArrayAccess) {
  328.             return $values;
  329.         }
  331.         if (!\count($values)) {
  332.             throw new RuntimeError('The "cycle" function does not work on empty arrays.');
  333.         }
  335.         return $values[$position % \count($values)];
  336.     }
  338.     /**
  339.      * Returns a random value depending on the supplied parameter type:
  340.      * - a random item from a \Traversable or array
  341.      * - a random character from a string
  342.      * - a random integer between 0 and the integer parameter.
  343.      *
  344.      * @param \Traversable|array|int|float|string $values The values to pick a random item from
  345.      * @param int|null                            $max    Maximum value used when $values is an int
  346.      *
  347.      * @return mixed A random value from the given sequence
  348.      *
  349.      * @throws RuntimeError when $values is an empty array (does not apply to an empty string which is returned as is)
  350.      *
  351.      * @internal
  352.      */
  353.     public static function random(string $charset, $values = null, $max = null)
  354.     {
  355.         if (null === $values) {
  356.             return null === $max ? mt_rand() : mt_rand(0, (int) $max);
  357.         }
  359.         if (\is_int($values) || \is_float($values)) {
  360.             if (null === $max) {
  361.                 if ($values < 0) {
  362.                     $max = 0;
  363.                     $min = $values;
  364.                 } else {
  365.                     $max = $values;
  366.                     $min = 0;
  367.                 }
  368.             } else {
  369.                 $min = $values;
  370.             }
  372.             return mt_rand((int) $min, (int) $max);
  373.         }
  375.         if (\is_string($values)) {
  376.             if ('' === $values) {
  377.                 return '';
  378.             }
  380.             if ('UTF-8' !== $charset) {
  381.                 $values = self::convertEncoding($values, 'UTF-8', $charset);
  382.             }
  384.             // unicode version of str_split()
  385.             // split at all positions, but not after the start and not before the end
  386.             $values = preg_split('/(?<!^)(?!$)/u', $values);
  388.             if ('UTF-8' !== $charset) {
  389.                 foreach ($values as $i => $value) {
  390.                     $values[$i] = self::convertEncoding($value, $charset, 'UTF-8');
  391.                 }
  392.             }
  393.         }
  395.         if (!is_iterable($values)) {
  396.             return $values;
  397.         }
  399.         $values = self::toArray($values);
  401.         if (0 === \count($values)) {
  402.             throw new RuntimeError('The random function cannot pick from an empty array.');
  403.         }
  405.         return $values[array_rand($values, 1)];
  406.     }
  408.     /**
  409.      * Formats a date.
  410.      *
  411.      *   {{ post.published_at|date("m/d/Y") }}
  412.      *
  413.      * @param \DateTimeInterface|\DateInterval|string $date     A date
  414.      * @param string|null                             $format   The target format, null to use the default
  415.      * @param \DateTimeZone|string|false|null         $timezone The target timezone, null to use the default, false to leave unchanged
  416.      */
  417.     public function formatDate($date, $format = null, $timezone = null): string
  418.     {
  419.         if (null === $format) {
  420.             $formats = $this->getDateFormat();
  421.             $format = $date instanceof \DateInterval ? $formats[1] : $formats[0];
  422.         }
  424.         if ($date instanceof \DateInterval) {
  425.             return $date->format($format);
  426.         }
  428.         return $this->convertDate($date, $timezone)->format($format);
  429.     }
  431.     /**
  432.      * Returns a new date object modified.
  433.      *
  434.      *   {{ post.published_at|date_modify("-1day")|date("m/d/Y") }}
  435.      *
  436.      * @param \DateTimeInterface|string $date     A date
  437.      * @param string                    $modifier A modifier string
  438.      *
  439.      * @return \DateTime|\DateTimeImmutable
  440.      *
  441.      * @internal
  442.      */
  443.     public function modifyDate($date, $modifier)
  444.     {
  445.         return $this->convertDate($date, false)->modify($modifier);
  446.     }
  448.     /**
  449.      * Returns a formatted string.
  450.      *
  451.      * @param string|null $format
  452.      * @param ...$values
  453.      *
  454.      * @internal
  455.      */
  456.     public static function sprintf($format, ...$values): string
  457.     {
  458.         return sprintf($format ?? '', ...$values);
  459.     }
  461.     /**
  462.      * @internal
  463.      */
  464.     public static function dateConverter(Environment $env, $date, $format = null, $timezone = null): string
  465.     {
  466.         return $env->getExtension(self::class)->formatDate($date, $format, $timezone);
  467.     }
  469.     /**
  470.      * Converts an input to a \DateTime instance.
  471.      *
  472.      *    {% if date(user.created_at) < date('+2days') %}
  473.      *      {# do something #}
  474.      *    {% endif %}
  475.      *
  476.      * @param \DateTimeInterface|string|null  $date     A date or null to use the current time
  477.      * @param \DateTimeZone|string|false|null $timezone The target timezone, null to use the default, false to leave unchanged
  478.      *
  479.      * @return \DateTime|\DateTimeImmutable
  480.      */
  481.     public function convertDate($date = null, $timezone = null)
  482.     {
  483.         // determine the timezone
  484.         if (false !== $timezone) {
  485.             if (null === $timezone) {
  486.                 $timezone = $this->getTimezone();
  487.             } elseif (!$timezone instanceof \DateTimeZone) {
  488.                 $timezone = new \DateTimeZone($timezone);
  489.             }
  490.         }
  492.         // immutable dates
  493.         if ($date instanceof \DateTimeImmutable) {
  494.             return false !== $timezone ? $date->setTimezone($timezone) : $date;
  495.         }
  497.         if ($date instanceof \DateTime) {
  498.             $date = clone $date;
  499.             if (false !== $timezone) {
  500.                 $date->setTimezone($timezone);
  501.             }
  503.             return $date;
  504.         }
  506.         if (null === $date || 'now' === $date) {
  507.             if (null === $date) {
  508.                 $date = 'now';
  509.             }
  511.             return new \DateTime($date, false !== $timezone ? $timezone : $this->getTimezone());
  512.         }
  514.         $asString = (string) $date;
  515.         if (ctype_digit($asString) || (!empty($asString) && '-' === $asString[0] && ctype_digit(substr($asString, 1)))) {
  516.             $date = new \DateTime('@'.$date);
  517.         } else {
  518.             $date = new \DateTime($date, $this->getTimezone());
  519.         }
  521.         if (false !== $timezone) {
  522.             $date->setTimezone($timezone);
  523.         }
  525.         return $date;
  526.     }
  528.     /**
  529.      * Replaces strings within a string.
  530.      *
  531.      * @param string|null        $str  String to replace in
  532.      * @param array|\Traversable $from Replace values
  533.      *
  534.      * @internal
  535.      */
  536.     public static function replace($str, $from): string
  537.     {
  538.         if (!is_iterable($from)) {
  539.             throw new RuntimeError(sprintf('The "replace" filter expects an array or "Traversable" as replace values, got "%s".', \is_object($from) ? \get_class($from) : \gettype($from)));
  540.         }
  542.         return strtr($str ?? '', self::toArray($from));
  543.     }
  545.     /**
  546.      * Rounds a number.
  547.      *
  548.      * @param int|float|string|null $value     The value to round
  549.      * @param int|float             $precision The rounding precision
  550.      * @param string                $method    The method to use for rounding
  551.      *
  552.      * @return int|float The rounded number
  553.      *
  554.      * @internal
  555.      */
  556.     public static function round($value, $precision = 0, $method = 'common')
  557.     {
  558.         $value = (float) $value;
  560.         if ('common' === $method) {
  561.             return round($value, $precision);
  562.         }
  564.         if ('ceil' !== $method && 'floor' !== $method) {
  565.             throw new RuntimeError('The round filter only supports the "common", "ceil", and "floor" methods.');
  566.         }
  568.         return $method($value * 10 ** $precision) / 10 ** $precision;
  569.     }
  571.     /**
  572.      * Formats a number.
  573.      *
  574.      * All of the formatting options can be left null, in that case the defaults will
  575.      * be used. Supplying any of the parameters will override the defaults set in the
  576.      * environment object.
  577.      *
  578.      * @param mixed       $number       A float/int/string of the number to format
  579.      * @param int|null    $decimal      the number of decimal points to display
  580.      * @param string|null $decimalPoint the character(s) to use for the decimal point
  581.      * @param string|null $thousandSep  the character(s) to use for the thousands separator
  582.      */
  583.     public function formatNumber($number, $decimal = null, $decimalPoint = null, $thousandSep = null): string
  584.     {
  585.         $defaults = $this->getNumberFormat();
  586.         if (null === $decimal) {
  587.             $decimal = $defaults[0];
  588.         }
  590.         if (null === $decimalPoint) {
  591.             $decimalPoint = $defaults[1];
  592.         }
  594.         if (null === $thousandSep) {
  595.             $thousandSep = $defaults[2];
  596.         }
  598.         return number_format((float) $number, $decimal, $decimalPoint, $thousandSep);
  599.     }
  601.     /**
  602.      * URL encodes (RFC 3986) a string as a path segment or an array as a query string.
  603.      *
  604.      * @param string|array|null $url A URL or an array of query parameters
  605.      *
  606.      * @internal
  607.      */
  608.     public static function urlencode($url): string
  609.     {
  610.         if (\is_array($url)) {
  611.             return http_build_query($url, '', '&', \PHP_QUERY_RFC3986);
  612.         }
  614.         return rawurlencode($url ?? '');
  615.     }
  617.     /**
  618.      * Merges any number of arrays or Traversable objects.
  619.      *
  620.      *  {% set items = { 'apple': 'fruit', 'orange': 'fruit' } %}
  621.      *
  622.      *  {% set items = items|merge({ 'peugeot': 'car' }, { 'banana': 'fruit' }) %}
  623.      *
  624.      *  {# items now contains { 'apple': 'fruit', 'orange': 'fruit', 'peugeot': 'car', 'banana': 'fruit' } #}
  625.      *
  626.      * @param array|\Traversable ...$arrays Any number of arrays or Traversable objects to merge
  627.      *
  628.      * @internal
  629.      */
  630.     public static function merge(...$arrays): array
  631.     {
  632.         $result = [];
  634.         foreach ($arrays as $argNumber => $array) {
  635.             if (!is_iterable($array)) {
  636.                 throw new RuntimeError(sprintf('The merge filter only works with arrays or "Traversable", got "%s" for argument %d.', \gettype($array), $argNumber + 1));
  637.             }
  639.             $result = array_merge($result, self::toArray($array));
  640.         }
  642.         return $result;
  643.     }
  645.     /**
  646.      * Slices a variable.
  647.      *
  648.      * @param mixed $item         A variable
  649.      * @param int   $start        Start of the slice
  650.      * @param int   $length       Size of the slice
  651.      * @param bool  $preserveKeys Whether to preserve key or not (when the input is an array)
  652.      *
  653.      * @return mixed The sliced variable
  654.      *
  655.      * @internal
  656.      */
  657.     public static function slice(string $charset, $item, $start, $length = null, $preserveKeys = false)
  658.     {
  659.         if ($item instanceof \Traversable) {
  660.             while ($item instanceof \IteratorAggregate) {
  661.                 $item = $item->getIterator();
  662.             }
  664.             if ($start >= 0 && $length >= 0 && $item instanceof \Iterator) {
  665.                 try {
  666.                     return iterator_to_array(new \LimitIterator($item, $start, $length ?? -1), $preserveKeys);
  667.                 } catch (\OutOfBoundsException $e) {
  668.                     return [];
  669.                 }
  670.             }
  672.             $item = iterator_to_array($item, $preserveKeys);
  673.         }
  675.         if (\is_array($item)) {
  676.             return \array_slice($item, $start, $length, $preserveKeys);
  677.         }
  679.         return mb_substr((string) $item, $start, $length, $charset);
  680.     }
  682.     /**
  683.      * Returns the first element of the item.
  684.      *
  685.      * @param mixed $item A variable
  686.      *
  687.      * @return mixed The first element of the item
  688.      *
  689.      * @internal
  690.      */
  691.     public static function first(string $charset, $item)
  692.     {
  693.         $elements = self::slice($charset, $item, 0, 1, false);
  695.         return \is_string($elements) ? $elements : current($elements);
  696.     }
  698.     /**
  699.      * Returns the last element of the item.
  700.      *
  701.      * @param mixed $item A variable
  702.      *
  703.      * @return mixed The last element of the item
  704.      *
  705.      * @internal
  706.      */
  707.     public static function last(string $charset, $item)
  708.     {
  709.         $elements = self::slice($charset, $item, -1, 1, false);
  711.         return \is_string($elements) ? $elements : current($elements);
  712.     }
  714.     /**
  715.      * Joins the values to a string.
  716.      *
  717.      * The separators between elements are empty strings per default, you can define them with the optional parameters.
  718.      *
  719.      *  {{ [1, 2, 3]|join(', ', ' and ') }}
  720.      *  {# returns 1, 2 and 3 #}
  721.      *
  722.      *  {{ [1, 2, 3]|join('|') }}
  723.      *  {# returns 1|2|3 #}
  724.      *
  725.      *  {{ [1, 2, 3]|join }}
  726.      *  {# returns 123 #}
  727.      *
  728.      * @param array       $value An array
  729.      * @param string      $glue  The separator
  730.      * @param string|null $and   The separator for the last pair
  731.      *
  732.      * @internal
  733.      */
  734.     public static function join($value, $glue = '', $and = null): string
  735.     {
  736.         if (!is_iterable($value)) {
  737.             $value = (array) $value;
  738.         }
  740.         $value = self::toArray($value, false);
  742.         if (0 === \count($value)) {
  743.             return '';
  744.         }
  746.         if (null === $and || $and === $glue) {
  747.             return implode($glue, $value);
  748.         }
  750.         if (1 === \count($value)) {
  751.             return $value[0];
  752.         }
  754.         return implode($glue, \array_slice($value, 0, -1)).$and.$value[\count($value) - 1];
  755.     }
  757.     /**
  758.      * Splits the string into an array.
  759.      *
  760.      *  {{ "one,two,three"|split(',') }}
  761.      *  {# returns [one, two, three] #}
  762.      *
  763.      *  {{ "one,two,three,four,five"|split(',', 3) }}
  764.      *  {# returns [one, two, "three,four,five"] #}
  765.      *
  766.      *  {{ "123"|split('') }}
  767.      *  {# returns [1, 2, 3] #}
  768.      *
  769.      *  {{ "aabbcc"|split('', 2) }}
  770.      *  {# returns [aa, bb, cc] #}
  771.      *
  772.      * @param string|null $value     A string
  773.      * @param string      $delimiter The delimiter
  774.      * @param int|null    $limit     The limit
  775.      *
  776.      * @internal
  777.      */
  778.     public static function split(string $charset, $value, $delimiter, $limit = null): array
  779.     {
  780.         $value = $value ?? '';
  782.         if ('' !== $delimiter) {
  783.             return null === $limit ? explode($delimiter, $value) : explode($delimiter, $value, $limit);
  784.         }
  786.         if ($limit <= 1) {
  787.             return preg_split('/(?<!^)(?!$)/u', $value);
  788.         }
  790.         $length = mb_strlen($value, $charset);
  791.         if ($length < $limit) {
  792.             return [$value];
  793.         }
  795.         $r = [];
  796.         for ($i = 0; $i < $length; $i += $limit) {
  797.             $r[] = mb_substr($value, $i, $limit, $charset);
  798.         }
  800.         return $r;
  801.     }
  803.     // The '_default' filter is used internally to avoid using the ternary operator
  804.     // which costs a lot for big contexts (before PHP 5.4). So, on average,
  805.     // a function call is cheaper.
  806.     /**
  807.      * @internal
  808.      */
  809.     public static function default($value, $default = '')
  810.     {
  811.         if (self::testEmpty($value)) {
  812.             return $default;
  813.         }
  815.         return $value;
  816.     }
  818.     /**
  819.      * Returns the keys for the given array.
  820.      *
  821.      * It is useful when you want to iterate over the keys of an array:
  822.      *
  823.      *  {% for key in array|keys %}
  824.      *      {# ... #}
  825.      *  {% endfor %}
  826.      *
  827.      * @internal
  828.      */
  829.     public static function keys($array): array
  830.     {
  831.         if ($array instanceof \Traversable) {
  832.             while ($array instanceof \IteratorAggregate) {
  833.                 $array = $array->getIterator();
  834.             }
  836.             $keys = [];
  837.             if ($array instanceof \Iterator) {
  838.                 $array->rewind();
  839.                 while ($array->valid()) {
  840.                     $keys[] = $array->key();
  841.                     $array->next();
  842.                 }
  844.                 return $keys;
  845.             }
  847.             foreach ($array as $key => $item) {
  848.                 $keys[] = $key;
  849.             }
  851.             return $keys;
  852.         }
  854.         if (!\is_array($array)) {
  855.             return [];
  856.         }
  858.         return array_keys($array);
  859.     }
  861.     /**
  862.      * Reverses a variable.
  863.      *
  864.      * @param array|\Traversable|string|null $item         An array, a \Traversable instance, or a string
  865.      * @param bool                           $preserveKeys Whether to preserve key or not
  866.      *
  867.      * @return mixed The reversed input
  868.      *
  869.      * @internal
  870.      */
  871.     public static function reverse(string $charset, $item, $preserveKeys = false)
  872.     {
  873.         if ($item instanceof \Traversable) {
  874.             return array_reverse(iterator_to_array($item), $preserveKeys);
  875.         }
  877.         if (\is_array($item)) {
  878.             return array_reverse($item, $preserveKeys);
  879.         }
  881.         $string = (string) $item;
  883.         if ('UTF-8' !== $charset) {
  884.             $string = self::convertEncoding($string, 'UTF-8', $charset);
  885.         }
  887.         preg_match_all('/./us', $string, $matches);
  889.         $string = implode('', array_reverse($matches[0]));
  891.         if ('UTF-8' !== $charset) {
  892.             $string = self::convertEncoding($string, $charset, 'UTF-8');
  893.         }
  895.         return $string;
  896.     }
  898.     /**
  899.      * Sorts an array.
  900.      *
  901.      * @param array|\Traversable $array
  902.      *
  903.      * @internal
  904.      */
  905.     public static function sort(Environment $env, $array, $arrow = null): array
  906.     {
  907.         if ($array instanceof \Traversable) {
  908.             $array = iterator_to_array($array);
  909.         } elseif (!\is_array($array)) {
  910.             throw new RuntimeError(sprintf('The sort filter only works with arrays or "Traversable", got "%s".', \gettype($array)));
  911.         }
  913.         if (null !== $arrow) {
  914.             self::checkArrowInSandbox($env, $arrow, 'sort', 'filter');
  916.             uasort($array, $arrow);
  917.         } else {
  918.             asort($array);
  919.         }
  921.         return $array;
  922.     }
  924.     /**
  925.      * @internal
  926.      */
  927.     public static function inFilter($value, $compare)
  928.     {
  929.         if ($value instanceof Markup) {
  930.             $value = (string) $value;
  931.         }
  932.         if ($compare instanceof Markup) {
  933.             $compare = (string) $compare;
  934.         }
  936.         if (\is_string($compare)) {
  937.             if (\is_string($value) || \is_int($value) || \is_float($value)) {
  938.                 return '' === $value || str_contains($compare, (string) $value);
  939.             }
  941.             return false;
  942.         }
  944.         if (!is_iterable($compare)) {
  945.             return false;
  946.         }
  948.         if (\is_object($value) || \is_resource($value)) {
  949.             if (!\is_array($compare)) {
  950.                 foreach ($compare as $item) {
  951.                     if ($item === $value) {
  952.                         return true;
  953.                     }
  954.                 }
  956.                 return false;
  957.             }
  959.             return \in_array($value, $compare, true);
  960.         }
  962.         foreach ($compare as $item) {
  963.             if (0 === self::compare($value, $item)) {
  964.                 return true;
  965.             }
  966.         }
  968.         return false;
  969.     }
  971.     /**
  972.      * Compares two values using a more strict version of the PHP non-strict comparison operator.
  973.      *
  974.      * @see https://wiki.php.net/rfc/string_to_number_comparison
  975.      * @see https://wiki.php.net/rfc/trailing_whitespace_numerics
  976.      *
  977.      * @internal
  978.      */
  979.     public static function compare($a, $b)
  980.     {
  981.         // int <=> string
  982.         if (\is_int($a) && \is_string($b)) {
  983.             $bTrim = trim($b, " \t\n\r\v\f");
  984.             if (!is_numeric($bTrim)) {
  985.                 return (string) $a <=> $b;
  986.             }
  987.             if ((int) $bTrim == $bTrim) {
  988.                 return $a <=> (int) $bTrim;
  989.             } else {
  990.                 return (float) $a <=> (float) $bTrim;
  991.             }
  992.         }
  993.         if (\is_string($a) && \is_int($b)) {
  994.             $aTrim = trim($a, " \t\n\r\v\f");
  995.             if (!is_numeric($aTrim)) {
  996.                 return $a <=> (string) $b;
  997.             }
  998.             if ((int) $aTrim == $aTrim) {
  999.                 return (int) $aTrim <=> $b;
  1000.             } else {
  1001.                 return (float) $aTrim <=> (float) $b;
  1002.             }
  1003.         }
  1005.         // float <=> string
  1006.         if (\is_float($a) && \is_string($b)) {
  1007.             if (is_nan($a)) {
  1008.                 return 1;
  1009.             }
  1010.             $bTrim = trim($b, " \t\n\r\v\f");
  1011.             if (!is_numeric($bTrim)) {
  1012.                 return (string) $a <=> $b;
  1013.             }
  1015.             return $a <=> (float) $bTrim;
  1016.         }
  1017.         if (\is_string($a) && \is_float($b)) {
  1018.             if (is_nan($b)) {
  1019.                 return 1;
  1020.             }
  1021.             $aTrim = trim($a, " \t\n\r\v\f");
  1022.             if (!is_numeric($aTrim)) {
  1023.                 return $a <=> (string) $b;
  1024.             }
  1026.             return (float) $aTrim <=> $b;
  1027.         }
  1029.         // fallback to <=>
  1030.         return $a <=> $b;
  1031.     }
  1033.     /**
  1034.      * @throws RuntimeError When an invalid pattern is used
  1035.      *
  1036.      * @internal
  1037.      */
  1038.     public static function matches(string $regexp, ?string $str): int
  1039.     {
  1040.         set_error_handler(function ($t, $m) use ($regexp) {
  1041.             throw new RuntimeError(sprintf('Regexp "%s" passed to "matches" is not valid', $regexp).substr($m, 12));
  1042.         });
  1043.         try {
  1044.             return preg_match($regexp, $str ?? '');
  1045.         } finally {
  1046.             restore_error_handler();
  1047.         }
  1048.     }
  1050.     /**
  1051.      * Returns a trimmed string.
  1052.      *
  1053.      * @param string|null $string
  1054.      * @param string|null $characterMask
  1055.      * @param string      $side
  1056.      *
  1057.      * @throws RuntimeError When an invalid trimming side is used (not a string or not 'left', 'right', or 'both')
  1058.      *
  1059.      * @internal
  1060.      */
  1061.     public static function trim($string, $characterMask = null, $side = 'both'): string
  1062.     {
  1063.         if (null === $characterMask) {
  1064.             $characterMask = " \t\n\r\0\x0B";
  1065.         }
  1067.         switch ($side) {
  1068.             case 'both':
  1069.                 return trim($string ?? '', $characterMask);
  1070.             case 'left':
  1071.                 return ltrim($string ?? '', $characterMask);
  1072.             case 'right':
  1073.                 return rtrim($string ?? '', $characterMask);
  1074.             default:
  1075.                 throw new RuntimeError('Trimming side must be "left", "right" or "both".');
  1076.         }
  1077.     }
  1079.     /**
  1080.      * Inserts HTML line breaks before all newlines in a string.
  1081.      *
  1082.      * @param string|null $string
  1083.      *
  1084.      * @internal
  1085.      */
  1086.     public static function nl2br($string): string
  1087.     {
  1088.         return nl2br($string ?? '');
  1089.     }
  1091.     /**
  1092.      * Removes whitespaces between HTML tags.
  1093.      *
  1094.      * @param string|null $content
  1095.      *
  1096.      * @internal
  1097.      */
  1098.     public static function spaceless($content): string
  1099.     {
  1100.         return trim(preg_replace('/>\s+</', '><', $content ?? ''));
  1101.     }
  1103.     /**
  1104.      * @param string|null $string
  1105.      * @param string      $to
  1106.      * @param string      $from
  1107.      *
  1108.      * @internal
  1109.      */
  1110.     public static function convertEncoding($string, $to, $from): string
  1111.     {
  1112.         if (!\function_exists('iconv')) {
  1113.             throw new RuntimeError('Unable to convert encoding: required function iconv() does not exist. You should install ext-iconv or symfony/polyfill-iconv.');
  1114.         }
  1116.         return iconv($from, $to, $string ?? '');
  1117.     }
  1119.     /**
  1120.      * Returns the length of a variable.
  1121.      *
  1122.      * @param mixed $thing A variable
  1123.      *
  1124.      * @internal
  1125.      */
  1126.     public static function length(string $charset, $thing): int
  1127.     {
  1128.         if (null === $thing) {
  1129.             return 0;
  1130.         }
  1132.         if (\is_scalar($thing)) {
  1133.             return mb_strlen($thing, $charset);
  1134.         }
  1136.         if ($thing instanceof \Countable || \is_array($thing) || $thing instanceof \SimpleXMLElement) {
  1137.             return \count($thing);
  1138.         }
  1140.         if ($thing instanceof \Traversable) {
  1141.             return iterator_count($thing);
  1142.         }
  1144.         if (method_exists($thing, '__toString')) {
  1145.             return mb_strlen((string) $thing, $charset);
  1146.         }
  1148.         return 1;
  1149.     }
  1151.     /**
  1152.      * Converts a string to uppercase.
  1153.      *
  1154.      * @param string|null $string A string
  1155.      *
  1156.      * @internal
  1157.      */
  1158.     public static function upper(string $charset, $string): string
  1159.     {
  1160.         return mb_strtoupper($string ?? '', $charset);
  1161.     }
  1163.     /**
  1164.      * Converts a string to lowercase.
  1165.      *
  1166.      * @param string|null $string A string
  1167.      *
  1168.      * @internal
  1169.      */
  1170.     public static function lower(string $charset, $string): string
  1171.     {
  1172.         return mb_strtolower($string ?? '', $charset);
  1173.     }
  1175.     /**
  1176.      * Strips HTML and PHP tags from a string.
  1177.      *
  1178.      * @param string|null          $string
  1179.      * @param string[]|string|null $allowable_tags
  1180.      *
  1181.      * @internal
  1182.      */
  1183.     public static function striptags($string, $allowable_tags = null): string
  1184.     {
  1185.         return strip_tags($string ?? '', $allowable_tags);
  1186.     }
  1188.     /**
  1189.      * Returns a titlecased string.
  1190.      *
  1191.      * @param string|null $string A string
  1192.      *
  1193.      * @internal
  1194.      */
  1195.     public static function titleCase(string $charset, $string): string
  1196.     {
  1197.         return mb_convert_case($string ?? '', \MB_CASE_TITLE, $charset);
  1198.     }
  1200.     /**
  1201.      * Returns a capitalized string.
  1202.      *
  1203.      * @param string|null $string A string
  1204.      *
  1205.      * @internal
  1206.      */
  1207.     public static function capitalize(string $charset, $string): string
  1208.     {
  1209.         return mb_strtoupper(mb_substr($string ?? '', 0, 1, $charset), $charset).mb_strtolower(mb_substr($string ?? '', 1, null, $charset), $charset);
  1210.     }
  1212.     /**
  1213.      * @internal
  1214.      */
  1215.     public static function callMacro(Template $template, string $method, array $args, int $lineno, array $context, Source $source)
  1216.     {
  1217.         if (!method_exists($template, $method)) {
  1218.             $parent = $template;
  1219.             while ($parent = $parent->getParent($context)) {
  1220.                 if (method_exists($parent, $method)) {
  1221.                     return $parent->$method(...$args);
  1222.                 }
  1223.             }
  1225.             throw new RuntimeError(sprintf('Macro "%s" is not defined in template "%s".', substr($method, \strlen('macro_')), $template->getTemplateName()), $lineno, $source);
  1226.         }
  1228.         return $template->$method(...$args);
  1229.     }
  1231.     /**
  1232.      * @internal
  1233.      */
  1234.     public static function ensureTraversable($seq)
  1235.     {
  1236.         if (is_iterable($seq)) {
  1237.             return $seq;
  1238.         }
  1240.         return [];
  1241.     }
  1243.     /**
  1244.      * @internal
  1245.      */
  1246.     public static function toArray($seq, $preserveKeys = true)
  1247.     {
  1248.         if ($seq instanceof \Traversable) {
  1249.             return iterator_to_array($seq, $preserveKeys);
  1250.         }
  1252.         if (!\is_array($seq)) {
  1253.             return $seq;
  1254.         }
  1256.         return $preserveKeys ? $seq : array_values($seq);
  1257.     }
  1259.     /**
  1260.      * Checks if a variable is empty.
  1261.      *
  1262.      *    {# evaluates to true if the foo variable is null, false, or the empty string #}
  1263.      *    {% if foo is empty %}
  1264.      *        {# ... #}
  1265.      *    {% endif %}
  1266.      *
  1267.      * @param mixed $value A variable
  1268.      *
  1269.      * @internal
  1270.      */
  1271.     public static function testEmpty($value): bool
  1272.     {
  1273.         if ($value instanceof \Countable) {
  1274.             return 0 === \count($value);
  1275.         }
  1277.         if ($value instanceof \Traversable) {
  1278.             return !iterator_count($value);
  1279.         }
  1281.         if (\is_object($value) && method_exists($value, '__toString')) {
  1282.             return '' === (string) $value;
  1283.         }
  1285.         return '' === $value || false === $value || null === $value || [] === $value;
  1286.     }
  1288.     /**
  1289.      * Renders a template.
  1290.      *
  1291.      * @param array                        $context
  1292.      * @param string|array|TemplateWrapper $template      The template to render or an array of templates to try consecutively
  1293.      * @param array                        $variables     The variables to pass to the template
  1294.      * @param bool                         $withContext
  1295.      * @param bool                         $ignoreMissing Whether to ignore missing templates or not
  1296.      * @param bool                         $sandboxed     Whether to sandbox the template or not
  1297.      *
  1298.      * @internal
  1299.      */
  1300.     public static function include(Environment $env, $context, $template, $variables = [], $withContext = true, $ignoreMissing = false, $sandboxed = false): string
  1301.     {
  1302.         $alreadySandboxed = false;
  1303.         $sandbox = null;
  1304.         if ($withContext) {
  1305.             $variables = array_merge($context, $variables);
  1306.         }
  1308.         if ($isSandboxed = $sandboxed && $env->hasExtension(SandboxExtension::class)) {
  1309.             $sandbox = $env->getExtension(SandboxExtension::class);
  1310.             if (!$alreadySandboxed = $sandbox->isSandboxed()) {
  1311.                 $sandbox->enableSandbox();
  1312.             }
  1314.             foreach ((\is_array($template) ? $template : [$template]) as $name) {
  1315.                 // if a Template instance is passed, it might have been instantiated outside of a sandbox, check security
  1316.                 if ($name instanceof TemplateWrapper || $name instanceof Template) {
  1317.                     $name->unwrap()->checkSecurity();
  1318.                 }
  1319.             }
  1320.         }
  1322.         try {
  1323.             $loaded = null;
  1324.             try {
  1325.                 $loaded = $env->resolveTemplate($template);
  1326.             } catch (LoaderError $e) {
  1327.                 if (!$ignoreMissing) {
  1328.                     throw $e;
  1329.                 }
  1330.             }
  1332.             return $loaded ? $loaded->render($variables) : '';
  1333.         } finally {
  1334.             if ($isSandboxed && !$alreadySandboxed) {
  1335.                 $sandbox->disableSandbox();
  1336.             }
  1337.         }
  1338.     }
  1340.     /**
  1341.      * Returns a template content without rendering it.
  1342.      *
  1343.      * @param string $name          The template name
  1344.      * @param bool   $ignoreMissing Whether to ignore missing templates or not
  1345.      *
  1346.      * @internal
  1347.      */
  1348.     public static function source(Environment $env, $name, $ignoreMissing = false): string
  1349.     {
  1350.         $loader = $env->getLoader();
  1351.         try {
  1352.             return $loader->getSourceContext($name)->getCode();
  1353.         } catch (LoaderError $e) {
  1354.             if (!$ignoreMissing) {
  1355.                 throw $e;
  1356.             }
  1358.             return '';
  1359.         }
  1360.     }
  1362.     /**
  1363.      * Provides the ability to get constants from instances as well as class/global constants.
  1364.      *
  1365.      * @param string      $constant The name of the constant
  1366.      * @param object|null $object   The object to get the constant from
  1367.      *
  1368.      * @return mixed Class constants can return many types like scalars, arrays, and
  1369.      *               objects depending on the PHP version (\BackedEnum, \UnitEnum, etc.)
  1370.      *
  1371.      * @internal
  1372.      */
  1373.     public static function constant($constant, $object = null)
  1374.     {
  1375.         if (null !== $object) {
  1376.             if ('class' === $constant) {
  1377.                 return \get_class($object);
  1378.             }
  1380.             $constant = \get_class($object).'::'.$constant;
  1381.         }
  1383.         if (!\defined($constant)) {
  1384.             if ('::class' === strtolower(substr($constant, -7))) {
  1385.                 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));
  1386.             }
  1388.             throw new RuntimeError(sprintf('Constant "%s" is undefined.', $constant));
  1389.         }
  1391.         return \constant($constant);
  1392.     }
  1394.     /**
  1395.      * Checks if a constant exists.
  1396.      *
  1397.      * @param string      $constant The name of the constant
  1398.      * @param object|null $object   The object to get the constant from
  1399.      *
  1400.      * @internal
  1401.      */
  1402.     public static function constantIsDefined($constant, $object = null): bool
  1403.     {
  1404.         if (null !== $object) {
  1405.             if ('class' === $constant) {
  1406.                 return true;
  1407.             }
  1409.             $constant = \get_class($object).'::'.$constant;
  1410.         }
  1412.         return \defined($constant);
  1413.     }
  1415.     /**
  1416.      * Batches item.
  1417.      *
  1418.      * @param array $items An array of items
  1419.      * @param int   $size  The size of the batch
  1420.      * @param mixed $fill  A value used to fill missing items
  1421.      *
  1422.      * @internal
  1423.      */
  1424.     public static function batch($items, $size, $fill = null, $preserveKeys = true): array
  1425.     {
  1426.         if (!is_iterable($items)) {
  1427.             throw new RuntimeError(sprintf('The "batch" filter expects an array or "Traversable", got "%s".', \is_object($items) ? \get_class($items) : \gettype($items)));
  1428.         }
  1430.         $size = ceil($size);
  1432.         $result = array_chunk(self::toArray($items, $preserveKeys), $size, $preserveKeys);
  1434.         if (null !== $fill && $result) {
  1435.             $last = \count($result) - 1;
  1436.             if ($fillCount = $size - \count($result[$last])) {
  1437.                 for ($i = 0; $i < $fillCount; ++$i) {
  1438.                     $result[$last][] = $fill;
  1439.                 }
  1440.             }
  1441.         }
  1443.         return $result;
  1444.     }
  1446.     /**
  1447.      * Returns the attribute value for a given array/object.
  1448.      *
  1449.      * @param mixed  $object            The object or array from where to get the item
  1450.      * @param mixed  $item              The item to get from the array or object
  1451.      * @param array  $arguments         An array of arguments to pass if the item is an object method
  1452.      * @param string $type              The type of attribute (@see \Twig\Template constants)
  1453.      * @param bool   $isDefinedTest     Whether this is only a defined check
  1454.      * @param bool   $ignoreStrictCheck Whether to ignore the strict attribute check or not
  1455.      * @param int    $lineno            The template line where the attribute was called
  1456.      *
  1457.      * @return mixed The attribute value, or a Boolean when $isDefinedTest is true, or null when the attribute is not set and $ignoreStrictCheck is true
  1458.      *
  1459.      * @throws RuntimeError if the attribute does not exist and Twig is running in strict mode and $isDefinedTest is false
  1460.      *
  1461.      * @internal
  1462.      */
  1463.     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)
  1464.     {
  1465.         // array
  1466.         if (/* Template::METHOD_CALL */ 'method' !== $type) {
  1467.             $arrayItem = \is_bool($item) || \is_float($item) ? (int) $item : $item;
  1469.             if (((\is_array($object) || $object instanceof \ArrayObject) && (isset($object[$arrayItem]) || \array_key_exists($arrayItem, (array) $object)))
  1470.                 || ($object instanceof \ArrayAccess && isset($object[$arrayItem]))
  1471.             ) {
  1472.                 if ($isDefinedTest) {
  1473.                     return true;
  1474.                 }
  1476.                 return $object[$arrayItem];
  1477.             }
  1479.             if (/* Template::ARRAY_CALL */ 'array' === $type || !\is_object($object)) {
  1480.                 if ($isDefinedTest) {
  1481.                     return false;
  1482.                 }
  1484.                 if ($ignoreStrictCheck || !$env->isStrictVariables()) {
  1485.                     return;
  1486.                 }
  1488.                 if ($object instanceof \ArrayAccess) {
  1489.                     $message = sprintf('Key "%s" in object with ArrayAccess of class "%s" does not exist.', $arrayItem, \get_class($object));
  1490.                 } elseif (\is_object($object)) {
  1491.                     $message = sprintf('Impossible to access a key "%s" on an object of class "%s" that does not implement ArrayAccess interface.', $item, \get_class($object));
  1492.                 } elseif (\is_array($object)) {
  1493.                     if (empty($object)) {
  1494.                         $message = sprintf('Key "%s" does not exist as the array is empty.', $arrayItem);
  1495.                     } else {
  1496.                         $message = sprintf('Key "%s" for array with keys "%s" does not exist.', $arrayItem, implode(', ', array_keys($object)));
  1497.                     }
  1498.                 } elseif (/* Template::ARRAY_CALL */ 'array' === $type) {
  1499.                     if (null === $object) {
  1500.                         $message = sprintf('Impossible to access a key ("%s") on a null variable.', $item);
  1501.                     } else {
  1502.                         $message = sprintf('Impossible to access a key ("%s") on a %s variable ("%s").', $item, \gettype($object), $object);
  1503.                     }
  1504.                 } elseif (null === $object) {
  1505.                     $message = sprintf('Impossible to access an attribute ("%s") on a null variable.', $item);
  1506.                 } else {
  1507.                     $message = sprintf('Impossible to access an attribute ("%s") on a %s variable ("%s").', $item, \gettype($object), $object);
  1508.                 }
  1510.                 throw new RuntimeError($message, $lineno, $source);
  1511.             }
  1512.         }
  1514.         if (!\is_object($object)) {
  1515.             if ($isDefinedTest) {
  1516.                 return false;
  1517.             }
  1519.             if ($ignoreStrictCheck || !$env->isStrictVariables()) {
  1520.                 return;
  1521.             }
  1523.             if (null === $object) {
  1524.                 $message = sprintf('Impossible to invoke a method ("%s") on a null variable.', $item);
  1525.             } elseif (\is_array($object)) {
  1526.                 $message = sprintf('Impossible to invoke a method ("%s") on an array.', $item);
  1527.             } else {
  1528.                 $message = sprintf('Impossible to invoke a method ("%s") on a %s variable ("%s").', $item, \gettype($object), $object);
  1529.             }
  1531.             throw new RuntimeError($message, $lineno, $source);
  1532.         }
  1534.         if ($object instanceof Template) {
  1535.             throw new RuntimeError('Accessing \Twig\Template attributes is forbidden.', $lineno, $source);
  1536.         }
  1538.         // object property
  1539.         if (/* Template::METHOD_CALL */ 'method' !== $type) {
  1540.             if (isset($object->$item) || \array_key_exists((string) $item, (array) $object)) {
  1541.                 if ($isDefinedTest) {
  1542.                     return true;
  1543.                 }
  1545.                 if ($sandboxed) {
  1546.                     $env->getExtension(SandboxExtension::class)->checkPropertyAllowed($object, $item, $lineno, $source);
  1547.                 }
  1549.                 return $object->$item;
  1550.             }
  1551.         }
  1553.         static $cache = [];
  1555.         $class = \get_class($object);
  1557.         // object method
  1558.         // precedence: getXxx() > isXxx() > hasXxx()
  1559.         if (!isset($cache[$class])) {
  1560.             $methods = get_class_methods($object);
  1561.             sort($methods);
  1562.             $lcMethods = array_map(function ($value) { return strtr($value, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz'); }, $methods);
  1563.             $classCache = [];
  1564.             foreach ($methods as $i => $method) {
  1565.                 $classCache[$method] = $method;
  1566.                 $classCache[$lcName = $lcMethods[$i]] = $method;
  1568.                 if ('g' === $lcName[0] && str_starts_with($lcName, 'get')) {
  1569.                     $name = substr($method, 3);
  1570.                     $lcName = substr($lcName, 3);
  1571.                 } elseif ('i' === $lcName[0] && str_starts_with($lcName, 'is')) {
  1572.                     $name = substr($method, 2);
  1573.                     $lcName = substr($lcName, 2);
  1574.                 } elseif ('h' === $lcName[0] && str_starts_with($lcName, 'has')) {
  1575.                     $name = substr($method, 3);
  1576.                     $lcName = substr($lcName, 3);
  1577.                     if (\in_array('is'.$lcName, $lcMethods)) {
  1578.                         continue;
  1579.                     }
  1580.                 } else {
  1581.                     continue;
  1582.                 }
  1584.                 // skip get() and is() methods (in which case, $name is empty)
  1585.                 if ($name) {
  1586.                     if (!isset($classCache[$name])) {
  1587.                         $classCache[$name] = $method;
  1588.                     }
  1590.                     if (!isset($classCache[$lcName])) {
  1591.                         $classCache[$lcName] = $method;
  1592.                     }
  1593.                 }
  1594.             }
  1595.             $cache[$class] = $classCache;
  1596.         }
  1598.         $call = false;
  1599.         if (isset($cache[$class][$item])) {
  1600.             $method = $cache[$class][$item];
  1601.         } elseif (isset($cache[$class][$lcItem = strtr($item, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz')])) {
  1602.             $method = $cache[$class][$lcItem];
  1603.         } elseif (isset($cache[$class]['__call'])) {
  1604.             $method = $item;
  1605.             $call = true;
  1606.         } else {
  1607.             if ($isDefinedTest) {
  1608.                 return false;
  1609.             }
  1611.             if ($ignoreStrictCheck || !$env->isStrictVariables()) {
  1612.                 return;
  1613.             }
  1615.             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);
  1616.         }
  1618.         if ($isDefinedTest) {
  1619.             return true;
  1620.         }
  1622.         if ($sandboxed) {
  1623.             $env->getExtension(SandboxExtension::class)->checkMethodAllowed($object, $method, $lineno, $source);
  1624.         }
  1626.         // Some objects throw exceptions when they have __call, and the method we try
  1627.         // to call is not supported. If ignoreStrictCheck is true, we should return null.
  1628.         try {
  1629.             $ret = $object->$method(...$arguments);
  1630.         } catch (\BadMethodCallException $e) {
  1631.             if ($call && ($ignoreStrictCheck || !$env->isStrictVariables())) {
  1632.                 return;
  1633.             }
  1634.             throw $e;
  1635.         }
  1637.         return $ret;
  1638.     }
  1640.     /**
  1641.      * Returns the values from a single column in the input array.
  1642.      *
  1643.      * <pre>
  1644.      *  {% set items = [{ 'fruit' : 'apple'}, {'fruit' : 'orange' }] %}
  1645.      *
  1646.      *  {% set fruits = items|column('fruit') %}
  1647.      *
  1648.      *  {# fruits now contains ['apple', 'orange'] #}
  1649.      * </pre>
  1650.      *
  1651.      * @param array|\Traversable $array An array
  1652.      * @param int|string         $name  The column name
  1653.      * @param int|string|null    $index The column to use as the index/keys for the returned array
  1654.      *
  1655.      * @return array The array of values
  1656.      *
  1657.      * @internal
  1658.      */
  1659.     public static function column($array, $name, $index = null): array
  1660.     {
  1661.         if ($array instanceof \Traversable) {
  1662.             $array = iterator_to_array($array);
  1663.         } elseif (!\is_array($array)) {
  1664.             throw new RuntimeError(sprintf('The column filter only works with arrays or "Traversable", got "%s" as first argument.', \gettype($array)));
  1665.         }
  1667.         return array_column($array, $name, $index);
  1668.     }
  1670.     /**
  1671.      * @internal
  1672.      */
  1673.     public static function filter(Environment $env, $array, $arrow)
  1674.     {
  1675.         if (!is_iterable($array)) {
  1676.             throw new RuntimeError(sprintf('The "filter" filter expects an array or "Traversable", got "%s".', \is_object($array) ? \get_class($array) : \gettype($array)));
  1677.         }
  1679.         self::checkArrowInSandbox($env, $arrow, 'filter', 'filter');
  1681.         if (\is_array($array)) {
  1682.             return array_filter($array, $arrow, \ARRAY_FILTER_USE_BOTH);
  1683.         }
  1685.         // the IteratorIterator wrapping is needed as some internal PHP classes are \Traversable but do not implement \Iterator
  1686.         return new \CallbackFilterIterator(new \IteratorIterator($array), $arrow);
  1687.     }
  1689.     /**
  1690.      * @internal
  1691.      */
  1692.     public static function map(Environment $env, $array, $arrow)
  1693.     {
  1694.         self::checkArrowInSandbox($env, $arrow, 'map', 'filter');
  1696.         $r = [];
  1697.         foreach ($array as $k => $v) {
  1698.             $r[$k] = $arrow($v, $k);
  1699.         }
  1701.         return $r;
  1702.     }
  1704.     /**
  1705.      * @internal
  1706.      */
  1707.     public static function reduce(Environment $env, $array, $arrow, $initial = null)
  1708.     {
  1709.         self::checkArrowInSandbox($env, $arrow, 'reduce', 'filter');
  1711.         if (!\is_array($array) && !$array instanceof \Traversable) {
  1712.             throw new RuntimeError(sprintf('The "reduce" filter only works with arrays or "Traversable", got "%s" as first argument.', \gettype($array)));
  1713.         }
  1715.         $accumulator = $initial;
  1716.         foreach ($array as $key => $value) {
  1717.             $accumulator = $arrow($accumulator, $value, $key);
  1718.         }
  1720.         return $accumulator;
  1721.     }
  1723.     /**
  1724.      * @internal
  1725.      */
  1726.     public static function arraySome(Environment $env, $array, $arrow)
  1727.     {
  1728.         self::checkArrowInSandbox($env, $arrow, 'has some', 'operator');
  1730.         foreach ($array as $k => $v) {
  1731.             if ($arrow($v, $k)) {
  1732.                 return true;
  1733.             }
  1734.         }
  1736.         return false;
  1737.     }
  1739.     /**
  1740.      * @internal
  1741.      */
  1742.     public static function arrayEvery(Environment $env, $array, $arrow)
  1743.     {
  1744.         self::checkArrowInSandbox($env, $arrow, 'has every', 'operator');
  1746.         foreach ($array as $k => $v) {
  1747.             if (!$arrow($v, $k)) {
  1748.                 return false;
  1749.             }
  1750.         }
  1752.         return true;
  1753.     }
  1755.     /**
  1756.      * @internal
  1757.      */
  1758.     public static function checkArrowInSandbox(Environment $env, $arrow, $thing, $type)
  1759.     {
  1760.         if (!$arrow instanceof \Closure && $env->hasExtension(SandboxExtension::class) && $env->getExtension(SandboxExtension::class)->isSandboxed()) {
  1761.             throw new RuntimeError(sprintf('The callable passed to the "%s" %s must be a Closure in sandbox mode.', $thing, $type));
  1762.         }
  1763.     }
  1765.     /**
  1766.      * @internal to be removed in Twig 4
  1767.      */
  1768.     public static function captureOutput(iterable $body): string
  1769.     {
  1770.         $output = '';
  1771.         $level = ob_get_level();
  1772.         ob_start();
  1774.         try {
  1775.             foreach ($body as $data) {
  1776.                 if (ob_get_length()) {
  1777.                     $output .= ob_get_clean();
  1778.                     ob_start();
  1779.                 }
  1781.                 $output .= $data;
  1782.             }
  1784.             if (ob_get_length()) {
  1785.                 $output .= ob_get_clean();
  1786.             }
  1787.         } finally {
  1788.             while (ob_get_level() > $level) {
  1789.                 ob_end_clean();
  1790.             }
  1791.         }
  1793.         return $output;
  1794.     }
  1795. }