WorkflowServiceInterface
The workflow service.
since |
4.0.0 |
---|---|
package |
Joomla CMS |
Methods
filterTransitions
Method to filter transitions by given id of state.
filterTransitions(int||string|int transitions, pk) : mixed||string|int
since |
4.0.0 |
---|
Arguments
- transitions
array<string|int, int>
Array of transitions to filter for- pk
int
Id of the state on which the transitions are performed
Response
array<string|int, mixed>
getCategoryWorkflowContext
Returns the workflow context based on the given category section
getCategoryWorkflowContext( section = null) : string|null
since |
4.0.0 |
---|
Arguments
- section
string
The section
Response
string|null
getConditions
Returns an array of possible conditions for the component.
getConditions( extension) : mixed||string|int
since |
4.0.0 |
---|
Arguments
- extension
string
Full extension string
Response
array<string|int, mixed>
getModelName
Returns the model name, based on the context
getModelName( context) :
Arguments
- context
string
The context of the workflow
Response
bool
getWorkflowContexts
Returns valid contexts.
getWorkflowContexts() : mixed||string|int
since |
4.0.0 |
---|
Response
array<string|int, mixed>
getWorkflowTableBySection
Returns a table name for the state association
getWorkflowTableBySection( section = null) :
since |
4.0.0 |
---|
Arguments
- section
string
An optional section to differ different areas in the component
Response
string
isWorkflowActive
Check if the workflow is active
isWorkflowActive( context) :
Arguments
- context
string
The context of the workflow
Response
bool
supportFunctionality
Check if the functionality is supported by the context
supportFunctionality( functionality, context) :
since |
4.0.0 |
---|
Arguments
- functionality
string
The functionality- context
string
The context of the functionality
Response
bool