vendor/pimcore/pimcore/lib/Controller/FrontendController.php line 52

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\Controller;
  18. use Pimcore\Http\Request\Resolver\DocumentResolver;
  19. use Pimcore\Http\Request\Resolver\EditmodeResolver;
  20. use Pimcore\Http\Request\Resolver\ResponseHeaderResolver;
  21. use Pimcore\Model\Document;
  22. use Pimcore\Templating\Renderer\EditableRenderer;
  23. use Symfony\Component\HttpFoundation\Request;
  24. use Symfony\Component\HttpFoundation\Response;
  26. /**
  27.  * @property Document|Document\PageSnippet $document
  28.  * @property bool $editmode
  29.  */
  30. abstract class FrontendController extends Controller
  31. {
  32.     public static function getSubscribedServices()
  33.     {
  34.         $services = parent::getSubscribedServices();
  35.         $services[EditmodeResolver::class] = '?'.EditmodeResolver::class;
  36.         $services[DocumentResolver::class] = '?'.DocumentResolver::class;
  37.         $services[ResponseHeaderResolver::class] = '?'.ResponseHeaderResolver::class;
  38.         $services[EditableRenderer::class] = '?'.EditableRenderer::class;
  40.         return $services;
  41.     }
  43.     /**
  44.      * document and editmode as properties and proxy them to request attributes through
  45.      * their resolvers.
  46.      *
  47.      * {@inheritdoc}
  48.      */
  49.     public function __get($name)
  50.     {
  51.         if ('document' === $name) {
  52.             return $this->get(DocumentResolver::class)->getDocument();
  53.         }
  55.         if ('editmode' === $name) {
  56.             return $this->get(EditmodeResolver::class)->isEditmode();
  57.         }
  59.         throw new \RuntimeException(sprintf('Trying to read undefined property "%s"', $name));
  60.     }
  62.     /**
  63.      * {@inheritdoc}
  64.      */
  65.     public function __set($name, $value)
  66.     {
  67.         $requestAttributes = ['document', 'editmode'];
  68.         if (in_array($name, $requestAttributes)) {
  69.             throw new \RuntimeException(sprintf(
  70.                 'Property "%s" is a request attribute and can\'t be set on the controller instance',
  71.                 $name
  72.             ));
  73.         }
  75.         throw new \RuntimeException(sprintf('Trying to set unknown property "%s"', $name));
  76.     }
  78.     /**
  79.      * We don't have a response object at this point, but we can add headers here which will be
  80.      * set by the ResponseHeaderListener which reads and adds this headers in the kernel.response event.
  81.      *
  82.      * @param string $key
  83.      * @param array|string $values
  84.      * @param bool $replace
  85.      * @param Request|null $request
  86.      */
  87.     protected function addResponseHeader(string $key, $values, bool $replace = false, Request $request = null)
  88.     {
  89.         if (null === $request) {
  90.             $request = $this->get('request_stack')->getCurrentRequest();
  91.         }
  93.         $this->get(ResponseHeaderResolver::class)->addResponseHeader($request, $key, $values, $replace);
  94.     }
  96.     /**
  97.      * Loads a document editable
  98.      *
  99.      * e.g. `$this->getDocumentEditable('input', 'foobar')`
  100.      *
  101.      * @param string $type
  102.      * @param string $inputName
  103.      * @param array $options
  104.      * @param Document\PageSnippet|null $document
  105.      *
  106.      * @return Document\Editable\EditableInterface
  107.      */
  108.     public function getDocumentEditable($type, $inputName, array $options = [], Document\PageSnippet $document = null)
  109.     {
  110.         if (null === $document) {
  111.             $document = $this->document;
  112.         }
  114.         $editableRenderer = $this->container->get(EditableRenderer::class);
  116.         return $editableRenderer->getEditable($document, $type, $inputName, $options);
  117.     }
  119.     /**
  120.      * @param string $view
  121.      * @param array $parameters
  122.      * @param Response|null $response
  123.      *
  124.      * @return \Symfony\Component\HttpFoundation\Response
  125.      */
  126.     public function renderTemplate($view, array $parameters = [], Response $response = null)
  127.     {
  128.         return $this->render($view, $parameters, $response);
  129.     }
  130. }