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

Fonctions membres publiques

 __construct ($config=array(), MVCFactoryInterface $factory=null)
 
 getAssoc ()
 
 getItems ()
 
 countItems (&$items, $extension)
 
- 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='a.lft', $direction='asc')
 
 getStoreId ($id='')
 
 getListQuery ()
 
 getEmptyStateQuery ()
 
- 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)
 

Attributs privés

 $hasAssociation
 

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

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $config = array(),
MVCFactoryInterface  $factory = null 
)

Constructor.

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

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

Documentation des fonctions membres

◆ countItems()

countItems ( $items,
  $extension 
)

Method to load the countItems method from the extensions

Paramètres

Références $component, $extension, $items, $parts, $section, et Factory\getApplication().

◆ getAssoc()

getAssoc ( )

Method to determine if an association exists

Renvoie
boolean True if the association exists
Depuis
3.0

Références $component, $extension, Joomla\CMS\MVC\Model\getState(), Associations\isEnabled(), JPATH_SITE, et JLoader\register().

◆ getEmptyStateQuery()

getEmptyStateQuery ( )
protected

Manipulate the query to be used to evaluate if this is an Empty State to provide specific conditions for this extension.

Renvoie
DatabaseQuery
Depuis
4.0.0

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

◆ getItems()

getItems ( )

Method to get an array of data items.

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

Implémente ListModelInterface.

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

◆ getListQuery()

getListQuery ( )
protected

◆ 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
1.6

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

◆ populateState()

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

Method to auto-populate the model state.

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
1.6

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

Documentation des champs

◆ $hasAssociation

$hasAssociation
private

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