Devise
Class

Devise\Users\Permissions\RuleManager

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
Array getClosure(string $method)

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

Add new element to 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.
boolean executeCondition(object $conditionObject)

Executes conditions one at a time and returns result
boolean evaluateResults($results, $redirectOnFail)

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

Details

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

Construct a new rule manager

Parameters

RedirectHandler $RedirectHandler
Framework $Framework

at line 51
public Array getRules()

Get all rules

Return Value

Array

at line 63
public Array getClosure(string $method)

Get all closures

Parameters

string $method

Return Value

Array

Exceptions

DeviseException

at line 80
public 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 97
public Void getCondition(string $conditionName)

Retrieve conditions JSON from permission conditions config

Parameters

string $conditionName

Return Value

Void

Exceptions

DeviseException

at line 115
public 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 129
public boolean executeCondition(object $conditionObject)

Executes conditions one at a time and returns result

Parameters

object $conditionObject

Return Value

boolean

at line 143
public boolean evaluateResults($results, $redirectOnFail)

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

Parameters

$results
$redirectOnFail

Return Value

boolean