Merge pull request #2 from webfox/name-in-to-array

Add enum value to array returned from toArray

Author: Jim-Webfox

README.md

@@ -51,11 +51,14 @@ return [
      ]
 ];
 ```
+
 You may then access these localized values using the `->label()` or `::labelFor()` methods
+
 ```php
 VolumeUnitEnum::MILLIGRAMS->label(); // "mg"
 VolumeUnitEnum::labelFor(VolumeUnitEnum::TONNE); // "t"
 ```
+
 If you do not specify a label in the lang file these methods will return the translation key e.g. `enums.\\App\\Enums\\VolumeUnitEnum.GRAMS`
 
 ### Meta data
@@ -87,6 +90,7 @@ public function withMeta(): array
     };
 }
 ```
+
 If you do not specify a `withMeta` method, meta will be an empty array.
 
 ## Other methods
@@ -106,15 +110,17 @@ returns
 ```php
 [
     [
-        'value' => 'Milligrams',
+        'name'  => 'MILLIGRAMS'
+        'value' => 'MILLIGRAMS',
         'label' => 'mg',
         'meta'  => [
             'background_color' => 'bg-green-100',
             'text_color'       => 'text-green-800',
         ],
     ],
     [
-        'value' => 'Grams',
+        'name'  => 'GRAMS',
+        'value' => 'GRAMS',
         'label' => 'g',
         'meta'  => [
             'background_color' => 'bg-red-100',
@@ -125,6 +131,27 @@ returns
 ]
 ```
 
+### names
+
+Returns an array of all enum values.
+
+#### Usage
+
+```php
+VolumeUnitEnum::names();
+```
+
+returns
+
+```php
+[
+    'MILLIGRAMS',
+    'GRAMS',
+    'KILOGRAMS',
+    'TONNE',
+]
+```
+
 ### values
 
 Returns an array of all enum values.
@@ -181,9 +208,9 @@ returns
 
 ```php
 [
-    'MILLIGRAM'=>'mg',
-    'GRAM'     =>'g',
-    'KILOGRAM' =>'kg',
+    'MILLIGRAMS'=>'mg',
+    'GRAMS'     =>'g',
+    'KILOGRAMS' =>'kg',
     'TONNE'    =>'t',
 ]
 ```
@@ -202,7 +229,8 @@ returns
 
 ```php
 [
-    'value' => 'Milligrams',
+    'name'  => 'MILLIGRAMS'
+    'value' => 'MILLIGRAMS',
     'label' => 'mg',
     'meta'  => [
         'color' => 'bg-green-100',
@@ -216,7 +244,8 @@ returns
 An alias for toArray.
 
 ### isA/isAn
-Allows you to check if an enum is a given value. Returns a boolean.  
+
+Allows you to check if an enum is a given value. Returns a boolean.
 > **Note**
 > `isAn` is just an alias for `isA`.
 
@@ -228,6 +257,7 @@ VolumeUnitEnum::MILLIGRAMS->isA(VolumeUnitEnum::MILLIGRAMS); //true
 ```
 
 ### isNotA/isNotAn
+
 Allows you to check if an enum is not a given value. Returns a boolean.
 > **Note**
 > `isNotAn` is just an alias for `isNotA`.
@@ -240,6 +270,7 @@ VolumeUnitEnum::MILLIGRAMS->isA(VolumeUnitEnum::MILLIGRAMS); //false
 ```
 
 ### isAny
+
 Allows you to check if an enum is contained in an array. Returns a boolean.
 
 #### Usage
@@ -250,6 +281,7 @@ VolumeUnitEnum::MILLIGRAMS->isAny([VolumeUnitEnum::GRAMS, VolumeUnitEnum::MILLIG
 ```
 
 ### isNotAny
+
 Allows you to check if an enum is not contained in an array. Returns a boolean.
 
 #### Usage

src/IsBackedEnum.php

@@ -21,12 +21,18 @@ public static function options(): array
         return array_map(fn($enum) => $enum->toArray(), self::cases());
     }
 
-    public static function values(): array
+    public static function names(): array
     {
         static::ensureImplementsInterface();
         return array_map(fn($enum) => $enum->name, self::cases());
     }
 
+    public static function values(): array
+    {
+        static::ensureImplementsInterface();
+        return array_map(fn($enum) => $enum->value, self::cases());
+    }
+
     public static function map(): array
     {
         static::ensureImplementsInterface();
@@ -72,7 +78,8 @@ public function toArray(): array
     {
         static::ensureImplementsInterface();
         return [
-            'value' => $this->name,
+            'name'  => $this->name,
+            'value' => $this->value,
             'label' => $this->label(),
             'meta'  => $this->withMeta(),
         ];