vendor/pimcore/pimcore/lib/Twig/Extension/TemplatingHelperExtension.php line 120

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /**
  6.  * Pimcore
  7.  *
  8.  * This source file is available under two different licenses:
  9.  * - GNU General Public License version 3 (GPLv3)
  10.  * - Pimcore Enterprise License (PEL)
  11.  * Full copyright and license information is available in
  12.  * LICENSE.md which is distributed with this source code.
  13.  *
  14.  * @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  15.  * @license    http://www.pimcore.org/license     GPLv3 and PEL
  16.  */
  18. namespace Pimcore\Twig\Extension;
  20. use Pimcore\Templating\PhpEngine;
  21. use Symfony\Component\Templating\Helper\HelperInterface;
  22. use Twig\Extension\AbstractExtension;
  23. use Twig\TwigFunction;
  25. /**
  26.  * Delegates calls to PHP templating helpers. Use this only with templating helpers which do not rely
  27.  * on PHP rendering!
  28.  */
  29. class TemplatingHelperExtension extends AbstractExtension
  30. {
  31.     /**
  32.      * @var PhpEngine
  33.      */
  34.     private $phpEngine;
  36.     /**
  37.      * @param PhpEngine $phpEngine
  38.      */
  39.     public function __construct(PhpEngine $phpEngine)
  40.     {
  41.         $this->phpEngine = $phpEngine;
  42.     }
  44.     public function getFunctions(): array
  45.     {
  46.         $helperNames = [
  47.             'headLink' => 'pimcore_head_link',
  48.             'headMeta' => 'pimcore_head_meta',
  49.             'headScript' => 'pimcore_head_script',
  50.             'headStyle' => 'pimcore_head_style',
  51.             'headTitle' => 'pimcore_head_title',
  52.             'inlineScript' => 'pimcore_inline_script',
  53.             'breachAttackRandomContent' => 'pimcore_breach_attack_random_content',
  54.             'placeholder' => 'pimcore_placeholder',
  55.             'cache' => 'pimcore_cache',
  56.             'device' => 'pimcore_device',
  57.             'pimcoreUrl' => [
  58.                 'name' => 'pimcore_url',
  59.                 'is_safe' => null,
  60.             ],
  61.         ];
  63.         $functions = [];
  64.         foreach ($helperNames as $helperName => $helperOptions) {
  65.             $functionName = null;
  66.             $options = [
  67.                 'is_safe' => ['html'],
  68.             ];
  70.             if (is_string($helperOptions)) {
  71.                 $functionName = $helperOptions;
  72.             } else {
  73.                 if (!isset($helperOptions['name'])) {
  74.                     throw new \LogicException('A helper declaration needs to define a Twig function name');
  75.                 }
  77.                 $functionName = $helperOptions['name'];
  78.                 unset($helperOptions['name']);
  80.                 $options = array_merge($options, $helperOptions);
  81.             }
  83.             $callable = function () use ($helperName) {
  84.                 return $this->callHelper($helperName, func_get_args());
  85.             };
  87.             $functions[] = new TwigFunction($functionName, $callable, $options);
  88.         }
  90.         return $functions;
  92.         // those are just for auto-complete, not nice, but works ;-)
  93.         new TwigFunction('pimcore_head_link');
  94.         new TwigFunction('pimcore_head_meta');
  95.         new TwigFunction('pimcore_head_script');
  96.         new TwigFunction('pimcore_head_style');
  97.         new TwigFunction('pimcore_head_title');
  98.         new TwigFunction('pimcore_inline_script');
  99.         new TwigFunction('pimcore_placeholder');
  100.         new TwigFunction('pimcore_cache');
  101.         new TwigFunction('pimcore_device');
  102.         new TwigFunction('pimcore_url');
  103.         new TwigFunction('pimcore_breach_attack_random_content');
  104.     }
  106.     /**
  107.      * Calls a helper with arguments
  108.      *
  109.      * @param string $helperName
  110.      * @param array $arguments
  111.      *
  112.      * @return mixed|HelperInterface
  113.      */
  114.     public function callHelper(string $helperName, array $arguments = [])
  115.     {
  116.         $helper = $this->phpEngine->get($helperName);
  118.         // helper implements __invoke -> run it directly
  119.         if (is_callable($helper)) {
  120.             return call_user_func_array($helper, $arguments);
  121.         }
  123.         return $helper;
  124.     }
  125. }