feature #42471 Add generic types to traversable implementations (derrabus)

fabpot · fabpot · commit 57ff35e35935 · 2021-11-03T11:36:38.000+01:00
This PR was merged into the 5.4 branch.

Discussion
----------

Add generic types to traversable implementations

| Q             | A
| ------------- | ---
| Branch?       | 5.4
| Bug fix?      | no
| New feature?  | kinda
| Deprecations? | no
| Tickets       | N/A
| License       | MIT
| Doc PR        | N/A

Since tool support for generic types is growing, I wanted to give it a try and add generics to our traversable implementations. This should help Psalm to understand our code better. Furthermore, it helps app developers with running static code analysis on their own codebases.

Marking this as WIP for now until I reviewed all errors reported by Psalm.

Commits
-------

7f824fcf95 Add generic types to traversable implementations
diff --git a/Authentication/AuthenticationProviderManager.php b/Authentication/AuthenticationProviderManager.php
@@ -47,8 +47,8 @@ class AuthenticationProviderManager implements AuthenticationManagerInterface
     private $eventDispatcher;
 
     /**
-     * @param iterable|AuthenticationProviderInterface[] $providers        An iterable with AuthenticationProviderInterface instances as values
-     * @param bool                                       $eraseCredentials Whether to erase credentials after authentication or not
+     * @param iterable<int, AuthenticationProviderInterface> $providers        An iterable with AuthenticationProviderInterface instances as values
+     * @param bool                                           $eraseCredentials Whether to erase credentials after authentication or not
      *
      * @throws \InvalidArgumentException
      */
diff --git a/Authorization/TraceableAccessDecisionManager.php b/Authorization/TraceableAccessDecisionManager.php
@@ -98,7 +98,7 @@ public function getStrategy(): string
     }
 
     /**
-     * @return iterable|VoterInterface[]
+     * @return iterable<int, VoterInterface>
      */
     public function getVoters(): iterable
     {
diff --git a/User/ChainUserProvider.php b/User/ChainUserProvider.php
@@ -27,15 +27,15 @@ class ChainUserProvider implements UserProviderInterface, PasswordUpgraderInterf
     private $providers;
 
     /**
-     * @param iterable|UserProviderInterface[] $providers
+     * @param iterable<int, UserProviderInterface> $providers
      */
     public function __construct(iterable $providers)
     {
         $this->providers = $providers;
     }
 
     /**
-     * @return array
+     * @return UserProviderInterface[]
      */
     public function getProviders()
     {

Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,7 @@ public function getStrategy(): string`
`98`	`98`	`}`
`99`	`99`
`100`	`100`	`/**`
`101`		`- * @return iterable\|VoterInterface[]`
	`101`	`+ * @return iterable<int, VoterInterface>`
`102`	`102`	`*/`
`103`	`103`	`public function getVoters(): iterable`
`104`	`104`	`{`
Original file line number	Diff line number	Diff line change
`@@ -27,15 +27,15 @@ class ChainUserProvider implements UserProviderInterface, PasswordUpgraderInterf`
`27`	`27`	`private $providers;`
`28`	`28`
`29`	`29`	`/**`
`30`		`- * @param iterable\|UserProviderInterface[] $providers`
	`30`	`+ * @param iterable<int, UserProviderInterface> $providers`
`31`	`31`	`*/`
`32`	`32`	`public function __construct(iterable $providers)`
`33`	`33`	`{`
`34`	`34`	`$this->providers = $providers;`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`/**`
`38`		`- * @return array`
	`38`	`+ * @return UserProviderInterface[]`
`39`	`39`	`*/`
`40`	`40`	`public function getProviders()`
`41`	`41`	`{`