lch/seo-bundle

Provides minimal SEO items on front-page-having entities : slug, title, description

1.5.9 2020-12-07 16:07 UTC

Requires

• php: ^7.1
• doctrine/annotations: ^1.8
• knplabs/doctrine-behaviors: ^2.0
• lch/components-bundle: ^1.2
• symfony/form: ^4.2
• symfony/framework-bundle: ^4.2
• symfony/orm-pack: ^1.0
• symfony/twig-bundle: ^4.2
• symfony/validator: ^4.2
• twig/extensions: 1.5.*

Requires (Dev)

• doctrine/doctrine-bundle: ^1.3
• phpunit/phpunit: ~4.8|~5.0

MIT

• Nicolas BONNIOT

• symfony
• seo
• management

README

This bundle add SEO capabilities for entities in any SF3 project. So far it handles:

• SEO meta (title, desc, slug with URL rewrite)
• Minimal OpenGraph implementation
• Canonical URL

Installation using composer

$ composer require lch/seo-bundle

Configuration and usage

1. Configuration
2. Entities preparations
3. Form type usage
4. Front rendering

Configuration

SeoBundle allows to generate minimal SEO requirements for specific pages (like homepage) or 'entity' pages (like news page). SEO for 'entity' pages is automatically generated. For specifics pages, follow these steps:

# app/config/config.yml

lch_seo:
    specific:
        route_name:
            tags:
                title: Page title               # Title of the current page
                description: Page description   # Desctiption (meta) of the current page
            sitemap:
                loc: /                          # URL of page
                priority: 1.0                   # Priority
        other_route_name:
            ...

Entities preparation

To automatically generate SEO for 'entity' pages, follow theses 2 steps:

Seoable trait

Add Seoable to any entity you want to have SEO settings on. This include

• seoTitle
• seoDescription
• slug field

    use Lch\SeoBundle\Behaviour\Seoable;
    use Lch\SeoBundle\Model\SeoInterface;
   
    class MyEntity implements SeoInterface
    {
    
        use Seoable;
        
        ...

SeoInterface implementation

Implements SeoInterface and fill 5 methods

1. getSluggableFields for getting fields name needed to build slug

    /**
     * @inheritdoc
     */
    public function getSluggableFields()
    {
        // This assume your entity have a field 'title'
        return [
            'title'
        ];
    }

1. getRouteFields for getting fields name needed to build route

An array is expected here, each key based on following pattern : routeParameter => entityParameter

    /**
     * @inheritdoc
     */
    public function getRouteFields()
    {
        return [
            'slug' => 'slug'
        ];
    }

1. getRouteName for allowing URL generation in SEO area (canonical URL, OpenGraph...)

    /**
     * @inheritdoc
     */
    public function getRouteName()
    {
        // This assume to return the entity show page route
        return 'yourproject_yourentity_show';
    }

1. getSeoTitleDefaultValue for pointing a field to use in case of SEO title empty (to generate default one)

   /**
     * @inheritdoc
     */
    public function getSeoTitleDefaultValue()
    {
        return $this->title;
    }

1. getOpenGraphData should return an array with OpenGraph data, such as : So far, SeoInterface declares following OG constants :

    const OG_TITLE = 'title';
    const OG_TYPE = 'type';
    const OG_URL = 'url';
    const OG_IMAGE = 'image';

Array returned example :

    /**
     * @inheritdoc
     */
    public function getOpenGraphData()
    {
        $openGraphData = [
            static::OG_TITLE => $this->title,
            static::OG_TYPE => "Open Graph type"
        ];

        // Image check example
        if($this->headBandImage instanceof Image) {
            $imageData = explode('/web', $this->getHeadBandImage()->getFile());
            $openGraphData[static::OG_IMAGE] = array_pop($imageData);
        }

        return $openGraphData;
    }

We assume that a unique constraint/index is set on slug field, or slug fields collection if more than one.

In addition, ton ensure proper form validation, be sure to add @UniqueEntity constraint, at least on slug field :

    use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
   
    /**
     * Class MyEntity
     * @package App\Entity\MyEntity
     *
     * @ORM\Table
     * @ORM\Entity
     * @UniqueEntity("slug")
     */
    class MyEntity implements SeoInterface
    {
    
        use Seoable;
        
        ...

Form type usage

SeoType

The bundle provides an SeoType, you can add to entities implementing SeoInterface types

use Lch\SeoBundle\Form\SeoType;

/**
 * {@inheritdoc}
 */
public function buildForm(FormBuilderInterface $builder, array $options)
{
    $builder

        // ...

        ->add('seo', SeoType::class, array(
            'label' => 'lch.seo.form.label',
            'required' => false,
            'attr' => [
                'no_label' => true,
                'force_two_columns_presentation' => true
            ]
        ))
    ;
}

Note: attr used are detailled with AdminBundle

Then, in the form twigs, add SEO form theme : {{ form_row(form.seo) }} to ensure fields rendering and logic.

Front rendering

Simply add a seo block in your base.html.twig in <head> section

    {% block seo %}{% endblock seo %}

Then, override this block on each page you want to display SEO information, with a custom Twig function:

• Specific pages :

    {% block seo %}
        {{ renderSeoTags(app.request) }}
    {% endblock seo %}

Note: app.request needs to be setting up here to generate SEO according to current route defined in config.yml

• Entity pages :

    {% block seo %}
        {{ renderSeoTags(entity) }}
    {% endblock seo %}

Persistence

So far, add call to $this->get('lch.seo.tools')->seoFilling() on controller before persist to ensure data will be set. Will be replaced with doctrine event later