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

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\Extension\Document\Areabrick;
  17. use Pimcore\Extension\Document\Areabrick\Exception\ConfigurationException;
  18. use Pimcore\Model\Document\Editable;
  19. use Pimcore\Model\Document\PageSnippet;
  20. use Pimcore\Model\Document\Tag\Area\Info;
  21. use Pimcore\Templating\Renderer\EditableRenderer;
  22. use Symfony\Component\DependencyInjection\ContainerAwareInterface;
  23. use Symfony\Component\DependencyInjection\ContainerAwareTrait;
  25. abstract class AbstractAreabrick implements AreabrickInterface, TemplateAreabrickInterface, ContainerAwareInterface
  26. {
  27.     use ContainerAwareTrait;
  29.     /**
  30.      * @var EditableRenderer
  31.      */
  32.     protected $editableRenderer;
  34.     /**
  35.      * @deprecated will be removed in Pimcore 7
  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 hasViewTemplate()
  119.     {
  120.         @trigger_error(sprintf('%s is deprecated, use hasTemplate() instead', __METHOD__), E_USER_DEPRECATED);
  122.         return $this->hasTemplate();
  123.     }
  125.     /**
  126.      * @inheritDoc
  127.      */
  128.     public function hasEditTemplate()
  129.     {
  130.         return false;
  131.     }
  133.     /**
  134.      * {@inheritdoc}
  135.      */
  136.     public function getEditTemplate()
  137.     {
  138.         return null;
  139.     }
  141.     /**
  142.      * {@inheritdoc}
  143.      */
  144.     public function action(Info $info)
  145.     {
  146.         // noop - implement as needed
  147.         return null;
  148.     }
  150.     /**
  151.      * {@inheritdoc}
  152.      */
  153.     public function postRenderAction(Info $info)
  154.     {
  155.         // noop - implement as needed
  156.         return null;
  157.     }
  159.     /**
  160.      * {@inheritdoc}
  161.      */
  162.     public function getHtmlTagOpen(Info $info)
  163.     {
  164.         return '<div class="pimcore_area_' . $info->getId() . ' pimcore_area_content '. $this->getOpenTagCssClass($info) .'">';
  165.     }
  167.     /**
  168.      * @param Info $info
  169.      *
  170.      * @return string|null
  171.      */
  172.     protected function getOpenTagCssClass(Info $info)
  173.     {
  174.         return null;
  175.     }
  177.     /**
  178.      * {@inheritdoc}
  179.      */
  180.     public function getHtmlTagClose(Info $info)
  181.     {
  182.         return '</div>';
  183.     }
  185.     /**
  186.      * @param PageSnippet $document
  187.      * @param string $type
  188.      * @param string $inputName
  189.      * @param array $options
  190.      *
  191.      * @return Editable|null
  192.      *
  193.      * @deprecated since v6.8 and will be removed in 7. Use getDocumentEditable() instead.
  194.      */
  195.     protected function getDocumentTag(PageSnippet $document, $type, $inputName, array $options = [])
  196.     {
  197.         return $this->getDocumentEditable($document, $type, $inputName, $options);
  198.     }
  200.     /**
  201.      * @param PageSnippet $document
  202.      * @param string $type
  203.      * @param string $inputName
  204.      * @param array $options
  205.      *
  206.      * @return Editable|null
  207.      */
  208.     protected function getDocumentEditable(PageSnippet $document, $type, $inputName, array $options = [])
  209.     {
  210.         return $this->editableRenderer->getEditable($document, $type, $inputName, $options);
  211.     }
  212. }