Doctrine PHPCR-ODM Integration¶

In order to easily persist the SeoMetadata when using Doctrine PHPCR-ODM, the SeoBundle provides a special SeoMetadata document with the correct mappings. This document should be mapped as a child of the content document.

To be able to use this document, you have to enable the PHPCR persistence:

After you've enabled PHPCR, map $seoMetadata as a child:

And after that, you can use the Symfony\Cmf\Bundle\SeoBundle\Doctrine\Phpcr\SeoMetadata document:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

// src/Acme/SiteBundle/DataFixture/PHPCR/LoadPageData.php
namespace Acme\SiteBundle\DataFixtures\PHPCR;

use Acme\SiteBundle\Document\Page;
use Symfony\Cmf\Bundle\SeoBundle\Doctrine\Phpcr\SeoMetadata;
use Doctrine\Common\Persistence\ObjectManager;
use Doctrine\Common\DataFixtures\FixtureInterface;

class LoadPageData implements FixtureInterface
{
    public function load(ObjectManager $manager)
    {
        if (!$dm instanceof DocumentManager) {
            $class = get_class($dm);
            throw new \RuntimeException("Fixture requires a PHPCR ODM DocumentManager instance, instance of '$class' given.");
        }

        $page = new Page();
        // ... set some page properties

        $pageMetadata = new SeoMetadata();
        $pageMetadata->setDescription('A special SEO description.');
        $pageMetadata->setTags('seo, cmf, symfony');

        $page->setSeoMetadata($pageMetadata);

        $manager->persist($page);
        $manager->flush();
    }
}

Doctrine ORM¶

You can also use the Doctrine ORM with the CmfSeoBundle. You can just use the Symfony\Cmf\Bundle\SeoBundle\SeoMetadata class and map it as an object:

You can also choose to put the SeoMetadata class into a separate table. To do this, you have to enable ORM support just like you enabled PHPCR enabled above and add a OneToOne or ManyToOne relation between the content entity and the SeoMetadata entity.

Form Type¶

The bundle also provides a special form type called Symfony\Cmf\Bundle\SeoBundle\Form\Type\SeoMetadataType (use seo_metadata for Symfony versions older than 2.8). This form type can be used in forms to edit the SeoMetadata object:

1
2
3
4
5
6
7

use Sonata\AdminBundle\Form\FormMapper;
use Symfony\Cmf\Bundle\SeoBundle\Form\Type\SeoMetadataType;

/** @var FormMapper $formMapper */
$formMapper
    ->add('seoMetadata', SeoMetadataType::class)
;

Sonata Admin Integration¶

Besides providing a form type, the bundle also provides a Sonata Admin Extension. This extension adds a field for the SeoMetadata when an admin edits an object that implements the SeoAwareInterface in the Sonata Admin panel.