vendor/pimcore/pimcore/lib/Twig/Extension/DocumentEditableExtension.php line 106

Open in your IDE?
  1. <?php
  2. /**
  3.  * Pimcore
  4.  *
  5.  * This source file is available under two different licenses:
  6.  * - GNU General Public License version 3 (GPLv3)
  7.  * - Pimcore Enterprise License (PEL)
  8.  * Full copyright and license information is available in
  9.  * LICENSE.md which is distributed with this source code.
  10.  *
  11.  * @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  12.  * @license    http://www.pimcore.org/license     GPLv3 and PEL
  13.  */
  15. namespace Pimcore\Twig\Extension;
  17. use Pimcore\Model\Document\Editable\BlockInterface;
  18. use Pimcore\Model\Document\PageSnippet;
  19. use Pimcore\Templating\Renderer\EditableRenderer;
  20. use Twig\Extension\AbstractExtension;
  21. use Twig\TwigFunction;
  23. class DocumentEditableExtension extends AbstractExtension
  24. {
  25.     /**
  26.      * @var EditableRenderer
  27.      */
  28.     protected $editableRenderer;
  30.     /**
  31.      * @param EditableRenderer $editableRenderer
  32.      */
  33.     public function __construct(EditableRenderer $editableRenderer)
  34.     {
  35.         $this->editableRenderer = $editableRenderer;
  36.     }
  38.     /**
  39.      * {@inheritdoc}
  40.      */
  41.     public function getFunctions()
  42.     {
  43.         return [
  44.             new TwigFunction('pimcore_*', [$this, 'renderEditable'], [
  45.                 'needs_context' => true,
  46.                 'is_safe' => ['html'],
  47.             ]),
  48.             new TwigFunction('pimcore_iterate_block', [$this, 'getBlockIterator']),
  49.         ];
  51.         // those are just for auto-complete, not nice, but works ;-)
  52.         new TwigFunction('pimcore_area');
  53.         new TwigFunction('pimcore_areablock');
  54.         new TwigFunction('pimcore_block');
  55.         new TwigFunction('pimcore_checkbox');
  56.         new TwigFunction('pimcore_date');
  57.         new TwigFunction('pimcore_embed');
  58.         new TwigFunction('pimcore_image');
  59.         new TwigFunction('pimcore_input');
  60.         new TwigFunction('pimcore_link');
  61.         new TwigFunction('pimcore_multiselect');
  62.         new TwigFunction('pimcore_numeric');
  63.         new TwigFunction('pimcore_pdf');
  64.         new TwigFunction('pimcore_relation');
  65.         new TwigFunction('pimcore_relations');
  66.         new TwigFunction('pimcore_renderlet');
  67.         new TwigFunction('pimcore_scheduledblock');
  68.         new TwigFunction('pimcore_select');
  69.         new TwigFunction('pimcore_snippet');
  70.         new TwigFunction('pimcore_textarea');
  71.         new TwigFunction('pimcore_video');
  72.         new TwigFunction('pimcore_wysiwyg');
  73.     }
  75.     /**
  76.      * @param array $context
  77.      * @param string $name
  78.      * @param string $inputName
  79.      * @param array $options
  80.      *
  81.      * @return \Pimcore\Model\Document\Editable|string
  82.      *
  83.      * @deprecated since v6.8 and will be removed in 7. use renderEditable instead.
  84.      */
  85.     public function renderTag($context, $name, $inputName, array $options = [])
  86.     {
  87.         return $this->renderEditable($context, $name, $inputName, $options);
  88.     }
  90.     /**
  91.      * @param array $context
  92.      * @param string $name
  93.      * @param string $inputName
  94.      * @param array $options
  95.      *
  96.      * @return \Pimcore\Model\Document\Editable|string
  97.      */
  98.     public function renderEditable($context, $name, $inputName, array $options = [])
  99.     {
  100.         $document = $context['document'];
  101.         $editmode = $context['editmode'];
  102.         if (!($document instanceof PageSnippet)) {
  103.             return '';
  104.         }
  106.         return $this->editableRenderer->render($document, $name, $inputName, $options, $editmode);
  107.     }
  109.     /**
  110.      * Returns an iterator which can be used instead of while($block->loop())
  111.      *
  112.      * @param BlockInterface $block
  113.      *
  114.      * @return \Generator|int[]
  115.      */
  116.     public function getBlockIterator(BlockInterface $block): \Generator
  117.     {
  118.         while ($block->loop()) {
  119.             yield $block->getCurrentIndex();
  120.         }
  121.     }
  122. }
  124. class_alias(DocumentEditableExtension::class, 'Pimcore\Twig\Extension\DocumentTagExtension');