Enum add Hidden attr and hide them in ListField #1096

packages/form/src/Field/Concern/ListOptionsTrait.php

@@ -10,6 +10,7 @@
 use Windwalker\DOM\HTMLFactory;
 use Windwalker\Utilities\Assert\TypeAssert;
 use Windwalker\Utilities\Contract\LanguageInterface;
+use Windwalker\Utilities\Enum\EnumMetaInterface;
 use Windwalker\Utilities\Enum\EnumTranslatableInterface;
 
 /**
@@ -135,6 +136,10 @@ public function registerFromEnums(iterable|string $enums, ?LanguageInterface $la
         $options = [];
 
         foreach ($enums as $enum) {
+            if (($enum instanceof EnumMetaInterface) && $enum->isHidden()) {
+                continue;
+            }
+
             if ($enum instanceof EnumTranslatableInterface) {
                 $options[$enum->getValue()] = $enum->getTitle($lang) ?: $enum->getKey();
             } elseif ($enum instanceof Enum) {

packages/utilities/src/Attributes/Enum/Hidden.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Windwalker\Utilities\Attributes\Enum;
+
+/**
+ * The EnumString class.
+ */
+#[\Attribute(\Attribute::TARGET_CLASS_CONSTANT)]
+class Hidden
+{
+    public function __construct()
+    {
+        //
+    }
+}

packages/utilities/src/Enum/EnumBCTrait.php

@@ -9,6 +9,13 @@
  */
 trait EnumBCTrait
 {
+    /**
+     * @param $variable
+     *
+     * @return  bool
+     *
+     * @deprecated  Use 8.2 enums compare
+     */
     public function equals($variable = null): bool
     {
         return $variable === $this;

packages/utilities/src/Enum/EnumMetaInterface.php

@@ -15,6 +15,10 @@ public function getTitle(?LanguageInterface $lang = null, ...$args): string;
 
     public static function getTitles(): array;
 
+    public static function fromTitle(string $title): self;
+
+    public static function tryFromTitle(string $title): ?self;
+
     public function getIcon(): string;
 
     public static function getIcons(): array;
@@ -28,4 +32,6 @@ public function getMeta(): array;
     public static function getMetas(): array;
 
     public static function maxLength(): int;
+
+    public function isHidden(): bool;
 }

packages/utilities/src/Enum/EnumMetaTrait.php

@@ -6,6 +6,7 @@
 
 use Windwalker\Attributes\AttributesAccessor;
 use Windwalker\Utilities\Attributes\Enum\Color;
+use Windwalker\Utilities\Attributes\Enum\Hidden;
 use Windwalker\Utilities\Attributes\Enum\Icon;
 use Windwalker\Utilities\Attributes\Enum\Meta;
 use Windwalker\Utilities\Attributes\Enum\Title;
@@ -44,6 +45,28 @@ public static function getTitles(): array
         return $values;
     }
 
+    public static function fromTitle(string $title): self
+    {
+        $titles = self::getTitles();
+
+        $value = array_search($title, $titles);
+
+        return self::wrap($value);
+    }
+
+    public static function tryFromTitle(string $title): ?self
+    {
+        $titles = self::getTitles();
+
+        $value = array_search($title, $titles);
+
+        if ($value === false) {
+            return null;
+        }
+
+        return self::wrap($value);
+    }
+
     public function getIcon(): string
     {
         return $this->getAttr(Icon::class)?->getIcon() ?? '';
@@ -92,6 +115,13 @@ public static function getMetas(): array
         return $values;
     }
 
+    public function isHidden(): bool
+    {
+        $hidden = $this->getAttr(Hidden::class);
+
+        return $hidden instanceof Hidden;
+    }
+
     /**
      * @template T
      *

packages/utilities/src/Enum/EnumPhpAdapterTrait.php

@@ -45,7 +45,7 @@ public static function tryWrap(mixed $value): ?static
     }
 
     /**
-     * @return  array<static>
+     * @return  array<string, static>
      *
      * @throws \ReflectionException
      */