[Security] Added missing phpdoc

This commit is contained in:
Tim Nagel 2011-04-16 16:21:04 +10:00
parent db8b118e8a
commit ad86f9ff0d
3 changed files with 33 additions and 0 deletions

View File

@ -18,5 +18,10 @@ namespace Symfony\Component\Security\Acl\Model;
*/
interface FieldAwareEntryInterface
{
/**
* Returns the field used for this entry.
*
* @return string
*/
function getField();
}

View File

@ -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) {

View File

@ -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);
}