custom/plugins/SasBlogModule/src/Page/Blog/BlogPageLoader.php line 68

  1. <?php declare(strict_types=1);
  3. namespace Sas\BlogModule\Page\Blog;
  5. use Sas\BlogModule\Content\Blog\BlogEntriesEntity;
  6. use Shopware\Core\Content\Cms\CmsPageEntity;
  7. use Shopware\Core\Content\Cms\Exception\PageNotFoundException;
  8. use Shopware\Core\Content\Cms\SalesChannel\SalesChannelCmsPageLoaderInterface;
  9. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Exception\InconsistentCriteriaIdsException;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  12. use Shopware\Core\Framework\Routing\Exception\MissingRequestParameterException;
  13. use Shopware\Core\Framework\Routing\RoutingException;
  14. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  15. use Shopware\Core\System\SystemConfig\Exception\ConfigurationNotFoundException;
  16. use Shopware\Core\System\SystemConfig\SystemConfigService;
  17. use Shopware\Storefront\Page\GenericPageLoaderInterface;
  18. use Shopware\Storefront\Page\MetaInformation;
  19. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  20. use Symfony\Component\HttpFoundation\Request;
  22. class BlogPageLoader
  23. {
  24.     private SystemConfigService $systemConfigService;
  26.     private GenericPageLoaderInterface $genericLoader;
  28.     private EventDispatcherInterface $eventDispatcher;
  30.     private SalesChannelCmsPageLoaderInterface $cmsPageLoader;
  32.     private EntityRepository $blogRepository;
  34.     public function __construct(
  35.         SystemConfigService $systemConfigService,
  36.         GenericPageLoaderInterface $genericLoader,
  37.         EventDispatcherInterface $eventDispatcher,
  38.         SalesChannelCmsPageLoaderInterface $cmsPageLoader,
  39.         EntityRepository $blogRepository
  40.     ) {
  41.         $this->systemConfigService = $systemConfigService;
  42.         $this->genericLoader = $genericLoader;
  43.         $this->eventDispatcher = $eventDispatcher;
  44.         $this->cmsPageLoader = $cmsPageLoader;
  45.         $this->blogRepository = $blogRepository;
  46.     }
  48.     /**
  49.      * Loads the blog page data
  50.      * It gets article id from request
  51.      * It get Storefront Page's instance for given request
  52.      * It assigns metadata to page instance
  53.      * It dispatches an event to allow other extensions to modify the page instance
  54.      *
  55.      * @throws PageNotFoundException
  56.      * @throws InconsistentCriteriaIdsException
  57.      * @throws MissingRequestParameterException
  58.      * @throws ConfigurationNotFoundException
  59.      */
  60.     public function load(Request $request, SalesChannelContext $context): BlogPage
  61.     {
  62.         $articleId = $request->attributes->get('articleId');
  63.         if (!$articleId) {
  64.             throw RoutingException::missingRequestParameter('articleId', '/articleId');
  65.         }
  67.         $blogEntry = $this->loadBlogEntry($articleId, $context);
  68.         $detailCmsPage = $this->loadBlogDetailCmsPage($request, $context);
  70.         $page = $this->genericLoader->load($request, $context);
  71.         $page = BlogPage::createFrom($page);
  73.         $page->setBlogEntry($blogEntry);
  74.         $page->setCmsPage($detailCmsPage);
  76.         if (
  77.             $page->getHeader()
  78.             && $page->getHeader()->getNavigation()
  79.             && $page->getHeader()->getNavigation()->getActive()
  80.         ) {
  81.             $navigationId = $page->getHeader()->getNavigation()->getActive()->getId();
  82.             $page->setNavigationId($navigationId);
  83.         }
  85.         $metaInformation = $page->getMetaInformation();
  86.         if ($metaInformation instanceof MetaInformation) {
  87.             $metaTitle = $blogEntry->getTranslation('metaTitle') ?? $blogEntry->getTitle();
  88.             $metaDescription = $blogEntry->getTranslation('metaDescription') ?? $blogEntry->getTeaser();
  89.             $metaAuthor = $blogEntry->getBlogAuthor() ? $blogEntry->getBlogAuthor()->getFullName() : '';
  90.             $metaKeywords = $blogEntry->getTranslation('metaKeywords');
  91.             $metaInformation->setMetaKeywords($metaKeywords ?? '');
  92.             $metaInformation->setMetaTitle($metaTitle ?? '');
  93.             $metaInformation->setMetaDescription($metaDescription ?? '');
  94.             $metaInformation->setAuthor($metaAuthor ?? '');
  95.             $page->setMetaInformation($metaInformation);
  96.         }
  98.         $this->eventDispatcher->dispatch(new BlogPageLoadedEvent($page, $context, $request));
  100.         return $page;
  101.     }
  103.     /**
  104.      * Loads the Blog Entry for the given article id
  105.      * It creates a criteria with the given article id
  106.      *   then associates the author's salutation and blog categories
  107.      * It dispatches an event to allow other extensions to modify the criteria
  108.      * It gets and returns the Blog Entry's instance for the given criteria
  109.      *
  110.      * @throws PageNotFoundException
  111.      */
  112.     private function loadBlogEntry(string $articleId, SalesChannelContext $context): BlogEntriesEntity
  113.     {
  114.         $criteria = (new Criteria([$articleId]))
  115.             ->addAssociation('blogAuthor.salutation')
  116.             ->addAssociation('media')
  117.             ->addAssociation('blogCategories');
  119.         $this->eventDispatcher->dispatch(new BlogPageCriteriaEvent($articleId, $criteria, $context));
  121.         $blogEntry = $this->blogRepository
  122.             ->search($criteria, $context->getContext())
  123.             ->first();
  125.         if (!$blogEntry instanceof BlogEntriesEntity) {
  126.             throw new PageNotFoundException($articleId);
  127.         }
  129.         return $blogEntry;
  130.     }
  132.     /**
  133.      * Loads the CMS Page for the blog detail page
  134.      * It gets the CMS Page's id from the plugin configuration
  135.      * It gets and returns the CMS Page's instance for the given id
  136.      *
  137.      * @throws PageNotFoundException
  138.      * @throws ConfigurationNotFoundException
  139.      */
  140.     private function loadBlogDetailCmsPage(Request $request, SalesChannelContext $context): CmsPageEntity
  141.     {
  142.         $detailCmsPageId = $this->systemConfigService->getString('SasBlogModule.config.cmsBlogDetailPage');
  143.         if (!$detailCmsPageId) {
  144.             throw new ConfigurationNotFoundException('SasBlogModule');
  145.         }
  147.         $detailCmsPage = $this->cmsPageLoader->load($request, new Criteria([$detailCmsPageId]), $context)->first();
  148.         if (!$detailCmsPage instanceof CmsPageEntity) {
  149.             throw new PageNotFoundException($detailCmsPageId);
  150.         }
  152.         return $detailCmsPage;
  153.     }
  154. }