a2lix / translation-form-bundle
Translate your doctrine objects easily with some helpers
Installs: 5 721 101
Dependents: 53
Suggesters: 2
Security: 0
Stars: 331
Watchers: 12
Forks: 138
Open Issues: 12
Type:symfony-bundle
Requires
- php: ^8.1
- a2lix/auto-form-bundle: ^0.4
- symfony/config: ^5.4.30|^6.3|^7.0
- symfony/dependency-injection: ^5.4.30|^6.3|^7.0
- symfony/doctrine-bridge: ^5.4.30|^6.3|^7.0
- symfony/event-dispatcher: ^5.4.30|^6.3|^7.0
- symfony/form: ^5.4.30|^6.3|^7.0
- symfony/http-foundation: ^5.4.30|^6.3|^7.0
- symfony/http-kernel: ^5.4.30|^6.3|^7.0
- symfony/options-resolver: ^5.4.30|^6.3|^7.0
Requires (Dev)
- doctrine/orm: ^2.15
- friendsofphp/php-cs-fixer: ^3.45
- knplabs/doctrine-behaviors: ^2.3
- kubawerlos/php-cs-fixer-custom-fixers: ^3.18
- matthiasnoback/symfony-dependency-injection-test: ^5.0
- phpstan/phpstan: ^1.10
- rector/rector: ^0.18
- symfony/cache: ^5.4.30|^6.3|^7.0
- symfony/phpunit-bridge: ^5.4.30|^6.3|^7.0
- symfony/validator: ^5.4.30|^6.3|^7.0
- vimeo/psalm: ^5.18
Suggests
- knplabs/doctrine-behaviors: For Knp strategy
- prezent/doctrine-translatable-bundle: For Prezent strategy
- dev-master / 3.x-dev
- 3.2.4
- 3.2.3
- 3.2.2
- 3.2.1
- 3.2.0
- 3.1.0
- 3.0.10
- 3.0.9
- 3.0.8
- 3.0.7
- 3.0.6
- 3.0.5
- 3.0.4
- 3.0.3
- 3.0.2
- 3.0.1
- 3.0.0
- 3.0.0-beta.1
- 2.x-dev
- 2.4.3
- 2.4.2
- 2.4.1
- 2.4.0
- 2.3.0
- 2.2.0
- 2.1.2
- 2.1.1
- 2.1
- 2.0.4
- 2.0.3
- 2.0.2
- 2.0.1
- 2.0.0
- 1.x-dev
- 1.3
- 1.2
- 1.1
- 1.0
- 0.x-dev
- 0.4.0
- 0.3.10
- 0.3.9
- 0.3.8
- 0.3.5
- 0.3.0
- 0.2.0
This package is auto-updated.
Last update: 2024-11-02 18:21:09 UTC
README
Translate your doctrine objects easily with some helps
Screenshot example
Support
3.x
depends on AutoFormBundle and has higher requirements (PHP8.1+, Symfony5.4+/6.3+/7.0+). It is compatible with KnpLabs, A2lix and Prezent
Installation
Use composer:
composer require a2lix/translation-form-bundle
After the successful installation, add/check the bundle registration:
// Symfony >= 4.0 in bundles.php // ... A2lix\AutoFormBundle\A2lixAutoFormBundle::class => ['all' => true], A2lix\TranslationFormBundle\A2lixTranslationFormBundle::class => ['all' => true], // ... // Symfony >= 3.4 in AppKernel::registerBundles() $bundles = array( // ... new A2lix\AutoFormBundle\A2lixAutoFormBundle(), new A2lix\TranslationFormBundle\A2lixTranslationFormBundle(), // ...
Configuration
There is no minimal configuration. Full list of optional parameters:
# Symfony >= 4.0. Create a dedicated a2lix.yaml in config/packages with: # Symfony >= 3.4. Add in your app/config/config.yml: a2lix_translation_form: locale_provider: default # [1] locales: [en, fr, es, de] # [1-a] default_locale: en # [1-b] required_locales: [fr] # [1-c] templating: "@A2lixTranslationForm/bootstrap_4_layout.html.twig" # [2]
- Custom locale provider service id. Default one relies on [1-*] values:
- [1-a] List of translations locales to display
- [1-b] Default locale
- [1-c] List of required translations locales
- The default template is Twitter Bootstrap compatible. You can redefine your own here
Usage
In a classic formType
use A2lix\TranslationFormBundle\Form\Type\TranslationsType; ... $builder->add('translations', TranslationsType::class);
Advanced examples
use A2lix\TranslationFormBundle\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] 'locale_labels' => [ // [5] 'fr' => 'Français', 'en' => 'English', ], ]);
- Optional. If set, override the default value from config.yml
- Optional. If set, override the default value from config.yml
- Optional. If set, override the auto configuration of fields
- [3.a] Optional. - For a field, applied to all locales
- [3.b] Optional. - For a specific locale of a field
- Optional. Common options of symfony forms (max_length, required, trim, read_only, constraints, ...), which was added 'field_type' and 'display'
- Optional. Set the labels for the translation tabs. Default to the name of the locale. Translation keys can be used here.
Additional
TranslationsFormsType
A different approach for entities which don't share fields untranslated. No strategy used here, only a locale field in your entity.
use A2lix\TranslationFormBundle\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' ] ]);
- Optional. If set, override the default value from config.yml
- Mandatory. A real form type that you have to do
- [2bis] Optional. - An array of options that you can set to your form
TranslatedEntityType
Modified version of the native 'entity' symfony form type to translate the label in the current locale by reading translations
use A2lix\TranslationFormBundle\Form\Type\TranslatedEntityType; ... $builder->add('medias', TranslatedEntityType::class, [ 'class' => 'A2lix\DemoTranslationBundle\Entity\Media', // [1 - Mandatory] 'translation_property' => 'title', // [2 - Mandatory] 'multiple' => true, // [3] ]);
- Path of the translatable class
- Property/Method of the translatable class that will be display
- Common options of the 'entity' Symfony form type (multiple, ...)
Example
See Demo Bundle for more examples.
Contribution help
docker run --rm --interactive --tty --volume $PWD:/app --user $(id -u):$(id -g) composer install --ignore-platform-reqs
docker run --rm --interactive --tty --volume $PWD:/app --user $(id -u):$(id -g) composer run-script phpunit
docker run --rm --interactive --tty --volume $PWD:/app --user $(id -u):$(id -g) composer run-script cs-fixer
License
This package is available under the MIT license.