calamityju/object-translation-bundle

This bundle provides a simple way to translate Doctrine entities in Symfony applications.

Installation

Install the bundle via Composer:

composer require calamityju/object-translation-bundle

Enable the bundle in your config/bundles.php file:

[!NOTE] This step is not required if you are using Symfony Flex.

return [
    // ...
    ObjectTranslationBundle::class => ['all' => true],
];

Create the translation entity in your app:

[!NOTE] This step is not required if you are using Symfony Flex.

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;
use CalamityJu\ObjectTranslationBundle\Model\Translation as BaseTranslation;

#[ORM\Entity]
class Translation extends BaseTranslation
{
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column]
    public int $id;
}

Configure the entity in your config/packages/object_translation.yaml file:

[!NOTE] This step is not required if you are using Symfony Flex.

calamityju_object_translation:
    translation_class: App\Entity\Translation

Create and run the migration to add the translation table:

symfony console make:migration
symfony console doctrine:migrations:migrate

Marking Entities as Translatable

To mark an entity as translatable, use the Translatable attribute on the entity class and the TranslatableProperty attribute on the fields you want to translate.

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;
use CalamityJu\ObjectTranslationBundle\Mapping\Translatable;
use CalamityJu\ObjectTranslationBundle\Mapping\TranslatableProperty;

#[ORM\Entity]
#[Translatable('product')]
class Product
{
    // ...

    #[ORM\Column(type: 'string', length: 255)]
    #[TranslatableProperty]
    public string $name;

    #[ORM\Column(type: 'text')]
    #[TranslatableProperty]
    public string $description;
}

Usage

ObjectTranslator Service

You can inject the ObjectTranslator service to translate entities.

use CalamityJu\ObjectTranslationBundle\ObjectTranslator;

class ProductController
{
    public function show(Product $product, ObjectTranslator $objectTranslator)
    {
        // translate into the current request locale
        $translatedProduct = $objectTranslator->translate($product);

        $translatedProduct->getName(); // returns the translated name (if available)
        $translatedProduct->getDescription(); // returns the translated description (if available)

        // ...
    }
}

The second argument of the translate() method allows you to specify a locale:

$product = $objectTranslator->translate($product, 'fr'); // translates into French

translate_object Twig Filter

If using Twig, you can use the translate_object filter to translate entities directly in templates.

{% set translatedProduct = product|translate_object %} {# translates into the current request locale #}

{% set frenchProduct = product|translate_object('fr') %} {# translates into French #}

Managing Translations

The Translation database table has the following structure:

• id: Primary key (added by you)
• object_type: The alias defined in the Translatable attribute (e.g., product)
• object_id: The ID of the translated entity
• locale: The locale of the translation (e.g., fr)
• field: The entity property name being translated (e.g., description)
• value: The translated value

Each row represents a single property translation for a specific entity in a specific locale.

You can manage these translations yourself but two console commands are provided to help:

object-translation:export

`` This command exports all entity translations, in your default locale, to a CSV file.

symfony console object-translation:export translations.csv

This will create a translations.csv file at the root of your project with the following structure:

type,id,field,value

You can then take this file to translation service for translation. Be sure to keep the type, id, and field columns intact. The value column is what needs to be translated into the desired language.

object-translation:import

This command imports translations from a CSV file created by the export command after the value column has been translated.

symfony console object-translation:import translations_fr.csv fr

The first argument is the path to the CSV file, and the second argument is the locale of the translations in that file.

Translation Caching

For performance, translations are cached. By default, they use your cache.app pool and have no expiration time. This can be configured:

calamityju_object_translation:
    cache:
        pool: 'cache.object_translation' # a custom pool name
        ttl: 3600 # expire after one hour

Translation Tags

If your cache pool supports cache tagging, tags are added to the cache keys. Two keys are added:

• object-translation: All translations are tagged with this key.
• object-translation-{type}: Where {type} is the translatable alias (e.g., product).

You can invalidate these tags by using the cache:pool:invalidate-tags command:

# invalidate all object translation caches
symfony console cache:pool:invalidate-tags object-translation

# invalidate only the translation cache for "product" entities
symfony console cache:pool:invalidate-tags object-translation-product

object-translation:warmup Command

This command preloads all translations into the cache for all your app's enabled locales.

symfony console object-translation:warmup

Full Default Configuration

calamityju_object_translation:

    # The class name of your translation entity.
    translation_class:    ~ # Required, Example: App\Entity\Translation

    # Cache settings for object translations.
    cache:
        enabled:              true

        # The cache pool to use for storing object translations.
        pool:                 cache.app

        # The time-to-livefor cached translations, in seconds, null for no expiration.
        ttl:                  null