PHP Class Pop\Auth\Acl

Author: Nick Sagona, III ([email protected])
Exibir arquivo Open project: nicksagona/PopPHP Class Usage Examples

Protected Properties

Property Type Description
$allowed array Array of allowed roles, resources and permissions
$denied array Array of denied roles, resources and permissions
$resources array Array of resources
$roles array Array of roles

Public Methods

Method Description
__construct ( mixed $roles = null, mixed $resources = null ) : Acl Constructor
addResource ( mixed $resource ) : Acl Method to add a resource
addResources ( mixed $resources ) : Acl Method to add a resource
addRole ( mixed $role ) : Acl Method to add a role
addRoles ( mixed $roles ) : Acl Method to add roles
allow ( mixed $roles, mixed $resources = null, mixed $permissions = null ) : Acl Method to allow a user role permission to a resource or resources
deny ( mixed $roles, mixed $resources = null, mixed $permissions = null ) : Acl Method to deny a user role permission to a resource or resources
factory ( mixed $roles = null, mixed $resources = null ) : Acl Static method to instantiate the ACL object and return itself to facilitate chaining methods together.
getResource ( string $resource ) : Resource Method to get a resource
getRole ( string $role ) : Role Method to get a role
hasResource ( string $resource ) : boolean Method to is if a resource has been added
hasRole ( string $role ) : boolean Method to is if a role has been added
isAllowed ( Role $user, string $resource = null, string $permission = null ) : boolean Method to determine if the user is allowed
isDenied ( Role $user, string $resource = null, string $permission = null ) : boolean Method to determine if the user is denied
removeAllow ( mixed $roles, mixed $resources = null, mixed $permissions = null ) : Acl Method to remove an allow rule
removeDeny ( mixed $roles, mixed $resources = null, mixed $permissions = null ) : Acl Method to remove a deny rule

Method Details

__construct() public method

Instantiate the auth object
public __construct ( mixed $roles = null, mixed $resources = null ) : Acl
$roles mixed
$resources mixed
return Acl

addResource() public method

Method to add a resource
public addResource ( mixed $resource ) : Acl
$resource mixed
return Acl

addResources() public method

Method to add a resource
public addResources ( mixed $resources ) : Acl
$resources mixed
return Acl

addRole() public method

Method to add a role
public addRole ( mixed $role ) : Acl
$role mixed
return Acl

addRoles() public method

Method to add roles
public addRoles ( mixed $roles ) : Acl
$roles mixed
return Acl

allow() public method

Method to allow a user role permission to a resource or resources
public allow ( mixed $roles, mixed $resources = null, mixed $permissions = null ) : Acl
$roles mixed
$resources mixed
$permissions mixed
return Acl

deny() public method

Method to deny a user role permission to a resource or resources
public deny ( mixed $roles, mixed $resources = null, mixed $permissions = null ) : Acl
$roles mixed
$resources mixed
$permissions mixed
return Acl

factory() public static method

Static method to instantiate the ACL object and return itself to facilitate chaining methods together.
public static factory ( mixed $roles = null, mixed $resources = null ) : Acl
$roles mixed
$resources mixed
return Acl

getResource() public method

Method to get a resource
public getResource ( string $resource ) : Resource
$resource string
return Resource

getRole() public method

Method to get a role
public getRole ( string $role ) : Role
$role string
return Role

hasResource() public method

Method to is if a resource has been added
public hasResource ( string $resource ) : boolean
$resource string
return boolean

hasRole() public method

Method to is if a role has been added
public hasRole ( string $role ) : boolean
$role string
return boolean

isAllowed() public method

Method to determine if the user is allowed
public isAllowed ( Role $user, string $resource = null, string $permission = null ) : boolean
$user Role
$resource string
$permission string
return boolean

isDenied() public method

Method to determine if the user is denied
public isDenied ( Role $user, string $resource = null, string $permission = null ) : boolean
$user Role
$resource string
$permission string
return boolean

removeAllow() public method

Method to remove an allow rule
public removeAllow ( mixed $roles, mixed $resources = null, mixed $permissions = null ) : Acl
$roles mixed
$resources mixed
$permissions mixed
return Acl

removeDeny() public method

Method to remove a deny rule
public removeDeny ( mixed $roles, mixed $resources = null, mixed $permissions = null ) : Acl
$roles mixed
$resources mixed
$permissions mixed
return Acl

Property Details

$allowed protected_oe property

Array of allowed roles, resources and permissions
protected array $allowed
return array

$denied protected_oe property

Array of denied roles, resources and permissions
protected array $denied
return array

$resources protected_oe property

Array of resources
protected array $resources
return array

$roles protected_oe property

Array of roles
protected array $roles
return array