Référence de la classe WorkflowModel

Graphe d'héritage de WorkflowModel:

Fonctions membres publiques
	populateState ()
	save ($data)
	getForm ($data=array(), $loadData=true)
	setDefault ($pk, $value=1)
	publish (&$pks, $value=1)
Fonctions membres publiques hérités de AdminModel
	__construct ($config=array(), MVCFactoryInterface $factory=null, FormFactoryInterface $formFactory=null)
	batch ($commands, $pks, $contexts)
	checkin ($pks=array())
	checkout ($pk=null)
	delete (&$pks)
	getItem ($pk=null)
	publish (&$pks, $value=1)
	reorder ($pks, $delta=0)
	save ($data)
	saveorder ($pks=array(), $order=null)
	generateTitle ($categoryId, $table)
	initBatch ()
	editAssociations ($data)
Fonctions membres publiques hérités de FormModel
	__construct ($config=array(), MVCFactoryInterface $factory=null, FormFactoryInterface $formFactory=null)
	checkin ($pk=null)
	checkout ($pk=null)
	validate ($form, $data, $group=null)
Fonctions membres publiques hérités de BaseDatabaseModel
	__construct ($config=array(), MVCFactoryInterface $factory=null)
	getTable ($name='', $prefix='', $options=array())
	isCheckedOut ($item)
	getDbo ()
	setDbo (DatabaseInterface $db=null)
	__get ($name)
Fonctions membres publiques hérités de BaseModel
	__construct ($config=array())
	getName ()
Fonctions membres publiques hérités de CMSObject
	__construct ($properties=null)
	__toString ()
	def ($property, $default=null)
	get ($property, $default=null)
	getProperties ($public=true)
	getError ($i=null, $toString=true)
	getErrors ()
	set ($property, $value=null)
	setProperties ($properties)
	setError ($error)
Fonctions membres publiques hérités de StatefulModelInterface
	getState ($property=null, $default=null)
	setState ($property, $value=null)
Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)
Fonctions membres publiques hérités de CurrentUserInterface
	setCurrentUser (User $currentUser)
Fonctions membres publiques hérités de CacheControllerFactoryAwareInterface
	setCacheControllerFactory (CacheControllerFactoryInterface $factory)
Fonctions membres publiques hérités de DatabaseAwareInterface
	setDatabase (DatabaseInterface $db)
Fonctions membres publiques hérités de FormFactoryAwareInterface
	setFormFactory (FormFactoryInterface $factory)

Fonctions membres protégées
	generateNewTitle ($categoryId, $alias, $title)
	loadFormData ()
	preprocessForm (Form $form, $data, $group='content')
	getReorderConditions ($table)
	canDelete ($record)
	canEditState ($record)
Fonctions membres protégées hérités de AdminModel
	batchAccess ($value, $pks, $contexts)
	batchCopy ($value, $pks, $contexts)
	cleanupPostBatchCopy (TableInterface $table, $newId, $oldId)
	batchLanguage ($value, $pks, $contexts)
	batchMove ($value, $pks, $contexts)
	batchTag ($value, $pks, $contexts)
	canDelete ($record)
	canEditState ($record)
	generateNewTitle ($categoryId, $alias, $title)
	getReorderConditions ($table)
	populateState ()
	prepareTable ($table)
	checkCategoryId ($categoryId)
	redirectToAssociations ($data)
Fonctions membres protégées hérités de BaseDatabaseModel
	_getList ($query, $limitstart=0, $limit=0)
	_getListCount ($query)
	_createTable ($name, $prefix='Table', $config=array())
	bootComponent ($component)
	dispatchEvent (EventInterface $event)

Membres hérités additionnels
Fonctions membres publiques statiques hérités de BaseModel
static	addIncludePath ($path='', $prefix='')
Champs de données hérités de AdminModel
	$typeAlias
Attributs protégés hérités de AdminModel
	$text_prefix = null
	$event_after_delete = null
	$event_after_save = null
	$event_before_delete = null
	$event_before_save = null
	$event_before_change_state = null
	$event_change_state = null
	$event_before_batch = null
	$batch_copymove = 'category_id'
	$batch_commands
	$associationsContext = null
	$batchSet = null
	$user = null
	$table = null
	$tableClassName = null
	$contentType = null
	$type = null
Attributs protégés hérités de FormModel
	$events_map = null
Attributs protégés hérités de BaseDatabaseModel
	$option = null
	$event_clean_cache = null
Attributs protégés hérités de BaseModel
	$name
Attributs protégés hérités de CMSObject
	$_errors = array()
Attributs protégés statiques hérités de BaseModel
static	$paths

Description détaillée

Model class for workflow

Depuis

4.0.0

Documentation des fonctions membres

canDelete()

canDelete (   $record )

protected

Method to test whether a record can be deleted.

Paramètres

object

$record

A record object.

Renvoie

boolean True if allowed to delete the record. Defaults to the permission for the component.

Depuis

4.0.0

Références Factory\getUser().

canEditState()

canEditState (   $record )

protected

Method to test whether a record can have its state changed.

Paramètres

object

$record

A record object.

Renvoie

boolean True if allowed to change the state of the record. Defaults to the permission set in the component.

Depuis

4.0.0

Références $user, et Factory\getUser().

generateNewTitle()

generateNewTitle (   $categoryId,   $alias,   $title  )

protected

Method to change the title

Paramètres

integer	$categoryId	The id of the category.
string	$alias	The alias.
string	$title	The title.

Renvoie

array Contains the modified title and alias.

Depuis

4.0.0

Références $title, et StringHelper\increment().

getForm()

getForm	(		$data = array(),
			$loadData = true
	)

Abstract method for getting the form from the model.

Paramètres

array	$data	Data for the form.
boolean	$loadData	True if the form is to load its own data (default case), false if not.

Renvoie

|boolean A Form object on success, false on failure

Depuis

4.0.0

Implémente FormModelInterface.

Références $canEditState, $data, $form, $id, $item, Factory\getDate(), et Joomla\CMS\MVC\Model\loadForm().

getReorderConditions()

getReorderConditions (   $table )

protected

A protected method to get a set of ordering conditions.

Paramètres

object

$table

A record object.

Renvoie

array An array of conditions to add to ordering queries.

Depuis

4.0.0

Références $db, et Joomla\Database\getDatabase().

loadFormData()

loadFormData ( )

protected

Method to get the data that should be injected in the form.

Renvoie

mixed The data for the form.

Depuis

4.0.0

Références $data, et Factory\getApplication().

populateState()

populateState

(

)

Auto-populate the model state.

Note. Calling getState in this method will result in recursion.

Renvoie

void

Depuis

4.0.0

Références $app, $context, $extension, $name, Factory\getApplication(), null, Joomla\CMS\MVC\Model\populateState(), et Joomla\CMS\MVC\Model\setState().

preprocessForm()

preprocessForm ( Form  $form,   $data,   $group = 'content'  )

protected

Method to preprocess the form.

Paramètres

Form	$form	Form object.
mixed	$data	The data expected for the form.
string	$group	The name of the plugin group to import (defaults to "content").

Renvoie

void

Depuis

4.0.0

Références $data, $extension, $form, $parts, Factory\getApplication(), et Joomla\CMS\MVC\Model\preprocessForm().

publish()

publish	(	&	$pks,
			$value = 1
	)

Method to change the published state of one or more records.

Paramètres

array	&$pks	A list of the primary keys to change.
integer	$value	The value of the published state.

Renvoie

boolean True on success.

Depuis

4.0.0

Références $date, $i, $value, Text\_(), Factory\getApplication(), et Factory\getDate().

save()

save

(

$data

)

Method to save the form data.

Paramètres

array

$data

The form data.

Renvoie

boolean True on success.

Depuis

4.0.0

Références $app, $context, $data, $extension, $input, $key, $name, $result, $title, $user, Factory\getApplication(), Joomla\CMS\MVC\Model\getState(), et null.

setDefault()

setDefault	(		$pk,
			$value = 1
	)

Method to change the default state of one item.

Paramètres

array	$pk	A list of the primary keys to change.
integer	$value	The value of the home state.

Renvoie

boolean True on success.

Depuis

4.0.0

Références $date, $this, $value, Text\_(), Log\add(), Factory\getDate(), et Log\WARNING.

---

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

• WorkflowModel.php