Custom
extends Trigger
in package
Table of Contents
- $active : bool
- $dateCreated : DateTime
- $dateUpdated : DateTime
- $eventName : string
- $handle : string
- $id : int
- $name : string
- $senderClass : string
- $triggered : int
- $uid : string
- $_actions : array<string|int, mixed>
- $_conditions : array<string|int, mixed>
- __sleep() : mixed
- afterValidate() : mixed
- applyActions() : mixed
- Apply trigger conditions
- attributeLabels() : mixed
- checkConditions() : bool
- Check trigger conditions
- configTemplate() : string|null
- Get configuration template
- defineRules() : array<string|int, mixed>
- getActions() : array<string|int, mixed>
- Get actions
- getActiveActions() : array<string|int, mixed>
- Get active actions
- getActiveConditions() : array<string|int, mixed>
- Get active conditions
- getConditions() : array<string|int, mixed>
- Conditions getter
- getConfig() : array<string|int, mixed>
- Get project config
- getHandle() : string
- Handle getter
- getInstructions() : string
- Get instructions
- getTip() : string
- Get tip
- getType() : string
- Type getter
- hasConfig() : bool
- Does this trigger have config
- hasErrors() : mixed
- initialize() : mixed
- Initialize trigger
- populateFromData() : mixed
- Populate trigger from array of data
- setActions() : mixed
- Actions setter
- setConditions() : mixed
- Conditions setter
- setData() : mixed
- Data setter
- baseAttributes() : array<string|int, mixed>
- Get all base attributes, all attributes not in this array will be considered data
Properties
$active
public
bool
$active
= true
$dateCreated
public
DateTime
$dateCreated
$dateUpdated
public
DateTime
$dateUpdated
$eventName
public
string
$eventName
$handle
public
string
$handle
$id
public
int
$id
$name
public
string
$name
$senderClass
public
string
$senderClass
$triggered
public
int
$triggered
= 0
$uid
public
string
$uid
$_actions
protected
array<string|int, mixed>
$_actions
$_conditions
protected
array<string|int, mixed>
$_conditions
Methods
__sleep()
public
__sleep() : mixed
Tags
Return values
mixed —afterValidate()
public
afterValidate() : mixed
Tags
Return values
mixed —applyActions()
Apply trigger conditions
public
applyActions(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
Tags
Return values
mixed —attributeLabels()
public
attributeLabels() : mixed
Tags
Return values
mixed —checkConditions()
Check trigger conditions
public
checkConditions(array<string|int, mixed> $data) : bool
Parameters
- $data : array<string|int, mixed>
Tags
Return values
bool —configTemplate()
Get configuration template
public
configTemplate() : string|null
Tags
Return values
string|null —defineRules()
public
defineRules() : array<string|int, mixed>
Return values
array<string|int, mixed> —getActions()
Get actions
public
getActions() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getActiveActions()
Get active actions
public
getActiveActions() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getActiveConditions()
Get active conditions
public
getActiveConditions() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getConditions()
Conditions getter
public
getConditions() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getConfig()
Get project config
public
getConfig() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getHandle()
Handle getter
public
getHandle() : string
Tags
Return values
string —getInstructions()
Get instructions
public
getInstructions() : string
Tags
Return values
string —getTip()
Get tip
public
getTip() : string
Tags
Return values
string —getType()
Type getter
public
getType() : string
Tags
Return values
string —hasConfig()
Does this trigger have config
public
hasConfig() : bool
Tags
Return values
bool —hasErrors()
public
hasErrors([mixed $attribute = null ]) : mixed
Parameters
- $attribute : mixed = null
Tags
Return values
mixed —initialize()
Initialize trigger
public
initialize() : mixed
Tags
Return values
mixed —populateFromData()
Populate trigger from array of data
public
populateFromData(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
Tags
Return values
mixed —setActions()
Actions setter
public
setActions(array<string|int, mixed> $actions) : mixed
Parameters
- $actions : array<string|int, mixed>
Tags
Return values
mixed —setConditions()
Conditions setter
public
setConditions(array<string|int, mixed> $conditions) : mixed
Parameters
- $conditions : array<string|int, mixed>
Tags
Return values
mixed —setData()
Data setter
public
setData(mixed $data) : mixed
Parameters
- $data : mixed
Tags
Return values
mixed —baseAttributes()
Get all base attributes, all attributes not in this array will be considered data
protected
baseAttributes() : array<string|int, mixed>