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

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.  * @deprecated
  30.  */
  31. class TemplatingHelperExtension extends AbstractExtension
  32. {
  33.     /**
  34.      * @var PhpEngine
  35.      */
  36.     private $phpEngine;
  38.     /**
  39.      * @param PhpEngine $phpEngine
  40.      */
  41.     public function __construct(PhpEngine $phpEngine)
  42.     {
  43.         $this->phpEngine = $phpEngine;
  44.     }
  46.     public function getFunctions(): array
  47.     {
  48.         $helperNames = [
  49.             'headLink' => 'pimcore_head_link',
  50.             'headMeta' => 'pimcore_head_meta',
  51.             'headScript' => 'pimcore_head_script',
  52.             'headStyle' => 'pimcore_head_style',
  53.             'headTitle' => 'pimcore_head_title',
  54.             'inlineScript' => 'pimcore_inline_script',
  55.             'breachAttackRandomContent' => 'pimcore_breach_attack_random_content',
  56.             'placeholder' => 'pimcore_placeholder',
  57.             'cache' => 'pimcore_cache',
  58.             'device' => 'pimcore_device',
  59.             'pimcoreUrl' => [
  60.                 'name' => 'pimcore_url',
  61.                 'is_safe' => null,
  62.             ],
  63.         ];
  65.         $functions = [];
  66.         foreach ($helperNames as $helperName => $helperOptions) {
  67.             $functionName = null;
  68.             $options = [
  69.                 'is_safe' => ['html'],
  70.             ];
  72.             if (is_string($helperOptions)) {
  73.                 $functionName = $helperOptions;
  74.             } else {
  75.                 if (!isset($helperOptions['name'])) {
  76.                     throw new \LogicException('A helper declaration needs to define a Twig function name');
  77.                 }
  79.                 $functionName = $helperOptions['name'];
  80.                 unset($helperOptions['name']);
  82.                 $options = array_merge($options, $helperOptions);
  83.             }
  85.             $callable = function () use ($helperName) {
  86.                 return $this->callHelper($helperName, func_get_args());
  87.             };
  89.             $functions[] = new TwigFunction($functionName, $callable, $options);
  90.         }
  92.         return $functions;
  94.         // those are just for auto-complete, not nice, but works ;-)
  95.         new TwigFunction('pimcore_head_link');
  96.         new TwigFunction('pimcore_head_meta');
  97.         new TwigFunction('pimcore_head_script');
  98.         new TwigFunction('pimcore_head_style');
  99.         new TwigFunction('pimcore_head_title');
  100.         new TwigFunction('pimcore_inline_script');
  101.         new TwigFunction('pimcore_placeholder');
  102.         new TwigFunction('pimcore_cache');
  103.         new TwigFunction('pimcore_device');
  104.         new TwigFunction('pimcore_url');
  105.         new TwigFunction('pimcore_breach_attack_random_content');
  106.     }
  108.     /**
  109.      * Calls a helper with arguments
  110.      *
  111.      * @param string $helperName
  112.      * @param array $arguments
  113.      *
  114.      * @return mixed|HelperInterface
  115.      */
  116.     public function callHelper(string $helperName, array $arguments = [])
  117.     {
  118.         $helper = $this->phpEngine->get($helperName);
  120.         // helper implements __invoke -> run it directly
  121.         if (is_callable($helper)) {
  122.             return call_user_func_array($helper, $arguments);
  123.         }
  125.         return $helper;
  126.     }
  127. }