bug #1646 Missmatch between PHPDoc and the reality on User::getRoles() (Curryed)

kbond · kbond · commit 022d79ebde8e · 2025-04-25T14:11:44.000-04:00
This PR was merged into the 1.x branch. Discussion ---------- Missmatch between PHPDoc and the reality on User::getRoles() See description in #1652 Commits ------- 28da5e4 fix: keep the return from the interface instead
diff --git a/src/Security/UserClassBuilder.php b/src/Security/UserClassBuilder.php
@@ -132,7 +132,7 @@ private function addGetRoles(ClassSourceManipulator $manipulator, UserClassConfi
             'getRoles',
             'array',
             false,
-            ['@see UserInterface', '@return list<string>']
+            ['@see UserInterface']
         );
 
         // $roles = $this->roles
diff --git a/tests/Security/fixtures/expected/UserEntityWithEmailAsIdentifier.php b/tests/Security/fixtures/expected/UserEntityWithEmailAsIdentifier.php
@@ -59,7 +59,6 @@ public function getUserIdentifier(): string
 
     /**
      * @see UserInterface
-     * @return list<string>
      */
     public function getRoles(): array
     {
diff --git a/tests/Security/fixtures/expected/UserEntityWithPassword.php b/tests/Security/fixtures/expected/UserEntityWithPassword.php
@@ -54,7 +54,6 @@ public function setUserIdentifier(string $userIdentifier): static
 
     /**
      * @see UserInterface
-     * @return list<string>
      */
     public function getRoles(): array
     {
diff --git a/tests/Security/fixtures/expected/UserEntityWithUser_IdentifierAsIdentifier.php b/tests/Security/fixtures/expected/UserEntityWithUser_IdentifierAsIdentifier.php
@@ -54,7 +54,6 @@ public function setUserIdentifier(string $user_identifier): static
 
     /**
      * @see UserInterface
-     * @return list<string>
      */
     public function getRoles(): array
     {
diff --git a/tests/Security/fixtures/expected/UserEntityWithoutPassword.php b/tests/Security/fixtures/expected/UserEntityWithoutPassword.php
@@ -47,7 +47,6 @@ public function setUserIdentifier(string $userIdentifier): static
 
     /**
      * @see UserInterface
-     * @return list<string>
      */
     public function getRoles(): array
     {
diff --git a/tests/Security/fixtures/expected/UserModelWithEmailAsIdentifier.php b/tests/Security/fixtures/expected/UserModelWithEmailAsIdentifier.php
@@ -43,7 +43,6 @@ public function getUserIdentifier(): string
 
     /**
      * @see UserInterface
-     * @return list<string>
      */
     public function getRoles(): array
     {
diff --git a/tests/Security/fixtures/expected/UserModelWithPassword.php b/tests/Security/fixtures/expected/UserModelWithPassword.php
@@ -38,7 +38,6 @@ public function setUserIdentifier(string $userIdentifier): static
 
     /**
      * @see UserInterface
-     * @return list<string>
      */
     public function getRoles(): array
     {
diff --git a/tests/Security/fixtures/expected/UserModelWithoutPassword.php b/tests/Security/fixtures/expected/UserModelWithoutPassword.php
@@ -32,7 +32,6 @@ public function setUserIdentifier(string $userIdentifier): static
 
     /**
      * @see UserInterface
-     * @return list<string>
      */
     public function getRoles(): array
     {

Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,6 @@ public function getUserIdentifier(): string`
`59`	`59`
`60`	`60`	`/**`
`61`	`61`	`* @see UserInterface`
`62`		`- * @return list<string>`
`63`	`62`	`*/`
`64`	`63`	`public function getRoles(): array`
`65`	`64`	`{`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,6 @@ public function setUserIdentifier(string $userIdentifier): static`
`54`	`54`
`55`	`55`	`/**`
`56`	`56`	`* @see UserInterface`
`57`		`- * @return list<string>`
`58`	`57`	`*/`
`59`	`58`	`public function getRoles(): array`
`60`	`59`	`{`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,6 @@ public function setUserIdentifier(string $userIdentifier): static`
`47`	`47`
`48`	`48`	`/**`
`49`	`49`	`* @see UserInterface`
`50`		`- * @return list<string>`
`51`	`50`	`*/`
`52`	`51`	`public function getRoles(): array`
`53`	`52`	`{`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,6 @@ public function getUserIdentifier(): string`
`43`	`43`
`44`	`44`	`/**`
`45`	`45`	`* @see UserInterface`
`46`		`- * @return list<string>`
`47`	`46`	`*/`
`48`	`47`	`public function getRoles(): array`
`49`	`48`	`{`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,6 @@ public function setUserIdentifier(string $userIdentifier): static`
`38`	`38`
`39`	`39`	`/**`
`40`	`40`	`* @see UserInterface`
`41`		`- * @return list<string>`
`42`	`41`	`*/`
`43`	`42`	`public function getRoles(): array`
`44`	`43`	`{`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,6 @@ public function setUserIdentifier(string $userIdentifier): static`
`32`	`32`
`33`	`33`	`/**`
`34`	`34`	`* @see UserInterface`
`35`		`- * @return list<string>`
`36`	`35`	`*/`
`37`	`36`	`public function getRoles(): array`
`38`	`37`	`{`