Overview

Namespaces

  • PHP
  • ProgrammingAreHard
    • Arbiter
      • Domain
      • Model
  • Symfony
    • Component
      • Security
        • Acl
          • Exception
          • Model
          • Permission
        • Core
          • User

Interfaces

  • AclCacheInterface
  • AclInterface
  • AclProviderInterface
  • AuditableAclInterface
  • AuditableEntryInterface
  • AuditLoggerInterface
  • DomainObjectInterface
  • EntryInterface
  • FieldEntryInterface
  • MutableAclInterface
  • MutableAclProviderInterface
  • ObjectIdentityInterface
  • ObjectIdentityRetrievalStrategyInterface
  • PermissionGrantingStrategyInterface
  • SecurityIdentityInterface
  • SecurityIdentityRetrievalStrategyInterface
  • Overview
  • Namespace
  • Class
  • Tree

Interface AclInterface

This interface represents an access control list (ACL) for a domain object. Each domain object can have exactly one associated ACL.

An ACL contains all access control entries (ACE) for a given domain object. In order to avoid needing references to the domain object itself, implementations use ObjectIdentity implementations as an additional level of indirection.

Symfony\Component\Security\Acl\Model\AclInterface implements Serializable

Direct known implementers

Symfony\Component\Security\Acl\Model\MutableAclInterface

Indirect known implementers

Symfony\Component\Security\Acl\Model\AuditableAclInterface
Namespace: Symfony\Component\Security\Acl\Model
Author: Johannes M. Schmitt <schmittjoh@gmail.com>
Located at AclInterface.php
Methods summary
public array
# getClassAces( )

Returns all class-based ACEs associated with this ACL

Returns all class-based ACEs associated with this ACL

Returns

array
public array
# getClassFieldAces( string $field )

Returns all class-field-based ACEs associated with this ACL

Returns all class-field-based ACEs associated with this ACL

Parameters

$field
string
$field

Returns

array
public array
# getObjectAces( )

Returns all object-based ACEs associated with this ACL

Returns all object-based ACEs associated with this ACL

Returns

array
public array
# getObjectFieldAces( string $field )

Returns all object-field-based ACEs associated with this ACL

Returns all object-field-based ACEs associated with this ACL

Parameters

$field
string
$field

Returns

array
public Symfony\Component\Security\Acl\Model\ObjectIdentityInterface
# getObjectIdentity( )

Returns the object identity associated with this ACL

Returns the object identity associated with this ACL

Returns

Symfony\Component\Security\Acl\Model\ObjectIdentityInterface
public Symfony\Component\Security\Acl\Model\AclInterface|null
# getParentAcl( )

Returns the parent ACL, or null if there is none.

Returns the parent ACL, or null if there is none.

Returns

Symfony\Component\Security\Acl\Model\AclInterface|null
public boolean
# isEntriesInheriting( )

Whether this ACL is inheriting ACEs from a parent ACL.

Whether this ACL is inheriting ACEs from a parent ACL.

Returns

boolean
public boolean
# isFieldGranted( string $field, array $masks, array $securityIdentities, boolean $administrativeMode = false )

Determines whether field access is granted

Determines whether field access is granted

Parameters

$field
string
$field
$masks
array
$masks
$securityIdentities
array
$securityIdentities
$administrativeMode
boolean
$administrativeMode

Returns

boolean
public boolean
# isGranted( array $masks, array $securityIdentities, boolean $administrativeMode = false )

Determines whether access is granted

Determines whether access is granted

Parameters

$masks
array
$masks
$securityIdentities
array
$securityIdentities
$administrativeMode
boolean
$administrativeMode

Returns

boolean

Throws

Symfony\Component\Security\Acl\Exception\NoAceFoundException
when no ACE was applicable for this request
public boolean
# isSidLoaded( mixed $securityIdentities )

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

Parameters

$securityIdentities
mixed
$securityIdentities an implementation of SecurityIdentityInterface, or an array thereof

Returns

boolean
Methods inherited from Serializable
serialize(), unserialize()
Arbiter API documentation generated by ApiGen 2.8.0