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

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