\Pop\AclAcl

__construct()

__construct() 

Constructor

Instantiate the ACL object

getRole()

getRole(string  $role) : \Pop\Acl\AclRole

Get a role

Parameters

Returns

getRoles()

getRoles() : array

Get roles

Returns

hasRole()

hasRole(string  $role) : boolean

See if a role has been added

Parameters

Returns

addRole()

addRole(\Pop\Acl\AclRole  $role) : \Pop\Acl\Acl

Add a role

Parameters

Returns

addRoles()

addRoles(array  $roles) : \Pop\Acl\Acl

Add roles

Parameters

Returns

getResource()

getResource(string  $resource) : \Pop\Acl\AclResource

Get a resource

Parameters

Returns

hasResource()

hasResource(string  $resource) : boolean

See if a resource has been added

Parameters

Returns

addResource()

addResource(\Pop\Acl\AclResource  $resource) : \Pop\Acl\Acl

Add a resource

Parameters

Returns

getResources()

getResources() : array

Get resources

Returns

addResources()

addResources(array  $resources) : \Pop\Acl\Acl

Add resources

Parameters

Throws

\Pop\Acl\Exception

Returns

allow()

allow(mixed  $role, mixed  $resource = null, mixed  $permission = null, \Pop\Acl\Assertion\AssertionInterface  $assertion = null) : \Pop\Acl\Acl

Allow a user role permission to a resource or resources

Parameters

Throws

\Pop\Acl\Exception

Returns

removeAllowRule()

removeAllowRule(mixed  $role, mixed  $resource = null, mixed  $permission = null) : \Pop\Acl\Acl

Remove an allow rule

Parameters

Throws

\Pop\Acl\Exception

Returns

deny()

deny(mixed  $role, mixed  $resource = null, mixed  $permission = null, \Pop\Acl\Assertion\AssertionInterface  $assertion = null) : \Pop\Acl\Acl

Deny a user role permission to a resource or resources

Parameters

Throws

\Pop\Acl\Exception

Returns

removeDenyRule()

removeDenyRule(mixed  $role, mixed  $resource = null, mixed  $permission = null) : \Pop\Acl\Acl

Remove a deny rule

Parameters

Throws

\Pop\Acl\Exception

Returns

isAllowed()

isAllowed(mixed  $role, mixed  $resource = null, mixed  $permission = null) : boolean

Determine if the user is allowed

Parameters

Returns

isAllowedMany()

isAllowedMany(array  $roles, mixed  $resource = null, mixed  $permission = null) : boolean

Determine if a user that is assigned many roles is allowed If one of the roles is allowed, then the user will be allowed (return true)

Parameters

Throws

\Pop\Acl\Exception

Returns

isAllowedManyStrict()

isAllowedManyStrict(array  $roles, mixed  $resource = null, mixed  $permission = null) : boolean

Determine if a user that is assigned many roles is allowed All of the roles must be allowed to allow the user (return true)

Parameters

Returns

isDenied()

isDenied(mixed  $role, mixed  $resource = null, mixed  $permission = null) : boolean

Determine if the user is denied

Parameters

Throws

\Pop\Acl\Exception

Returns

isDeniedMany()

isDeniedMany(array  $roles, mixed  $resource = null, mixed  $permission = null) : boolean

Determine if a user that is assigned many roles is denied If one of the roles is denied, then the user will be denied (return true)

Parameters

Throws

\Pop\Acl\Exception

Returns

isDeniedManyStrict()

isDeniedManyStrict(array  $roles, mixed  $resource = null, mixed  $permission = null) : boolean

Determine if a user that is assigned many roles is denied All of the roles must be denied to deny the user (return true)

Parameters

Throws

\Pop\Acl\Exception

Returns

createAssertion()

createAssertion(\Pop\Acl\Assertion\AssertionInterface  $assertion, string  $type, mixed  $role, mixed  $resource = null, string  $permission = null) : void

Create assertion

Parameters

Throws

\InvalidArgumentException

deleteAssertion()

deleteAssertion(string  $type, mixed  $role, mixed  $resource = null, string  $permission = null) : void

Delete assertion

Parameters

hasAssertionKey()

hasAssertionKey(string  $type, mixed  $role, mixed  $resource = null, string  $permission = null) : boolean

Has assertion key

Parameters

Throws

\InvalidArgumentException

Returns

getAssertionKey()

getAssertionKey(string  $type, mixed  $role, mixed  $resource = null, string  $permission = null) : string

Get assertion key

Parameters

Throws

\InvalidArgumentException

Returns

addPolicy()

addPolicy(string  $method, mixed  $role, mixed  $resource = null) : \Pop\Acl\Acl

Add policy

Parameters

Returns

hasPolicies()

hasPolicies() : boolean

Has policies

Returns

evaluatePolicies()

evaluatePolicies(mixed  $role = null, mixed  $resource = null, mixed  $permission = null) : boolean|null

Evaluate policies

Parameters

Returns

evaluatePolicy()

evaluatePolicy(string  $method, mixed  $role, mixed  $resource = null) : boolean

Evaluate policy

Parameters

Throws

\Pop\Acl\Exception

Returns

verifyRole()

verifyRole(mixed  $role) : boolean

Verify role

Parameters

Throws

\Pop\Acl\Exception

Returns

verifyResource()

verifyResource(mixed  $resource) : boolean

Verify resource

Parameters

Throws

\Pop\Acl\Exception

Returns

generateAssertionKey()

generateAssertionKey(mixed  $role, mixed  $resource = null, string  $permission = null) : string

Generate assertion key

Parameters

Returns

traverseChildren()

traverseChildren(array  $roles) : void

Traverse child roles to add them to the ACL object

Parameters