Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe WorkflowsModel
+ Graphe d'héritage de WorkflowsModel:

Fonctions membres publiques

 __construct ($config=array())
 
 getTable ($type='Workflow', $prefix='Administrator', $config=array())
 
 getItems ()
 
 getFilterForm ($data=array(), $loadData=true)
 
 getListQuery ()
 
- Fonctions membres publiques hérités de ListModel
 __construct ($config=array(), MVCFactoryInterface $factory=null)
 
 getIsEmptyState ()
 
 getActiveFilters ()
 
 getItems ()
 
 getPagination ()
 
 getTotal ()
 
 getStart ()
 
 getFilterForm ($data=array(), $loadData=true)
 
 getUserStateFromRequest ($key, $request, $default=null, $type='none', $resetPage=true)
 
- 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

 populateState ($ordering='w.ordering', $direction='asc')
 
 countItems ($items)
 
- Fonctions membres protégées hérités de ListModel
 getEmptyStateQuery ()
 
 _getListQuery ()
 
 getListQuery ()
 
 getStoreId ($id='')
 
 loadFormData ()
 
 populateState ($ordering=null, $direction=null)
 
 refineSearchStringToRegex ($search, $regexDelimiter='/')
 
- 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='')
 
- Attributs protégés hérités de ListModel
 $cache = array()
 
 $context = null
 
 $filter_fields = array()
 
 $query = array()
 
 $lastQueryStoreId = null
 
 $filterFormName = null
 
 $htmlFormName = 'adminForm'
 
 $filterBlacklist = array()
 
 $filterForbiddenList = array()
 
 $listBlacklist = array('select')
 
 $listForbiddenList = array('select')
 
- 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 workflows

Depuis
4.0.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $config = array())

Constructor.

Paramètres
array$configAn optional associative array of configuration settings.
Voir également
JController
Depuis
4.0.0

Références $config, et Symfony\Contracts\Service\__construct().

Documentation des fonctions membres

◆ countItems()

countItems (   $items)
protected

Add the number of transitions and states to all workflow items

Paramètres
array$itemsThe workflow items
Renvoie
mixed An array of data items on success, false on failure.
Depuis
4.0.0

Références $db, $item, $items, $query, $transitions, et Joomla\Database\getDatabase().

◆ getFilterForm()

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

Get the filter form

Paramètres
array$datadata
boolean$loadDataload current data
Renvoie
|bool the Form object or false
Depuis
4.0.0

Références $data, $form, Joomla\CMS\MVC\Model\getState(), et null.

◆ getItems()

getItems ( )

Method to get an array of data items.

Renvoie
mixed An array of data items on success, false on failure.
Depuis
4.0.0

Implémente ListModelInterface.

Références $items, et Joomla\CMS\Categories\countItems().

◆ getListQuery()

getListQuery ( )

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

Renvoie
string The query to database.
Depuis
4.0.0

Références $db, $extension, $query, elseif, Joomla\Database\getDatabase(), Joomla\CMS\MVC\Model\getState(), et ParameterType\INTEGER.

◆ getTable()

getTable (   $type = 'Workflow',
  $prefix = 'Administrator',
  $config = array() 
)

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

Paramètres
string$typeThe table name. Optional.
string$prefixThe class prefix. Optional.
array$configConfiguration array for model. Optional.
Renvoie
A Table object
Depuis
4.0.0

Références $config, $prefix, et $type.

◆ populateState()

populateState (   $ordering = 'w.ordering',
  $direction = 'asc' 
)
protected

Method to auto-populate the model state.

This method should only be called once per instantiation and is designed to be called on the first call to the getState() method unless the model configuration flag to ignore the request is set.

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

Paramètres
string$orderingAn optional ordering field.
string$directionAn optional direction (asc|desc).
Renvoie
void
Depuis
4.0.0

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


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