PrestaSitemapBundle

The Presta\SitemapBundle\Service\UrlContainerInterface::addUrl method accepts any object implementing the Presta\SitemapBundle\Sitemap\Url\Url interface. While the bundle automatically registers UrlConcrete instances for your configured static routes, you must manually register and use decorators to add advanced metadata (like images, video, or multilingual links).

All decorators follow the Decorator Pattern, allowing you to nest them to add multiple layers of information to a single URL.

Important: All URLs (routes, assets, etc.) must be absolute.

<?php
// Example of nesting decorators
$url = new Sitemap\UrlConcrete($router->generate('homepage', [], UrlGeneratorInterface::ABSOLUTE_URL));

// Wrap with mobile decorator
$url = new Sitemap\GoogleMobileUrlDecorator($url);

// Wrap with image decorator
$url = new Sitemap\GoogleImageUrlDecorator($url);
$url->addImage(new Sitemap\GoogleImage('https://acme.com/image.png'));

// Wrap with multilang decorator
$url = new Sitemap\GoogleMultilangUrlDecorator($url);
$url->addLink($router->generate('homepage_fr', [], UrlGeneratorInterface::ABSOLUTE_URL), 'fr');

$urls->addUrl($url, 'default');

The bundle generates standard XML sitemaps following the official specifications. It supports both sitemapindex files (to index multiple sitemaps) and urlset files (containing the actual URLs).

### Example sitemapindex
```xml
<?xml version="1.0" encoding="UTF-8"?>
<sitemapindex xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
              xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/siteindex.xsd"
              xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
    <sitemap>
        <loc>https://acme.org/sitemap.static.xml</loc>
        <lastmod>2020-01-01T10:00:00+02:00</lastmod>
    </sitemap>
</sitemapindex>

Example urlset

<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" 
        xmlns:xhtml="http://www.w3.org/1999/xhtml">
    <url>
        <loc>https://acme.org/</loc>
        <lastmod>2020-01-01T10:00:00+02:00</lastmod>
        <changefreq>daily</changefreq>
        <priority>0.5</priority>
    </url>
</urlset>

To include dynamic content (like blog posts, products, or custom entities) in your sitemap, you can register a Symfony EventSubscriber or EventListener that listens to the SitemapPopulateEvent.

When the event is dispatched, your subscriber receives a SitemapPopulateEvent object containing:

1. getUrlContainer(): A UrlContainerInterface used to add URLs to the sitemap.
2. getUrlGenerator(): A UrlGeneratorInterface (the Symfony router) to generate absolute URLs for your entities.

To add a URL, use the addUrl() method on the container. This method requires:

• A UrlConcrete object containing the generated absolute URL.
• A string identifier (e.g., 'blog') to categorize the URL.

Warning: When dealing with large datasets, avoid using Doctrine's findAll(). Instead, use iterators or array hydration to manage memory efficiently.

```php
namespace App\EventListener;

use App\\

To avoid regenerating the entire sitemap, you can use the --section option to regenerate only a specific part. This updates the corresponding section files and the main sitemap index while leaving other sections untouched.

Requirement: When using this feature, you must wrap your custom URL registration logic in a condition that checks the current section being dumped. Otherwise, all URLs will be added to every section dump.

<?php

use Presta\
SitemapBundle\\Event\\SitemapPopulateEvent;
use Presta\\SitemapBundle\\Sitemap\\Url as Sitemap;
use Symfony\\Component\\Routing\\Generator\\UrlGeneratorInterface;

/** @var SitemapPopulateEvent $event */
/** @var UrlGeneratorInterface $urlGenerator */

// Check if the current section being dumped matches your target section
if (in_array($event->getSection(), [null, 'mysection'], true)) {
    $event->getUrlContainer()->addUrl(
        new Sitemap\\UrlConcrete($urlGenerator->generate('route_in_my_section', [], UrlGeneratorInterface::ABSOLUTE_URL)),
        'mysection'
    );
}