Référence de l'interface WorkflowModelInterface

Graphe d'héritage de WorkflowModelInterface:

Fonctions membres publiques
	setUpWorkflow ($extension)
	workflowPreprocessForm (Form $form, $data)
	workflowBeforeStageChange ()
	workflowBeforeSave ()
	workflowAfterSave ($data)
	workflowCleanupBatchMove ($oldId, $newId)
	executeTransition (array $pks, int $transitionId)
	getState ($property=null, $default=null)
	getName ()
	getTable ($name='', $prefix='', $options=array())

Description détaillée

Interface for a workflow model.

Depuis

4.0.0

Documentation des fonctions membres

executeTransition()

executeTransition	(	array	$pks,
		int	$transitionId
	)

Runs transition for item.

Paramètres

array	$pks	Id of items to execute the transition
integer	$transitionId	Id of transition

Renvoie

boolean

Depuis

4.0.0

getName()

getName

(

)

Method to get the model name

The model name. By default parsed using the classname or it can be set by passing a $config['name'] in the class constructor

Renvoie

string The name of the model

Depuis

4.0.0

Exceptions

getState()

getState	(		$property = null,
			$default = null
	)

Method to get state variables.

Paramètres

string	$property	Optional parameter name
mixed	$default	Optional default value

Renvoie

mixed The property where specified, the state object where omitted

Depuis

4.0.0

getTable()

getTable	(		$name = '',
			$prefix = '',
			$options = array()
	)

Method to get a table object, load it if necessary.

Paramètres

string	$name	The table name. Optional.
string	$prefix	The class prefix. Optional.
array	$options	Configuration array for model. Optional.

Renvoie

Table A Table object

Depuis

3.0

Exceptions

Implémenté dans FormModel, et FeatureModel.

setUpWorkflow()

setUpWorkflow

(

$extension

)

Set Up the workflow

Paramètres

string

$extension

The option and section separated by.

Renvoie

void

Depuis

4.0.0

workflowAfterSave()

workflowAfterSave

(

$data

)

Executing of relevant workflow methods

Renvoie

void

Depuis

4.0.0

workflowBeforeSave()

workflowBeforeSave

(

)

Preparation of workflow data/plugins

Renvoie

void

Depuis

4.0.0

workflowBeforeStageChange()

workflowBeforeStageChange

(

)

Let plugins access stage change events

Renvoie

void

Depuis

4.0.0

workflowCleanupBatchMove()

workflowCleanupBatchMove	(		$oldId,
			$newId
	)

Batch change workflow stage or current.

Paramètres

integer	$oldId	The ID of the item copied from
integer	$newId	The ID of the new item

Renvoie

null

Depuis

4.0.0

workflowPreprocessForm()

workflowPreprocessForm	(	Form	$form,
			$data
	)

Method to allow derived classes to preprocess the form.

Paramètres

Form	$form	A Form object.
mixed	$data	The data expected for the form.

Renvoie

void

Voir également

FormField

Depuis

4.0.0

Exceptions

---

La documentation de cette interface a été générée à partir du fichier suivant :

• WorkflowModelInterface.php