Class Acl

Package: minPHP
Located at components/acl/acl.php

Methods summary

`public`	# `__construct( )` Initialize the ACL Initialize the ACL
`public boolean`	# `check( string $aro_alias, string $aco_alias, string $action = "*" )` Check whether the ARO is allowed access to the ACO Check whether the ARO is allowed access to the ACO Parameters `$aro_alias` `string` $aco_alias The alias of the ACO `$aco_alias` `string` $aro_alias The alias of the ARO `$action` `string` $action The action to verify on the ACO Returns `boolean` True if the ARO is allowed to access the ACO, else false
`public array`	# `getAccessList( string $aro_alias, string $aco_alias )` Fetches the Access List for the ARO on the given ACO Fetches the Access List for the ARO on the given ACO Parameters `$aro_alias` `string` $aco_alias The alias of the ACO `$aco_alias` `string` $aro_alias The alias of the ARO Returns `array` An array of ARO/ACO hierachy relationships
`public`	# `allow( string $aro_alias, string $aco_alias, string $action = "*" )` Record that the ARO has access to the ACO for the given action Record that the ARO has access to the ACO for the given action Parameters `$aro_alias` `string` $aco_alias The alias of the ACO `$aco_alias` `string` $aro_alias The alias of the ARO `$action` `string` $action The action to allow
`public`	# `deny( string $aro_alias, string $aco_alias, string $action = "*" )` Record that the ARO does not have access to the ACO for the given action Record that the ARO does not have access to the ACO for the given action Parameters `$aro_alias` `string` $aco_alias The alias of the ACO `$aco_alias` `string` $aro_alias The alias of the ARO `$action` `string` $action The action to deny
`public integer`	# `addAro( string $alias, mixed $parent = null )` Add a new ARO as a child to the given parent Add a new ARO as a child to the given parent Parameters `$alias` `string` $alias The alias of the ARO `$parent` `mixed` $parent The parent of this ARO, either the int ID, or a string alias of the parent ARO Returns `integer` The ID of the ARO added
`public`	# `removeAro( string $alias )` Removes the ARO from the ARO and ACL Removes the ARO from the ARO and ACL Parameters `$alias` `string` $alias The Alias of the ARO
`public integer`	# `addAco( string $alias )` Add a new ACO Add a new ACO Parameters `$alias` `string` $alias The alias of the ACO Returns `integer` The ID of the ACO added
`public`	# `removeAco( string $alias )` Removes the ACO from the ACO and ACL Removes the ACO from the ACO and ACL Parameters `$alias` `string` $alias The Alias of the ACO
`public`	# `removeAcl( string $aro_alias = null, string $aco_alias = null, string $action = null )` Removes an entry from the ACL that matches the given ARO, ACO, and action Removes an entry from the ACL that matches the given ARO, ACO, and action Parameters `$aro_alias` `string` $aro_alias The ARO alias `$aco_alias` `string` $aco_alias The ACO alias `$action` `string` $action The action
`private mixed`	# `getAroAcoByAlias( string $aro_alias, string $aco_alias )` Retrieve the ARO and ACO using the given ARO and ACO aliases Retrieve the ARO and ACO using the given ARO and ACO aliases Parameters `$aro_alias` `string` $aro_alias The ARO alias `$aco_alias` `string` $aco_alias The ACO alias Returns `mixed` An array of the ARO/ACO combo, false otherwise
`public mixed`	# `getAroByAlias( string $alias )` Retrieve the ARO with the given alias Retrieve the ARO with the given alias Parameters `$alias` `string` $alias The alias of the ARO Returns `mixed` An array containing the ARO, false if no match found
`public mixed`	# `getAcoByAlias( string $alias )` Retrieve the ACO with the given alias Retrieve the ACO with the given alias Parameters `$alias` `string` $alias The alias of the ACO Returns `mixed` An array containing the ACO, false if no match found
`private`	# `addAcl( integer $aro_id, integer $aco_id, string $action, string $permission )` Record the given ARO and ACO IDs for the action and permission given Record the given ARO and ACO IDs for the action and permission given Parameters `$aro_id` `integer` $aro_id The ARO ID `$aco_id` `integer` $aco_id The ACO ID `$action` `string` $action The action to allow or deny `$permission` `string` $permission "allow" or "deny"

Magic methods summary