diff options
author | Graham Campbell <graham@mineuk.com> | 2014-12-21 17:00:50 +0000 |
---|---|---|
committer | Fabien Potencier <fabien.potencier@gmail.com> | 2014-12-22 16:58:09 +0100 |
commit | a542abcf38b95de8e8f01f42b6127e7fffc645a8 (patch) | |
tree | c84aaf43e18f7fc448861b918a5785a117013fb6 /Acl/Model | |
parent | 3b1993579d11af545a1effd2cb3367665dd5a5fd (diff) | |
download | symfony-security-a542abcf38b95de8e8f01f42b6127e7fffc645a8.zip symfony-security-a542abcf38b95de8e8f01f42b6127e7fffc645a8.tar.gz symfony-security-a542abcf38b95de8e8f01f42b6127e7fffc645a8.tar.bz2 |
[2.3] CS And DocBlock Fixes
Diffstat (limited to 'Acl/Model')
-rw-r--r-- | Acl/Model/AclCacheInterface.php | 14 | ||||
-rw-r--r-- | Acl/Model/AclInterface.php | 16 | ||||
-rw-r--r-- | Acl/Model/AclProviderInterface.php | 6 | ||||
-rw-r--r-- | Acl/Model/AuditLoggerInterface.php | 2 | ||||
-rw-r--r-- | Acl/Model/AuditableAclInterface.php | 8 | ||||
-rw-r--r-- | Acl/Model/AuditableEntryInterface.php | 4 | ||||
-rw-r--r-- | Acl/Model/EntryInterface.php | 10 | ||||
-rw-r--r-- | Acl/Model/FieldEntryInterface.php | 2 | ||||
-rw-r--r-- | Acl/Model/MutableAclInterface.php | 30 | ||||
-rw-r--r-- | Acl/Model/ObjectIdentityRetrievalStrategyInterface.php | 4 | ||||
-rw-r--r-- | Acl/Model/PermissionGrantingStrategyInterface.php | 4 | ||||
-rw-r--r-- | Acl/Model/SecurityIdentityRetrievalStrategyInterface.php | 4 |
12 files changed, 52 insertions, 52 deletions
diff --git a/Acl/Model/AclCacheInterface.php b/Acl/Model/AclCacheInterface.php index 03431db..1e74585 100644 --- a/Acl/Model/AclCacheInterface.php +++ b/Acl/Model/AclCacheInterface.php @@ -12,21 +12,21 @@ namespace Symfony\Component\Security\Acl\Model; /** - * AclCache Interface + * AclCache Interface. * * @author Johannes M. Schmitt <schmittjoh@gmail.com> */ interface AclCacheInterface { /** - * Removes an ACL from the cache + * Removes an ACL from the cache. * * @param string $primaryKey a serialized primary key */ public function evictFromCacheById($primaryKey); /** - * Removes an ACL from the cache + * Removes an ACL from the cache. * * The ACL which is returned, must reference the passed object identity. * @@ -35,7 +35,7 @@ interface AclCacheInterface public function evictFromCacheByIdentity(ObjectIdentityInterface $oid); /** - * Retrieves an ACL for the given object identity primary key from the cache + * Retrieves an ACL for the given object identity primary key from the cache. * * @param int $primaryKey * @@ -44,7 +44,7 @@ interface AclCacheInterface public function getFromCacheById($primaryKey); /** - * Retrieves an ACL for the given object identity from the cache + * Retrieves an ACL for the given object identity from the cache. * * @param ObjectIdentityInterface $oid * @@ -53,14 +53,14 @@ interface AclCacheInterface public function getFromCacheByIdentity(ObjectIdentityInterface $oid); /** - * Stores a new ACL in the cache + * Stores a new ACL in the cache. * * @param AclInterface $acl */ public function putInCache(AclInterface $acl); /** - * Removes all ACLs from the cache + * Removes all ACLs from the cache. */ public function clearCache(); } diff --git a/Acl/Model/AclInterface.php b/Acl/Model/AclInterface.php index c5bbf18..6a70a7c 100644 --- a/Acl/Model/AclInterface.php +++ b/Acl/Model/AclInterface.php @@ -26,14 +26,14 @@ use Symfony\Component\Security\Acl\Exception\NoAceFoundException; interface AclInterface extends \Serializable { /** - * Returns all class-based ACEs associated with this ACL + * Returns all class-based ACEs associated with this ACL. * * @return array */ public function getClassAces(); /** - * Returns all class-field-based ACEs associated with this ACL + * Returns all class-field-based ACEs associated with this ACL. * * @param string $field * @@ -42,14 +42,14 @@ interface AclInterface extends \Serializable public function getClassFieldAces($field); /** - * Returns all object-based ACEs associated with this ACL + * Returns all object-based ACEs associated with this ACL. * * @return array */ public function getObjectAces(); /** - * Returns all object-field-based ACEs associated with this ACL + * Returns all object-field-based ACEs associated with this ACL. * * @param string $field * @@ -58,7 +58,7 @@ interface AclInterface extends \Serializable public function getObjectFieldAces($field); /** - * Returns the object identity associated with this ACL + * Returns the object identity associated with this ACL. * * @return ObjectIdentityInterface */ @@ -79,7 +79,7 @@ interface AclInterface extends \Serializable public function isEntriesInheriting(); /** - * Determines whether field access is granted + * Determines whether field access is granted. * * @param string $field * @param array $masks @@ -91,7 +91,7 @@ interface AclInterface extends \Serializable public function isFieldGranted($field, array $masks, array $securityIdentities, $administrativeMode = false); /** - * Determines whether access is granted + * Determines whether access is granted. * * @param array $masks * @param array $securityIdentities @@ -104,7 +104,7 @@ interface AclInterface extends \Serializable public function isGranted(array $masks, array $securityIdentities, $administrativeMode = false); /** - * Whether the ACL has loaded ACEs for all of the passed security identities + * Whether the ACL has loaded ACEs for all of the passed security identities. * * @param mixed $securityIdentities an implementation of SecurityIdentityInterface, or an array thereof * diff --git a/Acl/Model/AclProviderInterface.php b/Acl/Model/AclProviderInterface.php index dd8fb19..f9b41cb 100644 --- a/Acl/Model/AclProviderInterface.php +++ b/Acl/Model/AclProviderInterface.php @@ -21,7 +21,7 @@ use Symfony\Component\Security\Acl\Exception\AclNotFoundException; interface AclProviderInterface { /** - * Retrieves all child object identities from the database + * Retrieves all child object identities from the database. * * @param ObjectIdentityInterface $parentOid * @param bool $directChildrenOnly @@ -31,7 +31,7 @@ interface AclProviderInterface public function findChildren(ObjectIdentityInterface $parentOid, $directChildrenOnly = false); /** - * Returns the ACL that belongs to the given object identity + * Returns the ACL that belongs to the given object identity. * * @param ObjectIdentityInterface $oid * @param SecurityIdentityInterface[] $sids @@ -43,7 +43,7 @@ interface AclProviderInterface public function findAcl(ObjectIdentityInterface $oid, array $sids = array()); /** - * Returns the ACLs that belong to the given object identities + * Returns the ACLs that belong to the given object identities. * * @param ObjectIdentityInterface[] $oids an array of ObjectIdentityInterface implementations * @param SecurityIdentityInterface[] $sids an array of SecurityIdentityInterface implementations diff --git a/Acl/Model/AuditLoggerInterface.php b/Acl/Model/AuditLoggerInterface.php index 11fe7f5..fde4de6 100644 --- a/Acl/Model/AuditLoggerInterface.php +++ b/Acl/Model/AuditLoggerInterface.php @@ -12,7 +12,7 @@ namespace Symfony\Component\Security\Acl\Model; /** - * Interface for audit loggers + * Interface for audit loggers. * * @author Johannes M. Schmitt <schmittjoh@gmail.com> */ diff --git a/Acl/Model/AuditableAclInterface.php b/Acl/Model/AuditableAclInterface.php index 80b9987..e7a60e5 100644 --- a/Acl/Model/AuditableAclInterface.php +++ b/Acl/Model/AuditableAclInterface.php @@ -19,7 +19,7 @@ namespace Symfony\Component\Security\Acl\Model; interface AuditableAclInterface extends MutableAclInterface { /** - * Updates auditing for class-based ACE + * Updates auditing for class-based ACE. * * @param int $index * @param bool $auditSuccess @@ -28,7 +28,7 @@ interface AuditableAclInterface extends MutableAclInterface public function updateClassAuditing($index, $auditSuccess, $auditFailure); /** - * Updates auditing for class-field-based ACE + * Updates auditing for class-field-based ACE. * * @param int $index * @param string $field @@ -38,7 +38,7 @@ interface AuditableAclInterface extends MutableAclInterface public function updateClassFieldAuditing($index, $field, $auditSuccess, $auditFailure); /** - * Updates auditing for object-based ACE + * Updates auditing for object-based ACE. * * @param int $index * @param bool $auditSuccess @@ -47,7 +47,7 @@ interface AuditableAclInterface extends MutableAclInterface public function updateObjectAuditing($index, $auditSuccess, $auditFailure); /** - * Updates auditing for object-field-based ACE + * Updates auditing for object-field-based ACE. * * @param int $index * @param string $field diff --git a/Acl/Model/AuditableEntryInterface.php b/Acl/Model/AuditableEntryInterface.php index 509acda..9561577 100644 --- a/Acl/Model/AuditableEntryInterface.php +++ b/Acl/Model/AuditableEntryInterface.php @@ -19,14 +19,14 @@ namespace Symfony\Component\Security\Acl\Model; interface AuditableEntryInterface extends EntryInterface { /** - * Whether auditing for successful grants is turned on + * Whether auditing for successful grants is turned on. * * @return bool */ public function isAuditFailure(); /** - * Whether auditing for successful denies is turned on + * Whether auditing for successful denies is turned on. * * @return bool */ diff --git a/Acl/Model/EntryInterface.php b/Acl/Model/EntryInterface.php index b33f1f0..0b244b7 100644 --- a/Acl/Model/EntryInterface.php +++ b/Acl/Model/EntryInterface.php @@ -29,35 +29,35 @@ interface EntryInterface extends \Serializable public function getAcl(); /** - * The primary key of this ACE + * The primary key of this ACE. * * @return int */ public function getId(); /** - * The permission mask of this ACE + * The permission mask of this ACE. * * @return int */ public function getMask(); /** - * The security identity associated with this ACE + * The security identity associated with this ACE. * * @return SecurityIdentityInterface */ public function getSecurityIdentity(); /** - * The strategy for comparing masks + * The strategy for comparing masks. * * @return string */ public function getStrategy(); /** - * Returns whether this ACE is granting, or denying + * Returns whether this ACE is granting, or denying. * * @return bool */ diff --git a/Acl/Model/FieldEntryInterface.php b/Acl/Model/FieldEntryInterface.php index 8382ae1..ae2f808 100644 --- a/Acl/Model/FieldEntryInterface.php +++ b/Acl/Model/FieldEntryInterface.php @@ -12,7 +12,7 @@ namespace Symfony\Component\Security\Acl\Model; /** - * Interface for entries which are restricted to specific fields + * Interface for entries which are restricted to specific fields. * * @author Johannes M. Schmitt <schmittjoh@gmail.com> */ diff --git a/Acl/Model/MutableAclInterface.php b/Acl/Model/MutableAclInterface.php index f94e909..2ba7bd5 100644 --- a/Acl/Model/MutableAclInterface.php +++ b/Acl/Model/MutableAclInterface.php @@ -22,14 +22,14 @@ namespace Symfony\Component\Security\Acl\Model; interface MutableAclInterface extends AclInterface { /** - * Deletes a class-based ACE + * Deletes a class-based ACE. * * @param int $index */ public function deleteClassAce($index); /** - * Deletes a class-field-based ACE + * Deletes a class-field-based ACE. * * @param int $index * @param string $field @@ -37,14 +37,14 @@ interface MutableAclInterface extends AclInterface public function deleteClassFieldAce($index, $field); /** - * Deletes an object-based ACE + * Deletes an object-based ACE. * * @param int $index */ public function deleteObjectAce($index); /** - * Deletes an object-field-based ACE + * Deletes an object-field-based ACE. * * @param int $index * @param string $field @@ -52,14 +52,14 @@ interface MutableAclInterface extends AclInterface public function deleteObjectFieldAce($index, $field); /** - * Returns the primary key of this ACL + * Returns the primary key of this ACL. * * @return int */ public function getId(); /** - * Inserts a class-based ACE + * Inserts a class-based ACE. * * @param SecurityIdentityInterface $sid * @param int $mask @@ -70,7 +70,7 @@ interface MutableAclInterface extends AclInterface public function insertClassAce(SecurityIdentityInterface $sid, $mask, $index = 0, $granting = true, $strategy = null); /** - * Inserts a class-field-based ACE + * Inserts a class-field-based ACE. * * @param string $field * @param SecurityIdentityInterface $sid @@ -82,7 +82,7 @@ interface MutableAclInterface extends AclInterface public function insertClassFieldAce($field, SecurityIdentityInterface $sid, $mask, $index = 0, $granting = true, $strategy = null); /** - * Inserts an object-based ACE + * Inserts an object-based ACE. * * @param SecurityIdentityInterface $sid * @param int $mask @@ -93,7 +93,7 @@ interface MutableAclInterface extends AclInterface public function insertObjectAce(SecurityIdentityInterface $sid, $mask, $index = 0, $granting = true, $strategy = null); /** - * Inserts an object-field-based ACE + * Inserts an object-field-based ACE. * * @param string $field * @param SecurityIdentityInterface $sid @@ -105,21 +105,21 @@ interface MutableAclInterface extends AclInterface public function insertObjectFieldAce($field, SecurityIdentityInterface $sid, $mask, $index = 0, $granting = true, $strategy = null); /** - * Sets whether entries are inherited + * Sets whether entries are inherited. * * @param bool $boolean */ public function setEntriesInheriting($boolean); /** - * Sets the parent ACL + * Sets the parent ACL. * * @param AclInterface|null $acl */ public function setParentAcl(AclInterface $acl = null); /** - * Updates a class-based ACE + * Updates a class-based ACE. * * @param int $index * @param int $mask @@ -128,7 +128,7 @@ interface MutableAclInterface extends AclInterface public function updateClassAce($index, $mask, $strategy = null); /** - * Updates a class-field-based ACE + * Updates a class-field-based ACE. * * @param int $index * @param string $field @@ -138,7 +138,7 @@ interface MutableAclInterface extends AclInterface public function updateClassFieldAce($index, $field, $mask, $strategy = null); /** - * Updates an object-based ACE + * Updates an object-based ACE. * * @param int $index * @param int $mask @@ -147,7 +147,7 @@ interface MutableAclInterface extends AclInterface public function updateObjectAce($index, $mask, $strategy = null); /** - * Updates an object-field-based ACE + * Updates an object-field-based ACE. * * @param int $index * @param string $field diff --git a/Acl/Model/ObjectIdentityRetrievalStrategyInterface.php b/Acl/Model/ObjectIdentityRetrievalStrategyInterface.php index d5470ae..542066a 100644 --- a/Acl/Model/ObjectIdentityRetrievalStrategyInterface.php +++ b/Acl/Model/ObjectIdentityRetrievalStrategyInterface.php @@ -12,14 +12,14 @@ namespace Symfony\Component\Security\Acl\Model; /** - * Retrieves the object identity for a given domain object + * Retrieves the object identity for a given domain object. * * @author Johannes M. Schmitt <schmittjoh@gmail.com> */ interface ObjectIdentityRetrievalStrategyInterface { /** - * Retrieves the object identity from a domain object + * Retrieves the object identity from a domain object. * * @param object $domainObject * diff --git a/Acl/Model/PermissionGrantingStrategyInterface.php b/Acl/Model/PermissionGrantingStrategyInterface.php index 7ff475f..fa3430d 100644 --- a/Acl/Model/PermissionGrantingStrategyInterface.php +++ b/Acl/Model/PermissionGrantingStrategyInterface.php @@ -19,7 +19,7 @@ namespace Symfony\Component\Security\Acl\Model; interface PermissionGrantingStrategyInterface { /** - * Determines whether access to a domain object is to be granted + * Determines whether access to a domain object is to be granted. * * @param AclInterface $acl * @param array $masks @@ -31,7 +31,7 @@ interface PermissionGrantingStrategyInterface public function isGranted(AclInterface $acl, array $masks, array $sids, $administrativeMode = false); /** - * Determines whether access to a domain object's field is to be granted + * Determines whether access to a domain object's field is to be granted. * * @param AclInterface $acl * @param string $field diff --git a/Acl/Model/SecurityIdentityRetrievalStrategyInterface.php b/Acl/Model/SecurityIdentityRetrievalStrategyInterface.php index 5bb7915..b5fcb75 100644 --- a/Acl/Model/SecurityIdentityRetrievalStrategyInterface.php +++ b/Acl/Model/SecurityIdentityRetrievalStrategyInterface.php @@ -14,14 +14,14 @@ namespace Symfony\Component\Security\Acl\Model; use Symfony\Component\Security\Core\Authentication\Token\TokenInterface; /** - * Interface for retrieving security identities from tokens + * Interface for retrieving security identities from tokens. * * @author Johannes M. Schmitt <schmittjoh@gmail.com> */ interface SecurityIdentityRetrievalStrategyInterface { /** - * Retrieves the available security identities for the given token + * Retrieves the available security identities for the given token. * * The order in which the security identities are returned is significant. * Typically, security identities should be ordered from most specific to |