jeroendesloovere/sitemap-bundle

Symfony bundle for generating (one or multiple) Sitemaps and a SitemapIndex.

2.0.1 2018-07-19 11:06 UTC

README

Latest Stable Version License Build Status Scrutinizer Code Quality

This Symfony bundle allows you to easily generate a sitemapindex and one or multiple sitemap(s).

To Do Features

What needs to be done:

  • Generate the "sitemap provider last modified on datetime" which we need to show in the sitemapindex.

Usage

Installation

composer require jeroendesloovere/sitemap-bundle

Example: "How to create your custom sitemap?"

We need to notify Symfony that we have a new sitemap provider. Add the following somewhere in your services.yaml

services:
    App\SitemapProviders\NewsArticleSitemapProvider:
        tags:
            - { name: sitemap.provider }

When the SitemapGenerator needs to generate the sitemap(s), it will ask all SitemapProviders to fill in the items. Create something like the following in your app.

<?php

namespace App\SitemapProviders;

use JeroenDesloovere\SitemapBundle\Item\ChangeFrequency;
use JeroenDesloovere\SitemapBundle\Provider\SitemapProvider;
use JeroenDesloovere\SitemapBundle\Provider\SitemapProviderInterface;

class NewsArticleSitemapProvider extends SitemapProvider implements SitemapProviderInterface
{
    /** @var NewsArticleRepository */
    private $articleRepository;

    public function __construct(NewsArticleRepository $articleRepository)
    {
        $this->articleRepository = $articleRepository;

        // `NewsArticle::class` would even be better then just `NewsArticle`
        // because you can then use it with doctrine events.
        parent::__construct('NewsArticle');
    }

    public function createItems(): void
    {
        /** @var Article[] $articles */
        $articles = $this->articleRepository->findAll();
        foreach ($articles as $article) {
            $this->createItem('/nl/xxx/url-to-article', $article->getEditedOn(), ChangeFrequency::monthly());
        }
    }
}

You can now generate the sitemap(s) by executing:

bin/console sitemap:generate

Use a cronjob (f.e. every hour) to have up-to-date sitemaps.

OR if you want to use PHP

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

Example: You can overwrite the context

Problem

There is a known "bug" in symfony, that the context in console is always http://localhost, f.e.: when executing bin/console sitemap:generate. Read more about this on the Symfony website.

Solution

One of the two provided solutions is that you can solve the empty context by adding a CompilerPass in your code.

<?php

namespace App\Sitemap;

use App\Sitemap\DependencyInjection\Compiler\SitemapProviderPass;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\HttpKernel\Bundle\Bundle;

class SitemapBundle extends Bundle
{
    public function build(ContainerBuilder $container)
    {
        $container->addCompilerPass(new SitemapProviderPass());
    }
}
<?php

namespace App\Sitemap\DependencyInjection\Compiler;

use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;

class SitemapCompilerPass implements CompilerPassInterface
{
    public function process(ContainerBuilder $container): void
    {
        if (!$container->has('sitemap.generator')) {
            return;
        }

        $container->setParameter('router.request_context.host', 'www.mywebsite.com');
        $container->setParameter('router.request_context.scheme', 'http');
        $container->setParameter('router.request_context.base_url', '');
        $container->setParameter('asset.request_context.base_path', $container->getParameter('router.request_context.base_url'));
        $container->setParameter('asset.request_context.secure', true);
    }
}

Example: "How to use a Doctrine subscriber?"

Sometimes you want to fetch database changes from Doctrine events. The following code helps you doing that and regenerates the sitemaps.

    sitemap.subscriber:
        class: JeroenDesloovere\SitemapBundle\EventListener\SitemapSubscriber
        tags:
            - { name: doctrine.event_subscriber }
        arguments:
            - "@sitemap.providers"
            - "@sitemap.generator"
<?php

namespace JeroenDesloovere\SitemapBundle\EventListener;

use Doctrine\Common\EventSubscriber;
use Doctrine\Common\Persistence\Event\LifecycleEventArgs;
use Doctrine\ORM\Events;
use JeroenDesloovere\SitemapBundle\Generator\SitemapGenerator;
use JeroenDesloovere\SitemapBundle\Provider\SitemapProviders;

class SitemapSubscriber implements EventSubscriber
{
    /** @var SitemapGenerator */
    private $sitemapGenerator;

    /** @var SitemapProviders */
    private $sitemapProviders;

    public function __construct(SitemapProviders $sitemapProviders, SitemapGenerator $sitemapGenerator)
    {
        $this->sitemapProviders = $sitemapProviders;
        $this->sitemapGenerator = $sitemapGenerator;
    }

    public function getSubscribedEvents(): array
    {
        return [
            Events::postPersist,
            Events::postUpdate,
            Events::postRemove,
        ];
    }

    /**
     * @param LifecycleEventArgs $eventArgs
     * @throws \Exception
     */
    public function regenerate(LifecycleEventArgs $eventArgs): void
    {
        $entityClass = get_class($eventArgs->getObject());

        if ($this->sitemapProviders->exists($entityClass)) {
            $this->sitemapGenerator->regenerateForSitemapProvider($this->sitemapProviders->get($entityClass));
        }
    }

    public function postPersist(LifecycleEventArgs $eventArgs): void
    {
        $this->regenerate($eventArgs);
    }

    public function postRemove(LifecycleEventArgs $eventArgs): void
    {
        $this->regenerate($eventArgs);
    }

    public function postUpdate(LifecycleEventArgs $eventArgs): void
    {
        $this->regenerate($eventArgs);
    }
}

Documentation

The class is well documented inline. If you use a decent IDE you'll see that each method is documented with PHPDoc.

Contributing

Contributions are welcome and will be fully credited.

Pull Requests

To add or update code

  • Coding Syntax - Please keep the code syntax consistent with the rest of the package.
  • Add unit tests! - Your patch won't be accepted if it doesn't have tests.
  • Document any change in behavior - Make sure the README and any other relevant documentation are kept up-to-date.
  • Consider our release cycle - We try to follow semver. Randomly breaking public APIs is not an option.
  • Create topic branches - Don't ask us to pull from your master branch.
  • One pull request per feature - If you want to do more than one thing, send multiple pull requests.
  • Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.

Issues

For bug reporting or code discussions.

More info on how to work with GitHub on help.github.com.

Coding Syntax

We use squizlabs/php_codesniffer to maintain the code standards. Type the following to execute them:

# To view the code errors
vendor/bin/phpcs --standard=psr2 --extensions=php --warning-severity=0 --report=full "src"

# OR to fix the code errors
vendor/bin/phpcbf --standard=psr2 --extensions=php --warning-severity=0 --report=full "src"

Read documentation about the code standards

Unit Tests

We have build in tests, type the following to execute them:

vendor/bin/phpunit tests

Credits

License

The module is licensed under MIT. In short, this license allows you to do everything as long as the copyright statement stays present.