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

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