diff options
author | Fabien Potencier <fabien.potencier@gmail.com> | 2014-11-30 17:59:09 +0100 |
---|---|---|
committer | Fabien Potencier <fabien.potencier@gmail.com> | 2014-11-30 17:59:09 +0100 |
commit | f9c498153d663c0cf0710ff9c89a11d2a4833cdc (patch) | |
tree | fe2c86b4887eef95757f849324e26d20965766bc /Acl | |
parent | 748e258f7683a17e9803ded49ae94ab3e24e6c68 (diff) | |
parent | e5dfe6a3e96c71e87c0ca9aa84115accd9ebb229 (diff) | |
download | symfony-security-f9c498153d663c0cf0710ff9c89a11d2a4833cdc.zip symfony-security-f9c498153d663c0cf0710ff9c89a11d2a4833cdc.tar.gz symfony-security-f9c498153d663c0cf0710ff9c89a11d2a4833cdc.tar.bz2 |
minor #12774 Docblock Fixes (GrahamCampbell)
This PR was merged into the 2.3 branch.
Discussion
----------
Docblock Fixes
| Q | A
| ------------- | ---
| Bug fix? | no
| New feature? | no
| BC breaks? | no
| Deprecations? | no
| Tests pass? | yes
| Fixed tickets | N/A
| License | MIT
| Doc PR | N/A
##### This pull request fixes the docblock alignment as requested in #12760.
It was also necessary for me to ensure the `@return` annotations were correctly separated in order to accurately align the `@param` annotations.
Commits
-------
443307e Docblock fixes
Diffstat (limited to 'Acl')
-rw-r--r-- | Acl/Dbal/AclProvider.php | 8 | ||||
-rw-r--r-- | Acl/Dbal/MutableAclProvider.php | 80 | ||||
-rw-r--r-- | Acl/Domain/Acl.php | 43 | ||||
-rw-r--r-- | Acl/Domain/DoctrineAclCache.php | 3 | ||||
-rw-r--r-- | Acl/Domain/Entry.php | 6 | ||||
-rw-r--r-- | Acl/Domain/ObjectIdentity.php | 2 | ||||
-rw-r--r-- | Acl/Domain/PermissionGrantingStrategy.php | 2 | ||||
-rw-r--r-- | Acl/Domain/UserSecurityIdentity.php | 2 | ||||
-rw-r--r-- | Acl/Model/AclCacheInterface.php | 4 | ||||
-rw-r--r-- | Acl/Model/AclInterface.php | 20 | ||||
-rw-r--r-- | Acl/Model/AuditableAclInterface.php | 28 | ||||
-rw-r--r-- | Acl/Model/MutableAclInterface.php | 42 | ||||
-rw-r--r-- | Acl/Model/MutableAclProviderInterface.php | 6 | ||||
-rw-r--r-- | Acl/Model/ObjectIdentityInterface.php | 1 | ||||
-rw-r--r-- | Acl/Model/ObjectIdentityRetrievalStrategyInterface.php | 1 | ||||
-rw-r--r-- | Acl/Model/PermissionGrantingStrategyInterface.php | 1 | ||||
-rw-r--r-- | Acl/Permission/MaskBuilder.php | 6 | ||||
-rw-r--r-- | Acl/Permission/PermissionMapInterface.php | 2 |
18 files changed, 157 insertions, 100 deletions
diff --git a/Acl/Dbal/AclProvider.php b/Acl/Dbal/AclProvider.php index 96b6a4b..39d3efe 100644 --- a/Acl/Dbal/AclProvider.php +++ b/Acl/Dbal/AclProvider.php @@ -223,6 +223,7 @@ class AclProvider implements AclProviderInterface * ACEs, and security identities. * * @param array $ancestorIds + * * @return string */ protected function getLookupSql(array $ancestorIds) @@ -328,6 +329,7 @@ SELECTCLAUSE; * * @param ObjectIdentityInterface $oid * @param bool $directChildrenOnly + * * @return string */ protected function getFindChildrenSql(ObjectIdentityInterface $oid, $directChildrenOnly) @@ -359,6 +361,7 @@ FINDCHILDREN; * identity. * * @param ObjectIdentityInterface $oid + * * @return string */ protected function getSelectObjectIdentityIdSql(ObjectIdentityInterface $oid) @@ -383,6 +386,7 @@ QUERY; * Returns the primary key of the passed object identity. * * @param ObjectIdentityInterface $oid + * * @return int */ final protected function retrieveObjectIdentityPrimaryKey(ObjectIdentityInterface $oid) @@ -491,8 +495,10 @@ QUERY; * @param Statement $stmt * @param array $oidLookup * @param array $sids - * @throws \RuntimeException + * * @return \SplObjectStorage + * + * @throws \RuntimeException */ private function hydrateObjectIdentities(Statement $stmt, array $oidLookup, array $sids) { diff --git a/Acl/Dbal/MutableAclProvider.php b/Acl/Dbal/MutableAclProvider.php index 2a4eac0..558691a 100644 --- a/Acl/Dbal/MutableAclProvider.php +++ b/Acl/Dbal/MutableAclProvider.php @@ -354,7 +354,8 @@ class MutableAclProvider extends AclProvider implements MutableAclProviderInterf /** * Constructs the SQL for deleting access control entries. * - * @param int $oidPK + * @param int $oidPK + * * @return string */ protected function getDeleteAccessControlEntriesSql($oidPK) @@ -369,7 +370,8 @@ class MutableAclProvider extends AclProvider implements MutableAclProviderInterf /** * Constructs the SQL for deleting a specific ACE. * - * @param int $acePK + * @param int $acePK + * * @return string */ protected function getDeleteAccessControlEntrySql($acePK) @@ -384,7 +386,8 @@ class MutableAclProvider extends AclProvider implements MutableAclProviderInterf /** * Constructs the SQL for deleting an object identity. * - * @param int $pk + * @param int $pk + * * @return string */ protected function getDeleteObjectIdentitySql($pk) @@ -399,7 +402,8 @@ class MutableAclProvider extends AclProvider implements MutableAclProviderInterf /** * Constructs the SQL for deleting relation entries. * - * @param int $pk + * @param int $pk + * * @return string */ protected function getDeleteObjectIdentityRelationsSql($pk) @@ -414,16 +418,17 @@ class MutableAclProvider extends AclProvider implements MutableAclProviderInterf /** * Constructs the SQL for inserting an ACE. * - * @param int $classId - * @param int|null $objectIdentityId - * @param string|null $field - * @param int $aceOrder - * @param int $securityIdentityId - * @param string $strategy - * @param int $mask - * @param bool $granting - * @param bool $auditSuccess - * @param bool $auditFailure + * @param int $classId + * @param int|null $objectIdentityId + * @param string|null $field + * @param int $aceOrder + * @param int $securityIdentityId + * @param string $strategy + * @param int $mask + * @param bool $granting + * @param bool $auditSuccess + * @param bool $auditFailure + * * @return string */ protected function getInsertAccessControlEntrySql($classId, $objectIdentityId, $field, $aceOrder, $securityIdentityId, $strategy, $mask, $granting, $auditSuccess, $auditFailure) @@ -464,6 +469,7 @@ QUERY; * Constructs the SQL for inserting a new class type. * * @param string $classType + * * @return string */ protected function getInsertClassSql($classType) @@ -478,8 +484,9 @@ QUERY; /** * Constructs the SQL for inserting a relation entry. * - * @param int $objectIdentityId - * @param int $ancestorId + * @param int $objectIdentityId + * @param int $ancestorId + * * @return string */ protected function getInsertObjectIdentityRelationSql($objectIdentityId, $ancestorId) @@ -495,9 +502,10 @@ QUERY; /** * Constructs the SQL for inserting an object identity. * - * @param string $identifier - * @param int $classId - * @param bool $entriesInheriting + * @param string $identifier + * @param int $classId + * @param bool $entriesInheriting + * * @return string */ protected function getInsertObjectIdentitySql($identifier, $classId, $entriesInheriting) @@ -520,7 +528,9 @@ QUERY; * Constructs the SQL for inserting a security identity. * * @param SecurityIdentityInterface $sid + * * @throws \InvalidArgumentException + * * @return string */ protected function getInsertSecurityIdentitySql(SecurityIdentityInterface $sid) @@ -546,10 +556,11 @@ QUERY; /** * Constructs the SQL for selecting an ACE. * - * @param int $classId - * @param int $oid - * @param string $field - * @param int $order + * @param int $classId + * @param int $oid + * @param string $field + * @param int $order + * * @return string */ protected function getSelectAccessControlEntryIdSql($classId, $oid, $field, $order) @@ -573,6 +584,7 @@ QUERY; * the passed class type. * * @param string $classType + * * @return string */ protected function getSelectClassIdSql($classType) @@ -588,7 +600,9 @@ QUERY; * Constructs the SQL for selecting the primary key of a security identity. * * @param SecurityIdentityInterface $sid + * * @throws \InvalidArgumentException + * * @return string */ protected function getSelectSecurityIdentityIdSql(SecurityIdentityInterface $sid) @@ -614,9 +628,11 @@ QUERY; /** * Constructs the SQL for updating an object identity. * - * @param int $pk - * @param array $changes + * @param int $pk + * @param array $changes + * * @throws \InvalidArgumentException + * * @return string */ protected function getUpdateObjectIdentitySql($pk, array $changes) @@ -636,9 +652,11 @@ QUERY; /** * Constructs the SQL for updating an ACE. * - * @param int $pk - * @param array $sets + * @param int $pk + * @param array $sets + * * @throws \InvalidArgumentException + * * @return string */ protected function getUpdateAccessControlEntrySql($pk, array $sets) @@ -673,6 +691,7 @@ QUERY; * If the type does not yet exist in the database, it will be created. * * @param string $classType + * * @return int */ private function createOrRetrieveClassId($classType) @@ -693,6 +712,7 @@ QUERY; * created. * * @param SecurityIdentityInterface $sid + * * @return int */ private function createOrRetrieveSecurityIdentityId(SecurityIdentityInterface $sid) @@ -709,7 +729,7 @@ QUERY; /** * Deletes all ACEs for the given object identity primary key. * - * @param int $oidPK + * @param int $oidPK */ private function deleteAccessControlEntries($oidPK) { @@ -719,7 +739,7 @@ QUERY; /** * Deletes the object identity from the database. * - * @param int $pk + * @param int $pk */ private function deleteObjectIdentity($pk) { @@ -729,7 +749,7 @@ QUERY; /** * Deletes all entries from the relations table from the database. * - * @param int $pk + * @param int $pk */ private function deleteObjectIdentityRelations($pk) { diff --git a/Acl/Domain/Acl.php b/Acl/Domain/Acl.php index f426f34..a649d36 100644 --- a/Acl/Domain/Acl.php +++ b/Acl/Domain/Acl.php @@ -397,8 +397,9 @@ class Acl implements AuditableAclInterface, NotifyPropertyChanged /** * Deletes an ACE * - * @param string $property - * @param int $index + * @param string $property + * @param int $index + * * @throws \OutOfBoundsException */ private function deleteAce($property, $index) @@ -421,9 +422,10 @@ class Acl implements AuditableAclInterface, NotifyPropertyChanged /** * Deletes a field-based ACE * - * @param string $property - * @param int $index - * @param string $field + * @param string $property + * @param int $index + * @param string $field + * * @throws \OutOfBoundsException */ private function deleteFieldAce($property, $index, $field) @@ -452,6 +454,7 @@ class Acl implements AuditableAclInterface, NotifyPropertyChanged * @param SecurityIdentityInterface $sid * @param bool $granting * @param string $strategy + * * @throws \OutOfBoundsException * @throws \InvalidArgumentException */ @@ -501,6 +504,7 @@ class Acl implements AuditableAclInterface, NotifyPropertyChanged * @param SecurityIdentityInterface $sid * @param bool $granting * @param string $strategy + * * @throws \InvalidArgumentException * @throws \OutOfBoundsException */ @@ -551,10 +555,11 @@ class Acl implements AuditableAclInterface, NotifyPropertyChanged /** * Updates an ACE * - * @param string $property - * @param int $index - * @param int $mask - * @param string $strategy + * @param string $property + * @param int $index + * @param int $mask + * @param string $strategy + * * @throws \OutOfBoundsException */ private function updateAce($property, $index, $mask, $strategy = null) @@ -578,10 +583,11 @@ class Acl implements AuditableAclInterface, NotifyPropertyChanged /** * Updates auditing for an ACE * - * @param array &$aces - * @param int $index - * @param bool $auditSuccess - * @param bool $auditFailure + * @param array &$aces + * @param int $index + * @param bool $auditSuccess + * @param bool $auditFailure + * * @throws \OutOfBoundsException */ private function updateAuditing(array &$aces, $index, $auditSuccess, $auditFailure) @@ -604,11 +610,12 @@ class Acl implements AuditableAclInterface, NotifyPropertyChanged /** * Updates a field-based ACE * - * @param string $property - * @param int $index - * @param string $field - * @param int $mask - * @param string $strategy + * @param string $property + * @param int $index + * @param string $field + * @param int $mask + * @param string $strategy + * * @throws \InvalidArgumentException * @throws \OutOfBoundsException */ diff --git a/Acl/Domain/DoctrineAclCache.php b/Acl/Domain/DoctrineAclCache.php index 0c69773..00864f0 100644 --- a/Acl/Domain/DoctrineAclCache.php +++ b/Acl/Domain/DoctrineAclCache.php @@ -147,6 +147,7 @@ class DoctrineAclCache implements AclCacheInterface * Unserializes the ACL. * * @param string $serialized + * * @return AclInterface */ private function unserializeAcl($serialized) @@ -205,6 +206,7 @@ class DoctrineAclCache implements AclCacheInterface * Returns the key for the object identity * * @param ObjectIdentityInterface $oid + * * @return string */ private function getDataKeyByIdentity(ObjectIdentityInterface $oid) @@ -217,6 +219,7 @@ class DoctrineAclCache implements AclCacheInterface * Returns the alias key for the object identity key * * @param string $aclId + * * @return string */ private function getAliasKeyForIdentity($aclId) diff --git a/Acl/Domain/Entry.php b/Acl/Domain/Entry.php index b5eb28b..a487c96 100644 --- a/Acl/Domain/Entry.php +++ b/Acl/Domain/Entry.php @@ -125,7 +125,7 @@ class Entry implements AuditableEntryInterface * Do never call this method directly. Use the respective methods on the * AclInterface instead. * - * @param bool $boolean + * @param bool $boolean */ public function setAuditFailure($boolean) { @@ -138,7 +138,7 @@ class Entry implements AuditableEntryInterface * Do never call this method directly. Use the respective methods on the * AclInterface instead. * - * @param bool $boolean + * @param bool $boolean */ public function setAuditSuccess($boolean) { @@ -151,7 +151,7 @@ class Entry implements AuditableEntryInterface * Do never call this method directly. Use the respective methods on the * AclInterface instead. * - * @param int $mask + * @param int $mask */ public function setMask($mask) { diff --git a/Acl/Domain/ObjectIdentity.php b/Acl/Domain/ObjectIdentity.php index cf10330..1111089 100644 --- a/Acl/Domain/ObjectIdentity.php +++ b/Acl/Domain/ObjectIdentity.php @@ -51,7 +51,9 @@ final class ObjectIdentity implements ObjectIdentityInterface * Constructs an ObjectIdentity for the given domain object * * @param object $domainObject + * * @throws InvalidDomainObjectException + * * @return ObjectIdentity */ public static function fromDomainObject($domainObject) diff --git a/Acl/Domain/PermissionGrantingStrategy.php b/Acl/Domain/PermissionGrantingStrategy.php index 81ed9d8..5d91f61 100644 --- a/Acl/Domain/PermissionGrantingStrategy.php +++ b/Acl/Domain/PermissionGrantingStrategy.php @@ -130,7 +130,7 @@ class PermissionGrantingStrategy implements PermissionGrantingStrategyInterface * @param SecurityIdentityInterface[] $sids An array of SecurityIdentityInterface implementations * @param bool $administrativeMode True turns off audit logging * - * @return bool true, or false; either granting, or denying access respectively. + * @return bool true, or false; either granting, or denying access respectively. * * @throws NoAceFoundException */ diff --git a/Acl/Domain/UserSecurityIdentity.php b/Acl/Domain/UserSecurityIdentity.php index 9418c81..a5b3d77 100644 --- a/Acl/Domain/UserSecurityIdentity.php +++ b/Acl/Domain/UserSecurityIdentity.php @@ -51,6 +51,7 @@ final class UserSecurityIdentity implements SecurityIdentityInterface * Creates a user security identity from a UserInterface * * @param UserInterface $user + * * @return UserSecurityIdentity */ public static function fromAccount(UserInterface $user) @@ -62,6 +63,7 @@ final class UserSecurityIdentity implements SecurityIdentityInterface * Creates a user security identity from a TokenInterface * * @param TokenInterface $token + * * @return UserSecurityIdentity */ public static function fromToken(TokenInterface $token) diff --git a/Acl/Model/AclCacheInterface.php b/Acl/Model/AclCacheInterface.php index 4673e01..03431db 100644 --- a/Acl/Model/AclCacheInterface.php +++ b/Acl/Model/AclCacheInterface.php @@ -37,7 +37,8 @@ interface AclCacheInterface /** * Retrieves an ACL for the given object identity primary key from the cache * - * @param int $primaryKey + * @param int $primaryKey + * * @return AclInterface */ public function getFromCacheById($primaryKey); @@ -46,6 +47,7 @@ interface AclCacheInterface * Retrieves an ACL for the given object identity from the cache * * @param ObjectIdentityInterface $oid + * * @return AclInterface */ public function getFromCacheByIdentity(ObjectIdentityInterface $oid); diff --git a/Acl/Model/AclInterface.php b/Acl/Model/AclInterface.php index 85a4e83..c5bbf18 100644 --- a/Acl/Model/AclInterface.php +++ b/Acl/Model/AclInterface.php @@ -36,6 +36,7 @@ interface AclInterface extends \Serializable * Returns all class-field-based ACEs associated with this ACL * * @param string $field + * * @return array */ public function getClassFieldAces($field); @@ -51,6 +52,7 @@ interface AclInterface extends \Serializable * Returns all object-field-based ACEs associated with this ACL * * @param string $field + * * @return array */ public function getObjectFieldAces($field); @@ -79,10 +81,11 @@ interface AclInterface extends \Serializable /** * Determines whether field access is granted * - * @param string $field - * @param array $masks - * @param array $securityIdentities - * @param bool $administrativeMode + * @param string $field + * @param array $masks + * @param array $securityIdentities + * @param bool $administrativeMode + * * @return bool */ public function isFieldGranted($field, array $masks, array $securityIdentities, $administrativeMode = false); @@ -90,10 +93,12 @@ interface AclInterface extends \Serializable /** * Determines whether access is granted * + * @param array $masks + * @param array $securityIdentities + * @param bool $administrativeMode + * * @throws NoAceFoundException when no ACE was applicable for this request - * @param array $masks - * @param array $securityIdentities - * @param bool $administrativeMode + * * @return bool */ public function isGranted(array $masks, array $securityIdentities, $administrativeMode = false); @@ -102,6 +107,7 @@ interface AclInterface extends \Serializable * Whether the ACL has loaded ACEs for all of the passed security identities * * @param mixed $securityIdentities an implementation of SecurityIdentityInterface, or an array thereof + * * @return bool */ public function isSidLoaded($securityIdentities); diff --git a/Acl/Model/AuditableAclInterface.php b/Acl/Model/AuditableAclInterface.php index f5ed9dd..80b9987 100644 --- a/Acl/Model/AuditableAclInterface.php +++ b/Acl/Model/AuditableAclInterface.php @@ -21,38 +21,38 @@ interface AuditableAclInterface extends MutableAclInterface /** * Updates auditing for class-based ACE * - * @param int $index - * @param bool $auditSuccess - * @param bool $auditFailure + * @param int $index + * @param bool $auditSuccess + * @param bool $auditFailure */ public function updateClassAuditing($index, $auditSuccess, $auditFailure); /** * Updates auditing for class-field-based ACE * - * @param int $index - * @param string $field - * @param bool $auditSuccess - * @param bool $auditFailure + * @param int $index + * @param string $field + * @param bool $auditSuccess + * @param bool $auditFailure */ public function updateClassFieldAuditing($index, $field, $auditSuccess, $auditFailure); /** * Updates auditing for object-based ACE * - * @param int $index - * @param bool $auditSuccess - * @param bool $auditFailure + * @param int $index + * @param bool $auditSuccess + * @param bool $auditFailure */ public function updateObjectAuditing($index, $auditSuccess, $auditFailure); /** * Updates auditing for object-field-based ACE * - * @param int $index - * @param string $field - * @param bool $auditSuccess - * @param bool $auditFailure + * @param int $index + * @param string $field + * @param bool $auditSuccess + * @param bool $auditFailure */ public function updateObjectFieldAuditing($index, $field, $auditSuccess, $auditFailure); } diff --git a/Acl/Model/MutableAclInterface.php b/Acl/Model/MutableAclInterface.php index 8993aa5..f94e909 100644 --- a/Acl/Model/MutableAclInterface.php +++ b/Acl/Model/MutableAclInterface.php @@ -24,30 +24,30 @@ interface MutableAclInterface extends AclInterface /** * Deletes a class-based ACE * - * @param int $index + * @param int $index */ public function deleteClassAce($index); /** * Deletes a class-field-based ACE * - * @param int $index - * @param string $field + * @param int $index + * @param string $field */ public function deleteClassFieldAce($index, $field); /** * Deletes an object-based ACE * - * @param int $index + * @param int $index */ public function deleteObjectAce($index); /** * Deletes an object-field-based ACE * - * @param int $index - * @param string $field + * @param int $index + * @param string $field */ public function deleteObjectFieldAce($index, $field); @@ -107,7 +107,7 @@ interface MutableAclInterface extends AclInterface /** * Sets whether entries are inherited * - * @param bool $boolean + * @param bool $boolean */ public function setEntriesInheriting($boolean); @@ -121,38 +121,38 @@ interface MutableAclInterface extends AclInterface /** * Updates a class-based ACE * - * @param int $index - * @param int $mask - * @param string $strategy if null the strategy should not be changed + * @param int $index + * @param int $mask + * @param string $strategy if null the strategy should not be changed */ public function updateClassAce($index, $mask, $strategy = null); /** * Updates a class-field-based ACE * - * @param int $index - * @param string $field - * @param int $mask - * @param string $strategy if null the strategy should not be changed + * @param int $index + * @param string $field + * @param int $mask + * @param string $strategy if null the strategy should not be changed */ public function updateClassFieldAce($index, $field, $mask, $strategy = null); /** * Updates an object-based ACE * - * @param int $index - * @param int $mask - * @param string $strategy if null the strategy should not be changed + * @param int $index + * @param int $mask + * @param string $strategy if null the strategy should not be changed */ public function updateObjectAce($index, $mask, $strategy = null); /** * Updates an object-field-based ACE * - * @param int $index - * @param string $field - * @param int $mask - * @param string $strategy if null the strategy should not be changed + * @param int $index + * @param string $field + * @param int $mask + * @param string $strategy if null the strategy should not be changed */ public function updateObjectFieldAce($index, $field, $mask, $strategy = null); } diff --git a/Acl/Model/MutableAclProviderInterface.php b/Acl/Model/MutableAclProviderInterface.php index cb34b72..f5bb198 100644 --- a/Acl/Model/MutableAclProviderInterface.php +++ b/Acl/Model/MutableAclProviderInterface.php @@ -21,9 +21,11 @@ interface MutableAclProviderInterface extends AclProviderInterface /** * Creates a new ACL for the given object identity. * - * @throws AclAlreadyExistsException when there already is an ACL for the given - * object identity * @param ObjectIdentityInterface $oid + * + * @throws AclAlreadyExistsException when there already is an ACL for the given + * object identity + * * @return MutableAclInterface */ public function createAcl(ObjectIdentityInterface $oid); diff --git a/Acl/Model/ObjectIdentityInterface.php b/Acl/Model/ObjectIdentityInterface.php index 2ee365f..6574b49 100644 --- a/Acl/Model/ObjectIdentityInterface.php +++ b/Acl/Model/ObjectIdentityInterface.php @@ -28,6 +28,7 @@ interface ObjectIdentityInterface * Example for Object Equality: $object1->getId() === $object2->getId() * * @param ObjectIdentityInterface $identity + * * @return bool */ public function equals(ObjectIdentityInterface $identity); diff --git a/Acl/Model/ObjectIdentityRetrievalStrategyInterface.php b/Acl/Model/ObjectIdentityRetrievalStrategyInterface.php index b0f7f78..d5470ae 100644 --- a/Acl/Model/ObjectIdentityRetrievalStrategyInterface.php +++ b/Acl/Model/ObjectIdentityRetrievalStrategyInterface.php @@ -22,6 +22,7 @@ interface ObjectIdentityRetrievalStrategyInterface * Retrieves the object identity from a domain object * * @param object $domainObject + * * @return ObjectIdentityInterface */ public function getObjectIdentity($domainObject); diff --git a/Acl/Model/PermissionGrantingStrategyInterface.php b/Acl/Model/PermissionGrantingStrategyInterface.php index 25f1687..7ff475f 100644 --- a/Acl/Model/PermissionGrantingStrategyInterface.php +++ b/Acl/Model/PermissionGrantingStrategyInterface.php @@ -25,6 +25,7 @@ interface PermissionGrantingStrategyInterface * @param array $masks * @param array $sids * @param bool $administrativeMode + * * @return bool */ public function isGranted(AclInterface $acl, array $masks, array $sids, $administrativeMode = false); diff --git a/Acl/Permission/MaskBuilder.php b/Acl/Permission/MaskBuilder.php index bcf03c5..89cfd39 100644 --- a/Acl/Permission/MaskBuilder.php +++ b/Acl/Permission/MaskBuilder.php @@ -72,7 +72,7 @@ class MaskBuilder /** * Constructor * - * @param int $mask optional; defaults to 0 + * @param int $mask optional; defaults to 0 * * @throws \InvalidArgumentException */ @@ -178,9 +178,11 @@ class MaskBuilder /** * Returns the code for the passed mask * - * @param int $mask + * @param int $mask + * * @throws \InvalidArgumentException * @throws \RuntimeException + * * @return string */ public static function getCode($mask) diff --git a/Acl/Permission/PermissionMapInterface.php b/Acl/Permission/PermissionMapInterface.php index 20ca181..1b2a7fd 100644 --- a/Acl/Permission/PermissionMapInterface.php +++ b/Acl/Permission/PermissionMapInterface.php @@ -26,6 +26,7 @@ interface PermissionMapInterface * * @param string $permission * @param object $object + * * @return array may return null if permission/object combination is not supported */ public function getMasks($permission, $object); @@ -34,6 +35,7 @@ interface PermissionMapInterface * Whether this map contains the given permission * * @param string $permission + * * @return bool */ public function contains($permission); |