How prestaconcept/prestasitemapbundle works
Project type and purpose
• It’s a Symfony “bundle” (i.e., a reusable package) plugged into any Symfony application.
• Purpose: collect configured routes (static & dynamic), decorate them (images, video, mobile, multilang), then expose sitemaps via HTTP or dump them to XML files (optionally via Symfony Messenger).
File structure
• config/ (XML/YML DI, routing & messenger configs)
• src/
• DependencyInjection (bundle extension, config definition)
• Controller (SitemapController serving on-the-fly)
• Command (CLI entry DumpSitemapsCommand)
• Messenger (DumpSitemapMessage & handler)
• Service (Generator, Dumper, UrlContainer interfaces + implementations)
• EventListener (hook into routing & static routes)
• Sitemap (domain classes: Urlset, Url, Decorators, Sitemapindex)
• Tests (Integration using test Symfony apps; Unit tests)
README insights
• Describes two delivery modes: HTTP (Controller) and dumped files (Command + Messenger + Dumper).
• No database; it relies on Symfony Router + user callbacks (events) for dynamic URLs.
Main architectural components
A. Host Symfony Application
• Kernel
• Router → identifies routes matching “presta_sitemap” patterns
• EventDispatcher → dispatches SitemapPopulateEvent & custom events
• DI Container → loads services.xml, messenger.xml, routing.yml, services.xml
• Messenger Transport (if enabled)
B. PrestaSitemapBundle Components
1. Configuration & Extension (DependencyInjection)
– Reads bundle config (which routes to include)
– Registers services, routing, messenger handlers
2. Event Listeners
– RouteAnnotationEventListener (discovers annotated controllers)
– StaticRoutesAlternateEventListener (adds extra URLs)
3. UrlContainer (in-memory store)
4. Generator (builds Urlset & Sitemapindex objects by iterating UrlContainer)
5. Decorators (UrlDecorator, GoogleImage, GoogleVideo, etc.)
6. Controller (SitemapController)
– Calls Generator → returns HTTP Response with XML
7. Command (DumpSitemapsCommand)
– Optionally dispatches DumpSitemapMessage to Messenger
8. Messenger Handler (DumpSitemapMessageHandler)
– Invokes Dumper → writes files to disk
9. Dumper (implements file-based dumping, respects limits 50k URLs/10MB/file)
C. External Services / Systems
– Filesystem (local or cloud storage)
– Optional message queue (e.g., RabbitMQ, Redis) used by Messenger
Relationships & data flow
• HTTP Flow: Browser → Symfony Kernel → Router → SitemapController → Generator → UrlContainer ← (EventDispatcher) ← EventListeners → Decorated Url objects → Xml builder (Utils) → HTTP XML Response
• CLI + Async Flow: Console → DumpSitemapsCommand → (dispatch message) → Messenger Transport → DumpSitemapMessageHandler → Generator → Dumper → Filesystem (writes sitemapindex + urlset XML files)
Architectural patterns & design principles
• Dependency Injection (services wired via XML/YML)
• Event‐Driven (Symfony EventDispatcher for URL collection hooks)
• Command Bus / Messaging (Symfony Messenger for async dumping)
• Decorator Pattern (UrlDecorator classes for media enrichments)
• Single Responsibility (separate Generator vs Dumper vs Controller vs Handler)
Essential elements
• Clear component names matching code (e.g., SitemapController, DumpSitemapsCommand, DumpSitemapMessageHandler)
• Notes on extension points (events, decorators)