class RuleManager

Class RuleManager manages retrieval, creation/addition, execution and evaluation of native and user-defined rules.

Methods

__construct(RedirectHandler $RedirectHandler, Framework $Framework)

Construct a new rule manager

Array
getRules()

Get all rules

Integer
getNumberOfRequiredParametersForRule($ruleName)

Get all rules

Array
getClosure(string $method)

Get all closures

Void
addRule(string $rule, callback $closure = null)

Add new element to rules array

Void
overwriteRule(string $rule, callback $closure = null)

Add replaces element in rules array

Void
getCondition(string $conditionName)

Retrieve conditions JSON from permission conditions config

Void
runCondition(string $conditionName, boolean $redirectOnFail, boolean $evaluateResults = true)

Begins condition checking process by retrieving condition by name/key and then executing its contents.

array
executeCondition(object $conditionObject)

Executes conditions one at a time and returns result

boolean
evaluateResults($results, $redirectOnFail, $conditionObject)

Determines if access allowed/denied by checking results array for any occurences of a "false" value

Details

at line 38
__construct(RedirectHandler $RedirectHandler, Framework $Framework)

Construct a new rule manager

Parameters

RedirectHandler $RedirectHandler
Framework $Framework

at line 51
Array getRules()

Get all rules

Return Value

Array

at line 61
Integer getNumberOfRequiredParametersForRule($ruleName)

Get all rules

Parameters

$ruleName

Return Value

Integer

at line 83
Array getClosure(string $method)

Get all closures

Parameters

string $method

Return Value

Array

Exceptions

DeviseException

at line 100
Void addRule(string $rule, callback $closure = null)

Add new element to rules array

Parameters

string $rule
callback $closure

Return Value

Void

Exceptions

DeviseException

at line 118
Void overwriteRule(string $rule, callback $closure = null)

Add replaces element in rules array

Parameters

string $rule
callback $closure

Return Value

Void

Exceptions

DeviseException

at line 135
Void getCondition(string $conditionName)

Retrieve conditions JSON from permission conditions config

Parameters

string $conditionName

Return Value

Void

Exceptions

DeviseException

at line 154
Void runCondition(string $conditionName, boolean $redirectOnFail, boolean $evaluateResults = true)

Begins condition checking process by retrieving condition by name/key and then executing its contents.

Parameters

string $conditionName
boolean $redirectOnFail
boolean $evaluateResults If false, evaluateResults() omitted

Return Value

Void

at line 169
array executeCondition(object $conditionObject)

Executes conditions one at a time and returns result

Parameters

object $conditionObject

Return Value

array

at line 183
boolean evaluateResults($results, $redirectOnFail, $conditionObject)

Determines if access allowed/denied by checking results array for any occurences of a "false" value

Parameters

$results
$redirectOnFail
$conditionObject

Return Value

boolean