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

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