WorkflowDefinitionsTable
extends BaseTable
in package
WorkflowDefinitions Model
Table of Contents
Constants
- CACHE_GROUPS_TO_CLEAR : array<string|int, string> = []
- CACHES_TO_CLEAR : array<string|int, array{string, string}> = []
- ID_CACHES_TO_CLEAR : array<string|int, array{string, string}> = []
Properties
- $CurrentVersion : WorkflowVersionsTable|BelongsTo
- $WorkflowInstances : WorkflowInstancesTable|HasMany
- $WorkflowVersions : WorkflowVersionsTable|HasMany
Methods
- addBranchScopeQuery() : SelectQuery
- Add branch-based data scoping to a query.
- afterDelete() : void
- After delete hook to capture impersonation audit trail entries.
- afterSave() : void
- After-save handler for automatic cache invalidation.
- archiveDefinition() : bool
- Archive a workflow definition while preserving versions and run history.
- buildRules() : RulesChecker
- Build rules for referential integrity.
- deleteUnusedDefinition() : bool
- Delete an unused workflow definition.
- hasExecutionHistory() : bool
- Check whether a workflow definition has execution history.
- initialize() : void
- Initialize method.
- newEmptyEntity() : WorkflowDefinition
- newEntity() : WorkflowDefinition
- patchEntity() : WorkflowDefinition
- validationDefault() : Validator
- Default validation rules.
- logImpersonationAction() : void
- Record impersonated writes to audit log table.
- setJsonColumnTypesIfPresent() : void
- Mark JSON columns when the table schema is available.
Constants
CACHE_GROUPS_TO_CLEAR
protected
array<string|int, string>
CACHE_GROUPS_TO_CLEAR
= []
Cache groups to clear entirely on save
CACHES_TO_CLEAR
protected
array<string|int, array{string, string}>
CACHES_TO_CLEAR
= []
Static cache entries to clear on save
ID_CACHES_TO_CLEAR
protected
array<string|int, array{string, string}>
ID_CACHES_TO_CLEAR
= []
Entity-ID cache prefixes to clear on save
Properties
$CurrentVersion
public
WorkflowVersionsTable|BelongsTo
$CurrentVersion
$WorkflowInstances
public
WorkflowInstancesTable|HasMany
$WorkflowInstances
$WorkflowVersions
public
WorkflowVersionsTable|HasMany
$WorkflowVersions
Methods
addBranchScopeQuery()
Add branch-based data scoping to a query.
public
addBranchScopeQuery(SelectQuery $query, array<string|int, int> $branchIDs) : SelectQuery
Child tables should override for custom branch relationships.
Parameters
- $query : SelectQuery
-
The query to modify
- $branchIDs : array<string|int, int>
-
Authorized branch IDs
Return values
SelectQuery —Query with branch filtering
afterDelete()
After delete hook to capture impersonation audit trail entries.
public
afterDelete(EventInterface $event, EntityInterface $entity, ArrayObject $options) : void
Parameters
- $event : EventInterface
-
Delete event
- $entity : EntityInterface
-
Entity being deleted
- $options : ArrayObject
-
Delete options
afterSave()
After-save handler for automatic cache invalidation.
public
afterSave(EventInterface $event, EntityInterface $entity, ArrayObject $options) : void
Parameters
- $event : EventInterface
-
The afterSave event
- $entity : EntityInterface
-
The saved entity
- $options : ArrayObject
-
Save options
archiveDefinition()
Archive a workflow definition while preserving versions and run history.
public
archiveDefinition(WorkflowDefinition $workflow) : bool
Parameters
- $workflow : WorkflowDefinition
-
Workflow definition
Return values
boolbuildRules()
Build rules for referential integrity.
public
buildRules(RulesChecker $rules) : RulesChecker
Parameters
- $rules : RulesChecker
Return values
RulesCheckerdeleteUnusedDefinition()
Delete an unused workflow definition.
public
deleteUnusedDefinition(WorkflowDefinition $workflow) : bool
Parameters
- $workflow : WorkflowDefinition
-
Workflow definition
Return values
boolhasExecutionHistory()
Check whether a workflow definition has execution history.
public
hasExecutionHistory(int $id) : bool
Parameters
- $id : int
-
Workflow definition ID
Return values
boolinitialize()
Initialize method.
public
initialize(array<string|int, mixed> $config) : void
Parameters
- $config : array<string|int, mixed>
newEmptyEntity()
public
newEmptyEntity() : WorkflowDefinition
Return values
WorkflowDefinitionnewEntity()
public
newEntity(array<string|int, mixed> $data[, array<string|int, mixed> $options = = '[]' ]) : WorkflowDefinition
Parameters
- $data : array<string|int, mixed>
- $options : array<string|int, mixed> = = '[]'
Return values
WorkflowDefinitionpatchEntity()
public
patchEntity(EntityInterface $entity, array<string|int, mixed> $data[, array<string|int, mixed> $options = = '[]' ]) : WorkflowDefinition
Parameters
- $entity : EntityInterface
- $data : array<string|int, mixed>
- $options : array<string|int, mixed> = = '[]'
Return values
WorkflowDefinitionvalidationDefault()
Default validation rules.
public
validationDefault(Validator $validator) : Validator
Parameters
- $validator : Validator
Return values
ValidatorlogImpersonationAction()
Record impersonated writes to audit log table.
protected
logImpersonationAction(string $defaultOperation, EntityInterface $entity) : void
Parameters
- $defaultOperation : string
-
Operation fallback (save/delete)
- $entity : EntityInterface
-
Affected entity
setJsonColumnTypesIfPresent()
Mark JSON columns when the table schema is available.
protected
setJsonColumnTypesIfPresent(array<int, string> $columns) : void
Some reset/migration flows instantiate table classes before every table exists. JSON type mapping is optional metadata, so skip it until the schema can be described instead of failing application bootstrap.
Parameters
- $columns : array<int, string>
-
JSON column names.