vendor/presta/sitemap-bundle/Service/Generator.php line 113

Open in your IDE?
  1. <?php
  3. /**
  4.  * This file is part of the PrestaSitemapBundle package.
  5.  *
  6.  * (c) PrestaConcept <www.prestaconcept.net>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Presta\SitemapBundle\Service;
  14. use Doctrine\Common\Cache\Cache;
  15. use Presta\SitemapBundle\Sitemap\Urlset;
  16. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  17. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  19. /**
  20.  * Sitemap Manager service
  21.  *
  22.  * @author David Epely <depely@prestaconcept.net>
  23.  * @author Christophe Dolivet
  24.  * @author Konstantin Myakshin <koc-dp@yandex.ru>
  25.  */
  26. class Generator extends AbstractGenerator implements GeneratorInterface
  27. {
  28.     /**
  29.      * @var UrlGeneratorInterface
  30.      */
  31.     protected $router;
  33.     /**
  34.      * @var Cache|null
  35.      */
  36.     protected $cache;
  38.     /**
  39.      * @var int|null
  40.      */
  41.     protected $cacheTtl;
  43.     /**
  44.      * @param EventDispatcherInterface $dispatcher
  45.      * @param UrlGeneratorInterface    $router
  46.      * @param Cache|null               $cache
  47.      * @param int|null                 $cacheTtl
  48.      * @param int|null                 $itemsBySet
  49.      */
  50.     public function __construct(
  51.         EventDispatcherInterface $dispatcher,
  52.         UrlGeneratorInterface $router,
  53.         Cache $cache = null,
  54.         $cacheTtl = null,
  55.         $itemsBySet = null
  56.     ) {
  57.         parent::__construct($dispatcher, $itemsBySet);
  59.         $this->router = $router;
  60.         $this->cache = $cache;
  61.         $this->cacheTtl = $cacheTtl;
  63.         if ($cache !== null) {
  64.             @trigger_error(
  65.                 'Providing ' . __METHOD__ . ' $cache parameter is deprecated.' .
  66.                 ' Cache support has been deprecated since v2.3.2 and will be removed in v3.0.0.',
  67.                 E_USER_DEPRECATED
  68.             );
  69.         }
  70.     }
  72.     /**
  73.      * @inheritdoc
  74.      */
  75.     public function generate()
  76.     {
  77.         @trigger_error(
  78.             __METHOD__ . ' is deprecated since v2.3.2 and will be removed in v3.0.0.' .
  79.             ' Use ' . __CLASS__ . '::fetch instead.',
  80.             E_USER_DEPRECATED
  81.         );
  83.         $this->populate();
  85.         //---------------------
  86.         //---------------------
  87.         // cache management
  88.         if ($this->cache) {
  89.             $this->cache->save('root', $this->getRoot(), $this->cacheTtl);
  91.             foreach ($this->urlsets as $name => $urlset) {
  92.                 $this->cache->save($name, $urlset, $this->cacheTtl);
  93.             }
  94.         }
  95.         //---------------------
  96.     }
  98.     /**
  99.      * @inheritdoc
  100.      */
  101.     public function fetch($name)
  102.     {
  103.         if ($this->cache && $this->cache->contains($name)) {
  104.             return $this->cache->fetch($name);
  105.         }
  107.         if ('root' === $name) {
  108.             $this->populate();
  110.             return $this->getRoot();
  111.         }
  113.         $this->populate($name);
  115.         if (array_key_exists($name, $this->urlsets)) {
  116.             $urlset = $this->urlsets[$name];
  117.             if ($this->cache) {
  118.                 $this->cache->save($name, $urlset, $this->cacheTtl);
  119.             }
  121.             return $urlset;
  122.         }
  124.         return null;
  125.     }
  127.     /**
  128.      * @inheritdoc
  129.      */
  130.     protected function newUrlset($name, \DateTimeInterface $lastmod = null)
  131.     {
  132.         return new Urlset(
  133.             $this->router->generate(
  134.                 'PrestaSitemapBundle_section',
  135.                 ['name' => $name, '_format' => 'xml'],
  136.                 UrlGeneratorInterface::ABSOLUTE_URL
  137.             ),
  138.             $lastmod
  139.         );
  140.     }
  141. }