Craft Triggers (2.x)

ActionInterface

Table of Contents

apply()  : mixed
Apply action
configTemplate()  : string|null
Get configuration template
getConfig()  : array<string|int, mixed>
Get project config
getDescription()  : string
Description getter
getHandle()  : string
Handle getter
getName()  : string
Type getter
getTrigger()  : TriggerInterface|null
Trigger getter
hasConfig()  : bool
Does this action have configuration
populateFromData()  : mixed
Populate action from array of data
setData()  : mixed
Data setter
setTrigger()  : mixed
Trigger setter

Methods

configTemplate()

Get configuration template

public configTemplate() : string|null
Return values
string|null

getConfig()

Get project config

public getConfig() : array<string|int, mixed>
Return values
array<string|int, mixed>

getDescription()

Description getter

public getDescription() : string
Return values
string

getHandle()

Handle getter

public getHandle() : string
Return values
string

getName()

Type getter

public getName() : string
Return values
string

hasConfig()

Does this action have configuration

public hasConfig() : bool
Return values
bool

populateFromData()

Populate action from array of data

public populateFromData(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>
Return values
mixed

setData()

Data setter

public setData(string|array<string|int, mixed>|null $data) : mixed
Parameters
$data : string|array<string|int, mixed>|null
Return values
mixed

Search results