PHPackages                             calamityju/object-translation-bundle - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Localization & i18n](/categories/localization)
4. /
5. calamityju/object-translation-bundle

ActiveSymfony-bundle[Localization & i18n](/categories/localization)

calamityju/object-translation-bundle
====================================

Translate your entities!

v1.0.0(5mo ago)01MITPHPPHP >=8.2CI passing

Since Jan 19Pushed 5mo agoCompare

[ Source](https://github.com/CalamityJu/object-translation-bundle)[ Packagist](https://packagist.org/packages/calamityju/object-translation-bundle)[ RSS](/packages/calamityju-object-translation-bundle/feed)WikiDiscussions 1.x Synced today

READMEChangelog (1)Dependencies (10)Versions (2)Used By (0)

calamityju/object-translation-bundle
====================================

[](#calamityjuobject-translation-bundle)

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

Installation
------------

[](#installation)

### Install the bundle via Composer:

[](#install-the-bundle-via-composer)

```
composer require calamityju/object-translation-bundle
```

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

[](#enable-the-bundle-in-your-configbundlesphp-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:

[](#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:

[](#configure-the-entity-in-your-configpackagesobject_translationyaml-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:

[](#create-and-run-the-migration-to-add-the-translation-table)

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

Marking Entities as Translatable
--------------------------------

[](#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
-----

[](#usage)

### `ObjectTranslator` Service

[](#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

[](#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
---------------------

[](#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`

[](#object-translationexport)

`` 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`

[](#object-translationimport)

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
-------------------

[](#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

[](#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

[](#object-translationwarmup-command)

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

```
symfony console object-translation:warmup
```

Full Default Configuration
--------------------------

[](#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
```

###  Health Score

32

—

LowBetter than 69% of packages

Maintenance71

Regular maintenance activity

Popularity1

Limited adoption so far

Community2

Small or concentrated contributor base

Maturity47

Maturing project, gaining track record

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

2

Last Release

165d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/25982311?v=4)[CalamityJu](/maintainers/CalamityJu)[@CalamityJu](https://github.com/CalamityJu)

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Type Coverage Yes

### Embed Badge

![Health badge](/badges/calamityju-object-translation-bundle/health.svg)

```
[![Health](https://phpackages.com/badges/calamityju-object-translation-bundle/health.svg)](https://phpackages.com/packages/calamityju-object-translation-bundle)
```

###  Alternatives

[easycorp/easyadmin-bundle

Admin generator for Symfony applications

4.3k17.9M386](/packages/easycorp-easyadmin-bundle)[rcsofttech/audit-trail-bundle

Enterprise-grade, high-performance Symfony audit trail bundle. Automatically track Doctrine entity changes with split-phase architecture, multiple transports (HTTP, Queue, Doctrine), and sensitive data masking.

1189.8k](/packages/rcsofttech-audit-trail-bundle)[2lenet/crudit-bundle

The easy like Crud'it Bundle.

1616.4k14](/packages/2lenet-crudit-bundle)[kimai/kimai

Kimai - Time Tracking

4.8k9.0k1](/packages/kimai-kimai)[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.5k5.9M737](/packages/sylius-sylius)[pimcore/pimcore

Content & Product Management Framework (CMS/PIM/E-Commerce)

3.8k3.8M508](/packages/pimcore-pimcore)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)