Factory
Table of Contents
Methods
- canUseAutomation() : bool
- createTarget() : Base
- Create Target instance by entity type.
- getAvailableTriggers() : array<string|int, mixed>
- getTriggerByCode() : bool|Base
- isAutomationEnabled() : bool
- runOnAdd() : mixed
- runOnStatusChanged() : mixed
- stopAutomation() : mixed
Methods
canUseAutomation()
public
static canUseAutomation() : bool
Return values
boolcreateTarget()
Create Target instance by entity type.
public
static createTarget(mixed $documentType[, int|null $documentId = null ]) : Base
Parameters
- $documentType : mixed
-
Document type id.
- $documentId : int|null = null
-
Document id.
Tags
Return values
Base —Target instance, child of BaseTarget.
getAvailableTriggers()
public
static getAvailableTriggers(int $documentType) : array<string|int, mixed>
Parameters
- $documentType : int
-
Document type id.
Return values
array<string|int, mixed>getTriggerByCode()
public
static getTriggerByCode(mixed $code) : bool|Base
Parameters
- $code : mixed
-
- Trigger string code.
Return values
bool|Base —Trigger class name or false.
isAutomationEnabled()
public
static isAutomationEnabled() : bool
Return values
boolrunOnAdd()
public
static runOnAdd(mixed $documentType, mixed $documentId[, array<string|int, mixed> $fields = null ]) : mixed
Parameters
- $documentType : mixed
- $documentId : mixed
- $fields : array<string|int, mixed> = null
runOnStatusChanged()
public
static runOnStatusChanged(mixed $documentType, mixed $documentId[, array<string|int, mixed> $fields = null ]) : mixed
Parameters
- $documentType : mixed
- $documentId : mixed
- $fields : array<string|int, mixed> = null
stopAutomation()
public
static stopAutomation(mixed $documentType, mixed $documentId) : mixed
Parameters
- $documentType : mixed
- $documentId : mixed