diff options
Diffstat (limited to 'Acl')
30 files changed, 116 insertions, 114 deletions
diff --git a/Acl/Dbal/MutableAclProvider.php b/Acl/Dbal/MutableAclProvider.php index 1bf105f..8e6b536 100644 --- a/Acl/Dbal/MutableAclProvider.php +++ b/Acl/Dbal/MutableAclProvider.php @@ -152,7 +152,7 @@ class MutableAclProvider extends AclProvider implements MutableAclProviderInterf } /** - * Implementation of PropertyChangedListener + * Implementation of PropertyChangedListener. * * This allows us to keep track of which values have been changed, so we don't * have to do a full introspection when ->updateAcl() is called. @@ -742,7 +742,7 @@ QUERY; } /** - * Creates the ACL for the passed object identity + * Creates the ACL for the passed object identity. * * @param ObjectIdentityInterface $oid */ diff --git a/Acl/Dbal/Schema.php b/Acl/Dbal/Schema.php index fd25926..ed9327c 100644 --- a/Acl/Dbal/Schema.php +++ b/Acl/Dbal/Schema.php @@ -24,7 +24,7 @@ final class Schema extends BaseSchema protected $options; /** - * Constructor + * Constructor. * * @param array $options the names for tables * @param Connection $connection @@ -61,7 +61,7 @@ final class Schema extends BaseSchema } /** - * Adds the class table to the schema + * Adds the class table to the schema. */ protected function addClassTable() { @@ -73,7 +73,7 @@ final class Schema extends BaseSchema } /** - * Adds the entry table to the schema + * Adds the entry table to the schema. */ protected function addEntryTable() { @@ -101,7 +101,7 @@ final class Schema extends BaseSchema } /** - * Adds the object identity table to the schema + * Adds the object identity table to the schema. */ protected function addObjectIdentitiesTable() { @@ -121,7 +121,7 @@ final class Schema extends BaseSchema } /** - * Adds the object identity relation table to the schema + * Adds the object identity relation table to the schema. */ protected function addObjectIdentityAncestorsTable() { @@ -138,7 +138,7 @@ final class Schema extends BaseSchema } /** - * Adds the security identity table to the schema + * Adds the security identity table to the schema. */ protected function addSecurityIdentitiesTable() { diff --git a/Acl/Domain/Acl.php b/Acl/Domain/Acl.php index c237448..328f754 100644 --- a/Acl/Domain/Acl.php +++ b/Acl/Domain/Acl.php @@ -47,7 +47,7 @@ class Acl implements AuditableAclInterface, NotifyPropertyChanged private $listeners = array(); /** - * Constructor + * Constructor. * * @param int $id * @param ObjectIdentityInterface $objectIdentity @@ -65,7 +65,7 @@ class Acl implements AuditableAclInterface, NotifyPropertyChanged } /** - * Adds a property changed listener + * Adds a property changed listener. * * @param PropertyChangedListener $listener */ @@ -250,7 +250,7 @@ class Acl implements AuditableAclInterface, NotifyPropertyChanged } /** - * Implementation for the \Serializable interface + * Implementation for the \Serializable interface. * * @return string */ @@ -270,7 +270,7 @@ class Acl implements AuditableAclInterface, NotifyPropertyChanged } /** - * Implementation for the \Serializable interface + * Implementation for the \Serializable interface. * * @param string $serialized */ @@ -389,7 +389,7 @@ class Acl implements AuditableAclInterface, NotifyPropertyChanged } /** - * Deletes an ACE + * Deletes an ACE. * * @param string $property * @param int $index @@ -414,7 +414,7 @@ class Acl implements AuditableAclInterface, NotifyPropertyChanged } /** - * Deletes a field-based ACE + * Deletes a field-based ACE. * * @param string $property * @param int $index @@ -440,7 +440,7 @@ class Acl implements AuditableAclInterface, NotifyPropertyChanged } /** - * Inserts an ACE + * Inserts an ACE. * * @param string $property * @param int $index @@ -489,7 +489,7 @@ class Acl implements AuditableAclInterface, NotifyPropertyChanged } /** - * Inserts a field-based ACE + * Inserts a field-based ACE. * * @param string $property * @param int $index @@ -547,7 +547,7 @@ class Acl implements AuditableAclInterface, NotifyPropertyChanged } /** - * Updates an ACE + * Updates an ACE. * * @param string $property * @param int $index @@ -575,7 +575,7 @@ class Acl implements AuditableAclInterface, NotifyPropertyChanged } /** - * Updates auditing for an ACE + * Updates auditing for an ACE. * * @param array &$aces * @param int $index @@ -602,7 +602,7 @@ class Acl implements AuditableAclInterface, NotifyPropertyChanged } /** - * Updates a field-based ACE + * Updates a field-based ACE. * * @param string $property * @param int $index @@ -636,7 +636,7 @@ class Acl implements AuditableAclInterface, NotifyPropertyChanged } /** - * Called when a property of the ACL changes + * Called when a property of the ACL changes. * * @param string $name * @param mixed $oldValue @@ -650,7 +650,7 @@ class Acl implements AuditableAclInterface, NotifyPropertyChanged } /** - * Called when a property of an ACE associated with this ACL changes + * Called when a property of an ACE associated with this ACL changes. * * @param EntryInterface $entry * @param string $name diff --git a/Acl/Domain/AuditLogger.php b/Acl/Domain/AuditLogger.php index feb2c42..e3f3bdd 100644 --- a/Acl/Domain/AuditLogger.php +++ b/Acl/Domain/AuditLogger.php @@ -16,14 +16,14 @@ use Symfony\Component\Security\Acl\Model\EntryInterface; use Symfony\Component\Security\Acl\Model\AuditLoggerInterface; /** - * Base audit logger implementation + * Base audit logger implementation. * * @author Johannes M. Schmitt <schmittjoh@gmail.com> */ abstract class AuditLogger implements AuditLoggerInterface { /** - * Performs some checks if logging was requested + * Performs some checks if logging was requested. * * @param bool $granted * @param EntryInterface $ace @@ -42,7 +42,7 @@ abstract class AuditLogger implements AuditLoggerInterface } /** - * This method is only called when logging is needed + * This method is only called when logging is needed. * * @param bool $granted * @param EntryInterface $ace diff --git a/Acl/Domain/DoctrineAclCache.php b/Acl/Domain/DoctrineAclCache.php index 00864f0..667a19e 100644 --- a/Acl/Domain/DoctrineAclCache.php +++ b/Acl/Domain/DoctrineAclCache.php @@ -32,7 +32,7 @@ class DoctrineAclCache implements AclCacheInterface private $permissionGrantingStrategy; /** - * Constructor + * Constructor. * * @param Cache $cache * @param PermissionGrantingStrategyInterface $permissionGrantingStrategy @@ -203,7 +203,7 @@ class DoctrineAclCache implements AclCacheInterface } /** - * Returns the key for the object identity + * Returns the key for the object identity. * * @param ObjectIdentityInterface $oid * @@ -216,7 +216,7 @@ class DoctrineAclCache implements AclCacheInterface } /** - * Returns the alias key for the object identity key + * Returns the alias key for the object identity key. * * @param string $aclId * diff --git a/Acl/Domain/Entry.php b/Acl/Domain/Entry.php index a487c96..55c4b37 100644 --- a/Acl/Domain/Entry.php +++ b/Acl/Domain/Entry.php @@ -16,7 +16,7 @@ use Symfony\Component\Security\Acl\Model\AuditableEntryInterface; use Symfony\Component\Security\Acl\Model\SecurityIdentityInterface; /** - * Auditable ACE implementation + * Auditable ACE implementation. * * @author Johannes M. Schmitt <schmittjoh@gmail.com> */ @@ -32,7 +32,7 @@ class Entry implements AuditableEntryInterface private $granting; /** - * Constructor + * Constructor. * * @param int $id * @param AclInterface $acl @@ -146,7 +146,7 @@ class Entry implements AuditableEntryInterface } /** - * Sets the permission mask + * Sets the permission mask. * * Do never call this method directly. Use the respective methods on the * AclInterface instead. @@ -159,7 +159,7 @@ class Entry implements AuditableEntryInterface } /** - * Sets the mask comparison strategy + * Sets the mask comparison strategy. * * Do never call this method directly. Use the respective methods on the * AclInterface instead. @@ -172,7 +172,7 @@ class Entry implements AuditableEntryInterface } /** - * Implementation of \Serializable + * Implementation of \Serializable. * * @return string */ @@ -190,7 +190,7 @@ class Entry implements AuditableEntryInterface } /** - * Implementation of \Serializable + * Implementation of \Serializable. * * @param string $serialized */ diff --git a/Acl/Domain/FieldEntry.php b/Acl/Domain/FieldEntry.php index 2edc33d..86b1e5b 100644 --- a/Acl/Domain/FieldEntry.php +++ b/Acl/Domain/FieldEntry.php @@ -16,7 +16,7 @@ use Symfony\Component\Security\Acl\Model\FieldEntryInterface; use Symfony\Component\Security\Acl\Model\SecurityIdentityInterface; /** - * Field-aware ACE implementation which is auditable + * Field-aware ACE implementation which is auditable. * * @author Johannes M. Schmitt <schmittjoh@gmail.com> */ @@ -25,7 +25,7 @@ class FieldEntry extends Entry implements FieldEntryInterface private $field; /** - * Constructor + * Constructor. * * @param int $id * @param AclInterface $acl diff --git a/Acl/Domain/ObjectIdentity.php b/Acl/Domain/ObjectIdentity.php index 1111089..907b1d8 100644 --- a/Acl/Domain/ObjectIdentity.php +++ b/Acl/Domain/ObjectIdentity.php @@ -17,7 +17,7 @@ use Symfony\Component\Security\Acl\Model\DomainObjectInterface; use Symfony\Component\Security\Acl\Model\ObjectIdentityInterface; /** - * ObjectIdentity implementation + * ObjectIdentity implementation. * * @author Johannes M. Schmitt <schmittjoh@gmail.com> */ @@ -48,7 +48,7 @@ final class ObjectIdentity implements ObjectIdentityInterface } /** - * Constructs an ObjectIdentity for the given domain object + * Constructs an ObjectIdentity for the given domain object. * * @param object $domainObject * @@ -103,7 +103,7 @@ final class ObjectIdentity implements ObjectIdentityInterface } /** - * Returns a textual representation of this object identity + * Returns a textual representation of this object identity. * * @return string */ diff --git a/Acl/Domain/ObjectIdentityRetrievalStrategy.php b/Acl/Domain/ObjectIdentityRetrievalStrategy.php index fc66856..21ac812 100644 --- a/Acl/Domain/ObjectIdentityRetrievalStrategy.php +++ b/Acl/Domain/ObjectIdentityRetrievalStrategy.php @@ -15,7 +15,7 @@ use Symfony\Component\Security\Acl\Exception\InvalidDomainObjectException; use Symfony\Component\Security\Acl\Model\ObjectIdentityRetrievalStrategyInterface; /** - * Strategy to be used for retrieving object identities from domain objects + * Strategy to be used for retrieving object identities from domain objects. * * @author Johannes M. Schmitt <schmittjoh@gmail.com> */ diff --git a/Acl/Domain/PermissionGrantingStrategy.php b/Acl/Domain/PermissionGrantingStrategy.php index 5d91f61..ef80a20 100644 --- a/Acl/Domain/PermissionGrantingStrategy.php +++ b/Acl/Domain/PermissionGrantingStrategy.php @@ -32,7 +32,7 @@ class PermissionGrantingStrategy implements PermissionGrantingStrategyInterface private $auditLogger; /** - * Sets the audit logger + * Sets the audit logger. * * @param AuditLoggerInterface $auditLogger */ diff --git a/Acl/Domain/RoleSecurityIdentity.php b/Acl/Domain/RoleSecurityIdentity.php index 64f864d..5410a46 100644 --- a/Acl/Domain/RoleSecurityIdentity.php +++ b/Acl/Domain/RoleSecurityIdentity.php @@ -15,7 +15,7 @@ use Symfony\Component\Security\Acl\Model\SecurityIdentityInterface; use Symfony\Component\Security\Core\Role\Role; /** - * A SecurityIdentity implementation for roles + * A SecurityIdentity implementation for roles. * * @author Johannes M. Schmitt <schmittjoh@gmail.com> */ @@ -24,7 +24,7 @@ final class RoleSecurityIdentity implements SecurityIdentityInterface private $role; /** - * Constructor + * Constructor. * * @param mixed $role a Role instance, or its string representation */ @@ -38,7 +38,7 @@ final class RoleSecurityIdentity implements SecurityIdentityInterface } /** - * Returns the role name + * Returns the role name. * * @return string */ diff --git a/Acl/Domain/SecurityIdentityRetrievalStrategy.php b/Acl/Domain/SecurityIdentityRetrievalStrategy.php index 43f1d38..708c633 100644 --- a/Acl/Domain/SecurityIdentityRetrievalStrategy.php +++ b/Acl/Domain/SecurityIdentityRetrievalStrategy.php @@ -19,7 +19,7 @@ use Symfony\Component\Security\Core\Role\RoleHierarchyInterface; use Symfony\Component\Security\Core\Authorization\Voter\AuthenticatedVoter; /** - * Strategy for retrieving security identities + * Strategy for retrieving security identities. * * @author Johannes M. Schmitt <schmittjoh@gmail.com> */ @@ -29,7 +29,7 @@ class SecurityIdentityRetrievalStrategy implements SecurityIdentityRetrievalStra private $authenticationTrustResolver; /** - * Constructor + * Constructor. * * @param RoleHierarchyInterface $roleHierarchy * @param AuthenticationTrustResolver $authenticationTrustResolver diff --git a/Acl/Domain/UserSecurityIdentity.php b/Acl/Domain/UserSecurityIdentity.php index a5b3d77..e3d9a34 100644 --- a/Acl/Domain/UserSecurityIdentity.php +++ b/Acl/Domain/UserSecurityIdentity.php @@ -17,7 +17,7 @@ use Symfony\Component\Security\Core\Util\ClassUtils; use Symfony\Component\Security\Acl\Model\SecurityIdentityInterface; /** - * A SecurityIdentity implementation used for actual users + * A SecurityIdentity implementation used for actual users. * * @author Johannes M. Schmitt <schmittjoh@gmail.com> */ @@ -27,7 +27,7 @@ final class UserSecurityIdentity implements SecurityIdentityInterface private $class; /** - * Constructor + * Constructor. * * @param string $username the username representation * @param string $class the user's fully qualified class name @@ -48,7 +48,7 @@ final class UserSecurityIdentity implements SecurityIdentityInterface } /** - * Creates a user security identity from a UserInterface + * Creates a user security identity from a UserInterface. * * @param UserInterface $user * @@ -60,7 +60,7 @@ final class UserSecurityIdentity implements SecurityIdentityInterface } /** - * Creates a user security identity from a TokenInterface + * Creates a user security identity from a TokenInterface. * * @param TokenInterface $token * @@ -78,7 +78,7 @@ final class UserSecurityIdentity implements SecurityIdentityInterface } /** - * Returns the username + * Returns the username. * * @return string */ @@ -88,7 +88,7 @@ final class UserSecurityIdentity implements SecurityIdentityInterface } /** - * Returns the user's class name + * Returns the user's class name. * * @return string */ diff --git a/Acl/Exception/Exception.php b/Acl/Exception/Exception.php index d381c57..a38c8ee 100644 --- a/Acl/Exception/Exception.php +++ b/Acl/Exception/Exception.php @@ -12,7 +12,7 @@ namespace Symfony\Component\Security\Acl\Exception; /** - * Base ACL exception + * Base ACL exception. * * @author Johannes M. Schmitt <schmittjoh@gmail.com> */ diff --git a/Acl/Exception/NotAllAclsFoundException.php b/Acl/Exception/NotAllAclsFoundException.php index 3c02495..a634382 100644 --- a/Acl/Exception/NotAllAclsFoundException.php +++ b/Acl/Exception/NotAllAclsFoundException.php @@ -25,7 +25,7 @@ class NotAllAclsFoundException extends AclNotFoundException private $partialResult; /** - * Sets the partial result + * Sets the partial result. * * @param \SplObjectStorage $result */ @@ -35,7 +35,7 @@ class NotAllAclsFoundException extends AclNotFoundException } /** - * Returns the partial result + * Returns the partial result. * * @return \SplObjectStorage */ 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 diff --git a/Acl/Permission/MaskBuilder.php b/Acl/Permission/MaskBuilder.php index d238a18..5364c9b 100644 --- a/Acl/Permission/MaskBuilder.php +++ b/Acl/Permission/MaskBuilder.php @@ -70,7 +70,7 @@ class MaskBuilder private $mask; /** - * Constructor + * Constructor. * * @param int $mask optional; defaults to 0 * @@ -86,7 +86,7 @@ class MaskBuilder } /** - * Adds a mask to the permission + * Adds a mask to the permission. * * @param mixed $mask * @@ -102,7 +102,7 @@ class MaskBuilder } /** - * Returns the mask of this permission + * Returns the mask of this permission. * * @return int */ @@ -112,7 +112,7 @@ class MaskBuilder } /** - * Returns a human-readable representation of the permission + * Returns a human-readable representation of the permission. * * @return string */ @@ -136,7 +136,7 @@ class MaskBuilder } /** - * Removes a mask from the permission + * Removes a mask from the permission. * * @param mixed $mask * @@ -152,7 +152,7 @@ class MaskBuilder } /** - * Resets the PermissionBuilder + * Resets the PermissionBuilder. * * @return MaskBuilder */ @@ -164,7 +164,7 @@ class MaskBuilder } /** - * Returns the code for the passed mask + * Returns the code for the passed mask. * * @param int $mask * diff --git a/Acl/Permission/PermissionMapInterface.php b/Acl/Permission/PermissionMapInterface.php index 1b2a7fd..0b2f1ce 100644 --- a/Acl/Permission/PermissionMapInterface.php +++ b/Acl/Permission/PermissionMapInterface.php @@ -32,7 +32,7 @@ interface PermissionMapInterface public function getMasks($permission, $object); /** - * Whether this map contains the given permission + * Whether this map contains the given permission. * * @param string $permission * diff --git a/Acl/Tests/Dbal/MutableAclProviderTest.php b/Acl/Tests/Dbal/MutableAclProviderTest.php index 457fbfa..5ec23d3 100644 --- a/Acl/Tests/Dbal/MutableAclProviderTest.php +++ b/Acl/Tests/Dbal/MutableAclProviderTest.php @@ -441,6 +441,8 @@ class MutableAclProviderTest extends \PHPUnit_Framework_TestCase } /** + * Imports acls. + * * Data must have the following format: * array( * *name* => array( |