diff --git a/src/AuthenticationService.php b/src/AuthenticationService.php index 6335872b..95a57940 100644 --- a/src/AuthenticationService.php +++ b/src/AuthenticationService.php @@ -169,6 +169,9 @@ public function loadIdentifier(string $name, array $config = []): IdentifierInte /** * {@inheritDoc} * + * @param \Psr\Http\Message\ServerRequestInterface $request The request. + * @return \Authentication\Authenticator\ResultInterface The result object. If none of the adapters was a success + * the last failed result is returned. * @throws \RuntimeException Throws a runtime exception when no authenticators are loaded. */ public function authenticate(ServerRequestInterface $request): ResultInterface diff --git a/src/Authenticator/AuthenticatorCollection.php b/src/Authenticator/AuthenticatorCollection.php index ca6bde22..b0eff5ac 100644 --- a/src/Authenticator/AuthenticatorCollection.php +++ b/src/Authenticator/AuthenticatorCollection.php @@ -84,7 +84,6 @@ protected function _resolveClassName($class): ?string } /** - * * @param string $class Missing class. * @param string $plugin Class plugin. * @return void diff --git a/src/Authenticator/CookieAuthenticator.php b/src/Authenticator/CookieAuthenticator.php index c83864c3..c0535e52 100644 --- a/src/Authenticator/CookieAuthenticator.php +++ b/src/Authenticator/CookieAuthenticator.php @@ -37,7 +37,7 @@ class CookieAuthenticator extends AbstractAuthenticator implements PersistenceIn use UrlCheckerTrait; /** - * @inheritdoc + * @inheritDoc */ protected $_defaultConfig = [ 'loginUrl' => null, @@ -59,7 +59,7 @@ class CookieAuthenticator extends AbstractAuthenticator implements PersistenceIn ]; /** - * @inheritdoc + * @inheritDoc */ public function __construct(IdentifierCollection $identifiers, array $config = []) { @@ -81,7 +81,7 @@ protected function _checkCakeVersion(): void } /** - * @inheritdoc + * @inheritDoc */ public function authenticate(ServerRequestInterface $request): ResultInterface { @@ -123,7 +123,7 @@ public function authenticate(ServerRequestInterface $request): ResultInterface } /** - * @inheritdoc + * @inheritDoc */ public function persistIdentity(ServerRequestInterface $request, ResponseInterface $response, $identity): array { @@ -195,7 +195,7 @@ protected function _checkToken($identity, $tokenHash): bool } /** - * @inheritdoc + * @inheritDoc */ public function clearIdentity(ServerRequestInterface $request, ResponseInterface $response): array { diff --git a/src/Authenticator/JwtAuthenticator.php b/src/Authenticator/JwtAuthenticator.php index 741878a1..334ad07b 100644 --- a/src/Authenticator/JwtAuthenticator.php +++ b/src/Authenticator/JwtAuthenticator.php @@ -28,7 +28,7 @@ class JwtAuthenticator extends TokenAuthenticator { /** - * @inheritdoc + * @inheritDoc */ protected $_defaultConfig = [ 'header' => 'Authorization', @@ -47,7 +47,7 @@ class JwtAuthenticator extends TokenAuthenticator protected $payload; /** - * @inheritdoc + * @inheritDoc */ public function __construct(IdentifierInterface $identifier, array $config = []) { diff --git a/src/Authenticator/PersistenceInterface.php b/src/Authenticator/PersistenceInterface.php index a2d788e4..5dd011d3 100644 --- a/src/Authenticator/PersistenceInterface.php +++ b/src/Authenticator/PersistenceInterface.php @@ -28,7 +28,7 @@ interface PersistenceInterface * @param \Psr\Http\Message\ResponseInterface $response The response object. * @param \ArrayAccess|array $identity Identity data to persist. * @return array - * @psalm-return array{request: ServerRequestInterface, response: ResponseInterface} Returns an array containing the request and response object + * @psalm-return array{request: \Psr\Http\Message\ServerRequestInterface, response: \Psr\Http\Message\ResponseInterface} Returns an array containing the request and response object */ public function persistIdentity(ServerRequestInterface $request, ResponseInterface $response, $identity): array; @@ -38,7 +38,7 @@ public function persistIdentity(ServerRequestInterface $request, ResponseInterfa * @param \Psr\Http\Message\ServerRequestInterface $request The request object. * @param \Psr\Http\Message\ResponseInterface $response The response object. * @return array - * @psalm-return array{request: ServerRequestInterface, response: ResponseInterface} Returns an array containing the request and response object + * @psalm-return array{request: \Psr\Http\Message\ServerRequestInterface, response: \Psr\Http\Message\ResponseInterface} Returns an array containing the request and response object */ public function clearIdentity(ServerRequestInterface $request, ResponseInterface $response): array; } diff --git a/src/Authenticator/SessionAuthenticator.php b/src/Authenticator/SessionAuthenticator.php index 6d60d263..c405f3f3 100644 --- a/src/Authenticator/SessionAuthenticator.php +++ b/src/Authenticator/SessionAuthenticator.php @@ -80,7 +80,7 @@ public function authenticate(ServerRequestInterface $request): ResultInterface } /** - * @inheritdoc + * @inheritDoc */ public function persistIdentity(ServerRequestInterface $request, ResponseInterface $response, $identity): array { @@ -100,7 +100,7 @@ public function persistIdentity(ServerRequestInterface $request, ResponseInterfa } /** - * @inheritdoc + * @inheritDoc */ public function clearIdentity(ServerRequestInterface $request, ResponseInterface $response): array { diff --git a/src/Authenticator/TokenAuthenticator.php b/src/Authenticator/TokenAuthenticator.php index 19a95184..c775109b 100644 --- a/src/Authenticator/TokenAuthenticator.php +++ b/src/Authenticator/TokenAuthenticator.php @@ -27,7 +27,7 @@ class TokenAuthenticator extends AbstractAuthenticator implements StatelessInterface { /** - * @inheritdoc + * @inheritDoc */ protected $_defaultConfig = [ 'header' => null, diff --git a/src/Controller/Component/AuthenticationComponent.php b/src/Controller/Component/AuthenticationComponent.php index e6113ae6..60d04c79 100644 --- a/src/Controller/Component/AuthenticationComponent.php +++ b/src/Controller/Component/AuthenticationComponent.php @@ -33,7 +33,6 @@ /** * Controller Component for interacting with Authentication. - * */ class AuthenticationComponent extends Component implements EventDispatcherInterface { diff --git a/src/Identifier/CallbackIdentifier.php b/src/Identifier/CallbackIdentifier.php index 24c65be9..ef23f416 100644 --- a/src/Identifier/CallbackIdentifier.php +++ b/src/Identifier/CallbackIdentifier.php @@ -35,7 +35,7 @@ class CallbackIdentifier extends AbstractIdentifier ]; /** - * @inheritdoc + * @inheritDoc */ public function __construct(array $config) { @@ -63,7 +63,7 @@ protected function checkCallable(): void } /** - * @inheritdoc + * @inheritDoc */ public function identify(array $data) { diff --git a/src/Identifier/IdentifierCollection.php b/src/Identifier/IdentifierCollection.php index 94c61d14..ee0eeb4b 100644 --- a/src/Identifier/IdentifierCollection.php +++ b/src/Identifier/IdentifierCollection.php @@ -111,7 +111,6 @@ protected function _resolveClassName($class): ?string } /** - * * @param string $class Missing class. * @param string $plugin Class plugin. * @return void diff --git a/src/Identifier/LdapIdentifier.php b/src/Identifier/LdapIdentifier.php index 574cc580..b3962596 100644 --- a/src/Identifier/LdapIdentifier.php +++ b/src/Identifier/LdapIdentifier.php @@ -75,7 +75,7 @@ class LdapIdentifier extends AbstractIdentifier protected $_ldap; /** - * @inheritdoc + * @inheritDoc */ public function __construct(array $config = []) { @@ -138,7 +138,7 @@ protected function _buildLdapObject(): void } /** - * @inheritdoc + * @inheritDoc */ public function identify(array $data) { diff --git a/src/Identifier/PasswordIdentifier.php b/src/Identifier/PasswordIdentifier.php index 36edd4b1..6f2bdd52 100644 --- a/src/Identifier/PasswordIdentifier.php +++ b/src/Identifier/PasswordIdentifier.php @@ -88,7 +88,7 @@ public function getPasswordHasher(): PasswordHasherInterface } /** - * @inheritdoc + * @inheritDoc */ public function identify(array $data) { diff --git a/src/Identifier/Resolver/OrmResolver.php b/src/Identifier/Resolver/OrmResolver.php index 38d5ea2d..9068fa00 100644 --- a/src/Identifier/Resolver/OrmResolver.php +++ b/src/Identifier/Resolver/OrmResolver.php @@ -50,7 +50,7 @@ public function __construct(array $config = []) } /** - * @inheritdoc + * @inheritDoc */ public function find(array $conditions, $type = self::TYPE_AND) { diff --git a/src/Identifier/TokenIdentifier.php b/src/Identifier/TokenIdentifier.php index acd5bb5b..c4d25b43 100644 --- a/src/Identifier/TokenIdentifier.php +++ b/src/Identifier/TokenIdentifier.php @@ -37,7 +37,7 @@ class TokenIdentifier extends AbstractIdentifier ]; /** - * @inheritdoc + * @inheritDoc */ public function identify(array $data) { diff --git a/src/Identity.php b/src/Identity.php index 4c1c34bd..2a53bf7a 100644 --- a/src/Identity.php +++ b/src/Identity.php @@ -71,7 +71,7 @@ public function __construct($data, array $config = []) } /** - * {@inheritDoc} + * @inheritDoc */ public function getIdentifier() { @@ -172,7 +172,7 @@ public function offsetUnset($offset): void } /** - * @inheritdoc + * @inheritDoc */ public function getOriginalData() { diff --git a/src/PasswordHasher/LegacyPasswordHasher.php b/src/PasswordHasher/LegacyPasswordHasher.php index 74b73dde..15880145 100644 --- a/src/PasswordHasher/LegacyPasswordHasher.php +++ b/src/PasswordHasher/LegacyPasswordHasher.php @@ -40,7 +40,7 @@ class LegacyPasswordHasher extends AbstractPasswordHasher ]; /** - * @inheritdoc + * @inheritDoc */ public function __construct(array $config = []) { diff --git a/src/UrlChecker/CakeRouterUrlChecker.php b/src/UrlChecker/CakeRouterUrlChecker.php index 7a5fa180..423002a9 100644 --- a/src/UrlChecker/CakeRouterUrlChecker.php +++ b/src/UrlChecker/CakeRouterUrlChecker.php @@ -37,7 +37,7 @@ class CakeRouterUrlChecker extends DefaultUrlChecker ]; /** - * {@inheritDoc} + * @inheritDoc */ public function check(ServerRequestInterface $request, $loginUrls, array $options = []): bool { diff --git a/tests/TestCase/AuthenticationTestCase.php b/tests/TestCase/AuthenticationTestCase.php index 11ffe271..75087fba 100644 --- a/tests/TestCase/AuthenticationTestCase.php +++ b/tests/TestCase/AuthenticationTestCase.php @@ -32,7 +32,7 @@ class AuthenticationTestCase extends TestCase ]; /** - * @inheritdoc + * @inheritDoc */ public function setUp(): void { diff --git a/tests/TestCase/Authenticator/CookieAuthenticatorTest.php b/tests/TestCase/Authenticator/CookieAuthenticatorTest.php index 2725f543..83f1062f 100644 --- a/tests/TestCase/Authenticator/CookieAuthenticatorTest.php +++ b/tests/TestCase/Authenticator/CookieAuthenticatorTest.php @@ -39,7 +39,7 @@ class CookieAuthenticatorTest extends TestCase ]; /** - * {@inheritDoc} + * @inheritDoc */ public function setUp(): void { diff --git a/tests/TestCase/Authenticator/HttpBasicAuthenticatorTest.php b/tests/TestCase/Authenticator/HttpBasicAuthenticatorTest.php index 3ab3a561..21fd8a81 100644 --- a/tests/TestCase/Authenticator/HttpBasicAuthenticatorTest.php +++ b/tests/TestCase/Authenticator/HttpBasicAuthenticatorTest.php @@ -38,7 +38,7 @@ class HttpBasicAuthenticatorTest extends TestCase ]; /** - * @inheritdoc + * @inheritDoc */ public function setUp(): void { diff --git a/tests/TestCase/Authenticator/JwtAuthenticatorTest.php b/tests/TestCase/Authenticator/JwtAuthenticatorTest.php index 05427e5a..12f4ddcc 100644 --- a/tests/TestCase/Authenticator/JwtAuthenticatorTest.php +++ b/tests/TestCase/Authenticator/JwtAuthenticatorTest.php @@ -54,7 +54,7 @@ class JwtAuthenticatorTest extends TestCase public $identifiers; /** - * {@inheritDoc} + * @inheritDoc */ public function setUp(): void { diff --git a/tests/TestCase/Authenticator/SessionAuthenticatorTest.php b/tests/TestCase/Authenticator/SessionAuthenticatorTest.php index 38116382..1b6a063f 100644 --- a/tests/TestCase/Authenticator/SessionAuthenticatorTest.php +++ b/tests/TestCase/Authenticator/SessionAuthenticatorTest.php @@ -39,7 +39,7 @@ class SessionAuthenticatorTest extends TestCase ]; /** - * @inheritdoc + * @inheritDoc */ public function setUp(): void { diff --git a/tests/TestCase/Authenticator/TokenAuthenticatorTest.php b/tests/TestCase/Authenticator/TokenAuthenticatorTest.php index 133ef41e..8b5c3866 100644 --- a/tests/TestCase/Authenticator/TokenAuthenticatorTest.php +++ b/tests/TestCase/Authenticator/TokenAuthenticatorTest.php @@ -36,7 +36,7 @@ class TokenAuthenticatorTest extends TestCase ]; /** - * {@inheritDoc} + * @inheritDoc */ public function setUp(): void { diff --git a/tests/TestCase/Controller/Component/AuthenticationComponentTest.php b/tests/TestCase/Controller/Component/AuthenticationComponentTest.php index 1a042807..ff73d7cf 100644 --- a/tests/TestCase/Controller/Component/AuthenticationComponentTest.php +++ b/tests/TestCase/Controller/Component/AuthenticationComponentTest.php @@ -64,7 +64,7 @@ class AuthenticationComponentTest extends TestCase protected $service; /** - * {@inheritDoc} + * @inheritDoc */ public function setUp(): void { diff --git a/tests/TestCase/Middleware/AuthenticationMiddlewareTest.php b/tests/TestCase/Middleware/AuthenticationMiddlewareTest.php index 7273313c..a5a95317 100644 --- a/tests/TestCase/Middleware/AuthenticationMiddlewareTest.php +++ b/tests/TestCase/Middleware/AuthenticationMiddlewareTest.php @@ -41,7 +41,7 @@ class AuthenticationMiddlewareTest extends TestCase ]; /** - * @inheritdoc + * @inheritDoc */ public function setUp(): void { diff --git a/tests/TestCase/UrlChecker/CakeRouterUrlCheckerTest.php b/tests/TestCase/UrlChecker/CakeRouterUrlCheckerTest.php index d3fc4eed..b0dea78e 100644 --- a/tests/TestCase/UrlChecker/CakeRouterUrlCheckerTest.php +++ b/tests/TestCase/UrlChecker/CakeRouterUrlCheckerTest.php @@ -27,7 +27,7 @@ class CakeRouterUrlCheckerTest extends TestCase { /** - * {@inheritDoc} + * @inheritDoc */ public function setUp(): void {