vendor/contao/core-bundle/src/Routing/ResponseContext/CoreResponseContextFactory.php line 65

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of Contao.
  7.  *
  8.  * (c) Leo Feyer
  9.  *
  10.  * @license LGPL-3.0-or-later
  11.  */
  13. namespace Contao\CoreBundle\Routing\ResponseContext;
  15. use Contao\CoreBundle\InsertTag\InsertTagParser;
  16. use Contao\CoreBundle\Routing\ResponseContext\HtmlHeadBag\HtmlHeadBag;
  17. use Contao\CoreBundle\Routing\ResponseContext\JsonLd\ContaoPageSchema;
  18. use Contao\CoreBundle\Routing\ResponseContext\JsonLd\JsonLdManager;
  19. use Contao\CoreBundle\Security\Authentication\Token\TokenChecker;
  20. use Contao\CoreBundle\String\HtmlDecoder;
  21. use Contao\CoreBundle\Util\UrlUtil;
  22. use Contao\PageModel;
  23. use Spatie\SchemaOrg\WebPage;
  24. use Symfony\Component\HttpFoundation\RequestStack;
  25. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  27. class CoreResponseContextFactory
  28. {
  29.     private ResponseContextAccessor $responseContextAccessor;
  30.     private EventDispatcherInterface $eventDispatcher;
  31.     private TokenChecker $tokenChecker;
  32.     private HtmlDecoder $htmlDecoder;
  33.     private RequestStack $requestStack;
  34.     private InsertTagParser $insertTagParser;
  36.     public function __construct(ResponseContextAccessor $responseContextAccessor, EventDispatcherInterface $eventDispatcher, TokenChecker $tokenChecker, HtmlDecoder $htmlDecoder, RequestStack $requestStack, InsertTagParser $insertTagParser)
  37.     {
  38.         $this->responseContextAccessor = $responseContextAccessor;
  39.         $this->eventDispatcher = $eventDispatcher;
  40.         $this->tokenChecker = $tokenChecker;
  41.         $this->htmlDecoder = $htmlDecoder;
  42.         $this->requestStack = $requestStack;
  43.         $this->insertTagParser = $insertTagParser;
  44.     }
  46.     public function createResponseContext(): ResponseContext
  47.     {
  48.         $context = new ResponseContext();
  50.         $this->responseContextAccessor->setResponseContext($context);
  52.         return $context;
  53.     }
  55.     public function createWebpageResponseContext(): ResponseContext
  56.     {
  57.         $context = $this->createResponseContext();
  58.         $context->add($this->eventDispatcher);
  59.         $context->addLazy(HtmlHeadBag::class);
  61.         $context->addLazy(
  62.             JsonLdManager::class,
  63.             static function () use ($context) {
  64.                 $manager = new JsonLdManager($context);
  65.                 $manager->getGraphForSchema(JsonLdManager::SCHEMA_ORG)->add(new WebPage());
  67.                 return $manager;
  68.             }
  69.         );
  71.         return $context;
  72.     }
  74.     public function createContaoWebpageResponseContext(PageModel $pageModel): ResponseContext
  75.     {
  76.         $context = $this->createWebpageResponseContext();
  78.         /** @var HtmlHeadBag $htmlHeadBag */
  79.         $htmlHeadBag = $context->get(HtmlHeadBag::class);
  81.         /** @var JsonLdManager $jsonLdManager */
  82.         $jsonLdManager = $context->get(JsonLdManager::class);
  84.         $title = $this->htmlDecoder->inputEncodedToPlainText($pageModel->pageTitle ?: $pageModel->title ?: '');
  86.         $htmlHeadBag
  87.             ->setTitle($title ?: '')
  88.             ->setMetaDescription($this->htmlDecoder->inputEncodedToPlainText($pageModel->description ?: ''))
  89.         ;
  91.         if ($pageModel->robots) {
  92.             $htmlHeadBag->setMetaRobots($pageModel->robots);
  93.         }
  95.         if ($pageModel->enableCanonical && $pageModel->canonicalLink) {
  96.             $url = $this->insertTagParser->replaceInline($pageModel->canonicalLink);
  98.             // Ensure absolute links
  99.             if (!preg_match('#^https?://#', $url)) {
  100.                 if (!$request = $this->requestStack->getMainRequest()) {
  101.                     throw new \RuntimeException('The request stack did not contain a request');
  102.                 }
  104.                 $url = UrlUtil::makeAbsolute($url, $request->getUri());
  105.             }
  107.             $htmlHeadBag->setCanonicalUri($url);
  108.         }
  110.         if ($pageModel->enableCanonical && $pageModel->canonicalKeepParams) {
  111.             $htmlHeadBag->setKeepParamsForCanonical(array_map('trim', explode(',', $pageModel->canonicalKeepParams)));
  112.         }
  114.         $jsonLdManager
  115.             ->getGraphForSchema(JsonLdManager::SCHEMA_CONTAO)
  116.             ->set(
  117.                 new ContaoPageSchema(
  118.                     $title ?: '',
  119.                     (int) $pageModel->id,
  120.                     (bool) $pageModel->noSearch,
  121.                     (bool) $pageModel->protected,
  122.                     array_map('intval', array_filter((array) $pageModel->groups)),
  123.                     $this->tokenChecker->isPreviewMode()
  124.                 )
  125.             )
  126.         ;
  128.         return $context;
  129.     }
  130. }