#6 implement enums for embed colours

Author: scrummer

composer.json

@@ -12,7 +12,7 @@
         }
     ],
     "require": {
-        "php": "^8.0",
+        "php": "^8.1",
         "guzzlehttp/guzzle": ">=7.2",
         "symfony/serializer": "^4.4.35 || ^5.3.12 || ^6.0",
         "doctrine/collections": "^1.6",

src/DiscordWebhook/Embed.php

@@ -26,49 +26,6 @@ class Embed
      */
     public const CONFIG_MAX_COUNT = 10;
 
-    /** @deprecated Use \DiscordWebhook\EmbedColor::class instead */
-    public const COLOR_DEFAULT     = EmbedColor::DEFAULT;
-    /** @deprecated Use \DiscordWebhook\EmbedColor::class instead */
-    public const COLOR_AQUA        = EmbedColor::AQUA;
-    /** @deprecated Use \DiscordWebhook\EmbedColor::class instead */
-    public const COLOR_GREEN       = EmbedColor::GREEN;
-    /** @deprecated Use \DiscordWebhook\EmbedColor::class instead */
-    public const COLOR_BLUE        = EmbedColor::BLUE;
-    /** @deprecated Use \DiscordWebhook\EmbedColor::class instead */
-    public const COLOR_PURPLE      = EmbedColor::PURPLE;
-    /** @deprecated Use \DiscordWebhook\EmbedColor::class instead */
-    public const COLOR_GOLD        = EmbedColor::GOLD;
-    /** @deprecated Use \DiscordWebhook\EmbedColor::class instead */
-    public const COLOR_ORANGE      = EmbedColor::ORANGE;
-    /** @deprecated Use \DiscordWebhook\EmbedColor::class instead */
-    public const COLOR_RED         = EmbedColor::RED;
-    /** @deprecated Use \DiscordWebhook\EmbedColor::class instead */
-    public const COLOR_GREY        = EmbedColor::GREY;
-    /** @deprecated Use \DiscordWebhook\EmbedColor::class instead */
-    public const COLOR_DARKER_GREY = EmbedColor::DARKER_GREY;
-    /** @deprecated Use \DiscordWebhook\EmbedColor::class instead */
-    public const COLOR_NAVY        = EmbedColor::NAVY;
-    /** @deprecated Use \DiscordWebhook\EmbedColor::class instead */
-    public const COLOR_DARK_AQUA   = EmbedColor::DARK_AQUA;
-    /** @deprecated Use \DiscordWebhook\EmbedColor::class instead */
-    public const COLOR_DARK_GREEN  = EmbedColor::DARK_GREEN;
-    /** @deprecated Use \DiscordWebhook\EmbedColor::class instead */
-    public const COLOR_DARK_BLUE   = EmbedColor::DARK_BLUE;
-    /** @deprecated Use \DiscordWebhook\EmbedColor::class instead */
-    public const COLOR_DARK_PURPLE = EmbedColor::DARK_PURPLE;
-    /** @deprecated Use \DiscordWebhook\EmbedColor::class instead */
-    public const COLOR_DARK_GOLD   = EmbedColor::DARK_GOLD;
-    /** @deprecated Use \DiscordWebhook\EmbedColor::class instead */
-    public const COLOR_DARK_ORANGE = EmbedColor::DARK_ORANGE;
-    /** @deprecated Use \DiscordWebhook\EmbedColor::class instead */
-    public const COLOR_DARK_RED    = EmbedColor::DARK_RED;
-    /** @deprecated Use \DiscordWebhook\EmbedColor::class instead */
-    public const COLOR_DARK_GREY   = EmbedColor::DARK_GREY;
-    /** @deprecated Use \DiscordWebhook\EmbedColor::class instead */
-    public const COLOR_LIGHT_GREY  = EmbedColor::LIGHT_GREY;
-    /** @deprecated Use \DiscordWebhook\EmbedColor::class instead */
-    public const COLOR_DARK_NAVY   = EmbedColor::DARK_NAVY;
-
     private ?string $title;
 
     private ?string $type = 'rich';
@@ -79,7 +36,7 @@ class Embed
 
     private ?DateTime $timestamp;
 
-    private ?int $color;
+    private EmbedColor $color = EmbedColor::DEFAULT;
 
     private ?Footer $footer;
 
@@ -160,12 +117,12 @@ public function setTimestamp(?DateTime $timestamp): Embed
         return $this;
     }
 
-    public function getColor(): ?int
+    public function getColor(): EmbedColor
     {
         return $this->color;
     }
 
-    public function setColor(?int $color): Embed
+    public function setColor(EmbedColor $color): Embed
     {
         $this->color = $color;
 

src/DiscordWebhook/EmbedColor.php

@@ -3,27 +3,27 @@
 
 namespace DiscordWebhook;
 
-class EmbedColor
+enum EmbedColor: int
 {
-    public const DEFAULT     = 0;
-    public const AQUA        = 1752220;
-    public const GREEN       = 3066993;
-    public const BLUE        = 3447003;
-    public const PURPLE      = 10181046;
-    public const GOLD        = 15844367;
-    public const ORANGE      = 15105570;
-    public const RED         = 15158332;
-    public const GREY        = 9807270;
-    public const DARKER_GREY = 8359053;
-    public const NAVY        = 3426654;
-    public const DARK_AQUA   = 1146986;
-    public const DARK_GREEN  = 2067276;
-    public const DARK_BLUE   = 2123412;
-    public const DARK_PURPLE = 7419530;
-    public const DARK_GOLD   = 12745742;
-    public const DARK_ORANGE = 11027200;
-    public const DARK_RED    = 10038562;
-    public const DARK_GREY   = 9936031;
-    public const LIGHT_GREY  = 12370112;
-    public const DARK_NAVY   = 2899536;
+    case DEFAULT = 0;
+    case AQUA = 1752220;
+    case GREEN = 3066993;
+    case BLUE = 3447003;
+    case PURPLE = 10181046;
+    case GOLD = 15844367;
+    case ORANGE = 15105570;
+    case RED = 15158332;
+    case GREY = 9807270;
+    case DARKER_GREY = 8359053;
+    case NAVY = 3426654;
+    case DARK_AQUA = 1146986;
+    case DARK_GREEN = 2067276;
+    case DARK_BLUE = 2123412;
+    case DARK_PURPLE = 7419530;
+    case DARK_GOLD = 12745742;
+    case DARK_ORANGE = 11027200;
+    case DARK_RED = 10038562;
+    case DARK_GREY = 9936031;
+    case LIGHT_GREY = 12370112;
+    case DARK_NAVY = 2899536;
 }

src/DiscordWebhook/Generator/PayloadGenerator.php

@@ -3,6 +3,7 @@
 
 namespace DiscordWebhook\Generator;
 
+use BackedEnum;
 use DateTimeInterface;
 use SplFileInfo;
 use Symfony\Component\Serializer\Encoder\JsonEncoder;
@@ -32,7 +33,8 @@ public function __construct()
         $defaultContext = [
             AbstractNormalizer::CALLBACKS => [
                 'timestamp' => [$this, 'formatTimestamp'],
-                'file' => [$this, 'formatFile']
+                'file' => [$this, 'formatFile'],
+                'color' => [$this, 'enumToValue']
             ],
             AbstractObjectNormalizer::SKIP_NULL_VALUES => true
         ];
@@ -101,4 +103,9 @@ public function formatFile($file): ?array
 
         return null;
     }
+
+    public function enumToValue(BackedEnum $enum): mixed
+    {
+        return $enum->value;
+    }
 }

tests/test.php

@@ -38,7 +38,7 @@
                     ->setIconUrl('https://pbs.twimg.com/profile_images/1454563699587436557/KzhwN-fK_400x400.jpg')
             )
     )
-    ->setFile(new SplFileInfo(__DIR__ . '/lipsum.pdf'))
+//    ->setFile(new SplFileInfo(__DIR__ . '/lipsum.pdf'))
 ;
 
 $wh->send();