Merge pull request #959 from cakephp/enum-entity-annotation

Fix annotation for entity field mapped to enum type.
cakephp · Nov 2, 2023 · 369cfb1 · 369cfb1
2 parents 18486ac + 514c4b2
commit 369cfb1
Show file tree

Hide file tree

Showing 6 changed files with 79 additions and 4 deletions.
diff --git a/src/View/Helper/DocBlockHelper.php b/src/View/Helper/DocBlockHelper.php
@@ -5,6 +5,7 @@
 
 use Cake\Collection\Collection;
 use Cake\Core\App;
+use Cake\Database\Type\EnumType;
 use Cake\Database\TypeFactory;
 use Cake\ORM\Association;
 use Cake\Utility\Inflector;
@@ -230,6 +231,14 @@ public function columnTypeToHintType(string $type): ?string
                 }
 
                 return '\Cake\I18n\Time';
+
+            default:
+                if (str_starts_with($type, 'enum-')) {
+                    $dbType = TypeFactory::build($type);
+                    if ($dbType instanceof EnumType) {
+                        return '\\' . $dbType->getEnumClassName();
+                    }
+                }
         }
 
         // Any unique or custom types will have a `string` type hint

diff --git a/tests/TestCase/Command/ModelCommandTest.php b/tests/TestCase/Command/ModelCommandTest.php
@@ -46,6 +46,7 @@ class ModelCommandTest extends TestCase
      * @var array<string>
      */
     protected array $fixtures = [
+        'plugin.Bake.Articles',
         'plugin.Bake.Comments',
         'plugin.Bake.Tags',
         'plugin.Bake.ArticlesTags',
@@ -1924,6 +1925,22 @@ public function testBakeEntityWithPlugin()
         $this->assertSameAsFile(__FUNCTION__ . '.php', $result);
     }
 
+    /**
+     * test baking an entity class with an enum field
+     *
+     * @return void
+     */
+    public function testBakeEntityEnum()
+    {
+        $this->generatedFile = APP . 'Model/Entity/Article.php';
+        $this->exec('bake model --no-test --no-fixture --no-table --no-fields Articles');
+
+        $this->assertExitCode(CommandInterface::CODE_SUCCESS);
+        $this->assertFileExists($this->generatedFile);
+        $result = file_get_contents($this->generatedFile);
+        $this->assertSameAsFile(__FUNCTION__ . '.php', $result);
+    }
+
     /**
      * Tests baking a table with rules
      *

diff --git a/tests/comparisons/Model/testBakeEntityEnum.php b/tests/comparisons/Model/testBakeEntityEnum.php
@@ -0,0 +1,23 @@
+<?php
+declare(strict_types=1);
+
+namespace Bake\Test\App\Model\Entity;
+
+use Cake\ORM\Entity;
+
+/**
+ * Article Entity
+ *
+ * @property int $id
+ * @property int|null $author_id
+ * @property string|null $title
+ * @property string|null $body
+ * @property \Bake\Test\App\Model\Enum\ArticleStatus|null $published
+ *
+ * @property \Bake\Test\App\Model\Entity\Author $author
+ * @property \Bake\Test\App\Model\Entity\Tag[] $tags
+ * @property \Bake\Test\App\Model\Entity\ArticlesTag[] $articles_tags
+ */
+class Article extends Entity
+{
+}
diff --git a/tests/test_app/App/Model/Enum/ArticleStatus.php b/tests/test_app/App/Model/Enum/ArticleStatus.php
@@ -0,0 +1,21 @@
+<?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         3.0.4
+ * @license       https://opensource.org/licenses/mit-license.php MIT License
+ */
+namespace Bake\Test\App\Model\Enum;
+
+enum ArticleStatus: string
+{
+    case PUBLISHED = 'Y';
+    case UNPUBLISHED = 'N';
+}
diff --git a/tests/test_app/App/Model/Table/ArticlesTable.php b/tests/test_app/App/Model/Table/ArticlesTable.php
@@ -16,6 +16,8 @@
  */
 namespace Bake\Test\App\Model\Table;
 
+use Bake\Test\App\Model\Enum\ArticleStatus;
+use Cake\Database\Type\EnumType;
 use Cake\ORM\Table;
 
 /**
@@ -28,13 +30,15 @@ public function initialize(array $config): void
         $this->belongsTo('authors');
         $this->belongsToMany('tags');
         $this->hasMany('ArticlesTags');
+
+        $this->getSchema()->setColumnType('published', EnumType::from(ArticleStatus::class));
     }
 
     /**
      * Find published
      *
-     * @param  Cake\ORM\Query\SelectQuery $query The query
-     * @return Cake\ORM\Query\SelectQuery
+     * @param \Cake\ORM\Query\SelectQuery $query The query
+     * @return \Cake\ORM\Query\SelectQuery
      */
     public function findPublished($query)
     {

diff --git a/tests/test_app/App/plugins.php b/tests/test_app/App/plugins.php
@@ -1,7 +1,8 @@
 <?php
+
 return [
     'SimpleExample' => [],
     'Simple' => [],
     'Company/Example' => [],
-    'ComposerExample' => []
-];
+    'ComposerExample' => [],
+];