vendor/pimcore/pimcore/lib/Sitemap/Document/DocumentTreeGenerator.php line 78

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /**
  6.  * Pimcore
  7.  *
  8.  * This source file is available under two different licenses:
  9.  * - GNU General Public License version 3 (GPLv3)
  10.  * - Pimcore Commercial License (PCL)
  11.  * Full copyright and license information is available in
  12.  * LICENSE.md which is distributed with this source code.
  13.  *
  14.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  15.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  16.  */
  18. namespace Pimcore\Sitemap\Document;
  20. use Pimcore\Model\Document;
  21. use Pimcore\Model\Site;
  22. use Pimcore\Sitemap\Element\AbstractElementGenerator;
  23. use Presta\SitemapBundle\Service\UrlContainerInterface;
  24. use Presta\SitemapBundle\Sitemap\Url\Url;
  25. use Presta\SitemapBundle\Sitemap\Url\UrlConcrete;
  26. use Symfony\Component\OptionsResolver\OptionsResolver;
  28. class DocumentTreeGenerator extends AbstractElementGenerator
  29. {
  30.     /**
  31.      * @var DocumentUrlGeneratorInterface
  32.      */
  33.     private $urlGenerator;
  35.     /**
  36.      * @var array
  37.      */
  38.     protected $options = [];
  40.     /**
  41.      * @var int
  42.      */
  43.     private $currentBatchCount = 0;
  45.     public function __construct(
  46.         DocumentUrlGeneratorInterface $urlGenerator,
  47.         array $filters = [],
  48.         array $processors = [],
  49.         array $options = []
  50.     ) {
  51.         parent::__construct($filters, $processors);
  53.         $this->urlGenerator = $urlGenerator;
  55.         $optionsResolver = new OptionsResolver();
  56.         $this->configureOptions($optionsResolver);
  58.         $this->options = $optionsResolver->resolve($options);
  59.     }
  61.     protected function configureOptions(OptionsResolver $options)
  62.     {
  63.         $options->setDefaults([
  64.             'rootId' => 1,
  65.             'handleMainDomain' => true,
  66.             'handleSites' => true,
  67.             'urlGeneratorOptions' => [],
  68.             'garbageCollectThreshold' => 50,
  69.         ]);
  71.         $options->setAllowedTypes('rootId', 'int');
  72.         $options->setAllowedTypes('handleMainDomain', 'bool');
  73.         $options->setAllowedTypes('handleSites', 'bool');
  74.         $options->setAllowedTypes('urlGeneratorOptions', 'array');
  75.         $options->setAllowedTypes('garbageCollectThreshold', 'int');
  76.     }
  78.     public function populate(UrlContainerInterface $urlContainer, string $section = null)
  79.     {
  80.         if ($this->options['handleMainDomain'] && null === $section || $section === 'default') {
  81.             $rootDocument = Document::getById($this->options['rootId']);
  83.             $this->populateCollection($urlContainer, $rootDocument, 'default');
  84.         }
  86.         if ($this->options['handleSites']) {
  87.             $sites = (new Site\Listing())->load();
  88.             foreach ($sites as $site) {
  89.                 $siteSection = sprintf('site_%s', $site->getId());
  91.                 if (null === $section || $section === $siteSection) {
  92.                     $this->populateCollection($urlContainer, $site->getRootDocument(), $siteSection, $site);
  93.                 }
  94.             }
  95.         }
  96.     }
  98.     private function populateCollection(UrlContainerInterface $urlContainer, Document $rootDocument, string $section, Site $site = null)
  99.     {
  100.         $context = new DocumentGeneratorContext($urlContainer, $section, $site);
  101.         $visit = $this->visit($rootDocument, $context);
  103.         foreach ($visit as $document) {
  104.             $url = $this->createUrl($document, $context);
  105.             if (null === $url) {
  106.                 continue;
  107.             }
  109.             $urlContainer->addUrl($url, $section);
  110.         }
  111.     }
  113.     /**
  114.      * @param Document $document
  115.      * @param DocumentGeneratorContext $context
  116.      *
  117.      * @return Url|null
  118.      */
  119.     private function createUrl(Document $document, DocumentGeneratorContext $context)
  120.     {
  121.         $url = $this->urlGenerator->generateDocumentUrl(
  122.             $document,
  123.             $context->getSite(),
  124.             $this->options['urlGeneratorOptions']
  125.         );
  127.         $url = new UrlConcrete($url);
  128.         $url = $this->process($url, $document, $context);
  130.         return $url;
  131.     }
  133.     /**
  134.      * @param Document $document
  135.      * @param DocumentGeneratorContext $context
  136.      *
  137.      * @return \Generator
  138.      *
  139.      * @throws \Exception
  140.      */
  141.     private function visit(Document $document, DocumentGeneratorContext $context): \Generator
  142.     {
  143.         if ($document instanceof Document\Hardlink) {
  144.             $document = Document\Hardlink\Service::wrap($document);
  145.             if (empty($document)) {
  146.                 return;
  147.             }
  148.         }
  150.         if ($this->canBeAdded($document, $context)) {
  151.             yield $document;
  153.             if (++$this->currentBatchCount >= $this->options['garbageCollectThreshold']) {
  154.                 $this->currentBatchCount = 0;
  155.                 \Pimcore::collectGarbage();
  156.             }
  157.         }
  159.         if ($document->hasChildren() && $this->handlesChildren($document, $context)) {
  160.             foreach ($document->getChildren() as $child) {
  161.                 yield from $this->visit($child, $context);
  162.             }
  163.         }
  164.     }
  165. }