Code review

Author: yann-eugone

README.md

@@ -25,7 +25,7 @@ $ composer require yokai/enum-bundle
 
 ### Enable the bundle in the kernel
 
-``` php
+```php
 <?php
 // config/bundles.php
 
@@ -39,16 +39,17 @@ return [
 Usage
 -----
 
-Let's take an example : our application has some members and each member has a `gender` which can be "male" (`m`) or "female" (`f`).
+Let's take an example : our application has some members 
+and each member has a `gender` which can be "male" (`m`) or "female" (`f`).
 
 We first need to create the classes that will handle our enums :
 
 > **Note** this example is optimized for latest versions of Symfony, you will find more in dedicated doc file.
 
-``` php
+```php
 <?php
-// src/App/Enum/Member/GenderEnum.php
-namespace App\Enum\Member;
+// src/App/Enum/GenderEnum.php
+namespace App\Enum;
 
 use Yokai\EnumBundle\Enum\EnumInterface;
 use Yokai\EnumBundle\Enum\EnumWithClassAsNameTrait;
@@ -64,16 +65,17 @@ class GenderEnum implements EnumInterface
 }
 ```
 
-If you are using PSR-4 service discovery, then your service is already registered.
+If you are using [PSR-4 service discovery](https://symfony.com/blog/new-in-symfony-3-3-psr-4-based-service-discovery),
+then your service is already registered.
 
 That's it, now the bundle know your enum services. You can start using it.
 
 Adding validation to your model :
 
-``` php
+```php
 <?php
-// src/AppBundle/Model/Member.php
-namespace AppBundle\Model;
+// src/App/Model/Member.php
+namespace App\Model;
 
 use Yokai\EnumBundle\Validator\Constraints\Enum;
 
@@ -82,22 +84,24 @@ class Member
     /**
      * @var string
      *
-     * @Enum("App\Enum\Member\GenderEnum")
+     * @Enum("App\Enum\GenderEnum")
      */
     protected $gender;
 }
 ```
 
 Adding enum form types :
 
-``` php
+```php
 <?php
-// src/AppBundle/Form/Type/MemberType.php
-namespace AppBundle\Form\Type;
+// src/App/Form/Type/MemberType.php
+namespace App\Form\Type;
 
-use AppBundle\Enum\GenderEnum;
-use AppBundle\Enum\StateEnum;
+use App\Enum\GenderEnum;
 use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\FormBuilderInterface;
+// For Symfony >= 2.8
+use Yokai\EnumBundle\Form\Type\EnumType;
 
 class MemberType extends AbstractType
 {
@@ -106,6 +110,12 @@ class MemberType extends AbstractType
         $builder
             // Let the bundle guess the form type for you (requires that you configured the validation)
             ->add('gender')
+
+            // Manual form type binding for Symfony >= 2.8
+            ->add('gender', EnumType::class, ['enum' => GenderEnum::class])
+
+            // Manual form type binding for Symfony 2.7
+            ->add('gender', 'enum', ['enum' => GenderEnum::class])
         ;
     }
 }
@@ -114,15 +124,15 @@ class MemberType extends AbstractType
 Displaying the label for an enum value within a template :
 
 ```twig
-    {{ value|enum_label(constant('AppBundle\\Enum\\Member\\GenderEnum')) }}
+{{ value|enum_label('App\\Enum\\GenderEnum') }}
 ```
 
 
 Recipes
-------------
+-------
 
 - Usage in [SonataAdminBundle](https://github.com/sonata-project/SonataAdminBundle) : see [doc](Resources/doc/sonata-admin.md)
-- All the ways to [declare enums](Resources/doc/declaring-enum.md)
+- All the ways to declare [enums](Resources/doc/declaring-enum.md) or [translated enums](Resources/doc/declaring-translated-enum.md)
 
 
 MIT License
@@ -136,3 +146,7 @@ Authors
 
 The bundle was originally created by [Yann Eugoné](https://github.com/yann-eugone).
 See the list of [contributors](https://github.com/yokai-php/enum-bundle/contributors).
+
+---
+
+Thank's to [Prestaconcept](https://github.com/prestaconcept) for supporting this bundle.

Resources/doc/declaring-enum.md

@@ -3,11 +3,14 @@ Declaring enum
 
 An enum is nothing more than a class with 2 methods : `getName` & `getChoices`, registered as a service.
 
-There is a lot of way to create and declare such classes
+There is a lot of way to create and declare such classes.
+
+> **Note :** If you wish to declare translation based enum, 
+> please see [dedicated documentation](declaring-translated-enum.md)
 
 
 The classic way
------
+---------------
 
 Create a new class, implement both `getName` & `getChoices` methods.
 
@@ -34,7 +37,7 @@ class GenderEnum implements EnumInterface
 
 Define an enum service for it.
 
-``` yaml
+```yaml
 services:
     enum.member.gender:
         class: 'App\Enum\GenderEnum'
@@ -44,7 +47,7 @@ services:
 
 
 The class as name way
------
+---------------------
 
 Create a new class, use `EnumWithClassAsNameTrait` trait and implement `getChoices` methods.
 
@@ -69,7 +72,7 @@ class GenderEnum implements EnumInterface
 
 Define an enum service for it.
 
-``` yaml
+```yaml
 services:
     enum.member.gender:
         class: 'App\Enum\GenderEnum'
@@ -79,11 +82,11 @@ services:
 
 
 The configurable way
------
+--------------------
 
 No need for a class, just use the `ConfigurableEnum` class and define a new enum service.
 
-``` yaml
+```yaml
 services:
     enum.member.gender:
         class: 'Yokai\EnumBundle\Enum\ConfigurableEnum'
@@ -94,4 +97,3 @@ services:
             - m: 'Male'
               f: 'Female'
 ```
-

Resources/doc/declaring-translated-enum.md

@@ -0,0 +1,116 @@
+Declaring translated enum
+=========================
+
+If you wish to use Symfony's Translator for your enum labels, this bundle provide base classes to ease integration.
+
+There is a lot of way to create and declare such classes.
+
+> **Note :** It is pretty much like [declaring classic enums](declaring-enum.md), 
+> but with a `extends` instead of an `implements`.
+
+
+The classic way
+---------------
+
+Create a new class, implement both `getName` & `getValues` methods and specify the translation pattern.
+
+```php
+<?php
+
+namespace App\Enum;
+
+use Symfony\Component\Translation\TranslatorInterface;
+use Yokai\EnumBundle\Enum\AbstractTranslatedEnum;
+
+class GenderEnum extends AbstractTranslatedEnum
+{
+    public function __construct(TranslatorInterface $translator)
+    {
+        parent::__construct($translator, 'enum.gender.%s');
+    }
+
+    public function getName()
+    {
+        return 'gender';
+    }
+
+    public function getValues()
+    {
+        return ['m', 'f'];
+    }
+}
+```
+
+Define an enum service for it.
+
+```yaml
+services:
+    enum.member.gender:
+        class: 'App\Enum\GenderEnum'
+        public: false
+        tags: ['enum']
+        arguments:
+            - "@translator"
+```
+
+
+The class as name way
+---------------------
+
+Create a new class, use `EnumWithClassAsNameTrait` trait, implement `getValues` methods and specify the translation pattern.
+
+```php
+<?php
+
+namespace App\Enum;
+
+use Symfony\Component\Translation\TranslatorInterface;
+use Yokai\EnumBundle\Enum\AbstractTranslatedEnum;
+use Yokai\EnumBundle\Enum\EnumWithClassAsNameTrait;
+
+class GenderEnum extends AbstractTranslatedEnum
+{
+    use EnumWithClassAsNameTrait;
+
+    public function __construct(TranslatorInterface $translator)
+    {
+        parent::__construct($translator, 'enum.gender.%s');
+    }
+
+    public function getValues()
+    {
+        return ['m', 'f'];
+    }
+}
+```
+
+Define an enum service for it.
+
+```yaml
+services:
+    enum.member.gender:
+        class: 'App\Enum\GenderEnum'
+        public: false
+        tags: ['enum']
+        arguments:
+            - "@translator"
+```
+
+
+The configurable way
+--------------------
+
+No need for a class, just use the `ConfigurableTranslatedEnum` class and define a new enum service.
+
+```yaml
+services:
+    enum.member.gender:
+        class: 'Yokai\EnumBundle\Enum\ConfigurableTranslatedEnum'
+        public: false
+        tags: ['enum']
+        arguments:
+            - "@translator"
+            - "enum.gender.%s"
+            - "gender"
+            - ['m', 'f']
+```

Resources/doc/sonata-admin.md

@@ -12,11 +12,11 @@ And let's say we want to build a SonataAdmin for this model.
 namespace App\Admin;
 
 use App\Enum\GenderEnum;
-use Yokai\EnumBundle\Form\Type\EnumType;
 use Sonata\AdminBundle\Datagrid\DatagridMapper;
 use Sonata\AdminBundle\Datagrid\ListMapper;
 use Sonata\AdminBundle\Form\FormMapper;
 use Sonata\AdminBundle\Show\ShowMapper;
+use Yokai\EnumBundle\Form\Type\EnumType;
 
 class MemberAdmin extends AbstractAdmin
 {
@@ -46,9 +46,8 @@ class MemberAdmin extends AbstractAdmin
     protected function configureFormFields(FormMapper $form)
     {
         $form
-            ->add('gender', EnumType::class, [
-                'enum' => GenderEnum::NAME,
-            ])
+            // Let the bundle guess the form type for you (requires that you configured the validation)
+            ->add('gender')
             //...
         ;
     }
@@ -72,7 +71,7 @@ class MemberAdmin extends AbstractAdmin
 {% extends admin.getTemplate('base_list_field') %}
 
 {% block field %}
-    {{ value|enum_label(constant('AppBundle\\Enum\\Member\\GenderEnum')) }}
+    {{ value|enum_label('App\\Enum\\GenderEnum') }}
 {% endblock %}
 ```
 
@@ -83,6 +82,6 @@ class MemberAdmin extends AbstractAdmin
 {% extends admin.getTemplate('base_show_field') %}
 
 {% block field %}
-    {{ value|enum_label(constant('AppBundle\\Enum\\Member\\GenderEnum')) }}
+    {{ value|enum_label('App\\Enum\\GenderEnum') }}
 {% endblock %}
 ```