pimcore/lib/Pimcore/Bundle/CoreBundle/EventListener/Frontend/DocumentFallbackListener.php line 88

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\Bundle\CoreBundle\EventListener\Frontend;
  17. use Pimcore\Bundle\CoreBundle\EventListener\Traits\PimcoreContextAwareTrait;
  18. use Pimcore\Http\Request\Resolver\DocumentResolver;
  19. use Pimcore\Http\Request\Resolver\PimcoreContextResolver;
  20. use Pimcore\Http\Request\Resolver\SiteResolver;
  21. use Pimcore\Model\Document;
  22. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  23. use Symfony\Component\HttpFoundation\RequestStack;
  24. use Symfony\Component\HttpKernel\Event\GetResponseEvent;
  25. use Symfony\Component\HttpKernel\KernelEvents;
  27. /**
  28.  * If no document was found on the active request (not set by router or by initiator of a sub-request), try to find and
  29.  * set a fallback document:
  30.  *
  31.  *  - if request is a sub-request, try to read document from master request
  32.  *  - if all fails, try to find the nearest document by path
  33.  */
  34. class DocumentFallbackListener implements EventSubscriberInterface
  35. {
  36.     use PimcoreContextAwareTrait;
  38.     /**
  39.      * @var RequestStack
  40.      */
  41.     protected $requestStack;
  43.     /**
  44.      * @var DocumentResolver
  45.      */
  46.     protected $documentResolver;
  48.     /**
  49.      * @var SiteResolver
  50.      */
  51.     protected $siteResolver;
  53.     /**
  54.      * @var Document\Service
  55.      */
  56.     protected $documentService;
  58.     public function __construct(
  59.         RequestStack $requestStack,
  60.         DocumentResolver $documentResolver,
  61.         SiteResolver $siteResolver,
  62.         Document\Service $documentService
  63.     ) {
  64.         $this->requestStack     = $requestStack;
  65.         $this->documentResolver = $documentResolver;
  66.         $this->siteResolver     = $siteResolver;
  67.         $this->documentService  = $documentService;
  68.     }
  70.     /**
  71.      * {@inheritdoc}
  72.      */
  73.     public static function getSubscribedEvents()
  74.     {
  75.         return [
  76.             // priority must be before
  77.             // -> Symfony\Component\HttpKernel\EventListener\LocaleListener::onKernelRequest()
  78.             // -> Pimcore\Bundle\CoreBundle\EventListener\Frontend\EditmodeListener::onKernelRequest()
  79.             KernelEvents::REQUEST => ['onKernelRequest', 20],
  80.         ];
  81.     }
  83.     /**
  84.      * Finds the nearest document for the current request if the routing/document router didn't find one (e.g. static routes)
  85.      *
  86.      * @param GetResponseEvent $event
  87.      */
  88.     public function onKernelRequest(GetResponseEvent $event)
  89.     {
  90.         $request = $event->getRequest();
  91.         if (!$this->matchesPimcoreContext($request, PimcoreContextResolver::CONTEXT_DEFAULT)) {
  92.             return;
  93.         }
  95.         if ($this->documentResolver->getDocument($request)) {
  96.             // we already have a document (e.g. set through the document router)
  97.             return;
  98.         } else {
  99.             // if we're in a sub request and no explicit document is set - try to load document from
  100.             // parent and/or master request and set it on our sub-request
  101.             if (!$event->isMasterRequest()) {
  102.                 $parentRequest = $this->requestStack->getParentRequest();
  103.                 $masterRequest = $this->requestStack->getMasterRequest();
  105.                 $eligibleRequests = [];
  107.                 if (null !== $parentRequest) {
  108.                     $eligibleRequests[] = $parentRequest;
  109.                 }
  111.                 if ($masterRequest !== $parentRequest) {
  112.                     $eligibleRequests[] = $masterRequest;
  113.                 }
  115.                 foreach ($eligibleRequests as $eligibleRequest) {
  116.                     if ($document = $this->documentResolver->getDocument($eligibleRequest)) {
  117.                         $this->documentResolver->setDocument($request, $document);
  119.                         return;
  120.                     }
  121.                 }
  122.             }
  123.         }
  125.         // no document found yet - try to find the nearest document by request path
  126.         // this is only done on the master request as a sub-request's pathInfo is _fragment when
  127.         // rendered via actions helper
  128.         if ($event->isMasterRequest()) {
  129.             $path = null;
  130.             if ($this->siteResolver->isSiteRequest($request)) {
  131.                 $path = $this->siteResolver->getSitePath($request);
  132.             } else {
  133.                 $path = urldecode($request->getPathInfo());
  134.             }
  136.             $document = $this->documentService->getNearestDocumentByPath($path, false, ['page', 'snippet', 'hardlink']);
  137.             if ($document) {
  138.                 $this->documentResolver->setDocument($request, $document);
  139.             }
  140.         }
  141.     }
  142. }