Merge pull request cakephp#17400 from cakephp/5.x-enum-interface

Add Interface for enum labels.

src/Database/Type/EnumLabelInterface.php

@@ -0,0 +1,31 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
+ * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ * @link          https://cakephp.org CakePHP(tm) Project
+ * @since         5.0.3
+ * @license       https://opensource.org/licenses/mit-license.php MIT License
+ */
+namespace Cake\Database\Type;
+
+/**
+ * An interface used to clarify that an enum has a label() method instead of having to use
+ * `name` property.
+ */
+interface EnumLabelInterface
+{
+    /**
+     * Label to return as string.
+     *
+     * @return string
+     */
+    public function label(): string;
+}

src/View/Helper/FormHelper.php

@@ -19,6 +19,7 @@
 use BackedEnum;
 use Cake\Core\Configure;
 use Cake\Core\Exception\CakeException;
+use Cake\Database\Type\EnumLabelInterface;
 use Cake\Database\Type\EnumType;
 use Cake\Database\TypeFactory;
 use Cake\Form\FormProtector;
@@ -1358,7 +1359,8 @@ protected function enumOptions(string $enumClass): array
         $values = [];
         /** @var \BackedEnum $case */
         foreach ($enumClass::cases() as $case) {
-            $values[$case->value] = method_exists($case, 'label') ? $case->label() : $case->name;
+            $hasLabel = $case instanceof EnumLabelInterface || method_exists($case, 'label');
+            $values[$case->value] = $hasLabel ? $case->label() : $case->name;
         }
 
         return $values;

tests/TestCase/View/Helper/FormHelperTest.php

@@ -41,6 +41,7 @@
 use TestApp\Model\Entity\Article;
 use TestApp\Model\Enum\ArticleStatus;
 use TestApp\Model\Enum\ArticleStatusLabel;
+use TestApp\Model\Enum\ArticleStatusLabelInterface;
 use TestApp\Model\Table\ContactsTable;
 use TestApp\Model\Table\ValidateUsersTable;
 use TestApp\View\Form\StubContext;
@@ -3671,6 +3672,31 @@ public function testControlSelectType(): void
             '/div',
         ];
         $this->assertHtml($expected, $result);
+
+        $articlesTable->getSchema()->setColumnType(
+            'published',
+            EnumType::from(ArticleStatusLabelInterface::class)
+        );
+
+        $article = $articlesTable->newEmptyEntity();
+        $this->Form->create($article);
+        $result = $this->Form->control('published');
+        $expected = [
+            'div' => ['class' => 'input select'],
+            'label' => ['for' => 'published'],
+            'Published',
+            '/label',
+            'select' => ['name' => 'published', 'id' => 'published'],
+            ['option' => ['value' => 'Y']],
+            'Is published',
+            '/option',
+            ['option' => ['value' => 'N', 'selected' => 'selected']],
+            'Is unpublished',
+            '/option',
+            '/select',
+            '/div',
+        ];
+        $this->assertHtml($expected, $result);
     }
 
     /**

tests/test_app/TestApp/Model/Enum/ArticleStatusLabelInterface.php

@@ -0,0 +1,31 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
+ * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * Redistributions of files must retain the above copyright notice
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ * @since         5.0.3
+ * @license       https://opensource.org/licenses/mit-license.php MIT License
+ */
+namespace TestApp\Model\Enum;
+
+use Cake\Database\Type\EnumLabelInterface;
+
+enum ArticleStatusLabelInterface: string implements EnumLabelInterface
+{
+    case PUBLISHED = 'Y';
+    case UNPUBLISHED = 'N';
+
+    /**
+     * @return string
+     */
+    public function label(): string
+    {
+        return 'Is ' . strtolower($this->name);
+    }
+}