src/Sitemaps/NewsGenerator.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 Enterprise License (PEL)
  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 PEL
  14.  */
  16. namespace App\Sitemaps;
  18. use Pimcore\Localization\LocaleServiceInterface;
  19. use Pimcore\Model\DataObject\News;
  20. use Pimcore\Model\Document;
  21. use Pimcore\Sitemap\Element\AbstractElementGenerator;
  22. use Pimcore\Sitemap\Element\GeneratorContext;
  23. use Presta\SitemapBundle\Service\UrlContainerInterface;
  24. use Presta\SitemapBundle\Sitemap\Url\UrlConcrete;
  25. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  27. class NewsGenerator extends AbstractElementGenerator
  28. {
  29.     public function __construct(protected LocaleServiceInterface $localeService, array $filters = [], array $processors = [])
  30.     {
  31.         parent::__construct($filters, $processors);
  32.     }
  34.     public function populate(UrlContainerInterface $urlContainer, string $section = null)
  35.     {
  36.         if (null !== $section && $section !== 'news') {
  37.             // do not add entries if section doesn't match
  38.             return;
  39.         }
  41.         $section = 'news';
  43.         $list = new News\Listing();
  44.         $list->setOrderKey('date');
  45.         $list->setOrder('DESC');
  47.         // the context contains metadata for filters/processors
  48.         // it contains at least the url container, but you can add additional data
  49.         // with the params parameter
  50.         $context = new GeneratorContext($urlContainer, $section, ['foo' => 'bar']);
  52.         //change locale as per multilingual setup
  53.         $this->localeService->setLocale('en');
  55.         /** @var News $newsArticle */
  56.         foreach ($list as $newsArticle) {
  57.             // only add element if it is not filtered
  58.             if (!$this->canBeAdded($newsArticle, $context)) {
  59.                 continue;
  60.             }
  62.             // use a link generator to generate an URL to the article
  63.             // you need to make sure the link generator generates an absolute url
  64.             $link = $newsArticle->getClass()->getLinkGenerator()->generate($newsArticle, [
  65.                 'referenceType' => UrlGeneratorInterface::ABSOLUTE_URL,
  66.                 'document' => Document::getByPath('/en/News')
  67.             ]);
  69.             // create an entry for the sitemap
  70.             $url = new UrlConcrete($link);
  72.             // run url through processors
  73.             $url = $this->process($url, $newsArticle, $context);
  75.             // processors can return null to exclude the url
  76.             if (null === $url) {
  77.                 continue;
  78.             }
  80.             // add the url to the container
  81.             $urlContainer->addUrl($url, $section);
  82.         }
  83.     }
  84. }