jantaodev/sitemap-bundle

Symfony bundle that provides sitemap XML generation

JantaoDevSitemapBundle

This Symfony bundle provides sitemap XML generation., _(*1)

Features:, _(*2)

• advanced robots.txt configuration
• several hosts support
• optional sitemap GZip compression
• sitemap constraints (10 MBytes/50 000 items per file) support
• route parameters iteration

Requirements:, _(*3)

• PHP 7.2
• Symfony 5
• Doctrine 2

1. Installation

Run composer require jantaodev/sitemap-bundle., _(*4)

Register the bundle in the app/AppKernel.php file (optional):, _(*5)

...
public function registerBundles()
{
    $bundles = array(
        ...
        new JantaoDev\SitemapBundle\JantaoDevSitemapBundle(),
        ...
    );
...

Add host name in app/config/parameters.yml, _(*6)

parameters:
    ...
    router.request_context.host:   example.com
    router.request_context.scheme: http

or in app/config/config.yml, _(*7)

...
jantao_dev_sitemap:
    hosts:
        - example.com

Now you can use the bundle., _(*8)

2. Basic usage

There are several ways to add route to sitemap., _(*9)

2.1. Annotation, yaml, XML (for static routes without parameters)

Annotation simple example:, _(*10)

/**
 * @Route("/", name="homepage", options={"sitemap" = true})
 */

Yaml simple example:, _(*11)

homepage:
    path: /
    defaults: { _controller: "AppBundle:Default:index" }
    options:
        sitemap: true

XML simple example:, _(*12)

<route id="homepage" path="/">
    <default key="_controller">AppBundle:Default:index</default>
    <option key="sitemap">true</option>
</route>

Annotation full example:, _(*13)

/**
 * @Route("/", name="homepage", options={"priority" = 0.5, "changeFreq" = "monthly", "lastMod" = "2017-02-23T13:14:15+02:00" })
 */

Yaml full example:, _(*14)

homepage:
    path: /
    defaults: { _controller: "AppBundle:Default:index" }
    options:
        sitemap:
            priority: 0.5
            changeFreq: monthly
            lastMod: "2017-02-23T13:14:15+02:00"

XML full example:, _(*15)

<route id="homepage" path="/">
    <default key="_controller">AppBundle:Default:index</default>
    <option key="sitemap">
        {"priority":"0.5", "changeFreq":"monthly", "lastMod":"2017-02-23T13:14:15+02:00"}
    </option>
</route>

There are three parameters:, _(*16)

• priority (real number from 0 to 1)
• changeFreq (one of values: always, never, hourly, daily, weekly, monthly, yearly)
• lastMod (see http://php.net/manual/en/datetime.formats.php)

It`s not necessary to specify all parameters., _(*17)

2.2. Bundle configuration in app/config/config.yml

Simple example for static route:, _(*18)

jantao_dev_sitemap:
    ...
    sitemap:
        homepage: ~

Full example for static route:, _(*19)

jantao_dev_sitemap:
    ...
    sitemap:
        homepage:
            priority: 0.5
            change_freq: monthly
            last_mod: "2017-02-23T13:14:15+02:00"

Full example for dynamic route with parameters:, _(*20)

jantao_dev_sitemap:
    ...
    sitemap:
        homepage:
            priority: 0.5
            change_freq: monthly
            last_mod: "2017-02-23T13:14:15+02:00"
            route_parameters:
                slug: "someslug"

Iterate data for route parameters with array iterator:, _(*21)

jantao_dev_sitemap:
    ...
    sitemap:
        homepage:
            iterator: array
            values:
                - slugone
                - slugtwo
                - slugthree
            priority: 0.5
            change_freq: monthly
            last_mod: "2017-02-23T13:14:15+02:00"
            route_parameters:
                slug: "->"

Iterate data for route parameters with array iterator (example 2):, _(*22)

jantao_dev_sitemap:
    ...
    sitemap:
        homepage:
            iterator: array
            values:
                - {slug: slugone, change: monthly}
                - {slug: slugtwo, change: hourly}
                - {slug: slugthree, change: dayly}
            priority: 0.5
            change_freq: "->change"
            last_mod: "2017-02-23T13:14:15+02:00"
            route_parameters:
                slug: "->slug"

Iterate data for route parameters with Doctrine iterator:, _(*23)

jantao_dev_sitemap:
    ...
    sitemap:
        homepage:
            iterator: doctrine
            query: 'SELECT p FROM AppBundle:Page p WHERE p.enabled = true'
            priority: 0.5
            change_freq: monthly
            last_mod: "->modifiedAt"
            route_parameters:
                slug: "->slug"
                categorySlug: "->category->slug"

3. Execute sitemap generation

There are two ways to execute sitemap generation:, _(*24)

1) via console, _(*25)

bin/console jantao_dev:sitemap:generate

2) via service, _(*26)

$this->get('jantao_dev.sitemap')->generate();

4. Advanced configuration

Full bundle configuration:, _(*27)

jantao_dev_sitemap:
    hosts:
        - example.com
    gzip: false
    scheme: https
    robots:
        # Robots.txt configuration
    sitemap:
        # Sitemap configuration

Parameters description:, _(*28)

• https_only means that site is available only over https

4.1. Robots.txt configuration

Full robots.txt configuration:, _(*29)

jantao_dev_sitemap:
    ...
    robots:
        allow:
            "/ajax/": ~
            "/system/": "Googlebot"
        disallow:
            "/admin/": ~
            "/otherpath": "Googlebot"
        crawl_delay: 5
        clean_param:
            "/photo": ["query=1", "page=2"]

Parameters description:, _(*30)

For more details about robots.txt parameters see this or this., _(*31)

4.2. Several hosts support

Several hosts support allows you to generate different sitemaps to several hosts., _(*32)

So, enable several hosts support, list your hosts in bundle configuration:, _(*33)

jantao_dev_sitemap:
    ...
    hosts:
        example.com
        foo.com
        bar.com

Enable robots.txt switching controller in router (add following lines to app/config/routing.yml):, _(*34)

jantao_dev_sitemap:
    resource: "@JantaoDevSitemapBundle/Resources/config/routing.xml"
    prefix:   /

By default all ruotes will be added to each host sitemaps., _(*35)

But in sitemap section in bundle configuration you can specify host., _(*36)

Example:, _(*37)

jantao_dev_sitemap:
    ...
    hosts:
        example.com
        foo.com
        bar.com
    ...
    sitemap:
        homepage: ~
        about@foo.com: ~

In this example homepage will be added to all sitemaps, but about page will be add only to "foo.com" sitemap., _(*38)

Example 2 (different slugs):, _(*39)

jantao_dev_sitemap:
    ...
    hosts:
        example.com
        ru.example.com
        de.example.com
    ...
    sitemap:
        homepage@example.com:
            iterator: doctrine
            query: 'SELECT p FROM AppBundle:Page p WHERE p.enabled = true'
            priority: 0.5
            change_freq: monthly
            last_mod: "->modifiedAt"
            route_parameters:
                slug: "->slugEn"
        homepage@ru.example.com:
            iterator: doctrine
            query: 'SELECT p FROM AppBundle:Page p WHERE p.enabled = true'
            priority: 0.5
            change_freq: monthly
            last_mod: "->modifiedAt"
            route_parameters:
                slug: "->slugRu"
        homepage@de.example.com:
            iterator: doctrine
            query: 'SELECT p FROM AppBundle:Page p WHERE p.enabled = true'
            priority: 0.5
            change_freq: monthly
            last_mod: "->modifiedAt"
            route_parameters:
                slug: "->slugDe"

5. Add custom event listener

To add a URL using your own logic, you can use event listener or event subscriber., _(*40)

Example AppBundle/EventListener/SomeListener.php:, _(*41)

<?php

namespace AppBundle\EventListener;

use JantaoDev\SitemapBundle\Service\SitemapListenerInterface;
use JantaoDev\SitemapBundle\Event\SitemapGenerateEvent;
use JantaoDev\SitemapBundle\Sitemap\Url;

class SomeListener implements SitemapListenerInterface
{

    public function generateSitemap(SitemapGenerateEvent $event)
    {
        $sitemap = $event->getSitemap();

        $url = new Url('/index.php', new \DateTime('now'), 0.8, 'weekly');
        $sitemap->add($url);
    }

}

Example AppBundle/Resources/config/services.yml:, _(*42)

services:
    app.some_listener:
        class: AppBundle\EventListener\SomeListener
        tags:
            - { name: jantao_dev.sitemap.listener }

6. Notes

TODO:, _(*43)

• cover EventListener classes with tests
• add report on command

7. License

This bundle is under MIT license, _(*44)