Use an enum for the notice type

WoltLab · Nov 22, 2023 · 830bc12 · 830bc12
1 parent ef127c8
commit 830bc12
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 10 deletions.
diff --git a/wcfsetup/install/files/lib/system/form/builder/NoticeFormNode.class.php b/wcfsetup/install/files/lib/system/form/builder/NoticeFormNode.class.php
@@ -12,33 +12,27 @@
  */
 class NoticeFormNode extends LanguageItemFormNode
 {
-    const AVAILABLE_TYPES = ['info', 'success', 'warning', 'error'];
-
-    protected string $type = 'info';
+    protected NoticeFormNodeType $type = NoticeFormNodeType::Info;
 
     /**
      * @inheritDoc
      */
     public function getHtml()
     {
-        return '<woltlab-core-notice type="' . $this->getType() . '">' . parent::getHtml() . '</woltlab-core-notice>';
+        return '<woltlab-core-notice type="' . $this->getType()->toString() . '">' . parent::getHtml() . '</woltlab-core-notice>';
     }
 
     /**
      * Sets the type of this notice.
      */
-    public function type(string $type): static
+    public function type(NoticeFormNodeType $type): static
     {
-        if (!\in_array($type, self::AVAILABLE_TYPES)) {
-            throw new \BadMethodCallException("Invalid value '{$type}' given.");
-        }
-
         $this->type = $type;
 
         return $this;
     }
 
-    public function getType(): string
+    public function getType(): NoticeFormNodeType
     {
         return $this->type;
     }

diff --git a/wcfsetup/install/files/lib/system/form/builder/NoticeFormNodeType.class.php b/wcfsetup/install/files/lib/system/form/builder/NoticeFormNodeType.class.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace wcf\system\form\builder;
+
+/**
+ * Defines the available types for the notice form node.
+ *
+ * @author      Marcel Werk
+ * @copyright   2001-2023 WoltLab GmbH
+ * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since       6.1
+ */
+enum NoticeFormNodeType
+{
+    case Info;
+    case Success;
+    case Warning;
+    case Error;
+
+    public function toString(): string
+    {
+        return match ($this) {
+            self::Info => 'info',
+            self::Success => 'success',
+            self::Warning => 'warning',
+            self::Error => 'error',
+        };
+    }
+}