umanit / translation-bundle
Manages Doctrine translations
Installs: 6 379
Dependents: 0
Suggesters: 1
Security: 0
Stars: 7
Watchers: 16
Forks: 7
Open Issues: 2
Type:symfony-bundle
Requires
- php: >=8.0
- doctrine/doctrine-bundle: >=1.6
- doctrine/orm: >=2.9
- ramsey/uuid: >=3.7
- symfony/framework-bundle: ^4.4|^5.2|^6.0
- symfony/property-access: ^4.4|^5.2|^6.0
- symfony/security-bundle: ^4.4|^5.2|^6.0
- symfony/yaml: ^4.4|^5.2|^6.0
- twig/twig: >=2.7
Requires (Dev)
- jakub-onderka/php-parallel-lint: ^1.0
- phpunit/phpunit: >=6.5
- symfony/phpunit-bridge: ^4.4|^5.2|^6.0
This package is auto-updated.
Last update: 2024-10-19 10:13:03 UTC
README
This bundle intends to ease Doctrine entity translations. Unlike most translations libraries, every translation is stored in the same table as the source entity.
Features
- Add translations without changing existing entities
- Translation fields are stored in the same table (no expensive joins)
- Supports inherited entities
- Handle more than just text fields
- Integration with Sonata and EasyAdmin
- Auto-population of translated relations
Install
composer require umanit/translation-bundle
Register the bundle to your app/AppKernel.php
if it's not done automatically.
new Umanit\TranslationBundle\UmanitTranslationBundle(),
Configure your available locales and, optionally, the default one:
umanit_translation: locales: [en, fr, ja] default_locale: en
That's it!
Integration with Sonata Admin
You will need to add extra stylesheets and JavaScript to your admin interface:
sonata_admin: assets: extra_stylesheets: - 'bundles/umanittranslation/css/admin-sonata.css' extra_javascripts: - 'bundles/umanittranslation/js/admin-filters.js'
Usage
Make your entity translatable
Implement Umanit\TranslationBundle\Doctrine\TranslatableInterface
and use the trait
Umanit\TranslationBundle\Doctrine\ModelTranslatableTrait
on an entity you want to make translatable.
<?php namespace App\Entity\Content; use Doctrine\ORM\Mapping as ORM; use Umanit\TranslationBundle\Doctrine\Model\TranslatableInterface; use Umanit\TranslationBundle\Doctrine\Model\TranslatableTrait; /** * HomePage * * @ORM\Table(name="page") */ class Page implements TranslatableInterface { use TranslatableTrait; }
Translate your entity
Use the service umanit_translation.translator.entity_translator
to translate a source entity to a target language.
$translatedEntity = $this->get('umanit_translation.translator.entity_translator')->translate($entity, 'fr');
The $translatedEntity
will be persisted with Sonata, jumpstarted with EasyAdmin: with both, you'll be redirected to the
edit form.
Every attribute of the source entity will be cloned into a new entity, unless specified otherwise with the EmptyOnTranslate
attribute.
Options
Usually, you don't wan't to get all fields of your entity to be cloned. Some should be shared throughout all translations, others should be emptied in a new translation. Two special attributes are provided in order to solve this.
SharedAmongstTranslations
Using this attribute will make the value of your field identical throughout all translations: if you update this field in any translation, all the others will be synchronized. If the attribute is a relation to a translatable entity, it will associate the correct translation to each language.
Note : ManyToMany
associations are not supported with SharedAmongstTranslations
yet.
<?php namespace App\Entity\Content; use Doctrine\ORM\Mapping as ORM; use Umanit\TranslationBundle\Doctrine\Model\TranslatableInterface; use Umanit\TranslationBundle\Doctrine\Model\TranslatableTrait; use Umanit\TranslationBundle\Doctrine\Attribute\SharedAmongstTranslations; #[ORM\Table(name: "page")] class Page implements TranslatableInterface { use TranslatableTrait; #[ORM\ManyToOne(targetEntity: "Application\Sonata\MediaBundle\Entity\Media", cascade: {"persist"})] #[ORM\JoinColumn(name: "video_id", referencedColumnName: "id")] #[SharedAmongstTranslations] protected Application\Sonata\MediaBundle\Entity\Media $video; }
EmptyOnTranslate
This attribute will empty the field when creating a new translation.
<?php namespace App\Entity\Content; use Doctrine\ORM\Mapping as ORM; use Umanit\TranslationBundle\Doctrine\Model\TranslatableInterface; use Umanit\TranslationBundle\Doctrine\Model\TranslatableTrait; use Umanit\TranslationBundle\Doctrine\Attribute\EmptyOnTranslate; #[ORM\Table(name: "page")] class Page implements TranslatableInterface { use TranslatableTrait; // ... #[ORM\ManyToOne(targetEntity: "Application\Sonata\MediaBundle\Entity\Media", cascade: {"persist"})] #[ORM\JoinColumn(name: "image_id", referencedColumnName: "id")] #[EmptyOnTranslate] protected Application\Sonata\MediaBundle\Entity\Media $image; }
Filtering your contents
To fetch your contents out of your database in the current locale, you'd usually do something like $repository->findByLocale($request->getLocale())
.
Alternatively, you can use the provided filter that will automatically filter any Translatable entity by the current locale, every time you query the ORM.
This way, you can simply do $repository->findAll()
instead of the previous example.
Add this to your config.yml
file:
# Doctrine Configuration doctrine: orm: filters: # ... umanit_translation_locale_filter: class: 'Umanit\TranslationBundle\Doctrine\Filter\LocaleFilter' enabled: true
(Optional) Disable the filter for a specific firewall
Usually you'll need to administrate your contents. For doing so, you can disable the filter by configuring the disabled_firewalls option.
umanit_translation: # ... disabled_firewalls: ['admin']
Advanced usage
You can alter the entities to translate or translated, before and after translation using the Umanit\TranslationBundle\Event\TranslateEvent
TranslateEvent::PRE_TRANSLATE
called before starting to translate the properties. The new translation is just instanciated with the rightoid
andlocale
TranslateEvent::POST_TRANSLATE
called after saving the translation
Integration with admin bundles
Sonata
The bundle will automatically add translations widgets in SonataAdmin if you're using it.
- The
list
view will add two columnslocale
andtranslations
. - The
edit
button on thelist
view will show a dropdown to select the desired language to be edited. - The tab menu on the
edit
view will have an entry to translate the edited content.
If you want to define a default locale for the admin, configure the default_locale
.
umanit_translation: # ... default_locale: en
The admin will then show only the english contents on the list view.
EasyAdmin 4
- Have your controllers extend
AbstractTranslatableCRUDController
instead ofAbstractCrudController
from EasyAdmin. This will:- Add
TUUID
andlocale
as columns in the index view, as well as replace the edit action with links to translate to or edit a given locale - Add a translate dropdown with links to other locales on the edit view (translated or not)
- Add
The bundle does not automatically apply a filter to only show objects translated in the default locale (if it exists). The filter, however, is activated and can be manually triggered to display existing objects for the desired locale.
Integration with DoctrineSingletonBundle
The bundle will automatically work with the Doctrine Singleton Bundle. If your singleton implements the TranslatableInterface, it will be possible to get one instance per locale.