summaryrefslogtreecommitdiffstats
path: root/Guard/GuardAuthenticatorInterface.php
diff options
context:
space:
mode:
authorFabien Potencier <fabien.potencier@gmail.com>2015-11-02 21:34:04 +0100
committerFabien Potencier <fabien.potencier@gmail.com>2015-11-02 21:34:04 +0100
commit3ebe37fa9b133e4b9b0d784de95124e2af66f820 (patch)
treeebc7ecda2902d02a4bcc8605773d78af4c93bc40 /Guard/GuardAuthenticatorInterface.php
parent5c0b69ecabbb26a1181d3f25b7e6434bd47d977e (diff)
parent6844219adbbdbbfaf159e816fa988a6de6ed6478 (diff)
downloadsymfony-security-3ebe37fa9b133e4b9b0d784de95124e2af66f820.zip
symfony-security-3ebe37fa9b133e4b9b0d784de95124e2af66f820.tar.gz
symfony-security-3ebe37fa9b133e4b9b0d784de95124e2af66f820.tar.bz2
Merge branch '2.8'
* 2.8: removed @covers annotations in tests removed @covers annotations in tests removed all @covers annotations checkCredentials() force it to be an affirmative yes! [PropertyAccess] Major performance improvement
Diffstat (limited to 'Guard/GuardAuthenticatorInterface.php')
-rw-r--r--Guard/GuardAuthenticatorInterface.php6
1 files changed, 5 insertions, 1 deletions
diff --git a/Guard/GuardAuthenticatorInterface.php b/Guard/GuardAuthenticatorInterface.php
index 2db313c..6e62ae6 100644
--- a/Guard/GuardAuthenticatorInterface.php
+++ b/Guard/GuardAuthenticatorInterface.php
@@ -73,7 +73,11 @@ interface GuardAuthenticatorInterface extends AuthenticationEntryPointInterface
public function getUser($credentials, UserProviderInterface $userProvider);
/**
- * Throw an AuthenticationException if the credentials are invalid.
+ * Returns true if the credentials are valid.
+ *
+ * If any value other than true is returned, authentication will
+ * fail. You may also throw an AuthenticationException if you wish
+ * to cause authentication to fail.
*
* The *credentials* are the return value from getCredentials()
*