Documentation

VTWorkflowManager
in package

Table of Contents

$BLOCK_EDIT  : int
Block edit.
$MANUAL  : int
Manual.
$ON_DELETE  : int
On delete.
$ON_EVERY_SAVE  : int
On every save.
$ON_FIRST_SAVE  : int
On first save.
$ON_MODIFY  : int
On modify.
$ON_RELATED  : int
On related.
$ON_SCHEDULE  : int
On schedule.
$ONCE  : int
Once.
$TRIGGER  : int
Trigger.
delete()  : mixed
Delete workflow.
getScheduledWorkflows()  : Workflow
Function returns scheduled workflows.
getWorkflows()  : array<string|int, Workflow>
Return workflows.
getWorkflowsForModule()  : array<string|int, Workflow>
Return workflows for module.
newWorkflow()  : Workflow
Create new workflow in module.
retrieve()  : A
Retrieve a workflow from the database.
save()  : mixed
Save workflow data.
updateNexTriggerTime()  : mixed
Update the Next trigger timestamp for a workflow.
getWorkflowInstance()  : workflowClass
Return workflow instance.
getWorkflowsForResult()  : array<string|int, Workflow>
Return workflows for provided rows.

Properties

Methods

delete()

Delete workflow.

public delete(int $id) : mixed
Parameters
$id : int
Return values
mixed

getScheduledWorkflows()

Function returns scheduled workflows.

public getScheduledWorkflows([DateTime $referenceTime = false ]) : Workflow
Parameters
$referenceTime : DateTime = false
Return values
Workflow

getWorkflowsForModule()

Return workflows for module.

public getWorkflowsForModule(string $moduleName[, string $executionCondition = false ]) : array<string|int, Workflow>
Parameters
$moduleName : string
$executionCondition : string = false
Return values
array<string|int, Workflow>

retrieve()

Retrieve a workflow from the database.

public retrieve(mixed $id) : A

Returns null if the workflow doesn't exist.

Parameters
$id : mixed
Return values
A

workflow object

updateNexTriggerTime()

Update the Next trigger timestamp for a workflow.

public updateNexTriggerTime(Workflow $workflow) : mixed
Parameters
$workflow : Workflow
Return values
mixed

getWorkflowInstance()

Return workflow instance.

protected getWorkflowInstance([string $type = 'basic' ]) : workflowClass
Parameters
$type : string = 'basic'
Return values
workflowClass

getWorkflowsForResult()

Return workflows for provided rows.

protected getWorkflowsForResult(array<string|int, mixed> $rows) : array<string|int, Workflow>
Parameters
$rows : array<string|int, mixed>
Return values
array<string|int, Workflow>

        

Search results