Apperclass Sitemap Bundle

Apperclass Sitemap Bundle help you to create a sitemap for your site. It's easy to extend and customize. Based on the Apperclass SitemapBuilder library.

Create your own sitemap populator

Create a tagged service to populate the sitemap

    <service id="my_project.my_custom_sitemap_populator" class="MyProject\Sitemap\MySitemapPopulator">
        <tag name="apperclass_sitemap.sitemap_populator" />
    </service>

Implements SitemapPopulatorInterface as you need.

<?php

namespace MyProject\Sitemap;

use Apperclass\SitemapBuilder\Model\SitemapInterface;
use Apperclass\SitemapBuilder\Model\SitemapUrl;
use Apperclass\SitemapBuilder\SitemapPopulatorInterface;

class MySitemapPopulator implements SitemapPopulatorInterface
{

    /**
     * @param SitemapInterface $sitemap
     * @return void
     */
    public function populate(SitemapInterface $sitemap)
    {
        $sitemapUrl = new SitemapUrl();
        $url = 'http://www.mysite.com';
        $sitemapUrl->setLoc($url);

        $sitemap->add($url);
    }
}

This example of SitemapPopulator is trivial but it's a service so you can inject all you need to populate the sitemap.

Run the command

Run the command to write a file in a available format. Use --dump to see the output.

php app/console apperclass:sitemap:generate [--path[="..."]] [--format[="..."]] [--dump]

• You can specify in which format you want the sitemap by using --format option. (default: xml)
• You can specify the path to the output as an absolute path by using --path option. (default: apperclass_sitemap.path)

Configuration reference

apperclass_sitemap:
    path: %kernel.root_dir%/../web/sitemap.xml

Add a custom encoder (available format)

You can add a custom encoder/format by implementing a SitemapEncoderInterface:

<?php

namespace MyProject\Sitemap;

use Apperclass\SitemapBuilder\Model\SitemapInterface;
use Apperclass\SitemapBuilder\Encoder\SitemapEncoderInterface;

class MyFormatEncoder implements SitemapEncoderInterface
{
    /**
     * @param SitemapInterface $sitemap
     * @return string $string
     */
    public function encode(SitemapInterface $sitemap)
    {
        // ... encoding logic;
        return $string;
    }

    public function getFormat()
    {
        return 'my-format';
    }
}

register this class as a tagged service:

<service id="my_project.sitemap_my_format_encoder" class="MyProject\Sitemap\MyFormatEncoder">
    <tag name="apperclass_sitemap.sitemap_encoder" />
</service>

and you are done. Now you can use the new format with the generate command.

php app/console apperclass:sitemap:generate --format="my-format" --path="/my-project/sitemap.my-format"