kdefives
commented
3 years ago I find a solution by creating a SitemapSubscriber as below, if it can help other people who face the same problem, feel free to reuse and/or adapt the code:
<?php
namespace App\EventSubscriber;
use App\EventSubscriber\Model\RouteSiteMapped;
use Presta\SitemapBundle\Event\SitemapPopulateEvent;
use Presta\SitemapBundle\Service\UrlContainerInterface;
use Presta\SitemapBundle\Sitemap\Url\UrlConcrete;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
/**
* Class SitemapSubscriber
* @package App\EventSubscriber
*
* This subscriber is used to dump/generate the sitemap.
*/
class SitemapSubscriber implements EventSubscriberInterface
{
/**
* @var array<RouteSiteMapped>
*/
private array $routesToAddToSitemap;
/**
* @var UrlGeneratorInterface
*/
private UrlGeneratorInterface $urlGenerator;
/**
* @var array<string>
*/
private array $supportedLocales;
/**
* SitemapSubscriber constructor.
* @param UrlGeneratorInterface $urlGenerator
* @param string $supportedLocales
*/
public function __construct(UrlGeneratorInterface $urlGenerator, string $supportedLocales)
{
$this->urlGenerator = $urlGenerator;
$this->supportedLocales = explode('|', $supportedLocales);
// Initialise routes will be included inside sitemap
$this->initRoutesToAddToSitemap();
}
/**
* @return array<string, string>
*/
public static function getSubscribedEvents(): array
{
return [
SitemapPopulateEvent::ON_SITEMAP_POPULATE => 'populate',
];
}
public function populate(SitemapPopulateEvent $event): void
{
$this->registerStaticPages($event->getUrlContainer());
}
/**
* Initialized routes that will be included inside sitemap.
*
* Note: Add routes in this function to add a route inside sitemap.
*/
private function initRoutesToAddToSitemap(): void
{
// Add homepage
$this->routesToAddToSitemap[] = new RouteSiteMapped('homepage.display',
null, RouteSiteMapped::CHANGE_FREQ_WEEKLY, 1);
// Add aboutus page
$this->routesToAddToSitemap[] = new RouteSiteMapped('about.display',
null, RouteSiteMapped::CHANGE_FREQ_WEEKLY, 0.5);
// Add privacy policy page
$this->routesToAddToSitemap[] = new RouteSiteMapped('privacyPolicy.display',
null, RouteSiteMapped::CHANGE_FREQ_WEEKLY, 0.5);
// Add cookie consent page
$this->routesToAddToSitemap[] = new RouteSiteMapped('cookie.display',
null, RouteSiteMapped::CHANGE_FREQ_MONTHLY, 0.3);
}
/**
* @param UrlContainerInterface $urls
*/
private function registerStaticPages(UrlContainerInterface $urls): void
{
// Loop all available locales
foreach ($this->supportedLocales as $locale)
{
// Loop all routes that we want to add inside sitemap
foreach ($this->routesToAddToSitemap as $routeSiteMapped)
{
$urls->addUrl(
new UrlConcrete(
$this->urlGenerator->generate(
$routeSiteMapped->getRouteName(),
['_locale' => $locale],
UrlGeneratorInterface::ABSOLUTE_URL
),
$routeSiteMapped->getLastmod(),
$routeSiteMapped->getChangefreq(),
$routeSiteMapped->getPriority()
),
$routeSiteMapped->getSection()
);
}
}
}
}the code above this this:
# services.yaml
parameters:
app.supported_locales: 'en|fr'
router.request_context.host: 'my-website.com'
router.request_context.scheme: 'http'
services:
_defaults:
autowire: true # Automatically injects dependencies in your services.
autoconfigure: true # Automatically registers your services as commands, event subscribers, etc.
bind:
$supportedLocales: '%app.supported_locales%'<?php
namespace App\EventSubscriber\Model;
use DateTimeInterface;
/**
* Class RouteSiteMapped
* @package App\EventSubscriber\Model
*
* This class is a representation of route which will be includes inside generated sitemap.
*/
class RouteSiteMapped
{
/**
* Available values for changefreq used in sitemap.
*/
const CHANGE_FREQ_WEEKLY = 'weekly';
const CHANGE_FREQ_MONTHLY = 'monthly';
/**
* @var string The route name (cf. controller annotation).
*/
private string $routeName;
/**
* @var DateTimeInterface|null The data of last modification used in sitemap.
*/
private ?DateTimeInterface $lastmod;
/**
* @var string|null The change frequency value used in sitemap.
*/
private ?string $changefreq;
/**
* @var float|null The priority of the url used in sitemap.
*/
private ?float $priority;
/**
* @var string The section used in sitemap for the url.
*/
private string $section;
/**
* RouteSiteMapped constructor.
* @param string $routeName
* @param DateTimeInterface|null $lastmod
* @param string|null $changefreq
* @param float|null $priority
* @param string $section
*/
public function __construct(string $routeName,
?DateTimeInterface $lastmod,
?string $changefreq,
?float $priority,
string $section = 'default')
{
$this->routeName = $routeName;
$this->lastmod = $lastmod;
$this->changefreq = $changefreq;
$this->priority = $priority;
$this->section = $section;
}
/**
* @return string
*/
public function getRouteName(): string
{
return $this->routeName;
}
/**
* @return DateTimeInterface|null
*/
public function getLastmod(): ?DateTimeInterface
{
return $this->lastmod;
}
/**
* @return string|null
*/
public function getChangefreq(): ?string
{
return $this->changefreq;
}
/**
* @return float|null
*/
public function getPriority(): ?float
{
return $this->priority;
}
/**
* @return string
*/
public function getSection(): string
{
return $this->section;
}
}
yann-eugone
Hello,
Context:
To do that, below how my controller is declared:
Below the declaration of app.supported_locales parameter in services.yaml:
Problem: When i execute the command to dump the sitemap, i have an error message:
So i tried to execute this command to try to give the required parameter but it the same:
Questions: Could I use the concept of "dynamic route usage" as a solution? I mean, using Subscriber instead of route annotations? In this case, how to determine the supported sitemap parameters (mastmod, changefreq and priority)?
Thanks for your help