vendor/pimcore/pimcore/lib/Document/Editable/DelegatingEditableHandler.php line 147

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\Document\Editable;
  17. use Pimcore\Document\Editable\Exception\NotFoundException;
  18. use Pimcore\Model\Document\Editable;
  19. use Pimcore\Model\Document\Editable\Area\Info;
  20. use Pimcore\Model\Document\Tag;
  21. use Pimcore\Templating\Model\ViewModelInterface;
  23. /**
  24.  * @deprecated will be removed in v7, use EditableHandler directly instead
  25.  */
  26. class DelegatingEditableHandler implements EditableHandlerInterface
  27. {
  28.     /**
  29.      * @var EditableHandlerInterface[]
  30.      */
  31.     protected $handlers = [];
  33.     /**
  34.      * Register a handler
  35.      *
  36.      * @param EditableHandlerInterface $handler
  37.      *
  38.      * @return $this
  39.      */
  40.     public function addHandler(EditableHandlerInterface $handler)
  41.     {
  42.         $this->handlers[] = $handler;
  44.         return $this;
  45.     }
  47.     /**
  48.      * Get the matching handler for a view
  49.      *
  50.      * @param ViewModelInterface $view
  51.      *
  52.      * @return EditableHandlerInterface
  53.      */
  54.     public function getHandlerForView($view)
  55.     {
  56.         foreach ($this->handlers as $handler) {
  57.             if ($handler->supports($view)) {
  58.                 return $handler;
  59.             }
  60.         }
  62.         throw new NotFoundException(sprintf(
  63.             'No handler found for view type %s',
  64.             $view ? get_class($view) : 'null'
  65.         ));
  66.     }
  68.     /**
  69.      * Get the matching handler for a Tag
  70.      *
  71.      * @param Tag|Tag\Area|Tag\Areablock $tag
  72.      *
  73.      * @return EditableHandlerInterface
  74.      *
  75.      * @deprecated
  76.      */
  77.     public function getHandlerForTag(Tag $tag)
  78.     {
  79.         return $this->getHandlerForEditable($tag);
  80.     }
  82.     /**
  83.      * Get the matching handler for a Tag
  84.      *
  85.      * @param Editable|Editable\Area|Editable\Areablock $editable
  86.      *
  87.      * @return EditableHandlerInterface
  88.      */
  89.     public function getHandlerForEditable(Editable $editable)
  90.     {
  91.         $view = $editable->getView();
  93.         try {
  94.             return $this->getHandlerForView($view);
  95.         } catch (NotFoundException $e) {
  96.             throw new NotFoundException(sprintf(
  97.                 'No handler found for tag %s and view type %s',
  98.                 $editable->getName(),
  99.                 $view ? get_class($view) : 'null'
  100.             ), 0, $e);
  101.         }
  102.     }
  104.     /**
  105.      * {@inheritdoc}
  106.      */
  107.     public function supports($view)
  108.     {
  109.         try {
  110.             $this->getHandlerForView($view);
  112.             return true;
  113.         } catch (NotFoundException $e) {
  114.             // noop
  115.         }
  117.         return false;
  118.     }
  120.     /**
  121.      * @inheritDoc
  122.      */
  123.     public function isBrickEnabled(Editable $editable, $brick)
  124.     {
  125.         $handler = $this->getHandlerForEditable($editable);
  127.         return $handler->isBrickEnabled($editable, $brick);
  128.     }
  130.     /**
  131.      * {@inheritdoc}
  132.      */
  133.     public function getAvailableAreablockAreas(Editable\Areablock $editable, array $options)
  134.     {
  135.         $handler = $this->getHandlerForEditable($editable);
  137.         return $handler->getAvailableAreablockAreas($editable, $options);
  138.     }
  140.     /**
  141.      * {@inheritdoc}
  142.      */
  143.     public function renderAreaFrontend(Info $info)
  144.     {
  145.         $handler = $this->getHandlerForEditable($info->getEditable());
  147.         return $handler->renderAreaFrontend($info);
  148.     }
  150.     /**
  151.      * {@inheritdoc}
  152.      */
  153.     public function renderAction($view, $controller, $action, $parent = null, array $attributes = [], array $query = [], array $options = [])
  154.     {
  155.         $handler = $this->getHandlerForView($view);
  157.         return $handler->renderAction($view, $controller, $action, $parent, $attributes, $query, $options);
  158.     }
  159. }
  161. class_alias(DelegatingEditableHandler::class, 'Pimcore\Document\Tag\DelegatingTagHandler');