vendor/presta/sitemap-bundle/src/Event/SitemapPopulateEvent.php line 69

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the PrestaSitemapBundle package.
  5. *
  6. * (c) PrestaConcept <https://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\Event;
  14. use LogicException;
  15. use Presta\SitemapBundle\Service\UrlContainerInterface;
  16. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  17. use Symfony\Contracts\EventDispatcher\Event;
  19. /**
  20. * Event called whenever a sitemap build is requested.
  21. *
  22. * Subscribe to this event if :
  23. * - you want to register non-static routes
  24. */
  25. class SitemapPopulateEvent extends Event
  26. {
  27. /**
  28. * @Event("Presta\SitemapBundle\Event\SitemapPopulateEvent")
  29. * @deprecated since presta/sitemap-bundle 3.3, use `SitemapPopulateEvent::class` instead.
  30. */
  31. public const ON_SITEMAP_POPULATE = 'presta_sitemap.populate';
  33. /**
  34. * @var UrlContainerInterface
  35. */
  36. protected $urlContainer;
  38. /**
  39. * Allows creating EventListeners for particular sitemap sections, used when dumping
  40. * @var string|null
  41. */
  42. protected $section;
  44. /**
  45. * @var UrlGeneratorInterface|null
  46. */
  47. protected $urlGenerator;
  49. /**
  50. * @param UrlContainerInterface $urlContainer
  51. * @param string|null $section
  52. * @param UrlGeneratorInterface|null $urlGenerator
  53. */
  54. public function __construct(
  55. UrlContainerInterface $urlContainer,
  56. string $section = null,
  57. UrlGeneratorInterface $urlGenerator = null
  58. ) {
  59. $this->urlContainer = $urlContainer;
  60. $this->section = $section;
  61. $this->urlGenerator = $urlGenerator;
  62. }
  64. /**
  65. * @return UrlContainerInterface
  66. */
  67. public function getUrlContainer(): UrlContainerInterface
  68. {
  69. return $this->urlContainer;
  70. }
  72. /**
  73. * Section to be processed, null means any
  74. *
  75. * @return null|string
  76. */
  77. public function getSection(): ?string
  78. {
  79. return $this->section;
  80. }
  82. public function getUrlGenerator(): UrlGeneratorInterface
  83. {
  84. if (!$this->urlGenerator) {
  85. throw new LogicException('UrlGenerator was not set.');
  86. }
  88. return $this->urlGenerator;
  89. }
  90. }