vendor/pimcore/pimcore/lib/Extension/Document/Areabrick/AbstractAreabrick.php line 167

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\Extension\Document\Areabrick;
  18. use Pimcore\Extension\Document\Areabrick\Exception\ConfigurationException;
  19. use Pimcore\Model\Document\Editable;
  20. use Pimcore\Model\Document\Editable\Area\Info;
  21. use Pimcore\Model\Document\PageSnippet;
  22. use Pimcore\Templating\Renderer\EditableRenderer;
  23. use Symfony\Component\DependencyInjection\ContainerAwareInterface;
  24. use Symfony\Component\DependencyInjection\ContainerAwareTrait;
  26. abstract class AbstractAreabrick implements AreabrickInterface, TemplateAreabrickInterface, ContainerAwareInterface
  27. {
  28.     use ContainerAwareTrait;
  30.     /**
  31.      * @var EditableRenderer
  32.      */
  33.     protected $editableRenderer;
  35.     /**
  36.      * Called in AreabrickPass
  37.      *
  38.      * @param EditableRenderer $editableRenderer
  39.      */
  40.     public function setEditableRenderer(EditableRenderer $editableRenderer)
  41.     {
  42.         $this->editableRenderer = $editableRenderer;
  43.     }
  45.     /**
  46.      * @var string
  47.      */
  48.     protected $id;
  50.     /**
  51.      * {@inheritdoc}
  52.      */
  53.     public function setId($id)
  54.     {
  55.         // make sure ID is only set once
  56.         if (null !== $this->id) {
  57.             throw new ConfigurationException(sprintf(
  58.                 'Brick ID is immutable (trying to set ID %s for brick %s)',
  59.                 $id,
  60.                 $this->id
  61.             ));
  62.         }
  64.         $this->id = $id;
  65.     }
  67.     /**
  68.      * {@inheritdoc}
  69.      */
  70.     public function getId()
  71.     {
  72.         return $this->id;
  73.     }
  75.     /**
  76.      * {@inheritdoc}
  77.      */
  78.     public function getName()
  79.     {
  80.         return $this->id ? ucfirst($this->id) : '';
  81.     }
  83.     /**
  84.      * {@inheritdoc}
  85.      */
  86.     public function getDescription()
  87.     {
  88.         return '';
  89.     }
  91.     /**
  92.      * {@inheritdoc}
  93.      */
  94.     public function getVersion()
  95.     {
  96.         return '';
  97.     }
  99.     /**
  100.      * {@inheritdoc}
  101.      */
  102.     public function getIcon()
  103.     {
  104.         return null;
  105.     }
  107.     /**
  108.      * {@inheritdoc}
  109.      */
  110.     public function hasTemplate()
  111.     {
  112.         return true;
  113.     }
  115.     /**
  116.      * {@inheritdoc}
  117.      */
  118.     public function action(Info $info)
  119.     {
  120.         // noop - implement as needed
  121.         return null;
  122.     }
  124.     /**
  125.      * {@inheritdoc}
  126.      */
  127.     public function postRenderAction(Info $info)
  128.     {
  129.         // noop - implement as needed
  130.         return null;
  131.     }
  133.     /**
  134.      * {@inheritdoc}
  135.      */
  136.     public function getHtmlTagOpen(Info $info)
  137.     {
  138.         return '<div class="pimcore_area_' . $info->getId() . ' pimcore_area_content '. $this->getOpenTagCssClass($info) .'">';
  139.     }
  141.     /**
  142.      * @param Info $info
  143.      *
  144.      * @return string|null
  145.      */
  146.     protected function getOpenTagCssClass(Info $info)
  147.     {
  148.         return null;
  149.     }
  151.     /**
  152.      * {@inheritdoc}
  153.      */
  154.     public function getHtmlTagClose(Info $info)
  155.     {
  156.         return '</div>';
  157.     }
  159.     /**
  160.      * @param PageSnippet $document
  161.      * @param string $type
  162.      * @param string $inputName
  163.      * @param array $options
  164.      *
  165.      * @return Editable\EditableInterface
  166.      */
  167.     protected function getDocumentEditable(PageSnippet $document, $type, $inputName, array $options = [])
  168.     {
  169.         return $this->editableRenderer->getEditable($document, $type, $inputName, $options);
  170.     }
  172.     public function needsReload(): bool
  173.     {
  174.         return false;
  175.     }
  176. }