Use prefix "is" for getters on boolean fields (#456)

symfony · May 9, 2022 · e2d6c94 · e2d6c94
1 parent 8011758
commit e2d6c94
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 2 deletions.
diff --git a/src/Util/ClassSourceManipulator.php b/src/Util/ClassSourceManipulator.php
@@ -253,8 +253,7 @@ public function addAccessorMethod(string $propertyName, string $methodName, $ret
 
     public function addGetter(string $propertyName, $returnType, bool $isReturnTypeNullable, array $commentLines = []): void
     {
-        $methodName = 'get'.Str::asCamelCase($propertyName);
-
+        $methodName = ('bool' === $returnType ? 'is' : 'get').Str::asCamelCase($propertyName);
         $this->addCustomGetter($propertyName, $methodName, $returnType, $isReturnTypeNullable, $commentLines);
     }
 

diff --git a/tests/Util/ClassSourceManipulatorTest.php b/tests/Util/ClassSourceManipulatorTest.php
@@ -100,6 +100,14 @@ public function getAddGetterTests()
             'User_simple.php',
         ];
 
+        yield 'normal_getter_add_bool' => [
+            'legacy/User_simple.php',
+            'fooProp',
+            'bool',
+            [],
+            'User_simple_bool.php',
+        ];
+
         yield 'getter_no_props_comments' => [
             'User_no_props.php',
             'fooProp',

diff --git a/tests/Util/fixtures/add_getter/User_simple_bool.php b/tests/Util/fixtures/add_getter/User_simple_bool.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace App\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * @ORM\Entity()
+ */
+class User
+{
+    /**
+     * @ORM\Id
+     * @ORM\GeneratedValue
+     * @ORM\Column(type="integer")
+     */
+    private $id;
+
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+
+    public function isFooProp(): ?bool
+    {
+        return $this->fooProp;
+    }
+}