README

Locastic Api Translation Bundle

Translation bundle for API Platform based on Sylius translation: translations are stored per locale in a dedicated translation entity and exposed through your API as embedded objects, with the active locale resolved from each request.

Supported versions:

Installation:

composer require locastic/api-platform-translation-bundle

Implementation:

Translatable entity:

• Extend your resource with Locastic\ApiPlatformTranslationBundle\Model\AbstractTranslatable
• Add a createTranslation() method which returns a new object of the translation entity
• Add a translations property: a OneToMany to the translation entity, indexed by locale, with the translations serialization group
• Add virtual fields for all translatable fields; their getters and setters delegate to the translation object

Example:

use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\Get;
use ApiPlatform\Metadata\GetCollection;
use ApiPlatform\Metadata\Patch;
use ApiPlatform\Metadata\Post;
use ApiPlatform\Metadata\Put;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Locastic\ApiPlatformTranslationBundle\Model\AbstractTranslatable;
use Locastic\ApiPlatformTranslationBundle\Model\TranslationInterface;
use Symfony\Component\Serializer\Attribute\Groups;

#[ORM\Entity]
#[ApiResource(
    operations: [
        new Get(),
        new GetCollection(),
        new Post(normalizationContext: ['groups' => ['translations']]),
        new Patch(normalizationContext: ['groups' => ['translations']]),
        // PUT replaces the resource; standard_put must be off so it edits the
        // managed entity instead of building a new one (see the notes below).
        new Put(
            normalizationContext: ['groups' => ['translations']],
            extraProperties: ['standard_put' => false],
        ),
    ],
    normalizationContext: ['groups' => ['article_read']],
    denormalizationContext: ['groups' => ['article_write']],
    filters: ['translation.groups'],
)]
class Article extends AbstractTranslatable
{
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column]
    private ?int $id = null;

    #[ORM\OneToMany(
        targetEntity: ArticleTranslation::class,
        mappedBy: 'translatable',
        fetch: 'EXTRA_LAZY',
        indexBy: 'locale',
        cascade: ['persist'],
        orphanRemoval: true,
    )]
    #[Groups(['article_write', 'translations'])]
    protected Collection $translations;

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

    #[Groups(['article_read'])]
    public function getTitle(): ?string
    {
        return $this->getTranslation()->getTitle();
    }

    public function setTitle(string $title): void
    {
        $this->getTranslation()->setTitle($title);
    }

    protected function createTranslation(): TranslationInterface
    {
        return new ArticleTranslation();
    }
}

Translation entity:

• Add an entity with all translatable fields. The convention is the name of the translatable entity + Translation
• Extend Locastic\ApiPlatformTranslationBundle\Model\AbstractTranslation
• Add the translations serialization group to all fields, plus your usual read/write groups

Example:

use Doctrine\ORM\Mapping as ORM;
use Locastic\ApiPlatformTranslationBundle\Model\AbstractTranslation;
use Locastic\ApiPlatformTranslationBundle\Model\TranslatableInterface;
use Symfony\Component\Serializer\Attribute\Groups;

#[ORM\Entity]
class ArticleTranslation extends AbstractTranslation
{
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column]
    #[Groups(['translations'])]
    private ?int $id = null;

    #[ORM\ManyToOne(targetEntity: Article::class, inversedBy: 'translations')]
    protected ?TranslatableInterface $translatable = null;

    #[ORM\Column]
    #[Groups(['article_read', 'article_write', 'translations'])]
    private ?string $title = null;

    #[ORM\Column]
    #[Groups(['article_write', 'translations'])]
    protected ?string $locale = null;

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

    public function getTitle(): ?string
    {
        return $this->title;
    }

    public function setTitle(string $title): void
    {
        $this->title = $title;
    }
}

API resource notes:

• The translation.groups filter (registered by this bundle) lets clients request all translation objects in a response via ?groups[]=translations. Without the translations group, responses contain only the requested (or fallback) locale.
• Add the translations group to the normalizationContext of POST and PUT/PATCH operations, as in the example above, so write operations return all translation objects.

Editing translations (PUT vs PATCH): the bundle populates the submitted translations onto the managed entity, keeping existing translation rows (and their ids) stable, following the HTTP semantics of each method:

• PATCH (application/merge-patch+json) is a partial edit: it updates the submitted locales and leaves the others untouched. This is the recommended way to edit translations and needs no extra configuration.
• PUT is a full replace: locales absent from the payload are removed.

For PUT you must disable API Platform's standard_put, either per operation (extraProperties: ['standard_put' => false], as above) or once for the whole API:

# config/packages/api_platform.yaml
api_platform:
    defaults:
        extra_properties:
            standard_put: false

With standard_put on, API Platform deserializes into a brand-new object and copies its properties (including the translations collection) over the managed entity, so translations cannot be matched to their existing rows. The bundle detects this misconfiguration and fails with an explicit error instead of letting the write die in the persistence layer.

Usage:

Language param for displaying a single translation:

?locale=de

Or use the Accept-Language http header

Accept-Language: de

Restricting locales: if framework.enabled_locales is configured, only those locales are accepted: a ?locale= value outside the list and non-matching Accept-Language headers fall back to the default locale. When enabled_locales is not configured (Symfony's default), any requested locale is accepted.

Serialization group for displaying all translations:

?groups[]=translations

POST translations example

{
    "datetime":"2017-10-10",
    "translations": {
        "en":{
            "title":"test",
            "content":"test",
            "locale":"en"
        },
        "de":{
            "title":"test de",
            "content":"test de",
            "locale":"de"
        }
    }
}

EDIT translations example

Send the id of each existing translation so it is updated instead of replaced:

{
    "datetime": "2017-10-10T00:00:00+02:00",
    "translations": {
        "de": {
          "id": 3,
          "title": "test edit de",
          "content": "test edit de",
          "locale": "de"
        },
        "en": {
          "id": 2,
          "title": "test edit",
          "content": "test edit",
          "locale": "en"
        }
    }
}

Contribution

If you have an idea on how to improve this bundle, feel free to contribute. If you have problems or you found some bugs, please open an issue.

Support

Want us to help you with this bundle or any API Platform/Symfony project? Write us an email on info@locastic.com