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

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\Error\SyntaxError;
  18. use Twig\ExpressionParser;
  19. use Twig\Markup;
  20. use Twig\Node\Expression\AbstractExpression;
  21. use Twig\Node\Expression\Binary\AddBinary;
  22. use Twig\Node\Expression\Binary\AndBinary;
  23. use Twig\Node\Expression\Binary\BitwiseAndBinary;
  24. use Twig\Node\Expression\Binary\BitwiseOrBinary;
  25. use Twig\Node\Expression\Binary\BitwiseXorBinary;
  26. use Twig\Node\Expression\Binary\ConcatBinary;
  27. use Twig\Node\Expression\Binary\DivBinary;
  28. use Twig\Node\Expression\Binary\EndsWithBinary;
  29. use Twig\Node\Expression\Binary\EqualBinary;
  30. use Twig\Node\Expression\Binary\FloorDivBinary;
  31. use Twig\Node\Expression\Binary\GreaterBinary;
  32. use Twig\Node\Expression\Binary\GreaterEqualBinary;
  33. use Twig\Node\Expression\Binary\HasEveryBinary;
  34. use Twig\Node\Expression\Binary\HasSomeBinary;
  35. use Twig\Node\Expression\Binary\InBinary;
  36. use Twig\Node\Expression\Binary\LessBinary;
  37. use Twig\Node\Expression\Binary\LessEqualBinary;
  38. use Twig\Node\Expression\Binary\MatchesBinary;
  39. use Twig\Node\Expression\Binary\ModBinary;
  40. use Twig\Node\Expression\Binary\MulBinary;
  41. use Twig\Node\Expression\Binary\NotEqualBinary;
  42. use Twig\Node\Expression\Binary\NotInBinary;
  43. use Twig\Node\Expression\Binary\OrBinary;
  44. use Twig\Node\Expression\Binary\PowerBinary;
  45. use Twig\Node\Expression\Binary\RangeBinary;
  46. use Twig\Node\Expression\Binary\SpaceshipBinary;
  47. use Twig\Node\Expression\Binary\StartsWithBinary;
  48. use Twig\Node\Expression\Binary\SubBinary;
  49. use Twig\Node\Expression\BlockReferenceExpression;
  50. use Twig\Node\Expression\Filter\DefaultFilter;
  51. use Twig\Node\Expression\FunctionNode\EnumCasesFunction;
  52. use Twig\Node\Expression\GetAttrExpression;
  53. use Twig\Node\Expression\NullCoalesceExpression;
  54. use Twig\Node\Expression\ParentExpression;
  55. use Twig\Node\Expression\Test\ConstantTest;
  56. use Twig\Node\Expression\Test\DefinedTest;
  57. use Twig\Node\Expression\Test\DivisiblebyTest;
  58. use Twig\Node\Expression\Test\EvenTest;
  59. use Twig\Node\Expression\Test\NullTest;
  60. use Twig\Node\Expression\Test\OddTest;
  61. use Twig\Node\Expression\Test\SameasTest;
  62. use Twig\Node\Expression\Unary\NegUnary;
  63. use Twig\Node\Expression\Unary\NotUnary;
  64. use Twig\Node\Expression\Unary\PosUnary;
  65. use Twig\Node\Node;
  66. use Twig\NodeVisitor\MacroAutoImportNodeVisitor;
  67. use Twig\Parser;
  68. use Twig\Sandbox\SecurityNotAllowedMethodError;
  69. use Twig\Sandbox\SecurityNotAllowedPropertyError;
  70. use Twig\Source;
  71. use Twig\Template;
  72. use Twig\TemplateWrapper;
  73. use Twig\TokenParser\ApplyTokenParser;
  74. use Twig\TokenParser\BlockTokenParser;
  75. use Twig\TokenParser\DeprecatedTokenParser;
  76. use Twig\TokenParser\DoTokenParser;
  77. use Twig\TokenParser\EmbedTokenParser;
  78. use Twig\TokenParser\ExtendsTokenParser;
  79. use Twig\TokenParser\FlushTokenParser;
  80. use Twig\TokenParser\ForTokenParser;
  81. use Twig\TokenParser\FromTokenParser;
  82. use Twig\TokenParser\IfTokenParser;
  83. use Twig\TokenParser\ImportTokenParser;
  84. use Twig\TokenParser\IncludeTokenParser;
  85. use Twig\TokenParser\MacroTokenParser;
  86. use Twig\TokenParser\SetTokenParser;
  87. use Twig\TokenParser\TypesTokenParser;
  88. use Twig\TokenParser\UseTokenParser;
  89. use Twig\TokenParser\WithTokenParser;
  90. use Twig\TwigFilter;
  91. use Twig\TwigFunction;
  92. use Twig\TwigTest;
  93. use Twig\Util\CallableArgumentsExtractor;
  95. final class CoreExtension extends AbstractExtension
  96. {
  97. public const ARRAY_LIKE_CLASSES = [
  98. 'ArrayIterator',
  99. 'ArrayObject',
  100. 'CachingIterator',
  101. 'RecursiveArrayIterator',
  102. 'RecursiveCachingIterator',
  103. 'SplDoublyLinkedList',
  104. 'SplFixedArray',
  105. 'SplObjectStorage',
  106. 'SplQueue',
  107. 'SplStack',
  108. 'WeakMap',
  109. ];
  111. private $dateFormats = ['F j, Y H:i', '%d days'];
  112. private $numberFormat = [0, '.', ','];
  113. private $timezone = null;
  115. /**
  116. * Sets the default format to be used by the date filter.
  117. *
  118. * @param string|null $format The default date format string
  119. * @param string|null $dateIntervalFormat The default date interval format string
  120. */
  121. public function setDateFormat($format = null, $dateIntervalFormat = null)
  122. {
  123. if (null !== $format) {
  124. $this->dateFormats[0] = $format;
  125. }
  127. if (null !== $dateIntervalFormat) {
  128. $this->dateFormats[1] = $dateIntervalFormat;
  129. }
  130. }
  132. /**
  133. * Gets the default format to be used by the date filter.
  134. *
  135. * @return array The default date format string and the default date interval format string
  136. */
  137. public function getDateFormat()
  138. {
  139. return $this->dateFormats;
  140. }
  142. /**
  143. * Sets the default timezone to be used by the date filter.
  144. *
  145. * @param \DateTimeZone|string $timezone The default timezone string or a \DateTimeZone object
  146. */
  147. public function setTimezone($timezone)
  148. {
  149. $this->timezone = $timezone instanceof \DateTimeZone ? $timezone : new \DateTimeZone($timezone);
  150. }
  152. /**
  153. * Gets the default timezone to be used by the date filter.
  154. *
  155. * @return \DateTimeZone The default timezone currently in use
  156. */
  157. public function getTimezone()
  158. {
  159. if (null === $this->timezone) {
  160. $this->timezone = new \DateTimeZone(date_default_timezone_get());
  161. }
  163. return $this->timezone;
  164. }
  166. /**
  167. * Sets the default format to be used by the number_format filter.
  168. *
  169. * @param int $decimal the number of decimal places to use
  170. * @param string $decimalPoint the character(s) to use for the decimal point
  171. * @param string $thousandSep the character(s) to use for the thousands separator
  172. */
  173. public function setNumberFormat($decimal, $decimalPoint, $thousandSep)
  174. {
  175. $this->numberFormat = [$decimal, $decimalPoint, $thousandSep];
  176. }
  178. /**
  179. * Get the default format used by the number_format filter.
  180. *
  181. * @return array The arguments for number_format()
  182. */
  183. public function getNumberFormat()
  184. {
  185. return $this->numberFormat;
  186. }
  188. public function getTokenParsers(): array
  189. {
  190. return [
  191. new ApplyTokenParser(),
  192. new ForTokenParser(),
  193. new IfTokenParser(),
  194. new ExtendsTokenParser(),
  195. new IncludeTokenParser(),
  196. new BlockTokenParser(),
  197. new UseTokenParser(),
  198. new MacroTokenParser(),
  199. new ImportTokenParser(),
  200. new FromTokenParser(),
  201. new SetTokenParser(),
  202. new TypesTokenParser(),
  203. new FlushTokenParser(),
  204. new DoTokenParser(),
  205. new EmbedTokenParser(),
  206. new WithTokenParser(),
  207. new DeprecatedTokenParser(),
  208. ];
  209. }
  211. public function getFilters(): array
  212. {
  213. return [
  214. // formatting filters
  215. new TwigFilter('date', [$this, 'formatDate']),
  216. new TwigFilter('date_modify', [$this, 'modifyDate']),
  217. new TwigFilter('format', [self::class, 'sprintf']),
  218. new TwigFilter('replace', [self::class, 'replace']),
  219. new TwigFilter('number_format', [$this, 'formatNumber']),
  220. new TwigFilter('abs', 'abs'),
  221. new TwigFilter('round', [self::class, 'round']),
  223. // encoding
  224. new TwigFilter('url_encode', [self::class, 'urlencode']),
  225. new TwigFilter('json_encode', 'json_encode'),
  226. new TwigFilter('convert_encoding', [self::class, 'convertEncoding']),
  228. // string filters
  229. new TwigFilter('title', [self::class, 'titleCase'], ['needs_charset' => true]),
  230. new TwigFilter('capitalize', [self::class, 'capitalize'], ['needs_charset' => true]),
  231. new TwigFilter('upper', [self::class, 'upper'], ['needs_charset' => true]),
  232. new TwigFilter('lower', [self::class, 'lower'], ['needs_charset' => true]),
  233. new TwigFilter('striptags', [self::class, 'striptags']),
  234. new TwigFilter('trim', [self::class, 'trim']),
  235. new TwigFilter('nl2br', [self::class, 'nl2br'], ['pre_escape' => 'html', 'is_safe' => ['html']]),
  236. new TwigFilter('spaceless', [self::class, 'spaceless'], ['is_safe' => ['html'], 'deprecated' => '3.12', 'deprecating_package' => 'twig/twig']),
  238. // array helpers
  239. new TwigFilter('join', [self::class, 'join']),
  240. new TwigFilter('split', [self::class, 'split'], ['needs_charset' => true]),
  241. new TwigFilter('sort', [self::class, 'sort'], ['needs_environment' => true]),
  242. new TwigFilter('merge', [self::class, 'merge']),
  243. new TwigFilter('batch', [self::class, 'batch']),
  244. new TwigFilter('column', [self::class, 'column']),
  245. new TwigFilter('filter', [self::class, 'filter'], ['needs_environment' => true]),
  246. new TwigFilter('map', [self::class, 'map'], ['needs_environment' => true]),
  247. new TwigFilter('reduce', [self::class, 'reduce'], ['needs_environment' => true]),
  248. new TwigFilter('find', [self::class, 'find'], ['needs_environment' => true]),
  250. // string/array filters
  251. new TwigFilter('reverse', [self::class, 'reverse'], ['needs_charset' => true]),
  252. new TwigFilter('shuffle', [self::class, 'shuffle'], ['needs_charset' => true]),
  253. new TwigFilter('length', [self::class, 'length'], ['needs_charset' => true]),
  254. new TwigFilter('slice', [self::class, 'slice'], ['needs_charset' => true]),
  255. new TwigFilter('first', [self::class, 'first'], ['needs_charset' => true]),
  256. new TwigFilter('last', [self::class, 'last'], ['needs_charset' => true]),
  258. // iteration and runtime
  259. new TwigFilter('default', [self::class, 'default'], ['node_class' => DefaultFilter::class]),
  260. new TwigFilter('keys', [self::class, 'keys']),
  261. ];
  262. }
  264. public function getFunctions(): array
  265. {
  266. return [
  267. new TwigFunction('parent', null, ['parser_callable' => [self::class, 'parseParentFunction']]),
  268. new TwigFunction('block', null, ['parser_callable' => [self::class, 'parseBlockFunction']]),
  269. new TwigFunction('attribute', null, ['parser_callable' => [self::class, 'parseAttributeFunction']]),
  270. new TwigFunction('max', 'max'),
  271. new TwigFunction('min', 'min'),
  272. new TwigFunction('range', 'range'),
  273. new TwigFunction('constant', [self::class, 'constant']),
  274. new TwigFunction('cycle', [self::class, 'cycle']),
  275. new TwigFunction('random', [self::class, 'random'], ['needs_charset' => true]),
  276. new TwigFunction('date', [$this, 'convertDate']),
  277. new TwigFunction('include', [self::class, 'include'], ['needs_environment' => true, 'needs_context' => true, 'is_safe' => ['all']]),
  278. new TwigFunction('source', [self::class, 'source'], ['needs_environment' => true, 'is_safe' => ['all']]),
  279. new TwigFunction('enum_cases', [self::class, 'enumCases'], ['node_class' => EnumCasesFunction::class]),
  280. ];
  281. }
  283. public function getTests(): array
  284. {
  285. return [
  286. new TwigTest('even', null, ['node_class' => EvenTest::class]),
  287. new TwigTest('odd', null, ['node_class' => OddTest::class]),
  288. new TwigTest('defined', null, ['node_class' => DefinedTest::class]),
  289. new TwigTest('same as', null, ['node_class' => SameasTest::class, 'one_mandatory_argument' => true]),
  290. new TwigTest('none', null, ['node_class' => NullTest::class]),
  291. new TwigTest('null', null, ['node_class' => NullTest::class]),
  292. new TwigTest('divisible by', null, ['node_class' => DivisiblebyTest::class, 'one_mandatory_argument' => true]),
  293. new TwigTest('constant', null, ['node_class' => ConstantTest::class]),
  294. new TwigTest('empty', [self::class, 'testEmpty']),
  295. new TwigTest('iterable', 'is_iterable'),
  296. new TwigTest('sequence', [self::class, 'testSequence']),
  297. new TwigTest('mapping', [self::class, 'testMapping']),
  298. ];
  299. }
  301. public function getNodeVisitors(): array
  302. {
  303. return [new MacroAutoImportNodeVisitor()];
  304. }
  306. public function getOperators(): array
  307. {
  308. return [
  309. [
  310. 'not' => ['precedence' => 50, 'class' => NotUnary::class],
  311. '-' => ['precedence' => 500, 'class' => NegUnary::class],
  312. '+' => ['precedence' => 500, 'class' => PosUnary::class],
  313. ],
  314. [
  315. 'or' => ['precedence' => 10, 'class' => OrBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  316. 'and' => ['precedence' => 15, 'class' => AndBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  317. 'b-or' => ['precedence' => 16, 'class' => BitwiseOrBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  318. 'b-xor' => ['precedence' => 17, 'class' => BitwiseXorBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  319. 'b-and' => ['precedence' => 18, 'class' => BitwiseAndBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  320. '==' => ['precedence' => 20, 'class' => EqualBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  321. '!=' => ['precedence' => 20, 'class' => NotEqualBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  322. '<=>' => ['precedence' => 20, 'class' => SpaceshipBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  323. '<' => ['precedence' => 20, 'class' => LessBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  324. '>' => ['precedence' => 20, 'class' => GreaterBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  325. '>=' => ['precedence' => 20, 'class' => GreaterEqualBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  326. '<=' => ['precedence' => 20, 'class' => LessEqualBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  327. 'not in' => ['precedence' => 20, 'class' => NotInBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  328. 'in' => ['precedence' => 20, 'class' => InBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  329. 'matches' => ['precedence' => 20, 'class' => MatchesBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  330. 'starts with' => ['precedence' => 20, 'class' => StartsWithBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  331. 'ends with' => ['precedence' => 20, 'class' => EndsWithBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  332. 'has some' => ['precedence' => 20, 'class' => HasSomeBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  333. 'has every' => ['precedence' => 20, 'class' => HasEveryBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  334. '..' => ['precedence' => 25, 'class' => RangeBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  335. '+' => ['precedence' => 30, 'class' => AddBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  336. '-' => ['precedence' => 30, 'class' => SubBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  337. '~' => ['precedence' => 40, 'class' => ConcatBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  338. '*' => ['precedence' => 60, 'class' => MulBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  339. '/' => ['precedence' => 60, 'class' => DivBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  340. '//' => ['precedence' => 60, 'class' => FloorDivBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  341. '%' => ['precedence' => 60, 'class' => ModBinary::class, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  342. 'is' => ['precedence' => 100, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  343. 'is not' => ['precedence' => 100, 'associativity' => ExpressionParser::OPERATOR_LEFT],
  344. '**' => ['precedence' => 200, 'class' => PowerBinary::class, 'associativity' => ExpressionParser::OPERATOR_RIGHT],
  345. '??' => ['precedence' => 300, 'class' => NullCoalesceExpression::class, 'associativity' => ExpressionParser::OPERATOR_RIGHT],
  346. ],
  347. ];
  348. }
  350. /**
  351. * Cycles over a sequence.
  352. *
  353. * @param array|\ArrayAccess $values A non-empty sequence of values
  354. * @param positive-int $position The position of the value to return in the cycle
  355. *
  356. * @return mixed The value at the given position in the sequence, wrapping around as needed
  357. *
  358. * @internal
  359. */
  360. public static function cycle($values, $position): mixed
  361. {
  362. if (!\is_array($values)) {
  363. if (!$values instanceof \ArrayAccess) {
  364. throw new RuntimeError('The "cycle" function expects an array or "ArrayAccess" as first argument.');
  365. }
  367. if (!is_countable($values)) {
  368. // To be uncommented in 4.0
  369. // throw new RuntimeError('The "cycle" function expects a countable sequence as first argument.');
  371. trigger_deprecation('twig/twig', '3.12', 'Passing a non-countable sequence of values to "%s()" is deprecated.', __METHOD__);
  373. return $values;
  374. }
  376. $values = self::toArray($values, false);
  377. }
  379. if (!$count = \count($values)) {
  380. throw new RuntimeError('The "cycle" function does not work on empty sequences.');
  381. }
  383. return $values[$position % $count];
  384. }
  386. /**
  387. * Returns a random value depending on the supplied parameter type:
  388. * - a random item from a \Traversable or array
  389. * - a random character from a string
  390. * - a random integer between 0 and the integer parameter.
  391. *
  392. * @param \Traversable|array|int|float|string $values The values to pick a random item from
  393. * @param int|null $max Maximum value used when $values is an int
  394. *
  395. * @return mixed A random value from the given sequence
  396. *
  397. * @throws RuntimeError when $values is an empty array (does not apply to an empty string which is returned as is)
  398. *
  399. * @internal
  400. */
  401. public static function random(string $charset, $values = null, $max = null)
  402. {
  403. if (null === $values) {
  404. return null === $max ? mt_rand() : mt_rand(0, (int) $max);
  405. }
  407. if (\is_int($values) || \is_float($values)) {
  408. if (null === $max) {
  409. if ($values < 0) {
  410. $max = 0;
  411. $min = $values;
  412. } else {
  413. $max = $values;
  414. $min = 0;
  415. }
  416. } else {
  417. $min = $values;
  418. }
  420. return mt_rand((int) $min, (int) $max);
  421. }
  423. if (\is_string($values)) {
  424. if ('' === $values) {
  425. return '';
  426. }
  428. if ('UTF-8' !== $charset) {
  429. $values = self::convertEncoding($values, 'UTF-8', $charset);
  430. }
  432. // unicode version of str_split()
  433. // split at all positions, but not after the start and not before the end
  434. $values = preg_split('/(?<!^)(?!$)/u', $values);
  436. if ('UTF-8' !== $charset) {
  437. foreach ($values as $i => $value) {
  438. $values[$i] = self::convertEncoding($value, $charset, 'UTF-8');
  439. }
  440. }
  441. }
  443. if (!is_iterable($values)) {
  444. return $values;
  445. }
  447. $values = self::toArray($values);
  449. if (0 === \count($values)) {
  450. throw new RuntimeError('The random function cannot pick from an empty sequence/mapping.');
  451. }
  453. return $values[array_rand($values, 1)];
  454. }
  456. /**
  457. * Formats a date.
  458. *
  459. * {{ post.published_at|date("m/d/Y") }}
  460. *
  461. * @param \DateTimeInterface|\DateInterval|string $date A date
  462. * @param string|null $format The target format, null to use the default
  463. * @param \DateTimeZone|string|false|null $timezone The target timezone, null to use the default, false to leave unchanged
  464. */
  465. public function formatDate($date, $format = null, $timezone = null): string
  466. {
  467. if (null === $format) {
  468. $formats = $this->getDateFormat();
  469. $format = $date instanceof \DateInterval ? $formats[1] : $formats[0];
  470. }
  472. if ($date instanceof \DateInterval) {
  473. return $date->format($format);
  474. }
  476. return $this->convertDate($date, $timezone)->format($format);
  477. }
  479. /**
  480. * Returns a new date object modified.
  481. *
  482. * {{ post.published_at|date_modify("-1day")|date("m/d/Y") }}
  483. *
  484. * @param \DateTimeInterface|string $date A date
  485. * @param string $modifier A modifier string
  486. *
  487. * @return \DateTime|\DateTimeImmutable
  488. *
  489. * @internal
  490. */
  491. public function modifyDate($date, $modifier)
  492. {
  493. return $this->convertDate($date, false)->modify($modifier);
  494. }
  496. /**
  497. * Returns a formatted string.
  498. *
  499. * @param string|null $format
  500. * @param ...$values
  501. *
  502. * @internal
  503. */
  504. public static function sprintf($format, ...$values): string
  505. {
  506. return \sprintf($format ?? '', ...$values);
  507. }
  509. /**
  510. * @internal
  511. */
  512. public static function dateConverter(Environment $env, $date, $format = null, $timezone = null): string
  513. {
  514. return $env->getExtension(self::class)->formatDate($date, $format, $timezone);
  515. }
  517. /**
  518. * Converts an input to a \DateTime instance.
  519. *
  520. * {% if date(user.created_at) < date('+2days') %}
  521. * {# do something #}
  522. * {% endif %}
  523. *
  524. * @param \DateTimeInterface|string|null $date A date or null to use the current time
  525. * @param \DateTimeZone|string|false|null $timezone The target timezone, null to use the default, false to leave unchanged
  526. *
  527. * @return \DateTime|\DateTimeImmutable
  528. */
  529. public function convertDate($date = null, $timezone = null)
  530. {
  531. // determine the timezone
  532. if (false !== $timezone) {
  533. if (null === $timezone) {
  534. $timezone = $this->getTimezone();
  535. } elseif (!$timezone instanceof \DateTimeZone) {
  536. $timezone = new \DateTimeZone($timezone);
  537. }
  538. }
  540. // immutable dates
  541. if ($date instanceof \DateTimeImmutable) {
  542. return false !== $timezone ? $date->setTimezone($timezone) : $date;
  543. }
  545. if ($date instanceof \DateTime) {
  546. $date = clone $date;
  547. if (false !== $timezone) {
  548. $date->setTimezone($timezone);
  549. }
  551. return $date;
  552. }
  554. if (null === $date || 'now' === $date) {
  555. if (null === $date) {
  556. $date = 'now';
  557. }
  559. return new \DateTime($date, false !== $timezone ? $timezone : $this->getTimezone());
  560. }
  562. $asString = (string) $date;
  563. if (ctype_digit($asString) || (!empty($asString) && '-' === $asString[0] && ctype_digit(substr($asString, 1)))) {
  564. $date = new \DateTime('@'.$date);
  565. } else {
  566. $date = new \DateTime($date, $this->getTimezone());
  567. }
  569. if (false !== $timezone) {
  570. $date->setTimezone($timezone);
  571. }
  573. return $date;
  574. }
  576. /**
  577. * Replaces strings within a string.
  578. *
  579. * @param string|null $str String to replace in
  580. * @param array|\Traversable $from Replace values
  581. *
  582. * @internal
  583. */
  584. public static function replace($str, $from): string
  585. {
  586. if (!is_iterable($from)) {
  587. 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)));
  588. }
  590. return strtr($str ?? '', self::toArray($from));
  591. }
  593. /**
  594. * Rounds a number.
  595. *
  596. * @param int|float|string|null $value The value to round
  597. * @param int|float $precision The rounding precision
  598. * @param string $method The method to use for rounding
  599. *
  600. * @return int|float The rounded number
  601. *
  602. * @internal
  603. */
  604. public static function round($value, $precision = 0, $method = 'common')
  605. {
  606. $value = (float) $value;
  608. if ('common' === $method) {
  609. return round($value, $precision);
  610. }
  612. if ('ceil' !== $method && 'floor' !== $method) {
  613. throw new RuntimeError('The round filter only supports the "common", "ceil", and "floor" methods.');
  614. }
  616. return $method($value * 10 ** $precision) / 10 ** $precision;
  617. }
  619. /**
  620. * Formats a number.
  621. *
  622. * All of the formatting options can be left null, in that case the defaults will
  623. * be used. Supplying any of the parameters will override the defaults set in the
  624. * environment object.
  625. *
  626. * @param mixed $number A float/int/string of the number to format
  627. * @param int|null $decimal the number of decimal points to display
  628. * @param string|null $decimalPoint the character(s) to use for the decimal point
  629. * @param string|null $thousandSep the character(s) to use for the thousands separator
  630. */
  631. public function formatNumber($number, $decimal = null, $decimalPoint = null, $thousandSep = null): string
  632. {
  633. $defaults = $this->getNumberFormat();
  634. if (null === $decimal) {
  635. $decimal = $defaults[0];
  636. }
  638. if (null === $decimalPoint) {
  639. $decimalPoint = $defaults[1];
  640. }
  642. if (null === $thousandSep) {
  643. $thousandSep = $defaults[2];
  644. }
  646. return number_format((float) $number, $decimal, $decimalPoint, $thousandSep);
  647. }
  649. /**
  650. * URL encodes (RFC 3986) a string as a path segment or an array as a query string.
  651. *
  652. * @param string|array|null $url A URL or an array of query parameters
  653. *
  654. * @internal
  655. */
  656. public static function urlencode($url): string
  657. {
  658. if (\is_array($url)) {
  659. return http_build_query($url, '', '&', \PHP_QUERY_RFC3986);
  660. }
  662. return rawurlencode($url ?? '');
  663. }
  665. /**
  666. * Merges any number of arrays or Traversable objects.
  667. *
  668. * {% set items = { 'apple': 'fruit', 'orange': 'fruit' } %}
  669. *
  670. * {% set items = items|merge({ 'peugeot': 'car' }, { 'banana': 'fruit' }) %}
  671. *
  672. * {# items now contains { 'apple': 'fruit', 'orange': 'fruit', 'peugeot': 'car', 'banana': 'fruit' } #}
  673. *
  674. * @param array|\Traversable ...$arrays Any number of arrays or Traversable objects to merge
  675. *
  676. * @internal
  677. */
  678. public static function merge(...$arrays): array
  679. {
  680. $result = [];
  682. foreach ($arrays as $argNumber => $array) {
  683. if (!is_iterable($array)) {
  684. throw new RuntimeError(\sprintf('The merge filter only works with sequences/mappings or "Traversable", got "%s" for argument %d.', \gettype($array), $argNumber + 1));
  685. }
  687. $result = array_merge($result, self::toArray($array));
  688. }
  690. return $result;
  691. }
  693. /**
  694. * Slices a variable.
  695. *
  696. * @param mixed $item A variable
  697. * @param int $start Start of the slice
  698. * @param int $length Size of the slice
  699. * @param bool $preserveKeys Whether to preserve key or not (when the input is an array)
  700. *
  701. * @return mixed The sliced variable
  702. *
  703. * @internal
  704. */
  705. public static function slice(string $charset, $item, $start, $length = null, $preserveKeys = false)
  706. {
  707. if ($item instanceof \Traversable) {
  708. while ($item instanceof \IteratorAggregate) {
  709. $item = $item->getIterator();
  710. }
  712. if ($start >= 0 && $length >= 0 && $item instanceof \Iterator) {
  713. try {
  714. return iterator_to_array(new \LimitIterator($item, $start, $length ?? -1), $preserveKeys);
  715. } catch (\OutOfBoundsException $e) {
  716. return [];
  717. }
  718. }
  720. $item = iterator_to_array($item, $preserveKeys);
  721. }
  723. if (\is_array($item)) {
  724. return \array_slice($item, $start, $length, $preserveKeys);
  725. }
  727. return mb_substr((string) $item, $start, $length, $charset);
  728. }
  730. /**
  731. * Returns the first element of the item.
  732. *
  733. * @param mixed $item A variable
  734. *
  735. * @return mixed The first element of the item
  736. *
  737. * @internal
  738. */
  739. public static function first(string $charset, $item)
  740. {
  741. $elements = self::slice($charset, $item, 0, 1, false);
  743. return \is_string($elements) ? $elements : current($elements);
  744. }
  746. /**
  747. * Returns the last element of the item.
  748. *
  749. * @param mixed $item A variable
  750. *
  751. * @return mixed The last element of the item
  752. *
  753. * @internal
  754. */
  755. public static function last(string $charset, $item)
  756. {
  757. $elements = self::slice($charset, $item, -1, 1, false);
  759. return \is_string($elements) ? $elements : current($elements);
  760. }
  762. /**
  763. * Joins the values to a string.
  764. *
  765. * The separators between elements are empty strings per default, you can define them with the optional parameters.
  766. *
  767. * {{ [1, 2, 3]|join(', ', ' and ') }}
  768. * {# returns 1, 2 and 3 #}
  769. *
  770. * {{ [1, 2, 3]|join('|') }}
  771. * {# returns 1|2|3 #}
  772. *
  773. * {{ [1, 2, 3]|join }}
  774. * {# returns 123 #}
  775. *
  776. * @param array $value An array
  777. * @param string $glue The separator
  778. * @param string|null $and The separator for the last pair
  779. *
  780. * @internal
  781. */
  782. public static function join($value, $glue = '', $and = null): string
  783. {
  784. if (!is_iterable($value)) {
  785. $value = (array) $value;
  786. }
  788. $value = self::toArray($value, false);
  790. if (0 === \count($value)) {
  791. return '';
  792. }
  794. if (null === $and || $and === $glue) {
  795. return implode($glue, $value);
  796. }
  798. if (1 === \count($value)) {
  799. return $value[0];
  800. }
  802. return implode($glue, \array_slice($value, 0, -1)).$and.$value[\count($value) - 1];
  803. }
  805. /**
  806. * Splits the string into an array.
  807. *
  808. * {{ "one,two,three"|split(',') }}
  809. * {# returns [one, two, three] #}
  810. *
  811. * {{ "one,two,three,four,five"|split(',', 3) }}
  812. * {# returns [one, two, "three,four,five"] #}
  813. *
  814. * {{ "123"|split('') }}
  815. * {# returns [1, 2, 3] #}
  816. *
  817. * {{ "aabbcc"|split('', 2) }}
  818. * {# returns [aa, bb, cc] #}
  819. *
  820. * @param string|null $value A string
  821. * @param string $delimiter The delimiter
  822. * @param int|null $limit The limit
  823. *
  824. * @internal
  825. */
  826. public static function split(string $charset, $value, $delimiter, $limit = null): array
  827. {
  828. $value = $value ?? '';
  830. if ('' !== $delimiter) {
  831. return null === $limit ? explode($delimiter, $value) : explode($delimiter, $value, $limit);
  832. }
  834. if ($limit <= 1) {
  835. return preg_split('/(?<!^)(?!$)/u', $value);
  836. }
  838. $length = mb_strlen($value, $charset);
  839. if ($length < $limit) {
  840. return [$value];
  841. }
  843. $r = [];
  844. for ($i = 0; $i < $length; $i += $limit) {
  845. $r[] = mb_substr($value, $i, $limit, $charset);
  846. }
  848. return $r;
  849. }
  851. /**
  852. * @internal
  853. */
  854. public static function default($value, $default = '')
  855. {
  856. if (self::testEmpty($value)) {
  857. return $default;
  858. }
  860. return $value;
  861. }
  863. /**
  864. * Returns the keys for the given array.
  865. *
  866. * It is useful when you want to iterate over the keys of an array:
  867. *
  868. * {% for key in array|keys %}
  869. * {# ... #}
  870. * {% endfor %}
  871. *
  872. * @internal
  873. */
  874. public static function keys($array): array
  875. {
  876. if ($array instanceof \Traversable) {
  877. while ($array instanceof \IteratorAggregate) {
  878. $array = $array->getIterator();
  879. }
  881. $keys = [];
  882. if ($array instanceof \Iterator) {
  883. $array->rewind();
  884. while ($array->valid()) {
  885. $keys[] = $array->key();
  886. $array->next();
  887. }
  889. return $keys;
  890. }
  892. foreach ($array as $key => $item) {
  893. $keys[] = $key;
  894. }
  896. return $keys;
  897. }
  899. if (!\is_array($array)) {
  900. return [];
  901. }
  903. return array_keys($array);
  904. }
  906. /**
  907. * Reverses a variable.
  908. *
  909. * @param array|\Traversable|string|null $item An array, a \Traversable instance, or a string
  910. * @param bool $preserveKeys Whether to preserve key or not
  911. *
  912. * @return mixed The reversed input
  913. *
  914. * @internal
  915. */
  916. public static function reverse(string $charset, $item, $preserveKeys = false)
  917. {
  918. if ($item instanceof \Traversable) {
  919. return array_reverse(iterator_to_array($item), $preserveKeys);
  920. }
  922. if (\is_array($item)) {
  923. return array_reverse($item, $preserveKeys);
  924. }
  926. $string = (string) $item;
  928. if ('UTF-8' !== $charset) {
  929. $string = self::convertEncoding($string, 'UTF-8', $charset);
  930. }
  932. preg_match_all('/./us', $string, $matches);
  934. $string = implode('', array_reverse($matches[0]));
  936. if ('UTF-8' !== $charset) {
  937. $string = self::convertEncoding($string, $charset, 'UTF-8');
  938. }
  940. return $string;
  941. }
  943. /**
  944. * Shuffles an array, a \Traversable instance, or a string.
  945. * The function does not preserve keys.
  946. *
  947. * @param array|\Traversable|string|null $item
  948. *
  949. * @return mixed
  950. *
  951. * @internal
  952. */
  953. public static function shuffle(string $charset, $item)
  954. {
  955. if (\is_string($item)) {
  956. if ('UTF-8' !== $charset) {
  957. $item = self::convertEncoding($item, 'UTF-8', $charset);
  958. }
  960. $item = preg_split('/(?<!^)(?!$)/u', $item, -1);
  961. shuffle($item);
  962. $item = implode('', $item);
  964. if ('UTF-8' !== $charset) {
  965. $item = self::convertEncoding($item, $charset, 'UTF-8');
  966. }
  968. return $item;
  969. }
  971. if (is_iterable($item)) {
  972. $item = self::toArray($item, false);
  973. shuffle($item);
  974. }
  976. return $item;
  977. }
  979. /**
  980. * Sorts an array.
  981. *
  982. * @param array|\Traversable $array
  983. *
  984. * @internal
  985. */
  986. public static function sort(Environment $env, $array, $arrow = null): array
  987. {
  988. if ($array instanceof \Traversable) {
  989. $array = iterator_to_array($array);
  990. } elseif (!\is_array($array)) {
  991. throw new RuntimeError(\sprintf('The sort filter only works with sequences/mappings or "Traversable", got "%s".', \gettype($array)));
  992. }
  994. if (null !== $arrow) {
  995. self::checkArrowInSandbox($env, $arrow, 'sort', 'filter');
  997. uasort($array, $arrow);
  998. } else {
  999. asort($array);
  1000. }
  1002. return $array;
  1003. }
  1005. /**
  1006. * @internal
  1007. */
  1008. public static function inFilter($value, $compare)
  1009. {
  1010. if ($value instanceof Markup) {
  1011. $value = (string) $value;
  1012. }
  1013. if ($compare instanceof Markup) {
  1014. $compare = (string) $compare;
  1015. }
  1017. if (\is_string($compare)) {
  1018. if (\is_string($value) || \is_int($value) || \is_float($value)) {
  1019. return '' === $value || str_contains($compare, (string) $value);
  1020. }
  1022. return false;
  1023. }
  1025. if (!is_iterable($compare)) {
  1026. return false;
  1027. }
  1029. if (\is_object($value) || \is_resource($value)) {
  1030. if (!\is_array($compare)) {
  1031. foreach ($compare as $item) {
  1032. if ($item === $value) {
  1033. return true;
  1034. }
  1035. }
  1037. return false;
  1038. }
  1040. return \in_array($value, $compare, true);
  1041. }
  1043. foreach ($compare as $item) {
  1044. if (0 === self::compare($value, $item)) {
  1045. return true;
  1046. }
  1047. }
  1049. return false;
  1050. }
  1052. /**
  1053. * Compares two values using a more strict version of the PHP non-strict comparison operator.
  1054. *
  1055. * @see https://wiki.php.net/rfc/string_to_number_comparison
  1056. * @see https://wiki.php.net/rfc/trailing_whitespace_numerics
  1057. *
  1058. * @internal
  1059. */
  1060. public static function compare($a, $b)
  1061. {
  1062. // int <=> string
  1063. if (\is_int($a) && \is_string($b)) {
  1064. $bTrim = trim($b, " \t\n\r\v\f");
  1065. if (!is_numeric($bTrim)) {
  1066. return (string) $a <=> $b;
  1067. }
  1068. if ((int) $bTrim == $bTrim) {
  1069. return $a <=> (int) $bTrim;
  1070. } else {
  1071. return (float) $a <=> (float) $bTrim;
  1072. }
  1073. }
  1074. if (\is_string($a) && \is_int($b)) {
  1075. $aTrim = trim($a, " \t\n\r\v\f");
  1076. if (!is_numeric($aTrim)) {
  1077. return $a <=> (string) $b;
  1078. }
  1079. if ((int) $aTrim == $aTrim) {
  1080. return (int) $aTrim <=> $b;
  1081. } else {
  1082. return (float) $aTrim <=> (float) $b;
  1083. }
  1084. }
  1086. // float <=> string
  1087. if (\is_float($a) && \is_string($b)) {
  1088. if (is_nan($a)) {
  1089. return 1;
  1090. }
  1091. $bTrim = trim($b, " \t\n\r\v\f");
  1092. if (!is_numeric($bTrim)) {
  1093. return (string) $a <=> $b;
  1094. }
  1096. return $a <=> (float) $bTrim;
  1097. }
  1098. if (\is_string($a) && \is_float($b)) {
  1099. if (is_nan($b)) {
  1100. return 1;
  1101. }
  1102. $aTrim = trim($a, " \t\n\r\v\f");
  1103. if (!is_numeric($aTrim)) {
  1104. return $a <=> (string) $b;
  1105. }
  1107. return (float) $aTrim <=> $b;
  1108. }
  1110. // fallback to <=>
  1111. return $a <=> $b;
  1112. }
  1114. /**
  1115. * @throws RuntimeError When an invalid pattern is used
  1116. *
  1117. * @internal
  1118. */
  1119. public static function matches(string $regexp, ?string $str): int
  1120. {
  1121. set_error_handler(function ($t, $m) use ($regexp) {
  1122. throw new RuntimeError(\sprintf('Regexp "%s" passed to "matches" is not valid', $regexp).substr($m, 12));
  1123. });
  1124. try {
  1125. return preg_match($regexp, $str ?? '');
  1126. } finally {
  1127. restore_error_handler();
  1128. }
  1129. }
  1131. /**
  1132. * Returns a trimmed string.
  1133. *
  1134. * @param string|null $string
  1135. * @param string|null $characterMask
  1136. * @param string $side
  1137. *
  1138. * @throws RuntimeError When an invalid trimming side is used (not a string or not 'left', 'right', or 'both')
  1139. *
  1140. * @internal
  1141. */
  1142. public static function trim($string, $characterMask = null, $side = 'both'): string
  1143. {
  1144. if (null === $characterMask) {
  1145. $characterMask = " \t\n\r\0\x0B";
  1146. }
  1148. switch ($side) {
  1149. case 'both':
  1150. return trim($string ?? '', $characterMask);
  1151. case 'left':
  1152. return ltrim($string ?? '', $characterMask);
  1153. case 'right':
  1154. return rtrim($string ?? '', $characterMask);
  1155. default:
  1156. throw new RuntimeError('Trimming side must be "left", "right" or "both".');
  1157. }
  1158. }
  1160. /**
  1161. * Inserts HTML line breaks before all newlines in a string.
  1162. *
  1163. * @param string|null $string
  1164. *
  1165. * @internal
  1166. */
  1167. public static function nl2br($string): string
  1168. {
  1169. return nl2br($string ?? '');
  1170. }
  1172. /**
  1173. * Removes whitespaces between HTML tags.
  1174. *
  1175. * @param string|null $content
  1176. *
  1177. * @internal
  1178. */
  1179. public static function spaceless($content): string
  1180. {
  1181. return trim(preg_replace('/>\s+</', '><', $content ?? ''));
  1182. }
  1184. /**
  1185. * @param string|null $string
  1186. * @param string $to
  1187. * @param string $from
  1188. *
  1189. * @internal
  1190. */
  1191. public static function convertEncoding($string, $to, $from): string
  1192. {
  1193. if (!\function_exists('iconv')) {
  1194. throw new RuntimeError('Unable to convert encoding: required function iconv() does not exist. You should install ext-iconv or symfony/polyfill-iconv.');
  1195. }
  1197. return iconv($from, $to, $string ?? '');
  1198. }
  1200. /**
  1201. * Returns the length of a variable.
  1202. *
  1203. * @param mixed $thing A variable
  1204. *
  1205. * @internal
  1206. */
  1207. public static function length(string $charset, $thing): int
  1208. {
  1209. if (null === $thing) {
  1210. return 0;
  1211. }
  1213. if (\is_scalar($thing)) {
  1214. return mb_strlen($thing, $charset);
  1215. }
  1217. if ($thing instanceof \Countable || \is_array($thing) || $thing instanceof \SimpleXMLElement) {
  1218. return \count($thing);
  1219. }
  1221. if ($thing instanceof \Traversable) {
  1222. return iterator_count($thing);
  1223. }
  1225. if ($thing instanceof \Stringable) {
  1226. return mb_strlen((string) $thing, $charset);
  1227. }
  1229. return 1;
  1230. }
  1232. /**
  1233. * Converts a string to uppercase.
  1234. *
  1235. * @param string|null $string A string
  1236. *
  1237. * @internal
  1238. */
  1239. public static function upper(string $charset, $string): string
  1240. {
  1241. return mb_strtoupper($string ?? '', $charset);
  1242. }
  1244. /**
  1245. * Converts a string to lowercase.
  1246. *
  1247. * @param string|null $string A string
  1248. *
  1249. * @internal
  1250. */
  1251. public static function lower(string $charset, $string): string
  1252. {
  1253. return mb_strtolower($string ?? '', $charset);
  1254. }
  1256. /**
  1257. * Strips HTML and PHP tags from a string.
  1258. *
  1259. * @param string|null $string
  1260. * @param string[]|string|null $allowable_tags
  1261. *
  1262. * @internal
  1263. */
  1264. public static function striptags($string, $allowable_tags = null): string
  1265. {
  1266. return strip_tags($string ?? '', $allowable_tags);
  1267. }
  1269. /**
  1270. * Returns a titlecased string.
  1271. *
  1272. * @param string|null $string A string
  1273. *
  1274. * @internal
  1275. */
  1276. public static function titleCase(string $charset, $string): string
  1277. {
  1278. return mb_convert_case($string ?? '', \MB_CASE_TITLE, $charset);
  1279. }
  1281. /**
  1282. * Returns a capitalized string.
  1283. *
  1284. * @param string|null $string A string
  1285. *
  1286. * @internal
  1287. */
  1288. public static function capitalize(string $charset, $string): string
  1289. {
  1290. return mb_strtoupper(mb_substr($string ?? '', 0, 1, $charset), $charset).mb_strtolower(mb_substr($string ?? '', 1, null, $charset), $charset);
  1291. }
  1293. /**
  1294. * @internal
  1295. */
  1296. public static function callMacro(Template $template, string $method, array $args, int $lineno, array $context, Source $source)
  1297. {
  1298. if (!method_exists($template, $method)) {
  1299. $parent = $template;
  1300. while ($parent = $parent->getParent($context)) {
  1301. if (method_exists($parent, $method)) {
  1302. return $parent->$method(...$args);
  1303. }
  1304. }
  1306. throw new RuntimeError(\sprintf('Macro "%s" is not defined in template "%s".', substr($method, \strlen('macro_')), $template->getTemplateName()), $lineno, $source);
  1307. }
  1309. return $template->$method(...$args);
  1310. }
  1312. /**
  1313. * @template TSequence
  1314. *
  1315. * @param TSequence $seq
  1316. *
  1317. * @return ($seq is iterable ? TSequence : array{})
  1318. *
  1319. * @internal
  1320. */
  1321. public static function ensureTraversable($seq)
  1322. {
  1323. if (is_iterable($seq)) {
  1324. return $seq;
  1325. }
  1327. return [];
  1328. }
  1330. /**
  1331. * @internal
  1332. */
  1333. public static function toArray($seq, $preserveKeys = true)
  1334. {
  1335. if ($seq instanceof \Traversable) {
  1336. return iterator_to_array($seq, $preserveKeys);
  1337. }
  1339. if (!\is_array($seq)) {
  1340. return $seq;
  1341. }
  1343. return $preserveKeys ? $seq : array_values($seq);
  1344. }
  1346. /**
  1347. * Checks if a variable is empty.
  1348. *
  1349. * {# evaluates to true if the foo variable is null, false, or the empty string #}
  1350. * {% if foo is empty %}
  1351. * {# ... #}
  1352. * {% endif %}
  1353. *
  1354. * @param mixed $value A variable
  1355. *
  1356. * @internal
  1357. */
  1358. public static function testEmpty($value): bool
  1359. {
  1360. if ($value instanceof \Countable) {
  1361. return 0 === \count($value);
  1362. }
  1364. if ($value instanceof \Traversable) {
  1365. return !iterator_count($value);
  1366. }
  1368. if ($value instanceof \Stringable) {
  1369. return '' === (string) $value;
  1370. }
  1372. return '' === $value || false === $value || null === $value || [] === $value;
  1373. }
  1375. /**
  1376. * Checks if a variable is a sequence.
  1377. *
  1378. * {# evaluates to true if the foo variable is a sequence #}
  1379. * {% if foo is sequence %}
  1380. * {# ... #}
  1381. * {% endif %}
  1382. *
  1383. * @param mixed $value
  1384. *
  1385. * @internal
  1386. */
  1387. public static function testSequence($value): bool
  1388. {
  1389. if ($value instanceof \ArrayObject) {
  1390. $value = $value->getArrayCopy();
  1391. }
  1393. if ($value instanceof \Traversable) {
  1394. $value = iterator_to_array($value);
  1395. }
  1397. return \is_array($value) && array_is_list($value);
  1398. }
  1400. /**
  1401. * Checks if a variable is a mapping.
  1402. *
  1403. * {# evaluates to true if the foo variable is a mapping #}
  1404. * {% if foo is mapping %}
  1405. * {# ... #}
  1406. * {% endif %}
  1407. *
  1408. * @param mixed $value
  1409. *
  1410. * @internal
  1411. */
  1412. public static function testMapping($value): bool
  1413. {
  1414. if ($value instanceof \ArrayObject) {
  1415. $value = $value->getArrayCopy();
  1416. }
  1418. if ($value instanceof \Traversable) {
  1419. $value = iterator_to_array($value);
  1420. }
  1422. return (\is_array($value) && !array_is_list($value)) || \is_object($value);
  1423. }
  1425. /**
  1426. * Renders a template.
  1427. *
  1428. * @param array $context
  1429. * @param string|array|TemplateWrapper $template The template to render or an array of templates to try consecutively
  1430. * @param array $variables The variables to pass to the template
  1431. * @param bool $withContext
  1432. * @param bool $ignoreMissing Whether to ignore missing templates or not
  1433. * @param bool $sandboxed Whether to sandbox the template or not
  1434. *
  1435. * @internal
  1436. */
  1437. public static function include(Environment $env, $context, $template, $variables = [], $withContext = true, $ignoreMissing = false, $sandboxed = false): string
  1438. {
  1439. $alreadySandboxed = false;
  1440. $sandbox = null;
  1441. if ($withContext) {
  1442. $variables = array_merge($context, $variables);
  1443. }
  1445. if ($isSandboxed = $sandboxed && $env->hasExtension(SandboxExtension::class)) {
  1446. $sandbox = $env->getExtension(SandboxExtension::class);
  1447. if (!$alreadySandboxed = $sandbox->isSandboxed()) {
  1448. $sandbox->enableSandbox();
  1449. }
  1450. }
  1452. try {
  1453. $loaded = null;
  1454. try {
  1455. $loaded = $env->resolveTemplate($template);
  1456. } catch (LoaderError $e) {
  1457. if (!$ignoreMissing) {
  1458. throw $e;
  1459. }
  1461. return '';
  1462. }
  1464. if ($isSandboxed) {
  1465. $loaded->unwrap()->checkSecurity();
  1466. }
  1468. return $loaded->render($variables);
  1469. } finally {
  1470. if ($isSandboxed && !$alreadySandboxed) {
  1471. $sandbox->disableSandbox();
  1472. }
  1473. }
  1474. }
  1476. /**
  1477. * Returns a template content without rendering it.
  1478. *
  1479. * @param string $name The template name
  1480. * @param bool $ignoreMissing Whether to ignore missing templates or not
  1481. *
  1482. * @internal
  1483. */
  1484. public static function source(Environment $env, $name, $ignoreMissing = false): string
  1485. {
  1486. $loader = $env->getLoader();
  1487. try {
  1488. return $loader->getSourceContext($name)->getCode();
  1489. } catch (LoaderError $e) {
  1490. if (!$ignoreMissing) {
  1491. throw $e;
  1492. }
  1494. return '';
  1495. }
  1496. }
  1498. /**
  1499. * Returns the list of cases of the enum.
  1500. *
  1501. * @template T of \UnitEnum
  1502. *
  1503. * @param class-string<T> $enum
  1504. *
  1505. * @return list<T>
  1506. *
  1507. * @internal
  1508. */
  1509. public static function enumCases(string $enum): array
  1510. {
  1511. if (!enum_exists($enum)) {
  1512. throw new RuntimeError(\sprintf('Enum "%s" does not exist.', $enum));
  1513. }
  1515. return $enum::cases();
  1516. }
  1518. /**
  1519. * Provides the ability to get constants from instances as well as class/global constants.
  1520. *
  1521. * @param string $constant The name of the constant
  1522. * @param object|null $object The object to get the constant from
  1523. * @param bool $checkDefined Whether to check if the constant is defined or not
  1524. *
  1525. * @return mixed Class constants can return many types like scalars, arrays, and
  1526. * objects depending on the PHP version (\BackedEnum, \UnitEnum, etc.)
  1527. * When $checkDefined is true, returns true when the constant is defined, false otherwise
  1528. *
  1529. * @internal
  1530. */
  1531. public static function constant($constant, $object = null, bool $checkDefined = false)
  1532. {
  1533. if (null !== $object) {
  1534. if ('class' === $constant) {
  1535. return $checkDefined ? true : \get_class($object);
  1536. }
  1538. $constant = \get_class($object).'::'.$constant;
  1539. }
  1541. if (!\defined($constant)) {
  1542. if ($checkDefined) {
  1543. return false;
  1544. }
  1546. if ('::class' === strtolower(substr($constant, -7))) {
  1547. 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));
  1548. }
  1550. throw new RuntimeError(\sprintf('Constant "%s" is undefined.', $constant));
  1551. }
  1553. return $checkDefined ? true : \constant($constant);
  1554. }
  1556. /**
  1557. * Batches item.
  1558. *
  1559. * @param array $items An array of items
  1560. * @param int $size The size of the batch
  1561. * @param mixed $fill A value used to fill missing items
  1562. *
  1563. * @internal
  1564. */
  1565. public static function batch($items, $size, $fill = null, $preserveKeys = true): array
  1566. {
  1567. if (!is_iterable($items)) {
  1568. throw new RuntimeError(\sprintf('The "batch" filter expects a sequence/mapping or "Traversable", got "%s".', \is_object($items) ? \get_class($items) : \gettype($items)));
  1569. }
  1571. $size = (int) ceil($size);
  1573. $result = array_chunk(self::toArray($items, $preserveKeys), $size, $preserveKeys);
  1575. if (null !== $fill && $result) {
  1576. $last = \count($result) - 1;
  1577. if ($fillCount = $size - \count($result[$last])) {
  1578. for ($i = 0; $i < $fillCount; ++$i) {
  1579. $result[$last][] = $fill;
  1580. }
  1581. }
  1582. }
  1584. return $result;
  1585. }
  1587. /**
  1588. * Returns the attribute value for a given array/object.
  1589. *
  1590. * @param mixed $object The object or array from where to get the item
  1591. * @param mixed $item The item to get from the array or object
  1592. * @param array $arguments An array of arguments to pass if the item is an object method
  1593. * @param string $type The type of attribute (@see \Twig\Template constants)
  1594. * @param bool $isDefinedTest Whether this is only a defined check
  1595. * @param bool $ignoreStrictCheck Whether to ignore the strict attribute check or not
  1596. * @param int $lineno The template line where the attribute was called
  1597. *
  1598. * @return mixed The attribute value, or a Boolean when $isDefinedTest is true, or null when the attribute is not set and $ignoreStrictCheck is true
  1599. *
  1600. * @throws RuntimeError if the attribute does not exist and Twig is running in strict mode and $isDefinedTest is false
  1601. *
  1602. * @internal
  1603. */
  1604. 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)
  1605. {
  1606. $propertyNotAllowedError = null;
  1608. // array
  1609. if (Template::METHOD_CALL !== $type) {
  1610. $arrayItem = \is_bool($item) || \is_float($item) ? (int) $item : $item;
  1612. if ($sandboxed && $object instanceof \ArrayAccess && !\in_array($object::class, self::ARRAY_LIKE_CLASSES, true)) {
  1613. try {
  1614. $env->getExtension(SandboxExtension::class)->checkPropertyAllowed($object, $arrayItem, $lineno, $source);
  1615. } catch (SecurityNotAllowedPropertyError $propertyNotAllowedError) {
  1616. goto methodCheck;
  1617. }
  1618. }
  1620. if (((\is_array($object) || $object instanceof \ArrayObject) && (isset($object[$arrayItem]) || \array_key_exists($arrayItem, (array) $object)))
  1621. || ($object instanceof \ArrayAccess && isset($object[$arrayItem]))
  1622. ) {
  1623. if ($isDefinedTest) {
  1624. return true;
  1625. }
  1627. return $object[$arrayItem];
  1628. }
  1630. if (Template::ARRAY_CALL === $type || !\is_object($object)) {
  1631. if ($isDefinedTest) {
  1632. return false;
  1633. }
  1635. if ($ignoreStrictCheck || !$env->isStrictVariables()) {
  1636. return;
  1637. }
  1639. if ($object instanceof \ArrayAccess) {
  1640. $message = \sprintf('Key "%s" in object with ArrayAccess of class "%s" does not exist.', $arrayItem, \get_class($object));
  1641. } elseif (\is_object($object)) {
  1642. $message = \sprintf('Impossible to access a key "%s" on an object of class "%s" that does not implement ArrayAccess interface.', $item, \get_class($object));
  1643. } elseif (\is_array($object)) {
  1644. if (empty($object)) {
  1645. $message = \sprintf('Key "%s" does not exist as the sequence/mapping is empty.', $arrayItem);
  1646. } else {
  1647. $message = \sprintf('Key "%s" for sequence/mapping with keys "%s" does not exist.', $arrayItem, implode(', ', array_keys($object)));
  1648. }
  1649. } elseif (Template::ARRAY_CALL === $type) {
  1650. if (null === $object) {
  1651. $message = \sprintf('Impossible to access a key ("%s") on a null variable.', $item);
  1652. } else {
  1653. $message = \sprintf('Impossible to access a key ("%s") on a %s variable ("%s").', $item, \gettype($object), $object);
  1654. }
  1655. } elseif (null === $object) {
  1656. $message = \sprintf('Impossible to access an attribute ("%s") on a null variable.', $item);
  1657. } else {
  1658. $message = \sprintf('Impossible to access an attribute ("%s") on a %s variable ("%s").', $item, \gettype($object), $object);
  1659. }
  1661. throw new RuntimeError($message, $lineno, $source);
  1662. }
  1663. }
  1665. if (!\is_object($object)) {
  1666. if ($isDefinedTest) {
  1667. return false;
  1668. }
  1670. if ($ignoreStrictCheck || !$env->isStrictVariables()) {
  1671. return;
  1672. }
  1674. if (null === $object) {
  1675. $message = \sprintf('Impossible to invoke a method ("%s") on a null variable.', $item);
  1676. } elseif (\is_array($object)) {
  1677. $message = \sprintf('Impossible to invoke a method ("%s") on a sequence/mapping.', $item);
  1678. } else {
  1679. $message = \sprintf('Impossible to invoke a method ("%s") on a %s variable ("%s").', $item, \gettype($object), $object);
  1680. }
  1682. throw new RuntimeError($message, $lineno, $source);
  1683. }
  1685. if ($object instanceof Template) {
  1686. throw new RuntimeError('Accessing \Twig\Template attributes is forbidden.', $lineno, $source);
  1687. }
  1689. // object property
  1690. if (Template::METHOD_CALL !== $type) {
  1691. if ($sandboxed) {
  1692. try {
  1693. $env->getExtension(SandboxExtension::class)->checkPropertyAllowed($object, $item, $lineno, $source);
  1694. } catch (SecurityNotAllowedPropertyError $propertyNotAllowedError) {
  1695. goto methodCheck;
  1696. }
  1697. }
  1699. if (isset($object->$item) || \array_key_exists((string) $item, (array) $object)) {
  1700. if ($isDefinedTest) {
  1701. return true;
  1702. }
  1704. return $object->$item;
  1705. }
  1706. }
  1708. methodCheck:
  1710. static $cache = [];
  1712. $class = \get_class($object);
  1714. // object method
  1715. // precedence: getXxx() > isXxx() > hasXxx()
  1716. if (!isset($cache[$class])) {
  1717. $methods = get_class_methods($object);
  1718. sort($methods);
  1719. $lcMethods = array_map(function ($value) { return strtr($value, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz'); }, $methods);
  1720. $classCache = [];
  1721. foreach ($methods as $i => $method) {
  1722. $classCache[$method] = $method;
  1723. $classCache[$lcName = $lcMethods[$i]] = $method;
  1725. if ('g' === $lcName[0] && str_starts_with($lcName, 'get')) {
  1726. $name = substr($method, 3);
  1727. $lcName = substr($lcName, 3);
  1728. } elseif ('i' === $lcName[0] && str_starts_with($lcName, 'is')) {
  1729. $name = substr($method, 2);
  1730. $lcName = substr($lcName, 2);
  1731. } elseif ('h' === $lcName[0] && str_starts_with($lcName, 'has')) {
  1732. $name = substr($method, 3);
  1733. $lcName = substr($lcName, 3);
  1734. if (\in_array('is'.$lcName, $lcMethods)) {
  1735. continue;
  1736. }
  1737. } else {
  1738. continue;
  1739. }
  1741. // skip get() and is() methods (in which case, $name is empty)
  1742. if ($name) {
  1743. if (!isset($classCache[$name])) {
  1744. $classCache[$name] = $method;
  1745. }
  1747. if (!isset($classCache[$lcName])) {
  1748. $classCache[$lcName] = $method;
  1749. }
  1750. }
  1751. }
  1752. $cache[$class] = $classCache;
  1753. }
  1755. $call = false;
  1756. if (isset($cache[$class][$item])) {
  1757. $method = $cache[$class][$item];
  1758. } elseif (isset($cache[$class][$lcItem = strtr($item, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz')])) {
  1759. $method = $cache[$class][$lcItem];
  1760. } elseif (isset($cache[$class]['__call'])) {
  1761. $method = $item;
  1762. $call = true;
  1763. } else {
  1764. if ($isDefinedTest) {
  1765. return false;
  1766. }
  1768. if ($propertyNotAllowedError) {
  1769. throw $propertyNotAllowedError;
  1770. }
  1772. if ($ignoreStrictCheck || !$env->isStrictVariables()) {
  1773. return;
  1774. }
  1776. 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);
  1777. }
  1779. if ($sandboxed) {
  1780. try {
  1781. $env->getExtension(SandboxExtension::class)->checkMethodAllowed($object, $method, $lineno, $source);
  1782. } catch (SecurityNotAllowedMethodError $e) {
  1783. if ($isDefinedTest) {
  1784. return false;
  1785. }
  1787. if ($propertyNotAllowedError) {
  1788. throw $propertyNotAllowedError;
  1789. }
  1791. throw $e;
  1792. }
  1793. }
  1795. if ($isDefinedTest) {
  1796. return true;
  1797. }
  1799. // Some objects throw exceptions when they have __call, and the method we try
  1800. // to call is not supported. If ignoreStrictCheck is true, we should return null.
  1801. try {
  1802. $ret = $object->$method(...$arguments);
  1803. } catch (\BadMethodCallException $e) {
  1804. if ($call && ($ignoreStrictCheck || !$env->isStrictVariables())) {
  1805. return;
  1806. }
  1807. throw $e;
  1808. }
  1810. return $ret;
  1811. }
  1813. /**
  1814. * Returns the values from a single column in the input array.
  1815. *
  1816. * <pre>
  1817. * {% set items = [{ 'fruit' : 'apple'}, {'fruit' : 'orange' }] %}
  1818. *
  1819. * {% set fruits = items|column('fruit') %}
  1820. *
  1821. * {# fruits now contains ['apple', 'orange'] #}
  1822. * </pre>
  1823. *
  1824. * @param array|\Traversable $array An array
  1825. * @param int|string $name The column name
  1826. * @param int|string|null $index The column to use as the index/keys for the returned array
  1827. *
  1828. * @return array The array of values
  1829. *
  1830. * @internal
  1831. */
  1832. public static function column($array, $name, $index = null): array
  1833. {
  1834. if ($array instanceof \Traversable) {
  1835. $array = iterator_to_array($array);
  1836. } elseif (!\is_array($array)) {
  1837. throw new RuntimeError(\sprintf('The column filter only works with sequences/mappings or "Traversable", got "%s" as first argument.', \gettype($array)));
  1838. }
  1840. return array_column($array, $name, $index);
  1841. }
  1843. /**
  1844. * @internal
  1845. */
  1846. public static function filter(Environment $env, $array, $arrow)
  1847. {
  1848. if (!is_iterable($array)) {
  1849. throw new RuntimeError(\sprintf('The "filter" filter expects a sequence/mapping or "Traversable", got "%s".', \is_object($array) ? \get_class($array) : \gettype($array)));
  1850. }
  1852. self::checkArrowInSandbox($env, $arrow, 'filter', 'filter');
  1854. if (\is_array($array)) {
  1855. return array_filter($array, $arrow, \ARRAY_FILTER_USE_BOTH);
  1856. }
  1858. // the IteratorIterator wrapping is needed as some internal PHP classes are \Traversable but do not implement \Iterator
  1859. return new \CallbackFilterIterator(new \IteratorIterator($array), $arrow);
  1860. }
  1862. /**
  1863. * @internal
  1864. */
  1865. public static function find(Environment $env, $array, $arrow)
  1866. {
  1867. self::checkArrowInSandbox($env, $arrow, 'find', 'filter');
  1869. foreach ($array as $k => $v) {
  1870. if ($arrow($v, $k)) {
  1871. return $v;
  1872. }
  1873. }
  1875. return null;
  1876. }
  1878. /**
  1879. * @internal
  1880. */
  1881. public static function map(Environment $env, $array, $arrow)
  1882. {
  1883. if (!is_iterable($array)) {
  1884. throw new RuntimeError(\sprintf('The "map" filter expects a sequence/mapping or "Traversable", got "%s".', get_debug_type($array)));
  1885. }
  1887. self::checkArrowInSandbox($env, $arrow, 'map', 'filter');
  1889. $r = [];
  1890. foreach ($array as $k => $v) {
  1891. $r[$k] = $arrow($v, $k);
  1892. }
  1894. return $r;
  1895. }
  1897. /**
  1898. * @internal
  1899. */
  1900. public static function reduce(Environment $env, $array, $arrow, $initial = null)
  1901. {
  1902. self::checkArrowInSandbox($env, $arrow, 'reduce', 'filter');
  1904. if (!\is_array($array) && !$array instanceof \Traversable) {
  1905. throw new RuntimeError(\sprintf('The "reduce" filter only works with sequences/mappings or "Traversable", got "%s" as first argument.', \gettype($array)));
  1906. }
  1908. $accumulator = $initial;
  1909. foreach ($array as $key => $value) {
  1910. $accumulator = $arrow($accumulator, $value, $key);
  1911. }
  1913. return $accumulator;
  1914. }
  1916. /**
  1917. * @internal
  1918. */
  1919. public static function arraySome(Environment $env, $array, $arrow)
  1920. {
  1921. self::checkArrowInSandbox($env, $arrow, 'has some', 'operator');
  1923. foreach ($array as $k => $v) {
  1924. if ($arrow($v, $k)) {
  1925. return true;
  1926. }
  1927. }
  1929. return false;
  1930. }
  1932. /**
  1933. * @internal
  1934. */
  1935. public static function arrayEvery(Environment $env, $array, $arrow)
  1936. {
  1937. self::checkArrowInSandbox($env, $arrow, 'has every', 'operator');
  1939. foreach ($array as $k => $v) {
  1940. if (!$arrow($v, $k)) {
  1941. return false;
  1942. }
  1943. }
  1945. return true;
  1946. }
  1948. /**
  1949. * @internal
  1950. */
  1951. public static function checkArrowInSandbox(Environment $env, $arrow, $thing, $type)
  1952. {
  1953. if (!$arrow instanceof \Closure && $env->hasExtension(SandboxExtension::class) && $env->getExtension(SandboxExtension::class)->isSandboxed()) {
  1954. throw new RuntimeError(\sprintf('The callable passed to the "%s" %s must be a Closure in sandbox mode.', $thing, $type));
  1955. }
  1956. }
  1958. /**
  1959. * @internal to be removed in Twig 4
  1960. */
  1961. public static function captureOutput(iterable $body): string
  1962. {
  1963. $level = ob_get_level();
  1964. ob_start();
  1966. try {
  1967. foreach ($body as $data) {
  1968. echo $data;
  1969. }
  1970. } catch (\Throwable $e) {
  1971. while (ob_get_level() > $level) {
  1972. ob_end_clean();
  1973. }
  1975. throw $e;
  1976. }
  1978. return ob_get_clean();
  1979. }
  1981. /**
  1982. * @internal
  1983. */
  1984. public static function parseParentFunction(Parser $parser, Node $fakeNode, $args, int $line): AbstractExpression
  1985. {
  1986. if (!$blockName = $parser->peekBlockStack()) {
  1987. throw new SyntaxError('Calling the "parent" function outside of a block is forbidden.', $line, $parser->getStream()->getSourceContext());
  1988. }
  1990. if (!$parser->hasInheritance()) {
  1991. throw new SyntaxError('Calling the "parent" function on a template that does not call "extends" or "use" is forbidden.', $line, $parser->getStream()->getSourceContext());
  1992. }
  1994. return new ParentExpression($blockName, $line);
  1995. }
  1997. /**
  1998. * @internal
  1999. */
  2000. public static function parseBlockFunction(Parser $parser, Node $fakeNode, $args, int $line): AbstractExpression
  2001. {
  2002. $fakeFunction = new TwigFunction('block', fn ($name, $template = null) => null);
  2003. $args = (new CallableArgumentsExtractor($fakeNode, $fakeFunction))->extractArguments($args);
  2005. return new BlockReferenceExpression($args[0], $args[1] ?? null, $line);
  2006. }
  2008. /**
  2009. * @internal
  2010. */
  2011. public static function parseAttributeFunction(Parser $parser, Node $fakeNode, $args, int $line): AbstractExpression
  2012. {
  2013. $fakeFunction = new TwigFunction('attribute', fn ($variable, $attribute, $arguments = null) => null);
  2014. $args = (new CallableArgumentsExtractor($fakeNode, $fakeFunction))->extractArguments($args);
  2016. return new GetAttrExpression($args[0], $args[1], $args[2] ?? null, Template::ANY_CALL, $line);
  2017. }
  2018. }