WorkflowModelInterface
Interface for a workflow model.
| since |
4.0.0 |
|---|---|
| package |
Joomla CMS |
Methods
executeTransition
Runs transition for item.
executeTransition(mixed||string|int pks, transitionId) :
| since |
4.0.0 |
|---|
Arguments
- pks
array<string|int, mixed>Id of items to execute the transition- transitionId
intId of transition
Response
bool
getName
Method to get the model name
getName() :
The model name. By default parsed using the classname or it can be set by passing a $config['name'] in the class constructor
| since |
4.0.0 |
|---|---|
| throws |
|
Response
stringThe name of the model
getState
Method to get state variables.
getState( property = null, default = null) :
| since |
4.0.0 |
|---|
Arguments
- property
stringOptional parameter name- default
mixedOptional default value
Response
mixedThe property where specified, the state object where omitted
getTable
Method to get a table object, load it if necessary.
getTable( name = '', prefix = '', mixed||string|int options = []) : \Joomla\CMS\Table\Table
| since |
3.0 |
|---|---|
| throws |
|
Arguments
- name
stringThe table name. Optional.- prefix
stringThe class prefix. Optional.- options
array<string|int, mixed>Configuration array for model. Optional.
Response
TableA Table object
setUpWorkflow
Set Up the workflow
setUpWorkflow( extension) :
| since |
4.0.0 |
|---|
Arguments
- extension
stringThe option and section separated by.
Response
void
workflowAfterSave
Executing of relevant workflow methods
workflowAfterSave( data) :
| since |
4.0.0 |
|---|
Arguments
- data
mixed
Response
void
workflowBeforeSave
Preparation of workflow data/plugins
workflowBeforeSave() :
| since |
4.0.0 |
|---|
Response
void
workflowBeforeStageChange
Let plugins access stage change events
workflowBeforeStageChange() :
| since |
4.0.0 |
|---|
Response
void
workflowCleanupBatchMove
Batch change workflow stage or current.
workflowCleanupBatchMove( oldId, newId) :
| since |
4.0.0 |
|---|
Arguments
- oldId
intThe ID of the item copied from- newId
intThe ID of the new item
Response
null
workflowPreprocessForm
Method to allow derived classes to preprocess the form.
workflowPreprocessForm(\Joomla\CMS\Form\Form form, data) :
| see | FormField |
|---|---|
| since |
4.0.0 |
| throws |
|
Arguments
- form
FormA Form object.- data
mixedThe data expected for the form.
Response
void