Merge pull request #1051 from kenjis/docs-update-phpdoc-array

docs: update PHPDoc array types

Author: kenjis

src/Auth.php

@@ -177,7 +177,7 @@ public function getProvider(): UserModel
      * own, additional, features on top of the required ones,
      * like "remember-me" functionality.
      *
-     * @param string[] $args
+     * @param list<string> $args
      *
      * @throws AuthenticationException
      */

src/Authentication/Authenticators/Session.php

@@ -501,7 +501,7 @@ private function setAuthAction(): bool
     /**
      * Gets identities for action
      *
-     * @return UserIdentity[]
+     * @return list<UserIdentity>
      */
     private function getIdentitiesForAction(User $user): array
     {
@@ -512,7 +512,7 @@ private function getIdentitiesForAction(User $user): array
     }
 
     /**
-     * @return string[]
+     * @return list<string>
      */
     private function getActionTypes(): array
     {

src/Authentication/JWT/JWSAdapterInterface.php

@@ -20,7 +20,7 @@ interface JWSAdapterInterface
     /**
      * Issues Signed JWT (JWS)
      *
-     * @param array<mixed>               $payload The payload.
+     * @param array<string, mixed>       $payload The payload.
      * @param string                     $keyset  The key group.
      *                                            The array key of Config\AuthJWT::$keys.
      * @param array<string, string>|null $headers An array with header elements to attach.

src/Authentication/Traits/HasAccessTokens.php

@@ -34,8 +34,8 @@ trait HasAccessTokens
     /**
      * Generates a new personal access token for this user.
      *
-     * @param string   $name   Token name
-     * @param string[] $scopes Permissions the token grants
+     * @param string       $name   Token name
+     * @param list<string> $scopes Permissions the token grants
      */
     public function generateAccessToken(string $name, array $scopes = ['*']): AccessToken
     {
@@ -81,7 +81,7 @@ public function revokeAllAccessTokens(): void
     /**
      * Retrieves all personal access tokens for this user.
      *
-     * @return AccessToken[]
+     * @return list<AccessToken>
      */
     public function accessTokens(): array
     {

src/Authentication/Traits/HasHmacTokens.php

@@ -35,8 +35,8 @@ trait HasHmacTokens
     /**
      * Generates a new personal HMAC token for this user.
      *
-     * @param string   $name   Token name
-     * @param string[] $scopes Permissions the token grants
+     * @param string       $name   Token name
+     * @param list<string> $scopes Permissions the token grants
      *
      * @throws ReflectionException
      */
@@ -73,7 +73,7 @@ public function revokeAllHmacTokens(): void
     /**
      * Retrieves all personal HMAC tokens for this user.
      *
-     * @return AccessToken[]
+     * @return list<AccessToken>
      */
     public function hmacTokens(): array
     {

src/Authorization/Traits/Authorizable.php

@@ -399,15 +399,15 @@ private function saveGroupsOrPermissions(string $type, $model, array $cache): vo
     }
 
     /**
-     * @return string[]
+     * @return list<string>
      */
     private function getConfigGroups(): array
     {
         return array_keys(setting('AuthGroups.groups'));
     }
 
     /**
-     * @return string[]
+     * @return list<string>
      */
     private function getConfigPermissions(): array
     {

src/Config/Auth.php

@@ -137,8 +137,7 @@ class Auth extends BaseConfig
      * when using the 'chain' filter. Each Authenticator listed will be checked.
      * If no match is found, then the next in the chain will be checked.
      *
-     * @var string[]
-     * @phpstan-var list<string>
+     * @var list<string>
      */
     public array $authenticationChain = [
         'session',
@@ -264,7 +263,7 @@ class Auth extends BaseConfig
      * You can add custom classes as long as they adhere to the
      * CodeIgniter\Shield\Authentication\Passwords\ValidatorInterface.
      *
-     * @var class-string<ValidatorInterface>[]
+     * @var list<class-string<ValidatorInterface>>
      */
     public array $passwordValidators = [
         CompositionValidator::class,

src/Config/AuthJWT.php

@@ -49,7 +49,7 @@ class AuthJWT extends BaseConfig
      * The key of the array is the key group name.
      * The first key of the group is used for signing.
      *
-     * @var array<string, array<int, array<string, string>>>
+     * @var         array<string, array<int, array<string, string>>>
      * @phpstan-var array<string, list<array<string, string>>>
      */
     public array $keys = [

src/Controllers/ActionController.php

@@ -31,7 +31,7 @@ class ActionController extends BaseController
     /**
      * Perform an initial check if we have a valid action or not.
      *
-     * @param string[] $params
+     * @param list<string> $params
      *
      * @return Response|string
      */

src/Controllers/LoginController.php

@@ -84,8 +84,7 @@ public function loginAction(): RedirectResponse
     /**
      * Returns the rules that should be used for validation.
      *
-     * @return         array<string, array<string, array<string>|string>>
-     * @phpstan-return array<string, array<string, string|list<string>>>
+     * @return array<string, array<string, list<string>|string>>
      */
     protected function getValidationRules(): array
     {