PHP Класс Pop\Auth\Acl

Автор: Nick Sagona, III ([email protected])
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$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

Открытые методы

Метод Описание
__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

Описание методов

__construct() публичный Метод

Instantiate the auth object
public __construct ( mixed $roles = null, mixed $resources = null ) : Acl
$roles mixed
$resources mixed
Результат Acl

addResource() публичный Метод

Method to add a resource
public addResource ( mixed $resource ) : Acl
$resource mixed
Результат Acl

addResources() публичный Метод

Method to add a resource
public addResources ( mixed $resources ) : Acl
$resources mixed
Результат Acl

addRole() публичный Метод

Method to add a role
public addRole ( mixed $role ) : Acl
$role mixed
Результат Acl

addRoles() публичный Метод

Method to add roles
public addRoles ( mixed $roles ) : Acl
$roles mixed
Результат Acl

allow() публичный Метод

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
Результат Acl

deny() публичный Метод

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
Результат Acl

factory() публичный статический Метод

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
Результат Acl

getResource() публичный Метод

Method to get a resource
public getResource ( string $resource ) : Resource
$resource string
Результат Resource

getRole() публичный Метод

Method to get a role
public getRole ( string $role ) : Role
$role string
Результат Role

hasResource() публичный Метод

Method to is if a resource has been added
public hasResource ( string $resource ) : boolean
$resource string
Результат boolean

hasRole() публичный Метод

Method to is if a role has been added
public hasRole ( string $role ) : boolean
$role string
Результат boolean

isAllowed() публичный Метод

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
Результат boolean

isDenied() публичный Метод

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
Результат boolean

removeAllow() публичный Метод

Method to remove an allow rule
public removeAllow ( mixed $roles, mixed $resources = null, mixed $permissions = null ) : Acl
$roles mixed
$resources mixed
$permissions mixed
Результат Acl

removeDeny() публичный Метод

Method to remove a deny rule
public removeDeny ( mixed $roles, mixed $resources = null, mixed $permissions = null ) : Acl
$roles mixed
$resources mixed
$permissions mixed
Результат Acl

Описание свойств

$allowed защищенное свойство

Array of allowed roles, resources and permissions
protected array $allowed
Результат array

$denied защищенное свойство

Array of denied roles, resources and permissions
protected array $denied
Результат array

$resources защищенное свойство

Array of resources
protected array $resources
Результат array

$roles защищенное свойство

Array of roles
protected array $roles
Результат array