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

Fonctions membres publiques

 __construct ($config=array())
 
 getItems ()
 
 getStart ()
 
 countItemsByMonth ()
 
- 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='ordering', $direction='ASC')
 
 getStoreId ($id='')
 
- 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

This models supports retrieving lists of articles.

Depuis
1.6

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $config = array())

Constructor.

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

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

Documentation des fonctions membres

◆ countItemsByMonth()

countItemsByMonth ( )

Count Items by Month

Renvoie
mixed An array of objects on success, false on failure.
Depuis
3.9.0

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

◆ getItems()

getItems ( )

Method to get a list of articles.

Overridden to inject convert the attribs field into a Registry object.

Renvoie
mixed An array of objects on success, false on failure.
Depuis
1.6

For blogs, article params override menu item params only if menu param = 'use_article' Otherwise, menu item params control the layout If menu item is 'use_article' and there is no article param, use global

Compute the asset access permissions. Technically guest could edit an article, but lets not check that to improve performance a little.

Implémente ListModelInterface.

Références $groups, $id, $input, $item, $itemIds, $items, $key, $user, $userId, $value, AssociationHelper\displayAssociations(), elseif, Factory\getApplication(), ComponentHelper\getParams(), Joomla\CMS\MVC\Model\getState(), Factory\getUser(), Associations\isEnabled(), et null.

◆ getStart()

getStart ( )

Method to get the starting number of items for the data set.

Renvoie
integer The starting number of items available in the data set.
Depuis
3.0.1

Références Joomla\CMS\MVC\Model\getState().

◆ 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 = '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
3.0.1

Références $app, $listOrder, $params, $user, $value, ContentComponent\CONDITION_PUBLISHED, Factory\getApplication(), ComponentHelper\getParams(), Factory\getUser(), Multilanguage\isEnabled(), et Joomla\CMS\MVC\Model\setState().


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