Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/secit-pl/entity-translation-bundle
Doctrine entity translations for Symfony 4.x.
https://github.com/secit-pl/entity-translation-bundle
doctrine entity symfony translation translation-entity
Last synced: 2 months ago
JSON representation
Doctrine entity translations for Symfony 4.x.
- Host: GitHub
- URL: https://github.com/secit-pl/entity-translation-bundle
- Owner: secit-pl
- License: mit
- Created: 2018-07-02T07:57:30.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-16T12:56:00.000Z (almost 2 years ago)
- Last Synced: 2024-11-15T20:37:00.093Z (3 months ago)
- Topics: doctrine, entity, symfony, translation, translation-entity
- Language: PHP
- Homepage:
- Size: 24.4 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Entity Translation Bundle
Doctrine entity translations Symfony 4.x.
## Installation
From the command line run
```
$ composer require secit-pl/entity-translation-bundle
```
## Usage
#### Configuration
Open configuration file `./config/packages/entity_translation.yaml`. If file not exists create it.
The file content shoud looks somehting like this:
```yaml
entity_translation:
locales:
defined:
- pl
- en_GB
default: '%kernel.default_locale%' # in this example equals `pl`
```
#### Entity
###### Key rules
* Translatable entity should implements `SecIT\EntityTranslationBundle\Translations\TranslatableInterface`
* Translation entity should be called `Translation` and be placed in namespace same as translatable class name.
For example, if translatable entity is `App\Entity\Shop` the translation class should be `App\Entity\Shop\Translation`
* Translation should extends `SecIT\EntityTranslationBundle\Entity\AbstractTranslation`
###### Example
Let's say we have following entity and we want to translate the `name` and `description` fields.
Other field should not be translated.
./src/Entity/Shop.php
```php
id;
}
/**
* Get name.
*
* @return null|string
*/
public function getName(): ?string
{
return $this->name;
}
/**
* Set name.
*
* @param null|string $name
*
* @return Shop
*/
public function setName(?string $name): Shop
{
$this->name = $name;
return $this;
}
/**
* Get description.
*
* @return null|string
*/
public function getDescription(): ?string
{
return $this->description;
}
/**
* Set description.
*
* @param null|string $description
*
* @return Shop
*/
public function setDescription(?string $description): Shop
{
$this->description = $description;
return $this;
}
/**
* Get city.
*
* @return null|string
*/
public function getCity(): ?string
{
return $this->city;
}
/**
* Set city.
*
* @param null|string $city
*
* @return Shop
*/
public function setCity(?string $city): Shop
{
$this->city = $city;
return $this;
}
/**
* Get street.
*
* @return null|string
*/
public function getStreet(): ?string
{
return $this->street;
}
/**
* Set street.
*
* @param null|string $street
*
* @return Shop
*/
public function setStreet(?string $street): Shop
{
$this->street = $street;
return $this;
}
}
```
We need to split the file to two separeted files. One will contain the common part of each translation and one will contain the fields we want to translate.
First we need to create a Shop Translation entity. The entity should be placed in namespace `App\Entity\Shop`.
./src/Entity/Shop/Translation.php
```php
id;
}
/**
* Get name.
*
* @return null|string
*/
public function getName(): ?string
{
return $this->name;
}
/**
* Set name.
*
* @param null|string $name
*
* @return Translation
*/
public function setName(?string $name): Translation
{
$this->name = $name;
return $this;
}
/**
* Get description.
*
* @return null|string
*/
public function getDescription(): ?string
{
return $this->description;
}
/**
* Set description.
*
* @param null|string $description
*
* @return Translation
*/
public function setDescription(?string $description): Translation
{
$this->description = $description;
return $this;
}
}
```
What has been done:
* We created a class `Translation` in namespace `App\Entity\Shop`
* The class extends `SecIT\EntityTranslationBundle\Entity\AbstractTranslation`
* We created a standard entity with `name` and `description` fields copied from original entity
* To improve type hinting we added `@method Shop getTranslatable()`
Next it's time to change the base entity.
./src/Entity/Shop.php
```php
initializeTranslationsCollection();
}
/**
* Get id.
*
* @return int|null
*/
public function getId(): ?int
{
return $this->id;
}
/**
* Get name.
*
* @param null|string locale
*
* @return null|string
*/
public function getName(?string $locale = null): ?string
{
return $this->getTranslation($locale)->getName();
}
/**
* Get description.
*
* @param null|string locale
*
* @return null|string
*/
public function getDescription(?string $locale = null): ?string
{
return $this->getTranslation($locale)->getDescription();
}
/**
* Get city.
*
* @return null|string
*/
public function getCity(): ?string
{
return $this->city;
}
/**
* Set city.
*
* @param null|string $city
*
* @return Shop
*/
public function setCity(?string $city): Shop
{
$this->city = $city;
return $this;
}
/**
* Get street.
*
* @return null|string
*/
public function getStreet(): ?string
{
return $this->street;
}
/**
* Set street.
*
* @param null|string $street
*
* @return Shop
*/
public function setStreet(?string $street): Shop
{
$this->street = $street;
return $this;
}
}
```
What has been done:
* We added class implements `SecIT\EntityTranslationBundle\Translations\TranslatableInterface`
* We used default implementation of implemented interface using `SecIT\EntityTranslationBundle\Translations\TranslatableTrait`
* We added constructor to initialize translations collection
* We removed `name` and `description` setters
* `getName` and `getDescription` was changed to have easier way to get translated values and to be more backward compatible
* Type hinting was added
Now we need to update the database schema by `php bin/console doctrine:schema:update --force` and that's it. Now our entity is translatable.
**Remember, if you had a data in database you should move it manually to the new database schema!**
#### Usage
```php
setCity('city')
->setStreet('some street 1');
// adding polish translation
$shop->getTranslation('pl')
->setName('Nazwa')
->setDescription('Opis...');
// adding english translation
$shop->getTranslation('en_GB')
->setName('Name')
->setDescription('Description...');
$doctrine->getManager()->persist($shop);
$doctrine->getManager()->flush();
// fetching current locale translation
// let's say the default locale is en_GB
$name = $shop->getName(); // Name
// fetching defined locale translation
$name = $shop->getName('pl'); // Nazwa
// change the current locale
$shop->setCurrentLocale('pl');
$name = $shop->getName(); // Nazwa
```
#### Using translatable entity in forms
You need to create two classes. One for Translatable entity, and one for translation.
./src/Form/ShopType.php
```php
add('translations', ResourceTranslationsType::class, [
'entry_type' => TranslationType::class,
])
->add('city')
->add('street')
->add('save', SubmitType::class);
}
/**
* {@inheritdoc}
*/
public function configureOptions(OptionsResolver $resolver)
{
$resolver->setDefaults([
'data_class' => Shop::class,
]);
}
}
```
./src/Form/Shop/TranslationType.php
```php
add('name')
->add('description');
}
/**
* {@inheritdoc}
*/
public function configureOptions(OptionsResolver $resolver)
{
$resolver->setDefaults([
'data_class' => Translation::class,
]);
}
}
```
Now you can use `App\Form\ShopType` like a normal Symfony form.
Translations will be handled automatically.