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

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