vendor/pimcore/pimcore/lib/Templating/Renderer/EditableRenderer.php line 133

Open in your IDE?
  1. <?php
  3. /**
  4.  * Pimcore
  5.  *
  6.  * This source file is available under two different licenses:
  7.  * - GNU General Public License version 3 (GPLv3)
  8.  * - Pimcore Commercial License (PCL)
  9.  * Full copyright and license information is available in
  10.  * LICENSE.md which is distributed with this source code.
  11.  *
  12.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  14.  */
  16. namespace Pimcore\Templating\Renderer;
  18. use Pimcore\Document\Editable\EditmodeEditableDefinitionCollector;
  19. use Pimcore\Http\Request\Resolver\EditmodeResolver;
  20. use Pimcore\Model\Document\Editable;
  21. use Pimcore\Model\Document\Editable\Loader\EditableLoaderInterface;
  22. use Pimcore\Model\Document\PageSnippet;
  23. use Psr\Log\LoggerAwareInterface;
  24. use Psr\Log\LoggerAwareTrait;
  26. /**
  27.  * @internal
  28.  */
  29. class EditableRenderer implements LoggerAwareInterface
  30. {
  31.     use LoggerAwareTrait;
  33.     /**
  34.      * @var EditableLoaderInterface
  35.      */
  36.     protected $editableLoader;
  38.     /**
  39.      * @var EditmodeResolver
  40.      */
  41.     protected $editmodeResolver;
  43.     protected ?EditmodeEditableDefinitionCollector $configCollector;
  45.     /**
  46.      * @param EditableLoaderInterface $editableLoader
  47.      * @param EditmodeResolver $editmodeResolver
  48.      * @param EditmodeEditableDefinitionCollector $configCollector
  49.      */
  50.     public function __construct(EditableLoaderInterface $editableLoader, EditmodeResolver $editmodeResolver, EditmodeEditableDefinitionCollector $configCollector)
  51.     {
  52.         $this->editableLoader = $editableLoader;
  53.         $this->editmodeResolver = $editmodeResolver;
  54.         $this->configCollector = $configCollector;
  55.     }
  57.     /**
  58.      * @param string $type
  59.      *
  60.      * @return bool
  61.      */
  62.     public function editableExists($type)
  63.     {
  64.         return $this->editableLoader->supports($type);
  65.     }
  67.     /**
  68.      * @param PageSnippet $document
  69.      * @param string $type
  70.      * @param string $name
  71.      * @param array $config
  72.      * @param bool|null $editmode
  73.      *
  74.      * @return Editable\EditableInterface
  75.      *
  76.      * @throws \Exception
  77.      */
  78.     public function getEditable(PageSnippet $document, string $type, string $name, array $config = [], bool $editmode = null): Editable\EditableInterface
  79.     {
  80.         $type = strtolower($type);
  82.         $originalName = $name;
  83.         $name = Editable::buildEditableName($type, $originalName, $document);
  84.         $realName = Editable::buildEditableRealName($originalName, $document);
  86.         if (null === $editmode) {
  87.             $editmode = $this->editmodeResolver->isEditmode();
  88.         }
  90.         $editable = $document->getEditable($name);
  91.         if ($editable instanceof Editable\EditableInterface && $editable->getType() === $type) {
  92.             // call the load() method if it exists to reinitialize the data (eg. from serializing, ...)
  93.             if (method_exists($editable, 'load')) {
  94.                 $editable->load();
  95.             }
  96.         } else {
  97.             $editable = $this->editableLoader->build($type);
  98.             $editable->setName($name);
  99.             $document->setEditable($editable);
  101.             //set default value on initial build
  102.             if (isset($config['defaultValue'])) {
  103.                 $editable->setDataFromResource($config['defaultValue']);
  104.             }
  105.         }
  107.         $editable->setDocument($document);
  108.         $editable->setEditmode($editmode);
  109.         // set the real name of this editable, without the prefixes and suffixes from blocks and areablocks
  110.         $editable->setRealName($realName);
  111.         $editable->setConfig($config);
  113.         if ($editmode) {
  114.             $editable->setEditableDefinitionCollector($this->configCollector);
  115.         }
  117.         return $editable;
  118.     }
  120.     /**
  121.      * Renders an editable
  122.      *
  123.      * @param PageSnippet $document
  124.      * @param string $type
  125.      * @param string $name
  126.      * @param array $options
  127.      * @param bool|null $editmode
  128.      *
  129.      * @return mixed
  130.      *
  131.      * @throws \Exception
  132.      */
  133.     public function render(PageSnippet $document, string $type, string $name, array $options = [], bool $editmode = null)
  134.     {
  135.         return $this->getEditable($document, $type, $name, $options, $editmode);
  136.     }
  137. }