Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class WorkflowModelInterface - list of methods

Interface for a workflow model.
Package: Joomla\CMS\MVC\Model
Copyright: (C) 2020 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/MVC/Model/WorkflowModelInterface.php
Project: Joomla

Method Summary

public void
(mixed $extension)

Set Up the workflow
Parameters
  • string $extension The option and section separated by.
Returns
  • void
Since
  • 4.0.0
Show source code of this method: setUpWorkflow Source Code

public void
(\Joomla\CMS\Form\Form $form, mixed $data)

Method to allow derived classes to preprocess the form.
Parameters
  • \Joomla\CMS\Form\Form $form A Form object.
  • mixed $data The data expected for the form.
Returns
  • void
Since
  • 4.0.0
-
  • \Joomla\CMS\MVC\Model\FormField
  • \Exception if there is an error in the form event.
Show source code of this method: workflowPreprocessForm Source Code

public void
()

Let plugins access stage change events
Returns
  • void
Since
  • 4.0.0
Show source code of this method: workflowBeforeStageChange Source Code

public void
()

Preparation of workflow data/plugins
Returns
  • void
Since
  • 4.0.0
Show source code of this method: workflowBeforeSave Source Code

public void
(mixed $data)

Executing of relevant workflow methods
Returns
  • void
Since
  • 4.0.0
Show source code of this method: workflowAfterSave Source Code

public null
(mixed $oldId, mixed $newId)

Batch change workflow stage or current.
Parameters
  • int $oldId The ID of the item copied from
  • int $newId The ID of the new item
Returns
  • null
Since
  • 4.0.0
Show source code of this method: workflowCleanupBatchMove Source Code

public bool
(array $pks, int $transitionId)

Runs transition for item.
Parameters
  • array $pks Id of items to execute the transition
  • int $transitionId Id of transition
Returns
  • bool
Since
  • 4.0.0
Show source code of this method: executeTransition Source Code

public mixed
(mixed $property = null, mixed $default = null)

Method to get state variables.
Parameters
  • string $property Optional parameter name
  • mixed $default Optional default value
Returns
  • mixed The property where specified, the state object where omitted
Since
  • 4.0.0
Show source code of this method: getState Source Code

public string
()

Method to get the model name
Returns
  • string The name of the model
Since
  • 4.0.0
-
  • \Exception
Show source code of this method: getName Source Code

public \Joomla\CMS\Table\Table
(mixed $name = '', mixed $prefix = '', mixed $options = array())

Method to get a table object, load it if necessary.
Parameters
  • string $name The table name. Optional.
  • string $prefix The class prefix. Optional.
  • array $options Configuration array for model. Optional.
Returns
  • \Joomla\CMS\Table\Table A Table object
Since
  • 3.0
-
  • \Exception
Show source code of this method: getTable Source Code

Tags Summary

Since
4.0.0