WorkflowBehaviorTrait
支持状态行为的 Trait
| 自 |
4.0.0 |
|---|---|
| 包 |
Joomla CMS |
方法
addTransitionField
向表单添加转换字段。如果不需要，子类可以覆盖它。
addTransitionField(\Joomla\CMS\Form\Form form, data) :
batchWorkflowStage
批量更改工作流阶段或当前阶段。
batchWorkflowStage( value, mixed||string|int pks, mixed||string|int contexts) :
| 自 |
4.0.0 |
|---|
参数
- value
int工作流阶段 ID。- pks
array<string|int, mixed>行 ID 数组。- contexts
array<string|int, mixed>项目上下文数组。
返回值
mixed成功时返回新 ID 数组，失败时返回布尔值 false。
enableWorkflowBatch
将工作流批处理添加到命令列表中。子类可以覆盖它。
enableWorkflowBatch() :
| 自 |
4.0.0 |
|---|
返回值
void
executeTransition
为项目运行转换。
executeTransition(mixed||string|int pks, transitionId) :
| 自 |
4.0.0 |
|---|
参数
- pks
array<string|int, mixed>要执行转换的项目的 ID- transitionId
int转换 ID
返回值
bool
getStageForNewItem
尝试为新创建的项目加载工作流阶段，这些项目尚未分配工作流。如果类别不是承载者，请在您的模型中覆盖它并提供您自己的承载者。
getStageForNewItem(\Joomla\CMS\Form\Form form, data) : bool|int
importWorkflowPlugins
导入工作流插件。
importWorkflowPlugins() :
返回值
void
setUpWorkflow
设置工作流
setUpWorkflow( extension) :
| 自 |
4.0.0 |
|---|
参数
- extension
string选项和部分，用点分隔。
返回值
void
workflowAfterSave
执行相关工作流方法
workflowAfterSave( data) :
| 自 |
4.0.0 |
|---|
参数
- data
mixed
返回值
void
workflowBeforeSave
工作流数据/插件的准备
workflowBeforeSave() :
| 自 |
4.0.0 |
|---|
返回值
void
workflowBeforeStageChange
允许插件访问阶段更改事件
workflowBeforeStageChange() :
| 自 |
4.0.0 |
|---|
返回值
void
workflowCleanupBatchMove
批量更改工作流阶段或当前阶段。
workflowCleanupBatchMove( oldId, newId) :
| 自 |
4.0.0 |
|---|
参数
- oldId
int复制自的项目的 ID- newId
int新项目的 ID
返回值
null
workflowPreprocessForm
允许派生类预处理表单的方法。
workflowPreprocessForm(\Joomla\CMS\Form\Form form, data) :
属性
extension
组件的名称。
| 自 |
4.0.0 |
|---|
类型
string
section
组件的部分。
| 自 |
4.0.0 |
|---|
类型
string
workflowEnabled
此组件是否启用了工作流？
| 自 |
4.0.0 |
|---|
类型
bool