Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sadikoff/i18n-form-bundle
Translate your doctrine objects easily with some helps
https://github.com/sadikoff/i18n-form-bundle
internationalization localization symfony-bundle symfony-forms symfony4
Last synced: about 1 month ago
JSON representation
Translate your doctrine objects easily with some helps
- Host: GitHub
- URL: https://github.com/sadikoff/i18n-form-bundle
- Owner: sadikoff
- License: mit
- Created: 2017-12-14T20:15:53.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2023-12-12T10:20:25.000Z (11 months ago)
- Last Synced: 2024-09-29T16:40:31.618Z (about 2 months ago)
- Topics: internationalization, localization, symfony-bundle, symfony-forms, symfony4
- Language: PHP
- Homepage: https://koff.pro/
- Size: 295 KB
- Stars: 7
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
koff/i18n-form-bundle
=====================
[](https://travis-ci.org/sadikoff/i18n-form-bundle)
[](https://packagist.org/packages/koff/i18n-form-bundle)
[](https://packagist.org/packages/koff/i18n-form-bundle)
[](https://packagist.org/packages/koff/i18n-form-bundle)
[](https://packagist.org/packages/koff/i18n-form-bundle)
[](https://scrutinizer-ci.com/g/sadikoff/i18n-form-bundle/?branch=master)
[](https://styleci.io/repos/114292466)
[](https://coveralls.io/github/sadikoff/i18n-form-bundle?branch=master)
>This bundle is fork of [a2lix/TranslationFormBundle](https://github.com/a2lix/TranslationFormBundle), reorganized and optimized to work with symfony flex
Requirements
------------
* Symfony flex with Symfony 3.4|4.0
* i18n Doctrine strategy of your choice
* [KnpLabs/DoctrineBehaviors](https://github.com/KnpLabs/DoctrineBehaviors#translatable) with `knplabs/doctrine-behaviors`
* [Atlantic18/DoctrineExtensions](https://github.com/Atlantic18/DoctrineExtensions/blob/v2.4.x/doc/translatable.md) with `stof/doctrine-extensions-bundle`
Installation
------------
composer req koff/i18n-form-bundle
Configuration
-------------
Full configuration example
```yaml
# config/packages/i18n_form.yaml
i18n_form:
locales: [en, fr, es, de]
required_locales: [fr]
excluded_fields: ['id', 'locale', 'translatable']
form_theme: 'bootstrap_3' # you can use 'bootstrap_3' or 'bootstrap_4' form template
```
Usage
-----
Basic example
```php
use Koff\Bundle\I18nFormBundle\Form\Type\TranslationsType;
//...
$builder->add('translations', TranslationsType::class);
```
Advanced example
```php
use Koff\Bundle\I18nFormBundle\Form\Type\TranslationsType;
//...
$builder->add('translations', TranslationsType::class, [
'locales' => ['en', 'fr', 'es', 'de'], // [1]
'default_locale' => ['en'] // [1]
'required_locales' => ['fr'], // [1]
'fields' => [ // [2]
'description' => [ // [3.a]
'field_type' => 'textarea', // [4]
'label' => 'descript.', // [4]
'locale_options' => [ // [3.b]
'es' => ['label' => 'descripción'] // [4]
'fr' => ['display' => false] // [4]
]
]
],
'excluded_fields' => ['details'] // [2]
]);
```
* [1] Optionnal. If set, override the default value from config.yml
* [2] Optionnal. If set, override the default value from config.yml
* [3] Optionnal. If set, override the auto configuration of fields
* [3.a] Optionnal. - For a field, applied to all locales
* [3.b] Optionnal. - For a specific locale of a field
* [4] Optionnal. Common options of symfony forms (max_length, required, trim, read_only, constraints, ...), which was added 'field_type' and 'display'
Additional
----------
#### TranslationsFormsType
A different approach for entities which don't share fields untranslated. No strategy used here, only a locale field in your entity.
```php
use Koff\Bundle\I18nFormBundle\Form\Type\TranslationsFormsType;
//...
$builder->add('translations', TranslationsFormsType::class, [
'locales' => ['en', 'fr', 'es', 'de'], // [1]
'default_locale' => ['en'] // [1]
'required_locales' => ['fr'], // [1]
'form_type' => ProductMediaType::class, // [2 - Mandatory]
'form_options' => [ // [2bis]
'context' => 'pdf'
]
]);
```
* [1] Optionnal. If set, override the default value from config.yml
* [2 - Mandatory]. A real form type that you have to do
* [2bis] Optionnal. - An array of options that you can set to your form
#### TranslatedEntityType
Modified version of the native 'entity' symfony2 form type to translate the label in the current locale by reading translations
```php
use Koff\Bundle\I18nFormBundle\Form\Type\TranslatedEntityType;
//...
$builder->add('medias', TranslatedEntityType::class, [
'class' => 'App\Entity\Media', // [1 - Mandatory]
'translation_property' => 'text', // [2 - Mandatory]
'multiple' => true, // [3]
]);
```
* [1] Path of the translatable class
* [2] Property/Method of the translatable class that will be display
* [3] Common options of the 'entity' symfony2 form type (multiple, ...)
Credits
=======
All credits goes to [David ALLIX](https://github.com/a2lix) and his [a2lix/TranslationFormBundle](https://github.com/a2lix/TranslationFormBundle)
License
=======
This package is available under the MIT license.