Add support for default value (#167)

* Add support for default value

Author: fre5h

DBAL/Types/AbstractEnumType.php

@@ -112,6 +112,11 @@ static function (string $value) {
                 $sqlDeclaration = \sprintf('ENUM(%s)', $values);
         }
 
+        $defaultValue = static::getDefaultValue();
+        if (null !== $defaultValue) {
+            $sqlDeclaration .= \sprintf(' DEFAULT %s', $platform->quoteStringLiteral($defaultValue));
+        }
+
         return $sqlDeclaration;
     }
 
@@ -136,7 +141,7 @@ public function getName(): string
      *
      * @static
      *
-     * @return string[] Values for the ENUM field
+     * @return string[]
      */
     public static function getChoices(): array
     {
@@ -175,7 +180,7 @@ public static function getRandomValue()
      *
      * @static
      *
-     * @return string[] Array of values with readable format
+     * @return string[] Array of values in readable format
      */
     public static function getReadableValues(): array
     {
@@ -203,7 +208,7 @@ public static function assertValidChoice(string $value): void
      *
      * @static
      *
-     * @return string $value Value in readable format
+     * @return string Value in readable format
      */
     public static function getReadableValue(string $value): string
     {
@@ -226,6 +231,18 @@ public static function isValueExist(string $value): bool
         return isset(static::$choices[$value]);
     }
 
+    /**
+     * Get default value for DDL statement.
+     *
+     * @static
+     *
+     * @return string|null Default value for DDL statement
+     */
+    public static function getDefaultValue(): ?string
+    {
+        return null;
+    }
+
     /**
      * Gets an array of database types that map to this Doctrine type.
      *

README.md

@@ -24,8 +24,8 @@
 
 | Bundle Version (X.Y.Z) | PHP              | Symfony          | Doctrine Bundle    | Comment                   |
 |:----------------------:|:----------------:|:----------------:|:------------------:|:--------------------------|
-| `7.0.*`                | `>= 7.2.5`       | `>= 5.0`         | `>= 2.0`           | **Current version**       |
-| `6.6.*`                | `>= 7.1.3`       | `4.3, 4.4`       | `> 1.11`, `>= 2.0` | Bugfix support            |
+| `7.1.*`                | `>= 7.2.5`       | `>= 5.0`         | `>= 2.0`           | **Current version**       |
+| `6.6.*`                | `>= 7.1.3`       | `4.3, 4.4`       | `> 1.11`, `>= 2.0` | Previous version          |
 
 #### Check the `config/bundles.php` file
 
@@ -49,6 +49,7 @@ return [
 ## Features 🎁
 
 * [NULL values](./Resources/docs/null_values.md "NULL values")
+* [Default value](./Resources/docs/default_value.md "Default value")
 * [Building the form](./Resources/docs/building_the_form.md "Building the form")
 * [Additional methods](./Resources/docs/additional_methods.md "Additional methods")
 * [Common types](./Resources/docs/common_types.md "Common types")

Resources/docs/additional_methods.md

@@ -23,8 +23,6 @@ BasketballPositionType::getValues();
 // Will return: ['PG', 'SG', 'SF', 'PF', 'C']
 ```
 
----
-
 ##### If you need to return a random value:
 
 ```php
@@ -37,7 +35,9 @@ BasketballPositionType::getRandomValue();
 ### More features
 
 * [NULL values](./null_values.md "NULL values")
+* [Default value](./default_value.md "Default value")
 * [Building the form](./building_the_form.md "Building the form")
+* [Common types](./common_types.md "Common types")
 * [Readable ENUM values in templates](./readable_enum_values_in_template.md "Readable ENUM values in templates")
 * [ENUM constants in templates](./enum_constants_in_templates.md "ENUM constants in templates")
 * [ENUM values in templates](./enum_values_in_templates.md "ENUM values in templates")

Resources/docs/building_the_form.md

@@ -12,8 +12,8 @@ If you need to add some extra parameters, just skip the second *field type* para
 $builder->add('position', null, [
     'required' => true,
     'attr' => [
-        'class' => 'some-class'
-    ]
+        'class' => 'some-class',
+    ],
 ]);
 ```
 
@@ -23,7 +23,7 @@ If for some reason you need to specify full config, it can look like this:
 use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
 
 $builder->add('position', ChoiceType::class, [
-    'choices' => BasketballPositionType::getChoices()
+    'choices' => BasketballPositionType::getChoices(),
 ]);
 ```
 
@@ -35,7 +35,9 @@ All other custom DBAL types, which are defined, will be skipped from guessing.
 ### More features
 
 * [NULL values](./null_values.md "NULL values")
+* [Default value](./default_value.md "Default value")
 * [Additional methods](./additional_methods.md "Additional methods")
+* [Common types](./common_types.md "Common types")
 * [Readable ENUM values in templates](./readable_enum_values_in_template.md "Readable ENUM values in templates")
 * [ENUM constants in templates](./enum_constants_in_templates.md "ENUM constants in templates")
 * [ENUM values in templates](./enum_values_in_templates.md "ENUM values in templates")

Resources/docs/common_types.md

@@ -5,3 +5,15 @@
 [MonthFullNameType](./../../DBAL/Types/MonthFullNameType.php "MonthFullNameType"): january, february, march, etc.  
 [MonthShortNameType](./../../DBAL/Types/MonthShortNameType.php "MonthShortNameType"): jan, feb, mar, etc.
 
+---
+
+### More features
+
+* [NULL values](./null_values.md "NULL values")
+* [Default value](./default_value.md "Default value")
+* [Additional methods](./additional_methods.md "Additional methods")
+* [Building the form](./building_the_form.md "Building the form")
+* [Readable ENUM values in templates](./readable_enum_values_in_template.md "Readable ENUM values in templates")
+* [ENUM constants in templates](./enum_constants_in_templates.md "ENUM constants in templates")
+* [ENUM values in templates](./enum_values_in_templates.md "ENUM values in templates")
+* [Hook for Doctrine migrations](./hook_for_doctrine_migrations.md "Hook for Doctrine migrations")

Resources/docs/default_value.md

@@ -0,0 +1,45 @@
+## Default value
+
+Override method `getDefaultValue` in your ENUM class:
+
+```php
+<?php
+namespace App\DBAL\Types;
+
+use Fresh\DoctrineEnumBundle\DBAL\Types\AbstractEnumType;
+
+final class MapLocationType extends AbstractEnumType
+{
+    public const NORTH = 'N';
+    public const EAST = 'E';
+    public const SOUTH = 'S';
+    public const WEST = 'W';
+    public const CENTER = 'C';
+
+    protected static $choices = [
+        self::NORTH => 'North',
+        self::EAST => 'East',
+        self::SOUTH => 'South',
+        self::WEST => 'West',
+        self::CENTER => 'Center',
+    ];
+
+    public static function getDefaultValue(): ?string
+    {
+        return self::CENTER; // This value will be used as default in DDL statement
+    }
+}
+```
+
+---
+
+### More features
+
+* [NULL values](./null_values.md "NULL values")
+* [Building the form](./building_the_form.md "Building the form")
+* [Additional methods](./additional_methods.md "Additional methods")
+* [Common types](./common_types.md "Common types")
+* [Readable ENUM values in templates](./readable_enum_values_in_template.md "Readable ENUM values in templates")
+* [ENUM constants in templates](./enum_constants_in_templates.md "ENUM constants in templates")
+* [ENUM values in templates](./enum_values_in_templates.md "ENUM values in templates")
+* [Hook for Doctrine migrations](./hook_for_doctrine_migrations.md "Hook for Doctrine migrations")

Resources/docs/enum_constants_in_templates.md

@@ -2,7 +2,7 @@
 
 There is also another custom TWIG filter `|enum_constant`. It allows to use constants from ENUM classes in templates to print their values or to compare with other values.
 
-```jinja
+```twig
 {{ 'SHOOTING_GUARD'|enum_constant }}
 {{ 'NORTH_WEST'|enum_constant }}
 
@@ -14,7 +14,7 @@ There is also another custom TWIG filter `|enum_constant`. It allows to use cons
 Same problem as for `|readable_enum` filter is present here too. If some constant is defined in few ENUM classes then an exception will be thrown.
 You can specify the correct class for this constant and it solves the problem.
 
-```jinja
+```twig
 {{ 'CENTER'|enum_constant('BasketballPositionType') }}
 {{ 'CENTER'|enum_constant('MapLocationType') }}
 ```
@@ -24,8 +24,10 @@ You can specify the correct class for this constant and it solves the problem.
 ### More features
 
 * [NULL values](./null_values.md "NULL values")
+* [Default value](./default_value.md "Default value")
 * [Building the form](./building_the_form.md "Building the form")
 * [Additional methods](./additional_methods.md "Additional methods")
+* [Common types](./common_types.md "Common types")
 * [Readable ENUM values in templates](./readable_enum_values_in_template.md "Readable ENUM values in templates")
 * [ENUM values in templates](./enum_values_in_templates.md "ENUM values in templates")
 * [Hook for Doctrine migrations](./hook_for_doctrine_migrations.md "Hook for Doctrine migrations")

Resources/docs/enum_values_in_templates.md

@@ -5,7 +5,7 @@ They are `enum_values()` and `enum_readable_values()`.
 
 #### Example of using `enum_values()`
 
-```jinja
+```twig
 {% for value in enum_values('BasketballPositionType') %}
     {{ value }}<br />
 {% endfor %}
@@ -22,7 +22,7 @@ C
 
 #### Example of using `enum_readable_values()`
 
-```jinja
+```twig
 {% for key, value in enum_readable_values('BasketballPositionType') %}
     {{ key }} => {{ value }}<br />
 {% endfor %}
@@ -42,8 +42,10 @@ C => Center
 ### More features
 
 * [NULL values](./null_values.md "NULL values")
+* [Default value](./default_value.md "Default value")
 * [Building the form](./building_the_form.md "Building the form")
 * [Additional methods](./additional_methods.md "Additional methods")
+* [Common types](./common_types.md "Common types")
 * [Readable ENUM values in templates](./readable_enum_values_in_template.md "Readable ENUM values in templates")
 * [ENUM constants in templates](./enum_constants_in_templates.md "ENUM constants in templates")
 * [Hook for Doctrine migrations](./hook_for_doctrine_migrations.md "Hook for Doctrine migrations")

Resources/docs/example_of_using.md

@@ -8,7 +8,7 @@ In this example will be shown how to create a custom ENUM field for basketball p
 * `PF` - Power Forward
 * `C` - Center
 
-Create a class for new ENUM type `BasketballPositionType`:
+Create a class for a new ENUM type `BasketballPositionType`:
 
 ```php
 <?php
@@ -34,9 +34,9 @@ final class BasketballPositionType extends AbstractEnumType
 }
 ```
 
-Register `BasketballPositionType` for Doctrine in config.yml:
+Register `BasketballPositionType` for Doctrine in config.yaml:
 
-```yml
+```yaml
 doctrine:
     dbal:
         types:
@@ -109,8 +109,10 @@ use App\DBAL\Types\BasketballPositionType;
 ### More features
 
 * [NULL values](./null_values.md "NULL values")
+* [Default value](./default_value.md "Default value")
 * [Building the form](./building_the_form.md "Building the form")
 * [Additional methods](./additional_methods.md "Additional methods")
+* [Common types](./common_types.md "Common types")
 * [Readable ENUM values in templates](./readable_enum_values_in_template.md "Readable ENUM values in templates")
 * [ENUM constants in templates](./enum_constants_in_templates.md "ENUM constants in templates")
 * [ENUM values in templates](./enum_values_in_templates.md "ENUM values in templates")

Resources/docs/hook_for_doctrine_migrations.md

@@ -26,8 +26,10 @@ You should repeat these steps after each update of your custom ENUM type!
 ### More features
 
 * [NULL values](./null_values.md "NULL values")
+* [Default value](./default_value.md "Default value")
 * [Building the form](./building_the_form.md "Building the form")
 * [Additional methods](./additional_methods.md "Additional methods")
+* [Common types](./common_types.md "Common types")
 * [Readable ENUM values in templates](./readable_enum_values_in_template.md "Readable ENUM values in templates")
 * [ENUM constants in templates](./enum_constants_in_templates.md "ENUM constants in templates")
 * [ENUM values in templates](./enum_values_in_templates.md "ENUM values in templates")

Resources/docs/null_values.md

@@ -4,20 +4,22 @@
 
 ```php
 /** @ORM\Column(name="position", type="BasketballPositionType", nullable=true) */
-protected $position;
+private $position;
 
 // or
 
 /** @ORM\Column(name="position", type="BasketballPositionType", nullable=false) */
-protected $position;
+private $position;
 ```
 
 ---
 
 ### More features
 
+* [Default value](./default_value.md "Default value")
 * [Building the form](./building_the_form.md "Building the form")
 * [Additional methods](./additional_methods.md "Additional methods")
+* [Common types](./common_types.md "Common types")
 * [Readable ENUM values in templates](./readable_enum_values_in_template.md "Readable ENUM values in templates")
 * [ENUM constants in templates](./enum_constants_in_templates.md "ENUM constants in templates")
 * [ENUM values in templates](./enum_values_in_templates.md "ENUM values in templates")

Resources/docs/readable_enum_values_in_template.md

@@ -4,7 +4,7 @@ You might want to show ENUM values rendered in your templates in *readable forma
 It is easy to do by using the custom TWIG filter `|readable_enum` that was implemented for this purpose.
 In the example below if Player is a Point Guard in their basketball team then position will be rendered in template as `Point Guard` instead of `PG`.
 
-```jinja
+```twig
 {{ player.position|readable_enum }}
 ```
 
@@ -15,7 +15,7 @@ If only one ENUM type found, then it is possible to get the readable value from
 For example `BasketballPositionType` and `MapLocationType` can have same ENUM value `C` with its readable variant `Center`.
 The code below will throw an exception, because without additional parameter for `|readable_enum` filter, it can't determine which ENUM type to use in which case:
 
-```jinja
+```twig
 {{ set player_position = 'C' }}
 {{ set location_on_the_map = 'C' }}
 
@@ -25,7 +25,7 @@ The code below will throw an exception, because without additional parameter for
 
 So, the correct usage of `|readable_enum` filter in this case should be with additional parameter, that specifies the ENUM type:
 
-```jinja
+```twig
 {{ set player_position = 'C' }}
 {{ set location_on_the_map = 'C' }}
 
@@ -38,8 +38,10 @@ So, the correct usage of `|readable_enum` filter in this case should be with add
 ### More features
 
 * [NULL values](./null_values.md "NULL values")
+* [Default value](./default_value.md "Default value")
 * [Building the form](./building_the_form.md "Building the form")
 * [Additional methods](./additional_methods.md "Additional methods")
+
 * [ENUM constants in templates](./enum_constants_in_templates.md "ENUM constants in templates")
 * [ENUM values in templates](./enum_values_in_templates.md "ENUM values in templates")
 * [Hook for Doctrine migrations](./hook_for_doctrine_migrations.md "Hook for Doctrine migrations")