vendor/pimcore/pimcore/lib/Templating/HelperBroker/DocumentEditable.php line 53

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\Templating\HelperBroker;
  17. use Pimcore\Templating\PhpEngine;
  18. use Pimcore\Templating\Renderer\EditableRenderer;
  20. /**
  21.  * @deprecated
  22.  */
  23. class DocumentEditable implements HelperBrokerInterface
  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 supports(PhpEngine $engine, $method)
  42.     {
  43.         if ($this->editableRenderer->editableExists($method)) {
  44.             return true;
  45.         }
  47.         return false;
  48.     }
  50.     /**
  51.      * @inheritDoc
  52.      */
  53.     public function helper(PhpEngine $engine, $method, array $arguments)
  54.     {
  55.         $document = $engine->getViewParameter('document');
  57.         // if editmode is set as parameter override the editmode resolver value
  58.         $editmode = $engine->getViewParameter('editmode');
  59.         if (null !== $editmode) {
  60.             $editmode = (bool)$editmode;
  61.         }
  63.         if (null === $document) {
  64.             throw new \RuntimeException(sprintf('Trying to render the tag "%s", but no document was found', $method));
  65.         }
  67.         if (!isset($arguments[0])) {
  68.             throw new \Exception('You have to set a name for the called tag (editable): ' . $method);
  69.         }
  71.         // set default if there is no editable configuration provided
  72.         if (!isset($arguments[1])) {
  73.             $arguments[1] = [];
  74.         }
  76.         return $this->editableRenderer->render($document, $method, $arguments[0], $arguments[1], $editmode);
  77.     }
  78. }
  80. class_alias(DocumentEditable::class, 'Pimcore\Templating\HelperBroker\DocumentTag');