PHP Класс Devise\Users\Permissions\RuleManager

Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$Framework Devise\Support\Framework Framework components being used from Laravel's framework
$RedirectHandler RedirectHandler RedirectHandler redirects user-defined permission conditions
$RuleList RuleList RuleList fetches list of rules

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

Метод Описание
__construct ( RedirectHandler $RedirectHandler, Framework $Framework ) Construct a new rule manager
addRule ( string $rule, callback $closure = null ) : Void Add new element to rules array
evaluateResults ( $results, boolean $redirectOnFail, object $conditionObject ) : boolean Determines if access allowed/denied by checking results array for any occurences of a "false" value
executeCondition ( object $conditionObject ) : array Executes conditions one at a time and returns result
getClosure ( string $method ) : Array Get all closures
getCondition ( string $conditionName ) : Void Retrieve conditions JSON from permission conditions config
getNumberOfRequiredParametersForRule ( $ruleName ) : integer Get all rules
getRules ( ) : Array Get all rules
overwriteRule ( string $rule, callback $closure = null ) : Void Add replaces element in rules array
runCondition ( string $conditionName, boolean $redirectOnFail, boolean $evaluateResults = true ) : Void Begins condition checking process by retrieving condition by name/key and then executing its contents.

Приватные методы

Метод Описание
parseCondition ( &$conditions, $parentOperator = null ) : Void Iterate thru conditions and determines if condition is true or false
ruleNameAvailable ( string $rule ) : boolean Checks rules array to see if rule/function name has already been used for rule

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

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

Construct a new rule manager
public __construct ( RedirectHandler $RedirectHandler, Framework $Framework )
$RedirectHandler RedirectHandler
$Framework Devise\Support\Framework

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

Add new element to rules array
public addRule ( string $rule, callback $closure = null ) : Void
$rule string
$closure callback
Результат Void

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

Determines if access allowed/denied by checking results array for any occurences of a "false" value
public evaluateResults ( $results, boolean $redirectOnFail, object $conditionObject ) : boolean
$redirectOnFail boolean
$conditionObject object
Результат boolean

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

Executes conditions one at a time and returns result
public executeCondition ( object $conditionObject ) : array
$conditionObject object
Результат array

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

Get all closures
public getClosure ( string $method ) : Array
$method string
Результат Array

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

Retrieve conditions JSON from permission conditions config
public getCondition ( string $conditionName ) : Void
$conditionName string
Результат Void

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

Get all rules
public getNumberOfRequiredParametersForRule ( $ruleName ) : integer
Результат integer

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

Get all rules
public getRules ( ) : Array
Результат Array

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

Add replaces element in rules array
public overwriteRule ( string $rule, callback $closure = null ) : Void
$rule string
$closure callback
Результат Void

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

Begins condition checking process by retrieving condition by name/key and then executing its contents.
public runCondition ( string $conditionName, boolean $redirectOnFail, boolean $evaluateResults = true ) : Void
$conditionName string
$redirectOnFail boolean
$evaluateResults boolean If false, evaluateResults() omitted
Результат Void

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

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

Framework components being used from Laravel's framework
protected Framework,Devise\Support $Framework
Результат Devise\Support\Framework

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

RedirectHandler redirects user-defined permission conditions
protected RedirectHandler,Devise\Users\Permissions $RedirectHandler
Результат RedirectHandler

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

RuleList fetches list of rules
protected RuleList,Devise\Users\Permissions $RuleList
Результат RuleList