Add Include and Exclude Support to HasEnumValue::options() (#93)

Co-authored-by: EncoreBot <ghbot@encoredigitalgroup.com>

Author: onairmarc

.git-blame-ignore-revs

@@ -39,3 +39,4 @@ edb78e6307a371aff090127ce28aae9369605af8
 25c8e2da0ba2d49965926137dd8c26aede06ff32
 d4b03b64fcfc69e247b12f5f4afa4bd5f90ce5ab
 aa3797614d9280deb1b174d4878d484f2695efec
+e224e927dabcd3046455985118ed424c43aba054

src/Objects/Support/Traits/HasEnumValue.php

@@ -5,6 +5,7 @@
 use BackedEnum;
 use EncoreDigitalGroup\StdLib\Objects\Support\Types\Str;
 use LogicException;
+use RuntimeException;
 
 /**
  * Trait for PHP Enums that provides additional functionality.
@@ -55,8 +56,16 @@ public static function from(int|string $value): ?static
         return null;
     }
 
-    public static function options(): array
+    public static function options(array $include = [], array $exclude = []): array
     {
+        if ($include != []) {
+            return self::optionsIncluding($include);
+        }
+
+        if ($exclude != []) {
+            return self::optionsExcluding($exclude);
+        }
+
         $options = [];
 
         foreach (self::cases() as $case) {
@@ -68,7 +77,13 @@ public static function options(): array
 
     public static function name(self $self): string
     {
-        return $self->name;
+        $name = Str::formattedTitleCase($self->value);
+
+        if (is_array($name)) {
+            throw new RuntimeException("Name was provided as a string but returned as an array.");
+        }
+
+        return $name;
     }
 
     private static function enforceEnum(): void
@@ -80,4 +95,30 @@ private static function enforceEnum(): void
             ));
         }
     }
+
+    private static function optionsIncluding(array $include): array
+    {
+        $options = [];
+
+        foreach (self::cases() as $case) {
+            if (in_array($case, $include)) {
+                $options[$case->value] = self::name($case);
+            }
+        }
+
+        return $options;
+    }
+
+    private static function optionsExcluding(array $exclude): array
+    {
+        $options = [];
+
+        foreach (self::cases() as $case) {
+            if (!in_array($case, $exclude)) {
+                $options[$case->value] = self::name($case);
+            }
+        }
+
+        return $options;
+    }
 }