StructureAccessCheck extends Base
FinalYes
Table of Contents
Constants
- PREFILTER_KEY = 'ACCESS_CHECK'
- RULE_AND = 'AND'
- RULE_OR = 'OR'
Methods
- __construct() : mixed
- Constructor Controller.
- addRule() : self
- addRuleFromAttribute() : self
- bindAction() : mixed
- className() : string
- Returns the fully qualified name of this class.
- getAction() : Action
- getErrorByCode() : Error
- Getting once error with the necessary code.
- getErrors() : array<string|int, Error>
- Getting array of errors.
- listAllowedScopes() : array<string|int, mixed>
- List allowed values of scopes where the filter should work.
- onAfterAction() : mixed
- onBeforeAction() : EventResult|null
Constants
PREFILTER_KEY
public
mixed
PREFILTER_KEY
= 'ACCESS_CHECK'
RULE_AND
public
mixed
RULE_AND
= 'AND'
RULE_OR
public
mixed
RULE_OR
= 'OR'
Methods
__construct()
Constructor Controller.
public
__construct() : mixed
addRule()
public
addRule(string $accessPermission[, AccessibleItemType|null $itemType = null ][, string|null $itemIdRequestKey = null ][, string|null $itemParentIdRequestKey = null ]) : self
Parameters
- $accessPermission : string
- $itemType : AccessibleItemType|null = null
- $itemIdRequestKey : string|null = null
- $itemParentIdRequestKey : string|null = null
Return values
selfaddRuleFromAttribute()
public
addRuleFromAttribute(StructureActionAccess|LogicOr|LogicAnd $attribute) : self
Parameters
- $attribute : StructureActionAccess|LogicOr|LogicAnd
Return values
selfbindAction()
public
final bindAction(Action $action) : mixed
Parameters
- $action : Action
className()
Returns the fully qualified name of this class.
public
final static className() : string
Return values
stringgetAction()
public
final getAction() : Action
Return values
ActiongetErrorByCode()
Getting once error with the necessary code.
public
final getErrorByCode(string $code) : Error
Parameters
- $code : string
-
Code of error.
Return values
ErrorgetErrors()
Getting array of errors.
public
final getErrors() : array<string|int, Error>
Return values
array<string|int, Error>listAllowedScopes()
List allowed values of scopes where the filter should work.
public
listAllowedScopes() : array<string|int, mixed>
Return values
array<string|int, mixed>onAfterAction()
public
onAfterAction(Event $event) : mixed
Parameters
- $event : Event
onBeforeAction()
public
onBeforeAction(Event $event) : EventResult|null
Parameters
- $event : Event