summaryrefslogtreecommitdiffstats
path: root/Acl
diff options
context:
space:
mode:
Diffstat (limited to 'Acl')
-rw-r--r--Acl/Dbal/AclProvider.php14
-rw-r--r--Acl/Domain/Acl.php36
-rw-r--r--Acl/Domain/AclCollectionCache.php6
-rw-r--r--Acl/Domain/AuditLogger.php2
-rw-r--r--Acl/Domain/DoctrineAclCache.php5
-rw-r--r--Acl/Domain/Entry.php14
-rw-r--r--Acl/Domain/FieldEntry.php16
-rw-r--r--Acl/Domain/ObjectIdentity.php2
-rw-r--r--Acl/Domain/PermissionGrantingStrategy.php10
-rw-r--r--Acl/Domain/SecurityIdentityRetrievalStrategy.php3
-rw-r--r--Acl/Model/AclInterface.php10
-rw-r--r--Acl/Model/MutableAclInterface.php36
-rw-r--r--Acl/Model/PermissionGrantingStrategyInterface.php9
-rw-r--r--Acl/Voter/AclVoter.php2
14 files changed, 85 insertions, 80 deletions
diff --git a/Acl/Dbal/AclProvider.php b/Acl/Dbal/AclProvider.php
index 210c7f1..956fdd7 100644
--- a/Acl/Dbal/AclProvider.php
+++ b/Acl/Dbal/AclProvider.php
@@ -46,12 +46,12 @@ class AclProvider implements AclProviderInterface
private $permissionGrantingStrategy;
/**
- * Constructor
+ * Constructor.
*
- * @param Connection $connection
+ * @param Connection $connection
* @param PermissionGrantingStrategyInterface $permissionGrantingStrategy
- * @param array $options
- * @param AclCacheInterface $cache
+ * @param array $options
+ * @param AclCacheInterface $cache
*/
public function __construct(Connection $connection, PermissionGrantingStrategyInterface $permissionGrantingStrategy, array $options, AclCacheInterface $cache = null)
{
@@ -280,7 +280,7 @@ SELECTCLAUSE;
* object identities.
*
* @param ObjectIdentityInterface $oid
- * @param Boolean $directChildrenOnly
+ * @param Boolean $directChildrenOnly
* @return string
*/
protected function getFindChildrenSql(ObjectIdentityInterface $oid, $directChildrenOnly)
@@ -441,8 +441,8 @@ QUERY;
* performance of the entire ACL system.
*
* @param Statement $stmt
- * @param array $oidLookup
- * @param array $sids
+ * @param array $oidLookup
+ * @param array $sids
* @throws \RuntimeException
* @return \SplObjectStorage
*/
diff --git a/Acl/Domain/Acl.php b/Acl/Domain/Acl.php
index 09bcb34..661b892 100644
--- a/Acl/Domain/Acl.php
+++ b/Acl/Domain/Acl.php
@@ -51,11 +51,11 @@ class Acl implements AuditableAclInterface, NotifyPropertyChanged
/**
* Constructor
*
- * @param integer $id
- * @param ObjectIdentityInterface $objectIdentity
+ * @param integer $id
+ * @param ObjectIdentityInterface $objectIdentity
* @param PermissionGrantingStrategyInterface $permissionGrantingStrategy
- * @param array $loadedSids
- * @param Boolean $entriesInheriting
+ * @param array $loadedSids
+ * @param Boolean $entriesInheriting
* @return void
*/
public function __construct($id, ObjectIdentityInterface $objectIdentity, PermissionGrantingStrategyInterface $permissionGrantingStrategy, array $loadedSids = array(), $entriesInheriting)
@@ -453,12 +453,12 @@ class Acl implements AuditableAclInterface, NotifyPropertyChanged
/**
* Inserts an ACE
*
- * @param string $property
- * @param integer $index
- * @param integer $mask
+ * @param string $property
+ * @param integer $index
+ * @param integer $mask
* @param SecurityIdentityInterface $sid
- * @param Boolean $granting
- * @param string $strategy
+ * @param Boolean $granting
+ * @param string $strategy
* @throws \OutOfBoundsException
* @throws \InvalidArgumentException
* @return void
@@ -502,13 +502,13 @@ class Acl implements AuditableAclInterface, NotifyPropertyChanged
/**
* Inserts a field-based ACE
*
- * @param string $property
- * @param integer $index
- * @param string $field
- * @param integer $mask
+ * @param string $property
+ * @param integer $index
+ * @param string $field
+ * @param integer $mask
* @param SecurityIdentityInterface $sid
- * @param Boolean $granting
- * @param string $strategy
+ * @param Boolean $granting
+ * @param string $strategy
* @throws \InvalidArgumentException
* @throws \OutOfBoundsException
* @return void
@@ -665,9 +665,9 @@ class Acl implements AuditableAclInterface, NotifyPropertyChanged
* Called when a property of an ACE associated with this ACL changes
*
* @param EntryInterface $entry
- * @param string $name
- * @param mixed $oldValue
- * @param mixed $newValue
+ * @param string $name
+ * @param mixed $oldValue
+ * @param mixed $newValue
* @return void
*/
private function onEntryPropertyChanged(EntryInterface $entry, $name, $oldValue, $newValue)
diff --git a/Acl/Domain/AclCollectionCache.php b/Acl/Domain/AclCollectionCache.php
index f3fe6f0..6614724 100644
--- a/Acl/Domain/AclCollectionCache.php
+++ b/Acl/Domain/AclCollectionCache.php
@@ -27,10 +27,10 @@ class AclCollectionCache
private $securityIdentityRetrievalStrategy;
/**
- * Constructor
+ * Constructor.
*
- * @param AclProviderInterface $aclProvider
- * @param ObjectIdentityRetrievalStrategy $oidRetrievalStrategy
+ * @param AclProviderInterface $aclProvider
+ * @param ObjectIdentityRetrievalStrategy $oidRetrievalStrategy
* @param SecurityIdentityRetrievalStrategy $sidRetrievalStrategy
* @return void
*/
diff --git a/Acl/Domain/AuditLogger.php b/Acl/Domain/AuditLogger.php
index 0a4773f..9f95d06 100644
--- a/Acl/Domain/AuditLogger.php
+++ b/Acl/Domain/AuditLogger.php
@@ -25,7 +25,7 @@ abstract class AuditLogger implements AuditLoggerInterface
/**
* Performs some checks if logging was requested
*
- * @param Boolean $granted
+ * @param Boolean $granted
* @param EntryInterface $ace
* @return void
*/
diff --git a/Acl/Domain/DoctrineAclCache.php b/Acl/Domain/DoctrineAclCache.php
index eb18986..64241e2 100644
--- a/Acl/Domain/DoctrineAclCache.php
+++ b/Acl/Domain/DoctrineAclCache.php
@@ -33,9 +33,10 @@ class DoctrineAclCache implements AclCacheInterface
/**
* Constructor
*
- * @param Cache $cache
+ * @param Cache $cache
* @param PermissionGrantingStrategyInterface $permissionGrantingStrategy
- * @param string $prefix
+ * @param string $prefix
+ *
* @return void
*/
public function __construct(Cache $cache, PermissionGrantingStrategyInterface $permissionGrantingStrategy, $prefix = self::PREFIX)
diff --git a/Acl/Domain/Entry.php b/Acl/Domain/Entry.php
index 7498b03..c5226a4 100644
--- a/Acl/Domain/Entry.php
+++ b/Acl/Domain/Entry.php
@@ -35,14 +35,14 @@ class Entry implements AuditableEntryInterface
/**
* Constructor
*
- * @param integer $id
- * @param AclInterface $acl
+ * @param integer $id
+ * @param AclInterface $acl
* @param SecurityIdentityInterface $sid
- * @param string $strategy
- * @param integer $mask
- * @param Boolean $granting
- * @param Boolean $auditFailure
- * @param Boolean $auditSuccess
+ * @param string $strategy
+ * @param integer $mask
+ * @param Boolean $granting
+ * @param Boolean $auditFailure
+ * @param Boolean $auditSuccess
*/
public function __construct($id, AclInterface $acl, SecurityIdentityInterface $sid, $strategy, $mask, $granting, $auditFailure, $auditSuccess)
{
diff --git a/Acl/Domain/FieldEntry.php b/Acl/Domain/FieldEntry.php
index 1510df2..5ff6921 100644
--- a/Acl/Domain/FieldEntry.php
+++ b/Acl/Domain/FieldEntry.php
@@ -27,15 +27,15 @@ class FieldEntry extends Entry implements FieldEntryInterface
/**
* Constructor
*
- * @param integer $id
- * @param AclInterface $acl
- * @param string $field
+ * @param integer $id
+ * @param AclInterface $acl
+ * @param string $field
* @param SecurityIdentityInterface $sid
- * @param string $strategy
- * @param integer $mask
- * @param Boolean $granting
- * @param Boolean $auditFailure
- * @param Boolean $auditSuccess
+ * @param string $strategy
+ * @param integer $mask
+ * @param Boolean $granting
+ * @param Boolean $auditFailure
+ * @param Boolean $auditSuccess
* @return void
*/
public function __construct($id, AclInterface $acl, $field, SecurityIdentityInterface $sid, $strategy, $mask, $granting, $auditFailure, $auditSuccess)
diff --git a/Acl/Domain/ObjectIdentity.php b/Acl/Domain/ObjectIdentity.php
index 2cb1352..f55f8a5 100644
--- a/Acl/Domain/ObjectIdentity.php
+++ b/Acl/Domain/ObjectIdentity.php
@@ -26,7 +26,7 @@ class ObjectIdentity implements ObjectIdentityInterface
private $type;
/**
- * Constructor
+ * Constructor.
*
* @param string $identifier
* @param string $type
diff --git a/Acl/Domain/PermissionGrantingStrategy.php b/Acl/Domain/PermissionGrantingStrategy.php
index 37bbe4e..2cc23bd 100644
--- a/Acl/Domain/PermissionGrantingStrategy.php
+++ b/Acl/Domain/PermissionGrantingStrategy.php
@@ -129,10 +129,10 @@ class PermissionGrantingStrategy implements PermissionGrantingStrategyInterface
* access finally.
*
* @param AclInterface $acl
- * @param array $aces an array of ACE to check against
- * @param array $masks an array of permission masks
- * @param array $sids an array of SecurityIdentityInterface implementations
- * @param Boolean $administrativeMode true turns off audit logging
+ * @param array $aces An array of ACE to check against
+ * @param array $masks An array of permission masks
+ * @param array $sids An array of SecurityIdentityInterface implementations
+ * @param Boolean $administrativeMode True turns off audit logging
* @return Boolean true, or false; either granting, or denying access respectively.
*/
private function hasSufficientPermissions(AclInterface $acl, array $aces, array $masks, array $sids, $administrativeMode)
@@ -189,7 +189,7 @@ class PermissionGrantingStrategy implements PermissionGrantingStrategyInterface
* Strategy EQUAL:
* The ACE will be considered applicable when the bitmasks are equal.
*
- * @param integer $requiredMask
+ * @param integer $requiredMask
* @param EntryInterface $ace
* @return Boolean
*/
diff --git a/Acl/Domain/SecurityIdentityRetrievalStrategy.php b/Acl/Domain/SecurityIdentityRetrievalStrategy.php
index 1252a0f..d16a978 100644
--- a/Acl/Domain/SecurityIdentityRetrievalStrategy.php
+++ b/Acl/Domain/SecurityIdentityRetrievalStrategy.php
@@ -33,8 +33,9 @@ class SecurityIdentityRetrievalStrategy implements SecurityIdentityRetrievalStra
/**
* Constructor
*
- * @param RoleHierarchyInterface $roleHierarchy
+ * @param RoleHierarchyInterface $roleHierarchy
* @param AuthenticationTrustResolver $authenticationTrustResolver
+ *
* @return void
*/
public function __construct(RoleHierarchyInterface $roleHierarchy, AuthenticationTrustResolver $authenticationTrustResolver)
diff --git a/Acl/Model/AclInterface.php b/Acl/Model/AclInterface.php
index a9cfc5a..e8119fe 100644
--- a/Acl/Model/AclInterface.php
+++ b/Acl/Model/AclInterface.php
@@ -77,9 +77,9 @@ interface AclInterface extends \Serializable
/**
* Determines whether field access is granted
*
- * @param string $field
- * @param array $masks
- * @param array $securityIdentities
+ * @param string $field
+ * @param array $masks
+ * @param array $securityIdentities
* @param Boolean $administrativeMode
* @return Boolean
*/
@@ -89,8 +89,8 @@ interface AclInterface extends \Serializable
* Determines whether access is granted
*
* @throws NoAceFoundException when no ACE was applicable for this request
- * @param array $masks
- * @param array $securityIdentities
+ * @param array $masks
+ * @param array $securityIdentities
* @param Boolean $administrativeMode
* @return Boolean
*/
diff --git a/Acl/Model/MutableAclInterface.php b/Acl/Model/MutableAclInterface.php
index fdd6712..9a64709 100644
--- a/Acl/Model/MutableAclInterface.php
+++ b/Acl/Model/MutableAclInterface.php
@@ -66,10 +66,10 @@ interface MutableAclInterface extends AclInterface
* Inserts a class-based ACE
*
* @param SecurityIdentityInterface $sid
- * @param integer $mask
- * @param integer $index
- * @param Boolean $granting
- * @param string $strategy
+ * @param integer $mask
+ * @param integer $index
+ * @param Boolean $granting
+ * @param string $strategy
* @return void
*/
function insertClassAce(SecurityIdentityInterface $sid, $mask, $index = 0, $granting = true, $strategy = null);
@@ -77,12 +77,12 @@ interface MutableAclInterface extends AclInterface
/**
* Inserts a class-field-based ACE
*
- * @param string $field
+ * @param string $field
* @param SecurityIdentityInterface $sid
- * @param integer $mask
- * @param integer $index
- * @param Boolean $granting
- * @param string $strategy
+ * @param integer $mask
+ * @param integer $index
+ * @param Boolean $granting
+ * @param string $strategy
* @return void
*/
function insertClassFieldAce($field, SecurityIdentityInterface $sid, $mask, $index = 0, $granting = true, $strategy = null);
@@ -91,10 +91,10 @@ interface MutableAclInterface extends AclInterface
* Inserts an object-based ACE
*
* @param SecurityIdentityInterface $sid
- * @param integer $mask
- * @param integer $index
- * @param Boolean $granting
- * @param string $strategy
+ * @param integer $mask
+ * @param integer $index
+ * @param Boolean $granting
+ * @param string $strategy
* @return void
*/
function insertObjectAce(SecurityIdentityInterface $sid, $mask, $index = 0, $granting = true, $strategy = null);
@@ -102,12 +102,12 @@ interface MutableAclInterface extends AclInterface
/**
* Inserts an object-field-based ACE
*
- * @param string $field
+ * @param string $field
* @param SecurityIdentityInterface $sid
- * @param integer $mask
- * @param integer $index
- * @param Boolean $granting
- * @param string $strategy
+ * @param integer $mask
+ * @param integer $index
+ * @param Boolean $granting
+ * @param string $strategy
* @return void
*/
function insertObjectFieldAce($field, SecurityIdentityInterface $sid, $mask, $index = 0, $granting = true, $strategy = null);
diff --git a/Acl/Model/PermissionGrantingStrategyInterface.php b/Acl/Model/PermissionGrantingStrategyInterface.php
index 5cf10e6..882eb08 100644
--- a/Acl/Model/PermissionGrantingStrategyInterface.php
+++ b/Acl/Model/PermissionGrantingStrategyInterface.php
@@ -33,10 +33,11 @@ interface PermissionGrantingStrategyInterface
* Determines whether access to a domain object's field is to be granted
*
* @param AclInterface $acl
- * @param string $field
- * @param array $masks
- * @param array $sids
- * @param Boolean $administrativeMode
+ * @param string $field
+ * @param array $masks
+ * @param array $sids
+ * @param Boolean $administrativeMode
+ *
* @return Boolean
*/
function isFieldGranted(AclInterface $acl, $field, array $masks, array $sids, $administrativeMode = false);
diff --git a/Acl/Voter/AclVoter.php b/Acl/Voter/AclVoter.php
index 9ae4c04..7bd8610 100644
--- a/Acl/Voter/AclVoter.php
+++ b/Acl/Voter/AclVoter.php
@@ -138,6 +138,8 @@ class AclVoter implements VoterInterface
* You can override this method when writing a voter for a specific domain
* class.
*
+ * @param string $class The class name
+ *
* @return Boolean
*/
public function supportsClass($class)