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

Fonctions membres publiques

 __construct ($config=[], MVCFactoryInterface $factory=null)
 
- 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

 getStoreId ($id='')
 
 getListQuery ()
 
 _getList ($query, $limitstart=0, $limit=0)
 
 populateState ($ordering='a.title', $direction='ASC')
 
- 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)
 

Fonctions membres privées

 attachTaskOptions (array $items)
 

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

The MVC Model for TasksView. Defines methods to deal with operations concerning multiple #__scheduler_tasks entries.

Depuis
4.1.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $config = [],
MVCFactoryInterface  $factory = null 
)

Constructor.

Paramètres
array$configAn optional associative array of configuration settings.
MVCFactoryInterface | null$factoryThe factory.
Depuis
4.1.0
Exceptions

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

Documentation des fonctions membres

◆ _getList()

_getList (   $query,
  $limitstart = 0,
  $limit = 0 
)
protected

Overloads the parent _getList() method. Takes care of attaching TaskOption objects and sorting by type titles.

Paramètres
DatabaseQuery$queryThe database query to get the list with
int$limitstartThe list offset
int$limitNumber of list items to fetch
Renvoie
object[]
Depuis
4.1.0
Exceptions

Références $limit, $listOrder, $query, Joomla\Database\getDatabase(), et Joomla\CMS\MVC\Model\getState().

◆ attachTaskOptions()

attachTaskOptions ( array  $items)
private

For an array of items, attaches TaskOption objects and (safe) type titles to each.

Paramètres
array$itemsArray of items, passed by reference
Renvoie
void
Depuis
4.1.0
Exceptions

Références $item, $items, et Text\_().

◆ getListQuery()

getListQuery ( )
protected

Method to create a query for a list of items.

Renvoie
QueryInterface
Depuis
4.1.0
Exceptions

Select the required fields from the table. ? Do we need all these defaults ? ? Does 'list.select' exist ?

Extends query if already filtered.

Paramètres
string$outerGlue
array$conditions
string$innerGlue
Depuis
4.1.0

Références $db, $id, $now, $query, $state, $title, elseif, Joomla\Database\getDatabase(), Factory\getDate(), ComponentHelper\getParams(), Joomla\CMS\MVC\Model\getState(), ParameterType\INTEGER, et ParameterType\STRING.

◆ getStoreId()

getStoreId (   $id = '')
protected

Method to get a store id based on model configuration state.

This is necessary because the model is used by the component and different modules that might need different sets of data or different ordering requirements.

Paramètres
string$idA prefix for the store id.
Renvoie
string A store id.
Depuis
4.1.0

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

◆ populateState()

populateState (   $ordering = 'a.title',
  $direction = 'ASC' 
)
protected

Proxy for the parent method. Sets ordering defaults.

Paramètres
string$orderingField to order/sort list by
string$directionDirection in which to sort list
Renvoie
void
Depuis
4.1.0

Références $direction, $ordering, et Joomla\CMS\MVC\Model\populateState().


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