Skip to content

Commit 04cbc10

Browse files
committed
minor symfony#16944 [Security][Guard] checkCredentials() should have a @return annotation (derrabus)
This PR was merged into the 2.8 branch. Discussion ---------- [Security][Guard] checkCredentials() should have a @return annotation | Q | A | ------------- | --- | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | none | License | MIT | Doc PR | none According to its documentation, an implementation of the `GuardAuthenticatorInterface::checkCredentials()` method should return `true` on success. I've added a `@return` annotation to the PHPDoc block to reflect the fact that this method should actually return something. Commits ------- 4fd24a0 Added @return to checkCredentials()
2 parents b782cf9 + 4fd24a0 commit 04cbc10

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

src/Symfony/Component/Security/Guard/GuardAuthenticatorInterface.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,8 @@ public function getUser($credentials, UserProviderInterface $userProvider);
8383
*
8484
* @param mixed $credentials
8585
* @param UserInterface $user
86+
*
87+
* @return bool
8688
*
8789
* @throws AuthenticationException
8890
*/

0 commit comments

Comments
 (0)