Merge pull request #732 from cakephp/3.x-array-doc

markstory · web-flow · commit 76e859261832 · 2025-07-30T16:38:32.000-04:00
Fix up array docblocks.
diff --git a/src/AuthenticationService.php b/src/AuthenticationService.php
@@ -110,7 +110,7 @@ class AuthenticationService implements AuthenticationServiceInterface, Impersona
     /**
      * Constructor
      *
-     * @param array $config Configuration options.
+     * @param array<string, mixed> $config Configuration options.
      */
     public function __construct(array $config = [])
     {
@@ -151,7 +151,7 @@ public function authenticators(): AuthenticatorCollection
      * Loads an authenticator.
      *
      * @param string $name Name or class name.
-     * @param array $config Authenticator configuration.
+     * @param array<string, mixed> $config Authenticator configuration.
      * @return \Authentication\Authenticator\AuthenticatorInterface
      */
     public function loadAuthenticator(string $name, array $config = []): AuthenticatorInterface
@@ -163,7 +163,7 @@ public function loadAuthenticator(string $name, array $config = []): Authenticat
      * Loads an identifier.
      *
      * @param string $name Name or class name.
-     * @param array $config Identifier configuration.
+     * @param array<string, mixed> $config Identifier configuration.
      * @return \Authentication\Identifier\IdentifierInterface Identifier instance
      * @deprecated 3.3.0: loadIdentifier() usage is deprecated. Directly pass Identifier to Authenticator.
      */
diff --git a/src/AuthenticationServiceInterface.php b/src/AuthenticationServiceInterface.php
@@ -28,7 +28,7 @@ interface AuthenticationServiceInterface extends PersistenceInterface
      * Loads an authenticator.
      *
      * @param string $name Name or class name.
-     * @param array $config Authenticator configuration.
+     * @param array<string, mixed> $config Authenticator configuration.
      * @return \Authentication\Authenticator\AuthenticatorInterface
      */
     public function loadAuthenticator(string $name, array $config = []): AuthenticatorInterface;
@@ -37,7 +37,7 @@ public function loadAuthenticator(string $name, array $config = []): Authenticat
      * Loads an identifier.
      *
      * @param string $name Name or class name.
-     * @param array $config Identifier configuration.
+     * @param array<string, mixed> $config Identifier configuration.
      * @return \Authentication\Identifier\IdentifierInterface
      * @deprecated 3.3.0: loadIdentifier() usage is deprecated. Directly pass Identifier to Authenticator.
      */
diff --git a/src/Authenticator/AbstractAuthenticator.php b/src/Authenticator/AbstractAuthenticator.php
@@ -49,7 +49,7 @@ abstract class AbstractAuthenticator implements AuthenticatorInterface
      * Constructor
      *
      * @param \Authentication\Identifier\IdentifierInterface $identifier Identifier or identifiers collection.
-     * @param array $config Configuration settings.
+     * @param array<string, mixed> $config Configuration settings.
      */
     public function __construct(IdentifierInterface $identifier, array $config = [])
     {
diff --git a/src/Authenticator/AuthenticatorCollection.php b/src/Authenticator/AuthenticatorCollection.php
@@ -38,7 +38,7 @@ class AuthenticatorCollection extends AbstractCollection
      * Constructor.
      *
      * @param \Authentication\Identifier\IdentifierCollection $identifiers Identifiers collection.
-     * @param array $config Config array.
+     * @param array<string, mixed> $config Config array.
      */
     public function __construct(IdentifierCollection $identifiers, array $config = [])
     {
@@ -58,7 +58,7 @@ public function __construct(IdentifierCollection $identifiers, array $config = [
      *
      * @param \Authentication\Authenticator\AuthenticatorInterface|class-string<\Authentication\Authenticator\AuthenticatorInterface> $class Authenticator class.
      * @param string $alias Authenticator alias.
-     * @param array $config Config array.
+     * @param array<string, mixed> $config Config array.
      * @return \Authentication\Authenticator\AuthenticatorInterface
      * @throws \RuntimeException
      */
diff --git a/src/Authenticator/HttpDigestAuthenticator.php b/src/Authenticator/HttpDigestAuthenticator.php
@@ -56,7 +56,7 @@ class HttpDigestAuthenticator extends HttpBasicAuthenticator
      *    Defaults to `md5($config['realm'])`
      *
      * @param \Authentication\Identifier\IdentifierInterface $identifier Identifier instance.
-     * @param array $config Configuration settings.
+     * @param array<string, mixed> $config Configuration settings.
      */
     public function __construct(IdentifierInterface $identifier, array $config = [])
     {
diff --git a/src/Controller/Component/AuthenticationComponent.php b/src/Controller/Component/AuthenticationComponent.php
@@ -83,7 +83,7 @@ class AuthenticationComponent extends Component implements EventDispatcherInterf
     /**
      * Initialize component.
      *
-     * @param array $config The config data.
+     * @param array<string, mixed> $config The config data.
      * @return void
      */
     public function initialize(array $config): void
diff --git a/src/Identifier/AbstractIdentifier.php b/src/Identifier/AbstractIdentifier.php
@@ -43,7 +43,7 @@ abstract class AbstractIdentifier implements IdentifierInterface
     /**
      * Constructor
      *
-     * @param array $config Configuration
+     * @param array<string, mixed> $config Configuration
      */
     public function __construct(array $config = [])
     {
diff --git a/src/Identifier/IdentifierCollection.php b/src/Identifier/IdentifierCollection.php
@@ -69,7 +69,7 @@ public function identify(array $credentials): ArrayAccess|array|null
      *
      * @param \Authentication\Identifier\IdentifierInterface|class-string<\Authentication\Identifier\IdentifierInterface> $class Identifier class.
      * @param string $alias Identifier alias.
-     * @param array $config Config array.
+     * @param array<string, mixed> $config Config array.
      * @return \Authentication\Identifier\IdentifierInterface
      * @throws \RuntimeException
      */
diff --git a/src/Identifier/Resolver/OrmResolver.php b/src/Identifier/Resolver/OrmResolver.php
@@ -43,7 +43,7 @@ class OrmResolver implements ResolverInterface
     /**
      * Constructor.
      *
-     * @param array $config Config array.
+     * @param array<string, mixed> $config Config array.
      */
     public function __construct(array $config = [])
     {
diff --git a/src/Identity.php b/src/Identity.php
@@ -51,7 +51,7 @@ class Identity implements IdentityInterface
      * Constructor
      *
      * @param \ArrayAccess|array $data Identity data
-     * @param array $config Config options
+     * @param array<string, mixed> $config Config options
      */
     public function __construct(ArrayAccess|array $data, array $config = [])
     {
diff --git a/src/PasswordHasher/AbstractPasswordHasher.php b/src/PasswordHasher/AbstractPasswordHasher.php
@@ -36,7 +36,7 @@ abstract class AbstractPasswordHasher implements PasswordHasherInterface
     /**
      * Constructor
      *
-     * @param array $config Array of config.
+     * @param array<string, mixed> $config Array of config.
      */
     public function __construct(array $config = [])
     {
diff --git a/src/PasswordHasher/FallbackPasswordHasher.php b/src/PasswordHasher/FallbackPasswordHasher.php
@@ -41,7 +41,7 @@ class FallbackPasswordHasher extends AbstractPasswordHasher
     /**
      * Constructor
      *
-     * @param array $config configuration options for this object. Requires the
+     * @param array<string, mixed> $config configuration options for this object. Requires the
      * `hashers` key to be present in the array with a list of other hashers to be
      * used
      */
diff --git a/src/View/Helper/IdentityHelper.php b/src/View/Helper/IdentityHelper.php
@@ -49,7 +49,7 @@ class IdentityHelper extends Helper
      *
      * Implement this method to avoid having to overwrite the constructor and call parent.
      *
-     * @param array $config The configuration settings provided to this helper.
+     * @param array<string, mixed> $config The configuration settings provided to this helper.
      * @return void
      */
     public function initialize(array $config): void

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ abstract class AbstractAuthenticator implements AuthenticatorInterface`
`49`	`49`	`* Constructor`
`50`	`50`	`*`
`51`	`51`	`* @param \Authentication\Identifier\IdentifierInterface $identifier Identifier or identifiers collection.`
`52`		`- * @param array $config Configuration settings.`
	`52`	`+ * @param array<string, mixed> $config Configuration settings.`
`53`	`53`	`*/`
`54`	`54`	`public function __construct(IdentifierInterface $identifier, array $config = [])`
`55`	`55`	`{`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ class AuthenticatorCollection extends AbstractCollection`
`38`	`38`	`* Constructor.`
`39`	`39`	`*`
`40`	`40`	`* @param \Authentication\Identifier\IdentifierCollection $identifiers Identifiers collection.`
`41`		`- * @param array $config Config array.`
	`41`	`+ * @param array<string, mixed> $config Config array.`
`42`	`42`	`*/`
`43`	`43`	`public function __construct(IdentifierCollection $identifiers, array $config = [])`
`44`	`44`	`{`
`@@ -58,7 +58,7 @@ public function __construct(IdentifierCollection $identifiers, array $config = [`
`58`	`58`	`*`
`59`	`59`	`* @param \Authentication\Authenticator\AuthenticatorInterface\|class-string<\Authentication\Authenticator\AuthenticatorInterface> $class Authenticator class.`
`60`	`60`	`* @param string $alias Authenticator alias.`
`61`		`- * @param array $config Config array.`
	`61`	`+ * @param array<string, mixed> $config Config array.`
`62`	`62`	`* @return \Authentication\Authenticator\AuthenticatorInterface`
`63`	`63`	`* @throws \RuntimeException`
`64`	`64`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ class HttpDigestAuthenticator extends HttpBasicAuthenticator`
`56`	`56`	* Defaults to `md5($config['realm'])`
`57`	`57`	`*`
`58`	`58`	`* @param \Authentication\Identifier\IdentifierInterface $identifier Identifier instance.`
`59`		`- * @param array $config Configuration settings.`
	`59`	`+ * @param array<string, mixed> $config Configuration settings.`
`60`	`60`	`*/`
`61`	`61`	`public function __construct(IdentifierInterface $identifier, array $config = [])`
`62`	`62`	`{`
Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,7 @@ class AuthenticationComponent extends Component implements EventDispatcherInterf`
`83`	`83`	`/**`
`84`	`84`	`* Initialize component.`
`85`	`85`	`*`
`86`		`- * @param array $config The config data.`
	`86`	`+ * @param array<string, mixed> $config The config data.`
`87`	`87`	`* @return void`
`88`	`88`	`*/`
`89`	`89`	`public function initialize(array $config): void`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ abstract class AbstractIdentifier implements IdentifierInterface`
`43`	`43`	`/**`
`44`	`44`	`* Constructor`
`45`	`45`	`*`
`46`		`- * @param array $config Configuration`
	`46`	`+ * @param array<string, mixed> $config Configuration`
`47`	`47`	`*/`
`48`	`48`	`public function __construct(array $config = [])`
`49`	`49`	`{`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ public function identify(array $credentials): ArrayAccess\|array\|null`
`69`	`69`	`*`
`70`	`70`	`* @param \Authentication\Identifier\IdentifierInterface\|class-string<\Authentication\Identifier\IdentifierInterface> $class Identifier class.`
`71`	`71`	`* @param string $alias Identifier alias.`
`72`		`- * @param array $config Config array.`
	`72`	`+ * @param array<string, mixed> $config Config array.`
`73`	`73`	`* @return \Authentication\Identifier\IdentifierInterface`
`74`	`74`	`* @throws \RuntimeException`
`75`	`75`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ class OrmResolver implements ResolverInterface`
`43`	`43`	`/**`
`44`	`44`	`* Constructor.`
`45`	`45`	`*`
`46`		`- * @param array $config Config array.`
	`46`	`+ * @param array<string, mixed> $config Config array.`
`47`	`47`	`*/`
`48`	`48`	`public function __construct(array $config = [])`
`49`	`49`	`{`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ class Identity implements IdentityInterface`
`51`	`51`	`* Constructor`
`52`	`52`	`*`
`53`	`53`	`* @param \ArrayAccess\|array $data Identity data`
`54`		`- * @param array $config Config options`
	`54`	`+ * @param array<string, mixed> $config Config options`
`55`	`55`	`*/`
`56`	`56`	`public function __construct(ArrayAccess\|array $data, array $config = [])`
`57`	`57`	`{`