diff options
author | Tim Nagel <tim@nagel.com.au> | 2011-04-16 16:21:04 +1000 |
---|---|---|
committer | Tim Nagel <tim@nagel.com.au> | 2011-04-16 16:21:04 +1000 |
commit | d70af2f43eeaaa05e0c74bf470000cdc2295ef7c (patch) | |
tree | 31875a006f9b3cf7877ed4f61b54f08808b27a18 /Core | |
parent | 77dd608cc377cf77fc9c51d824fce36192346d2f (diff) | |
download | symfony-security-d70af2f43eeaaa05e0c74bf470000cdc2295ef7c.zip symfony-security-d70af2f43eeaaa05e0c74bf470000cdc2295ef7c.tar.gz symfony-security-d70af2f43eeaaa05e0c74bf470000cdc2295ef7c.tar.bz2 |
[Security] Added missing phpdoc
Diffstat (limited to 'Core')
-rw-r--r-- | Core/SecurityContext.php | 8 | ||||
-rw-r--r-- | Core/SecurityContextInterface.php | 20 |
2 files changed, 28 insertions, 0 deletions
diff --git a/Core/SecurityContext.php b/Core/SecurityContext.php index 76ec4c1..2910e3b 100644 --- a/Core/SecurityContext.php +++ b/Core/SecurityContext.php @@ -45,6 +45,14 @@ class SecurityContext implements SecurityContextInterface $this->alwaysAuthenticate = $alwaysAuthenticate; } + /** + * Checks if the attributes are granted against the current token. + * + * @throws AuthenticationCredentialsNotFoundException when the security context has no authentication token. + * @param mixed $attributes + * @param mixed|null $object + * @return boolean + */ public final function isGranted($attributes, $object = null) { if (null === $this->token) { diff --git a/Core/SecurityContextInterface.php b/Core/SecurityContextInterface.php index a811557..a47c89d 100644 --- a/Core/SecurityContextInterface.php +++ b/Core/SecurityContextInterface.php @@ -15,7 +15,27 @@ interface SecurityContextInterface const AUTHENTICATION_ERROR = '_security.last_error'; const LAST_USERNAME = '_security.last_username'; + /** + * Returns the current security token. + * + * @return TokenInterface|null A TokenInterface instance or null if no authentication information is available + */ function getToken(); + + /** + * Sets the authentication token. + * + * @param TokenInterface $token + * @return void + */ function setToken(TokenInterface $token); + + /** + * Checks if the attributes are granted against the current authentication token and optionally supplied object. + * + * @param array $attributes + * @param mixed $object + * @return boolean + */ function isGranted($attributes, $object = null); }
\ No newline at end of file |