Workflow

Workflow 类。

4.0.0

Joomla CMS

方法

__construct

类构造函数

__construct( extension, \Joomla\CMS\Application\CMSApplication app = null, \Joomla\Database\DatabaseDriver db = null) : 

4.0.0

参数

extension

string扩展名

app

CMSApplication|null应用程序对象

db

DatabaseDriver|null数据库驱动程序对象

响应

混合

createAssociation

为 workflow_associations 表创建关联

createAssociation( pk,  state) : 

4.0.0

参数

pk

int项目的 ID

state

int状态的 ID

响应

bool

deleteAssociation

从 workflow_associations 表中删除关联

deleteAssociation(int||string|int pks) : 

4.0.0

参数

pks

array<string|int, int>内容的 ID

响应

bool

executeTransition

执行转换以更改关联表中的当前状态

executeTransition(int||string|int pks,  transitionId) : 

参数

pks

array<string|int, int>应使用转换的项目 ID

transitionId

int应执行的转换

响应

bool

getAssociation

加载具有状态和项目 ID 的现有关联项目

getAssociation( itemId) : \stdClass|null

4.0.0

参数

itemId

int要加载的项目 ID

响应

stdClass|null

getComponent

返回启动的组件

getComponent() : \Joomla\CMS\Extension\ComponentInterface

4.0.0

响应

ComponentInterface

getConditionName

返回基于给定数字的翻译后的条件名称

getConditionName( value) : 

4.0.0

参数

value

int条件 ID

响应

string

getDefaultStageByCategory

尝试根据类别 ID 加载工作流默认阶段。

getDefaultStageByCategory( catId) : bool|int

4.0.0

参数

catId

int类别 ID。

响应

bool|int一个整数,保存阶段 ID 或 false

getValidTransition

检查是否可以执行转换

getValidTransition(int||string|int pks,  transitionId) : object|null

参数

pks

array<string|int, int>应使用转换的项目 ID

transitionId

int应执行的转换

响应

object|null

updateAssociations

使用新状态更新现有关联

updateAssociations(mixed||string|int pks,  state) : 

4.0.0

参数

pks

array<string|int, mixed>应更改的项目 ID 数组

state

int新的状态 ID

响应

bool

常量

CONDITION_NAMES

条件到名称的映射

[self::CONDITION_PUBLISHED => 'JPUBLISHED', self::CONDITION_UNPUBLISHED => 'JUNPUBLISHED', self::CONDITION_TRASHED => 'JTRASHED', self::CONDITION_ARCHIVED => 'JARCHIVED']

4.0.0

CONDITION_PUBLISHED

每个具有具有 PUBLISHED 条件的状态的项目在页面上可见/活动

1

CONDITION_UNPUBLISHED

每个具有具有 UNPUBLISHED 条件的状态的项目在页面上不可见/不活动

0

CONDITION_TRASHED

每个具有具有 TRASHED 条件的状态的项目都被废弃

-2

CONDITION_ARCHIVED

每个具有具有 ARCHIVED 条件的状态的项目都被归档

2

属性

component

启动的组件

extension

工作流所属的扩展名称

4.0.0

类型

string

app

应用程序对象

4.0.0

类型

CMSApplication

db

数据库驱动程序

4.0.0

类型

DatabaseDriver