summaryrefslogtreecommitdiffstats
path: root/Guard/GuardAuthenticatorInterface.php
diff options
context:
space:
mode:
authorRyan Weaver <ryan@thatsquality.com>2015-10-30 15:12:11 -0400
committerFabien Potencier <fabien.potencier@gmail.com>2015-10-31 08:07:17 -0700
commitdc8d7f7f1d5f94fc92c0872063409acf042b0d3c (patch)
tree31bc29b5b8b67f83fb3f32a95bfa1d8b90cc2bb3 /Guard/GuardAuthenticatorInterface.php
parent7c51b1c6f08ea0bfd4a44e8d0f202c6423a39587 (diff)
downloadsymfony-security-dc8d7f7f1d5f94fc92c0872063409acf042b0d3c.zip
symfony-security-dc8d7f7f1d5f94fc92c0872063409acf042b0d3c.tar.gz
symfony-security-dc8d7f7f1d5f94fc92c0872063409acf042b0d3c.tar.bz2
checkCredentials() force it to be an affirmative yes!
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()
*