PHP Класс Authority\Rule

Authority is an authorization library for CodeIgniter 2+ and PHPActiveRecord This library is inspired by, and largely based off, Ryan Bates' CanCan gem for Ruby on Rails. It is not a 1:1 port, but the essentials are available. Please check out his work at http://github.com/ryanb/cancan/
См. ссылку: http://github.com/machuga
Автор: Matthew Machuga
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$action Action the rule applies to
$behavior True defines a privilege, false defines a restriction
$conditions Array of conditions (closures) to check rule against

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

Метод Описание
__construct ( boolean $behavior, string $action, string | mixed $resource, Closure | null $condition = null ) Rule constructor
addCondition ( Closure $condition ) : void Add a condition for the rule to check against
getAction ( ) : string Returns action this rule represents
getBehavior ( ) : boolean Returns whether rule is a privilege or a restriction
getResource ( ) : mixed Returns resource this rule represents
isAllowed ( ) : boolean Determine if current rule allows access
isPrivilege ( ) : boolean Determine if rule is a privilege
isRelevant ( string $action, string | mixed $resource ) : boolean Determine if current rule is relevant based on an action and resource
isRestriction ( ) : boolean Determine if rule is a restriction
matchesAction ( string $action ) : boolean Determine if the instance's action matches the one passed in
matchesResource ( string | mixed $resource ) : boolean Determine if the instance's resource matches the one passed in
setAction ( string $action ) : void Set instance action
setBehavior ( boolean $behavior ) : void Set instance behavior
setResource ( string | mixed $resource ) : void Set instance resource
when ( $condition ) : void API friendly alias for addCondition

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

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

Rule constructor
public __construct ( boolean $behavior, string $action, string | mixed $resource, Closure | null $condition = null )
$behavior boolean Determines if privilege or restriction
$action string Action the rule applies to
$resource string | mixed Name of resource or instance of object
$condition Closure | null Optional closure to act as a condition

addCondition() публичный метод

Add a condition for the rule to check against
public addCondition ( Closure $condition ) : void
$condition Closure Condition callback for rule to utilize
Результат void

getAction() публичный метод

Returns action this rule represents
public getAction ( ) : string
Результат string

getBehavior() публичный метод

Returns whether rule is a privilege or a restriction
public getBehavior ( ) : boolean
Результат boolean

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

Returns resource this rule represents
public getResource ( ) : mixed
Результат mixed

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

Determine if current rule allows access
public isAllowed ( ) : boolean
Результат boolean

isPrivilege() публичный метод

Determine if rule is a privilege
public isPrivilege ( ) : boolean
Результат boolean

isRelevant() публичный метод

Determine if current rule is relevant based on an action and resource
public isRelevant ( string $action, string | mixed $resource ) : boolean
$action string Action in question
$resource string | mixed Name of resource or instance of object
Результат boolean

isRestriction() публичный метод

Determine if rule is a restriction
public isRestriction ( ) : boolean
Результат boolean

matchesAction() публичный метод

Determine if the instance's action matches the one passed in
public matchesAction ( string $action ) : boolean
$action string Action in question
Результат boolean

matchesResource() публичный метод

Determine if the instance's resource matches the one passed in
public matchesResource ( string | mixed $resource ) : boolean
$resource string | mixed Name of resource or instance of object
Результат boolean

setAction() публичный метод

Set instance action
public setAction ( string $action ) : void
$action string Action for rule to use
Результат void

setBehavior() публичный метод

Set instance behavior
public setBehavior ( boolean $behavior ) : void
$behavior boolean True for privilege, false for restriction
Результат void

setResource() публичный метод

Set instance resource
public setResource ( string | mixed $resource ) : void
$resource string | mixed Set resource for rule to be checked against
Результат void

when() публичный метод

API friendly alias for addCondition
public when ( $condition ) : void
Результат void

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

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

Action the rule applies to
protected $action

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

True defines a privilege, false defines a restriction
protected $behavior

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

Array of conditions (closures) to check rule against
protected $conditions