larapulse/sitemap-bundle

Provides a way to generate a sitemap as well as for static and dynamic routes, which require Propel, Doctrine, etc.

SitemapBundle

![Software License][ico-license] ![SensioLabs Insight][ico-sensio] ![Coverage Status][ico-scrutinizer] , _(*1)

This Bundle provides a way to create a xml sitemap using any source you want (Doctrine, Propel, MongoDB, Faker, etc.)., _(*2)

This bundle aims to generate standards compliant sitemaps. For more information about sitemaps go to sitemaps.org., _(*3)

The sitemap generation part is handled by the SitemapGenerator library, this bundle eases its integration into a Symfony2 application., _(*4)

Main features

• static sitemap generation
• dynamic sitemap generation
• sitemap index generation
• memory efficient
• datasource independent
• support for media content (currently images and videos)

Install

Via Composer, _(*5)

``` bash $ composer require larapulse/sitemap-bundle, <sub>(*6)</sub>

Register the `SitemapBundle` in `app/AppKernel.php`:

```php
# app/AppKernel.php
public function registerBundles()
{
    $bundles = [
        // ...
        new Larapulse\SitemapBundle\LarapulseSitemapBundle(),
    ];
}

Configuration

Add the following options to app/config/config.yml file:, <sub>(*7)</sub>

larapulse_sitemap:
    base_host:         http://www.foo.com
    base_host_sitemap: http://www.foo.com
    limit:             50000

Note:, <sub>(*8)</sub>

• The base_host will be prepended to relative urls added to the sitemap.
• The base_host_sitemap will be prepended to the sitemap filename (used for sitemap index)
• The limit is the number of url allowed in the same sitemap, if defined it will create a sitemap index

Routing

If you don't want to use the console to generate the sitemap, import the routes:, <sub>(*9)</sub>

larapulse_sitemap:
    resource: "@LarapulseSitemapBundle/Resources/config/routing.yml"

This will make the sitemap available from the /sitemap.xml URL., <sub>(*10)</sub>

Usage

Add this line /web/sitemap.xml* to your .gitignore to prevent tracking sitemap.xml files by version control system., <sub>(*11)</sub>

Providers

In order to support any kind of datasource, the sitemap uses providers to fetch the data., <sub>(*12)</sub>

Exemple provider:, <sub>(*13)</sub>

<?php

namespace SitemapGenerator\Provider;

use SitemapGenerator\Entity\Url;
use SitemapGenerator\Provider\ProviderInterface;
use SitemapGenerator\Sitemap\Sitemap;

class CustomProvider implements ProviderInterface
{
    public function populate(Sitemap $sitemap)
    {
        $url = new Url();
        $url->setLoc('http://www.google.de');
        $url->setChangefreq(Url::CHANGEFREQ_NEVER);
        $url->setLastmod('2012-12-19 02:28');
        $sitemap->add($url);
    }
}

All the providers implement the ProviderInterface, which define the populate() method., <sub>(*14)</sub>

Note: so they can be automatically used by the sitemap, providers have to be described in the DIC with the sitemap.provider tag:, <sub>(*15)</sub>

services:
    sitemap_custom_provider:
        class: SitemapGenerator\Provider\CustomProvider
        tags:
            -  { name: sitemap.provider }

All the services tagged as sitemap.provider will be used to generate the sitemap., <sub>(*16)</sub>

Simple provider

A provider to add static routes into the sitemap easily., <sub>(*17)</sub>

parameters:
    sitemap.simple_options:
        routes:
            - {name: homepage}
            - name: foo
              params: {foo: bar}
              lastmod: '2017-11-23'
              changefreq: monthly
              priority: 0.5
        # the following parameters are optionnal
        lastmod:        '2015-01-01'
        changefreq:     never
        priority:       0.2

services:
    sitemap_simple_provider:
        class:      SitemapGenerator\Provider\SimpleProvider
        arguments:  [ @router, %sitemap.simple_options% ]
        tags:
            -  { name: sitemap.provider }

Propel provider

A propel provider is included in the bundle. It allows to populate a sitemap with the content of a table., <sub>(*18)</sub>

Here is how you would configure the provider:, <sub>(*19)</sub>

# app/config/parameters.yml
parameters:
    sitemap.propel_options:
        model:      ACME\DemoBundle\Model\News
        # /news/{id}
        loc:        {route: news_show, params: {id: slug}}
        # the following parameters are optionnal
        filters:    ['filterByIsValid']
        lastmod:    date
        changefreq: daily
        priority:   0.2

# app/config/services.yml
services:
    sitemap_propel_provider:
        class:      SitemapGenerator\Provider\PropelProvider
        arguments:  
            - "@router"
            - "%sitemap.propel_options%"
        tags:
            -  { name: sitemap.provider }

Doctrine provider

A doctrine provider is included in the bundle. It allows to populate a sitemap with the content of a table., <sub>(*20)</sub>

Here is how you would configure the provider:, <sub>(*21)</sub>

# app/config/parameters.yml
parameters:
    sitemap.doctrine_options:
        entity:         AcmeDemoBundle:News
        # /news/{id}
        loc:            {route: news_show, params: {id: slug}}
        # the following parameters are optionnal
        query_method:   findValidQuery
        lastmod:        updatedAt
        changefreq:     daily
        priority:       0.2

# app/config/services.yml
services:
    sitemap_doctrine_provider:
        class:      SitemapGenerator\Provider\DoctrineProvider
        arguments:
            - "@doctrine.orm.entity_manager"
            - "@router"
            - "%sitemap.doctrine_options%"
        tags:
            -  { name: sitemap.provider }

Change log

Please see CHANGELOG for more information on what has changed recently., <sub>(*22)</sub>

Testing

bash $ composer test, <sub>(*23)</sub>

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details., <sub>(*24)</sub>

Security

If you discover any security related issues, please email :author_email instead of using the issue tracker., <sub>(*25)</sub>

Credits

• Sergey Podgornyy
• All Contributors

License

The MIT License (MIT). Please see License File for more information. This project was forked from sitemap-php/KPhoenSitemapBundle, <sub>(*26)</sub>