Merge pull request #146 from fre5h/feature-random-values

Add new method `getRandomValue` for AbstractEnumType

Author: fre5h

DBAL/Types/AbstractEnumType.php

@@ -143,6 +143,21 @@ public static function getValues(): array
         return \array_keys(static::$choices);
     }
 
+    /**
+     * Get random value for the ENUM field.
+     *
+     * @static
+     *
+     * @return int|string
+     */
+    public static function getRandomValue()
+    {
+        $values = self::getValues();
+        $randomKey = \random_int(0, \count($values) - 1);
+
+        return $values[$randomKey];
+    }
+
     /**
      * Get array of ENUM Values, where ENUM values are keys and their readable versions are values.
      *

Resources/docs/additional_methods.md

@@ -16,7 +16,7 @@ BasketballPositionType::getReadableValue(BasketballPositionType::SHOOTING_GUARD)
 // Will return: Shooting Guard
 ```
 
-##### If you need to get values in the readable format:
+##### If you need to get all values:
 
 ```php
 BasketballPositionType::getValues();
@@ -25,6 +25,15 @@ BasketballPositionType::getValues();
 
 ---
 
+##### If you need to return a random value:
+
+```php
+BasketballPositionType::getRandomValue();
+// Will randomly return one of the available values: 'PG', 'SG', 'SF', 'PF', 'C'
+```
+
+---
+
 ### More features
 
 * [NULL values](./null_values.md "NULL values")

Tests/DBAL/Types/AbstractEnumTypeTest.php

@@ -109,6 +109,15 @@ public function testInvalidArgumentExceptionInConvertToDatabaseValue(): void
         $this->type->convertToDatabaseValue('YO', new MySqlPlatform());
     }
 
+    public function testGetRandomValue(): void
+    {
+        $values = $this->type::getValues();
+
+        self::assertContains($this->type::getRandomValue(), $values);
+        self::assertContains($this->type::getRandomValue(), $values);
+        self::assertContains($this->type::getRandomValue(), $values);
+    }
+
     public function testGetReadableValues(): void
     {
         $choices = [