3. Translate Doctrine ORM models

You can either use Gedmo Doctrine Extensions or KnpLabs Doctrine Behaviors.

3.1. Using Gedmo Doctrine Extensions

Doctrine ORM models translations are handled by Gedmo translatable extension.

Gedmo has two ways to handle translations.

Either everything is saved in a unique table, this is easier to set up but can lead to bad performance if your project grows or it can have one translation table for every model table. This second way is called personal translation.

3.1.1. Implement Translatable

First step, your entities have to implement GedmoTranslatableTranslatable.

3.1.2. Define translatable Fields

Please check the docs in the Gedmo translatable documentation.

3.1.2.1. Example using Personal Translation

// src/Entity/FAQCategory.php

namespace Presta\CMSFAQBundle\Entity;

use Doctrine\Common\Collections\Collection;
use Doctrine\DBAL\Types;
use Doctrine\ORM\Mapping as ORM;
use Doctrine\Common\Collections\ArrayCollection;
use Gedmo\Mapping\Annotation as Gedmo;
use Gedmo\Translatable\Translatable;
use Presta\CMSFAQBundle\Entity\FAQCategory\Repository;
use Presta\CMSFAQBundle\Entity\FAQCategory\Translation;

#[ORM\Table(name: 'presta_cms_faq_category')]
#[ORM\Entity(repositoryClass: Repository::class)]
#[Gedmo\TranslationEntity(class: Translation::class)]
class FAQCategory implements Translatable
{
    #[ORM\Id]
    #[ORM\Column(type: Types::INTEGER)]
    #[ORM\GeneratedValue(strategy: 'AUTO')]
    private ?int $id;

    #[Gedmo\Translatable]
    #[ORM\Column(name: 'title', type: Types::STRING, length: 255, nullable: true)]
    private string $title;

    #[ORM\Column(type: Types::BOOLEAN, nullable: false)]
    private bool $enabled = false;

    #[ORM\Column(type: Types::INTEGER, length: 2, nullable: true)]
    private int $position;

    #[ORM\OneToMany(
        targetEntity: Translation::class,
        mappedBy: 'object',
        cascade: ['persist', 'remove']
    )]
    protected Collection $translations;

    // ...
}

3.1.3. Define your translation Table

This step is optional, but if you choose Personal Translation, you have to make a translation class to handle it.

3.1.3.1. Example for translation class for Personal Translation

// src/Entity/FAQCategory/Translation.php

namespace Presta\CMSFAQBundle\Entity\FAQCategory;

use Doctrine\ORM\Mapping as ORM;
use Gedmo\Translatable\Entity\MappedSuperclass\AbstractPersonalTranslation;
use Presta\CMSFAQBundle\Entity\FAQCategory;

#[ORM\Entity]
#[ORM\Table(name: 'presta_cms_faq_category_translation')]
#[ORM\UniqueConstraint(
    name: 'lookup_unique_faq_category_translation_idx',
    columns: ['locale', 'object_id', 'field']
)]
class Translation extends AbstractPersonalTranslation
{
    #[ORM\ManyToOne(
        targetEntity: FAQCategory::class,
        inversedBy: 'translations'
    )]
    #[ORM\JoinColumn(
        name: 'object_id',
        referencedColumnName: 'id',
        onDelete: 'CASCADE'
    )]
    protected $object;
}

3.2. Using KnpLabs Doctrine Behaviors

Due to Sonata internals, the magic method of Doctrine Behavior does not work. For more background on that topic, see this post:

// src/Entity/TranslatableEntity.php

namespace App\Entity;

use Doctrine\DBAL\Types;
use Doctrine\ORM\Mapping as ORM;
use Knp\DoctrineBehaviors\Contract\Entity\TranslatableInterface;
use Knp\DoctrineBehaviors\Model\Translatable\TranslatableTrait;

#[ORM\Table(name: 'app_translatable_entity')]
#[ORM\Entity()]
class TranslatableEntity implements TranslatableInterface
{
    use TranslatableTrait;

    #[ORM\Id]
    #[ORM\Column(type: Types::INTEGER)]
    #[ORM\GeneratedValue(strategy: 'AUTO')]
    private int $id;

    #[ORM\Column(type: Types::STRING, length: 255)]
    private string $nonTranslatedField;

    public function getId(): int
    {
        return $this->id;
    }

    public function getNonTranslatableField(): string
    {
        return $this->nonTranslatedField;
    }

    public function setNonTranslatableField(string $nonTranslatedField): TranslatableEntity
    {
        $this->nonTranslatedField = $nonTranslatedField;

        return $this;
    }

    public function getName(): string
    {
        return $this->translate(null, false)->getName();
    }

    public function setName(string $name): TranslatableEntity
    {
        $this->translate(null, false)->setName($name);

        return $this;
    }
}

3.2.1. Define your translation table

Please refer to KnpLabs Doctrine2 Behaviors Documentation.

Here is an example:

// src/Entity/TranslatableEntityTranslation.php

namespace App\Entity;

use Doctrine\DBAL\Types;
use Doctrine\ORM\Mapping as ORM;
use Knp\DoctrineBehaviors\Contract\Entity\TranslationInterface;
use Knp\DoctrineBehaviors\Model\Translatable\TranslationTrait;

#[ORM\Entity]
class TranslatableEntityTranslation implements TranslationInterface
{
    use TranslationTrait;

    #[ORM\Column(type: Types::STRING, length: 255)]
    private string $name;

    public function getId(): int
    {
        return $this->id;
    }

    public function getName(): string
    {
        return $this->name;
    }

    public function setName(string $name): TranslatableEntityTranslation
    {
        $this->name = $name;

        return $this;
    }
}