feature #1411 [make:user] Add phpdocs in class generated by make:user for PHPStan

maelanleborgne · web-flow · commit 490e55057302 · 2024-02-20T14:04:38.000-05:00
diff --git a/src/Security/UserClassBuilder.php b/src/Security/UserClassBuilder.php
@@ -99,34 +99,38 @@ private function addGetRoles(ClassSourceManipulator $manipulator, UserClassConfi
         if ($userClassConfig->isEntity()) {
             // add entity property
             $manipulator->addEntityField(
-                new ClassProperty(propertyName: 'roles', type: 'json')
+                new ClassProperty(propertyName: 'roles', type: 'json', comments: ['@var list<string> The user roles'])
             );
         } else {
             // add normal property
             $manipulator->addProperty(
                 name: 'roles',
-                defaultValue: new Node\Expr\Array_([], ['kind' => Node\Expr\Array_::KIND_SHORT])
+                defaultValue: new Node\Expr\Array_([], ['kind' => Node\Expr\Array_::KIND_SHORT]),
+                comments: [
+                    '@var list<string> The user roles',
+                ]
             );
 
             $manipulator->addGetter(
                 'roles',
                 'array',
-                false
-            );
-
-            $manipulator->addSetter(
-                'roles',
-                'array',
-                false
+                false,
             );
         }
 
+        $manipulator->addSetter(
+            'roles',
+            'array',
+            false,
+            ['@param list<string> $roles']
+        );
+
         // define getRoles (if it was defined above, this will override)
         $builder = $manipulator->createMethodBuilder(
             'getRoles',
             'array',
             false,
-            ['@see UserInterface']
+            ['@see UserInterface', '@return list<string>']
         );
 
         // $roles = $this->roles
diff --git a/tests/Security/fixtures/expected/UserEntityWithEmailAsIdentifier.php b/tests/Security/fixtures/expected/UserEntityWithEmailAsIdentifier.php
@@ -17,6 +17,9 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface
     #[ORM\Column(length: 180, unique: true)]
     private ?string $email = null;
 
+    /**
+     * @var list<string> The user roles
+     */
     #[ORM\Column]
     private array $roles = [];
 
@@ -55,6 +58,7 @@ public function getUserIdentifier(): string
 
     /**
      * @see UserInterface
+     * @return list<string>
      */
     public function getRoles(): array
     {
@@ -65,6 +69,9 @@ public function getRoles(): array
         return array_unique($roles);
     }
 
+    /**
+     * @param list<string> $roles
+     */
     public function setRoles(array $roles): static
     {
         $this->roles = $roles;
diff --git a/tests/Security/fixtures/expected/UserEntityWithPassword.php b/tests/Security/fixtures/expected/UserEntityWithPassword.php
@@ -17,6 +17,9 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface
     #[ORM\Column(length: 180, unique: true)]
     private ?string $userIdentifier = null;
 
+    /**
+     * @var list<string> The user roles
+     */
     #[ORM\Column]
     private array $roles = [];
 
@@ -50,6 +53,7 @@ public function setUserIdentifier(string $userIdentifier): static
 
     /**
      * @see UserInterface
+     * @return list<string>
      */
     public function getRoles(): array
     {
@@ -60,6 +64,9 @@ public function getRoles(): array
         return array_unique($roles);
     }
 
+    /**
+     * @param list<string> $roles
+     */
     public function setRoles(array $roles): static
     {
         $this->roles = $roles;
diff --git a/tests/Security/fixtures/expected/UserEntityWithUser_IdentifierAsIdentifier.php b/tests/Security/fixtures/expected/UserEntityWithUser_IdentifierAsIdentifier.php
@@ -17,6 +17,9 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface
     #[ORM\Column(length: 180, unique: true)]
     private ?string $user_identifier = null;
 
+    /**
+     * @var list<string> The user roles
+     */
     #[ORM\Column]
     private array $roles = [];
 
@@ -50,6 +53,7 @@ public function setUserIdentifier(string $user_identifier): static
 
     /**
      * @see UserInterface
+     * @return list<string>
      */
     public function getRoles(): array
     {
@@ -60,6 +64,9 @@ public function getRoles(): array
         return array_unique($roles);
     }
 
+    /**
+     * @param list<string> $roles
+     */
     public function setRoles(array $roles): static
     {
         $this->roles = $roles;
diff --git a/tests/Security/fixtures/expected/UserEntityWithoutPassword.php b/tests/Security/fixtures/expected/UserEntityWithoutPassword.php
@@ -16,6 +16,9 @@ class User implements UserInterface
     #[ORM\Column(length: 180, unique: true)]
     private ?string $userIdentifier = null;
 
+    /**
+     * @var list<string> The user roles
+     */
     #[ORM\Column]
     private array $roles = [];
 
@@ -43,6 +46,7 @@ public function setUserIdentifier(string $userIdentifier): static
 
     /**
      * @see UserInterface
+     * @return list<string>
      */
     public function getRoles(): array
     {
@@ -53,6 +57,9 @@ public function getRoles(): array
         return array_unique($roles);
     }
 
+    /**
+     * @param list<string> $roles
+     */
     public function setRoles(array $roles): static
     {
         $this->roles = $roles;
diff --git a/tests/Security/fixtures/expected/UserModelWithEmailAsIdentifier.php b/tests/Security/fixtures/expected/UserModelWithEmailAsIdentifier.php
@@ -9,6 +9,9 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface
 {
     private $email;
 
+    /**
+     * @var list<string> The user roles
+     */
     private $roles = [];
 
     /**
@@ -40,6 +43,7 @@ public function getUserIdentifier(): string
 
     /**
      * @see UserInterface
+     * @return list<string>
      */
     public function getRoles(): array
     {
@@ -50,6 +54,9 @@ public function getRoles(): array
         return array_unique($roles);
     }
 
+    /**
+     * @param list<string> $roles
+     */
     public function setRoles(array $roles): static
     {
         $this->roles = $roles;
diff --git a/tests/Security/fixtures/expected/UserModelWithPassword.php b/tests/Security/fixtures/expected/UserModelWithPassword.php
@@ -9,6 +9,9 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface
 {
     private $userIdentifier;
 
+    /**
+     * @var list<string> The user roles
+     */
     private $roles = [];
 
     /**
@@ -35,6 +38,7 @@ public function setUserIdentifier(string $userIdentifier): static
 
     /**
      * @see UserInterface
+     * @return list<string>
      */
     public function getRoles(): array
     {
@@ -45,6 +49,9 @@ public function getRoles(): array
         return array_unique($roles);
     }
 
+    /**
+     * @param list<string> $roles
+     */
     public function setRoles(array $roles): static
     {
         $this->roles = $roles;
diff --git a/tests/Security/fixtures/expected/UserModelWithoutPassword.php b/tests/Security/fixtures/expected/UserModelWithoutPassword.php
@@ -8,6 +8,9 @@ class User implements UserInterface
 {
     private $userIdentifier;
 
+    /**
+     * @var list<string> The user roles
+     */
     private $roles = [];
 
     /**
@@ -29,6 +32,7 @@ public function setUserIdentifier(string $userIdentifier): static
 
     /**
      * @see UserInterface
+     * @return list<string>
      */
     public function getRoles(): array
     {
@@ -39,6 +43,9 @@ public function getRoles(): array
         return array_unique($roles);
     }
 
+    /**
+     * @param list<string> $roles
+     */
     public function setRoles(array $roles): static
     {
         $this->roles = $roles;

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,9 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface`
`9`	`9`	`{`
`10`	`10`	`private $email;`
`11`	`11`
	`12`	`+ /**`
	`13`	`+ * @var list<string> The user roles`
	`14`	`+ */`
`12`	`15`	`private $roles = [];`
`13`	`16`
`14`	`17`	`/**`
`@@ -40,6 +43,7 @@ public function getUserIdentifier(): string`
`40`	`43`
`41`	`44`	`/**`
`42`	`45`	`* @see UserInterface`
	`46`	`+ * @return list<string>`
`43`	`47`	`*/`
`44`	`48`	`public function getRoles(): array`
`45`	`49`	`{`
`@@ -50,6 +54,9 @@ public function getRoles(): array`
`50`	`54`	`return array_unique($roles);`
`51`	`55`	`}`
`52`	`56`
	`57`	`+ /**`
	`58`	`+ * @param list<string> $roles`
	`59`	`+ */`
`53`	`60`	`public function setRoles(array $roles): static`
`54`	`61`	`{`
`55`	`62`	`$this->roles = $roles;`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,9 @@ class User implements UserInterface`
`8`	`8`	`{`
`9`	`9`	`private $userIdentifier;`
`10`	`10`
	`11`	`+ /**`
	`12`	`+ * @var list<string> The user roles`
	`13`	`+ */`
`11`	`14`	`private $roles = [];`
`12`	`15`
`13`	`16`	`/**`
`@@ -29,6 +32,7 @@ public function setUserIdentifier(string $userIdentifier): static`
`29`	`32`
`30`	`33`	`/**`
`31`	`34`	`* @see UserInterface`
	`35`	`+ * @return list<string>`
`32`	`36`	`*/`
`33`	`37`	`public function getRoles(): array`
`34`	`38`	`{`
`@@ -39,6 +43,9 @@ public function getRoles(): array`
`39`	`43`	`return array_unique($roles);`
`40`	`44`	`}`
`41`	`45`
	`46`	`+ /**`
	`47`	`+ * @param list<string> $roles`
	`48`	`+ */`
`42`	`49`	`public function setRoles(array $roles): static`
`43`	`50`	`{`
`44`	`51`	`$this->roles = $roles;`