WorkflowDefinition
extends BaseEntity
in package
WorkflowDefinition Entity
Blueprint/template for workflows. Each definition can have multiple versioned snapshots and running instances.
Table of Contents
Constants
- TRIGGER_API : mixed = 'api'
- TRIGGER_EVENT : mixed = 'event'
- TRIGGER_MANUAL : mixed = 'manual'
- TRIGGER_SCHEDULED : mixed = 'scheduled'
Properties
- $branch_id : int|null
- $created : DateTime|null
- $created_by : int|null
- $current_version : WorkflowVersion|null
- $current_version_id : int|null
- $deleted : DateTime|null
- $description : string|null
- $entity_type : string|null
- $id : int
- $is_active : bool
- $modified : DateTime|null
- $modified_by : int|null
- $name : string
- $slug : string
- $trigger_config : array<string|int, mixed>|null
- $trigger_type : string
- $workflow_instances : array<string|int, WorkflowInstance>
- $workflow_versions : array<string|int, WorkflowVersion>
- $_accessible : array<string, bool>
- Fields that can be mass assigned.
Methods
- getBranchId() : int|null
- Get the branch ID for authorization checks.
Constants
TRIGGER_API
public
mixed
TRIGGER_API
= 'api'
TRIGGER_EVENT
public
mixed
TRIGGER_EVENT
= 'event'
TRIGGER_MANUAL
public
mixed
TRIGGER_MANUAL
= 'manual'
TRIGGER_SCHEDULED
public
mixed
TRIGGER_SCHEDULED
= 'scheduled'
Properties
$branch_id
public
int|null
$branch_id
Associated branch ID (when applicable)
$created
public
DateTime|null
$created
$created_by
public
int|null
$created_by
$current_version
public
WorkflowVersion|null
$current_version
$current_version_id
public
int|null
$current_version_id
$deleted
public
DateTime|null
$deleted
$description
public
string|null
$description
$entity_type
public
string|null
$entity_type
$id
public
int
$id
$is_active
public
bool
$is_active
$modified
public
DateTime|null
$modified
$modified_by
public
int|null
$modified_by
$name
public
string
$name
$slug
public
string
$slug
$trigger_config
public
array<string|int, mixed>|null
$trigger_config
$trigger_type
public
string
$trigger_type
$workflow_instances
public
array<string|int, WorkflowInstance>
$workflow_instances
$workflow_versions
public
array<string|int, WorkflowVersion>
$workflow_versions
$_accessible
Fields that can be mass assigned.
protected
array<string, bool>
$_accessible
= ['name' => true, 'slug' => true, 'description' => true, 'trigger_type' => true, 'trigger_config' => true, 'entity_type' => true, 'is_active' => true, 'execution_mode' => true, 'current_version_id' => true, 'created_by' => true, 'modified_by' => true, 'deleted' => true]
Methods
getBranchId()
Get the branch ID for authorization checks.
public
getBranchId() : int|null
Child classes should override for complex branch relationships.
Return values
int|null —The branch ID, or null if no association