src/Sitemaps/CategoryGenerator.php line 73

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\Model\DataObject\Category;
  19. use Pimcore\Sitemap\Element\AbstractElementGenerator;
  20. use Pimcore\Sitemap\Element\GeneratorContext;
  21. use Presta\SitemapBundle\Service\UrlContainerInterface;
  22. use Presta\SitemapBundle\Sitemap\Url\UrlConcrete;
  23. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  25. class CategoryGenerator extends AbstractElementGenerator
  26. {
  27.     public function __construct(array $filters = [], array $processors = [])
  28.     {
  29.         parent::__construct($filters, $processors);
  30.     }
  32.     public function populate(UrlContainerInterface $urlContainer, string $section = null)
  33.     {
  34.         if (null !== $section && $section !== 'category') {
  35.             // do not add entries if section doesn't match
  36.             return;
  37.         }
  39.         $section = 'category';
  41.         $list = new Category\Listing();
  43.         // the context contains metadata for filters/processors
  44.         // it contains at least the url container, but you can add additional data
  45.         // with the params parameter
  46.         $context = new GeneratorContext($urlContainer, $section, ['de' => 'de']);
  48.         /** @var Category $category */
  49.         foreach ($list as $category) {
  50.             // only add element if it is not filtered
  51.             if (!$this->canBeAdded($category, $context)) {
  52.                 continue;
  53.             }
  55.             // use a link generator to generate an URL to the article
  56.             // you need to make sure the link generator generates an absolute url
  57.             $link = $category->getClass()->getLinkGenerator()->generate($category, [
  58.                 'referenceType' => UrlGeneratorInterface::ABSOLUTE_URL
  59.             ], true);
  61.             // create an entry for the sitemap
  62.             $url = new UrlConcrete($link);
  64.             // run url through processors
  65.             $url = $this->process($url, $category, $context);
  67.             // processors can return null to exclude the url
  68.             if (null === $url) {
  69.                 continue;
  70.             }
  72.             // add the url to the container
  73.             $urlContainer->addUrl($url, $section);
  74.         }
  75.     }
  76. }