Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mhujer/consistence-bundle
ConsistenceBundle adds translator service, translator twig filter and form type for Consistence Enums
https://github.com/mhujer/consistence-bundle
bundle consistence enum enums php symfony
Last synced: about 2 months ago
JSON representation
ConsistenceBundle adds translator service, translator twig filter and form type for Consistence Enums
- Host: GitHub
- URL: https://github.com/mhujer/consistence-bundle
- Owner: mhujer
- License: mit
- Created: 2019-11-05T13:15:45.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-09T15:23:18.000Z (about 1 year ago)
- Last Synced: 2024-09-15T22:10:34.950Z (4 months ago)
- Topics: bundle, consistence, enum, enums, php, symfony
- Language: PHP
- Homepage:
- Size: 45.9 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ConsistenceBundle adds translator service, translator twig filter and form type for Consistence Enums
[](https://travis-ci.org/mhujer/consistence-bundle) [](https://packagist.org/packages/mhujer/consistence-bundle) [](https://packagist.org/packages/mhujer/consistence-bundle) [](https://packagist.org/packages/mhujer/consistence-bundle) [](https://coveralls.io/r/mhujer/consistence-bundle?branch=master)
This Bundle provides translator service, translator twig filter and form type for [consistence/consistence](https://github.com/consistence/consistence) enums.
# Installation
## Applications that use Symfony Flex
Open a command console, enter your project directory and execute:
```console
$ composer require mhujer/consistence-bundle
```
## Applications that don't use Symfony Flex
### Step 1: Download the Bundle
Open a command console, enter your project directory and execute the
following command to download the latest stable version of this bundle:
```console
$ composer require mhujer/consistence-bundle
```
This command requires you to have Composer installed globally, as explained
in the [installation chapter](https://getcomposer.org/doc/00-intro.md)
of the Composer documentation.
### Step 2: Enable the Bundle
Then, enable the bundle by adding it to the list of registered bundles
in the `config/bundles.php` file of your project:
```php
// config/bundles.php
return [
// ...
Mhujer\ConsistenceBundle\MhujerConsistenceBundle::class => ['all' => true],
];
```
# Usage
Examples consider having the following enum:
```php
'red',
CardColor::class . ':' . CardColor::BLACK => 'black',
];
```
As you might have noticed, the translation domain is set to `enums`.
## Twig
In Twig templates you can use `transEnum` filter to convert an enum to a translated string:
```twig
{{ variableContainingEnum | transEnum }}
```
## Translation domain
Sometimes it is useful to have different translations for the same enum (e.g. when the enum is used in admin and frontend UI). This is achieved by an `translationDomain` parameter which can be passed to `transEnum`:
```twig
{{ variableContainingEnum | transEnum('enums-frontend') }}
```
It loads translations transparently from another domain using Symfony translator:
```php
// enums-frontend.en.php
'Red',
CardColor::class . ':' . CardColor::BLACK => 'Black',
];
```
## Forms
In forms, you can use `EnumType` as a field type. You need to set an option `enum_class` to an enum class:
```php
public function buildForm(FormBuilderInterface $builder, array $options)
{
$builder
->add('cardColor', EnumType::class, [
'enum_class' => CardColor::class,
'label' => 'Card Color',
])
//...
```
Property in your [request object](https://blog.martinhujer.cz/symfony-forms-with-request-objects/) should look like this (it contains an instance of `CardColor`):
```php
/**
* @Assert\NotBlank()
* @var \App\Card\CardColor
*/
public $cardColor;
```
# Requirements
Works with PHP 7.4 or higher and Symfony 5.4 or higher.
# Submitting bugs and feature requests
Bugs and feature request are tracked on [GitHub](https://github.com/mhujer/consistence-bundle/issues)
# Author
[Martin Hujer](https://www.martinhujer.cz)
# Changelog
## 2.0.1 (2023-12-09)
- add Symfony 7 and PHP 8.2 support (dfridrich)
## 2.0.0 (2022-09-20)
- require PHP 8.1
- add support for native enums to make migration easier
## 1.4.0 (2021-12-04)
- require Symfony 5.4+
- allow PHP 8.1
- allow Symfony 6.0
## 1.3.0 (2021-06-10)
- BC break: optional parameter in `transEnum` is treated as translation domain
## 1.2.0 (2021-06-03)
- add optional parameter `$enumNamespace` to `transEnum` method
## 1.1.0 (2021-02-28)
- allow PHP 8.0
- require PHP 7.4+
## 1.0.2 (2020-01-13)
- Fixed [#3](https://github.com/mhujer/consistence-bundle/issues/3): _Undefined "translator" dependency in services.yaml_
## 1.0.1 (2019-11-24)
- Symfony 5 and Twig 3 compatibility
## 1.0.0 (2019-11-06)
- initial release