From 1e3d3edfa4935b13fe3e7274addb95889452aa5d Mon Sep 17 00:00:00 2001 From: mscherer Date: Tue, 29 Jul 2025 11:35:51 +0200 Subject: [PATCH] Fix up array docblocks. --- src/AuthenticationService.php | 6 +++--- src/AuthenticationServiceInterface.php | 4 ++-- src/Authenticator/AbstractAuthenticator.php | 2 +- src/Authenticator/AuthenticatorCollection.php | 4 ++-- src/Authenticator/HttpDigestAuthenticator.php | 2 +- src/Controller/Component/AuthenticationComponent.php | 2 +- src/Identifier/AbstractIdentifier.php | 2 +- src/Identifier/IdentifierCollection.php | 2 +- src/Identifier/Resolver/OrmResolver.php | 2 +- src/Identity.php | 2 +- src/PasswordHasher/AbstractPasswordHasher.php | 2 +- src/PasswordHasher/FallbackPasswordHasher.php | 2 +- src/View/Helper/IdentityHelper.php | 2 +- 13 files changed, 17 insertions(+), 17 deletions(-) diff --git a/src/AuthenticationService.php b/src/AuthenticationService.php index e4a08276..b9e75480 100644 --- 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 $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 $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 $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 index 304147a0..ade15c28 100644 --- 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 $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 $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 index 1ba69997..ad53b741 100644 --- 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 $config Configuration settings. */ public function __construct(IdentifierInterface $identifier, array $config = []) { diff --git a/src/Authenticator/AuthenticatorCollection.php b/src/Authenticator/AuthenticatorCollection.php index 1796f87b..171c0fdc 100644 --- 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 $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 $config Config array. * @return \Authentication\Authenticator\AuthenticatorInterface * @throws \RuntimeException */ diff --git a/src/Authenticator/HttpDigestAuthenticator.php b/src/Authenticator/HttpDigestAuthenticator.php index e18cdfc7..0647b8ea 100644 --- 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 $config Configuration settings. */ public function __construct(IdentifierInterface $identifier, array $config = []) { diff --git a/src/Controller/Component/AuthenticationComponent.php b/src/Controller/Component/AuthenticationComponent.php index 7ad3cc5b..7cdcf335 100644 --- 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 $config The config data. * @return void */ public function initialize(array $config): void diff --git a/src/Identifier/AbstractIdentifier.php b/src/Identifier/AbstractIdentifier.php index f91945db..e2e36e36 100644 --- 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 $config Configuration */ public function __construct(array $config = []) { diff --git a/src/Identifier/IdentifierCollection.php b/src/Identifier/IdentifierCollection.php index 5afaf9e5..ec49d1dc 100644 --- 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 $config Config array. * @return \Authentication\Identifier\IdentifierInterface * @throws \RuntimeException */ diff --git a/src/Identifier/Resolver/OrmResolver.php b/src/Identifier/Resolver/OrmResolver.php index dfa35737..071ff9d5 100644 --- 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 $config Config array. */ public function __construct(array $config = []) { diff --git a/src/Identity.php b/src/Identity.php index d91fb635..0a699fce 100644 --- 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 $config Config options */ public function __construct(ArrayAccess|array $data, array $config = []) { diff --git a/src/PasswordHasher/AbstractPasswordHasher.php b/src/PasswordHasher/AbstractPasswordHasher.php index f379054c..f9fbed94 100644 --- 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 $config Array of config. */ public function __construct(array $config = []) { diff --git a/src/PasswordHasher/FallbackPasswordHasher.php b/src/PasswordHasher/FallbackPasswordHasher.php index 00abe2a7..6aee5378 100644 --- 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 $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 index eca4e322..6c2dc947 100644 --- 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 $config The configuration settings provided to this helper. * @return void */ public function initialize(array $config): void