Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JModelList

Est dérivée de JModel.

Dérivée par BannersModelBanners, BannersModelBanners, BannersModelClients, BannersModelTracks, CacheModelCache, CategoriesModelCategories, CheckinModelCheckin, ContactModelCategories, ContactModelCategory, ContactModelContacts, ContactModelFeatured, ContentModelArticles, ContentModelArticles, ContentModelCategories, ContentModelCategory, FinderModelFilters, FinderModelIndex, FinderModelMaps, FinderModelSearch, FinderModelSuggestions, InstallerModel, InstallerModelLanguages, InstallerModelUpdate, InstallerModelWarnings, LanguagesModelInstalled, LanguagesModelLanguages, LanguagesModelOverrides, MenusModelItems, MenusModelMenus, MessagesModelMessages, ModulesModelModules, ModulesModelPositions, ModulesModelSelect, NewsfeedsModelCategories, NewsfeedsModelCategory, NewsfeedsModelNewsfeeds, PluginsModelPlugins, RedirectModelLinks, SearchModelSearches, TemplatesModelStyles, TemplatesModelTemplates, UsersModelDebugGroup, UsersModelDebugUser, UsersModelGroups, UsersModelLevels, UsersModelNotes, UsersModelUsers, WeblinksModelCategories, WeblinksModelCategory, et WeblinksModelWeblinks.

+ Graphe de collaboration de JModelList:

Liste de tous les membres

Fonctions membres publiques

 __construct ($config=array())
 getItems ()
 getPagination ()
 getTotal ()
 getStart ()
 getUserStateFromRequest ($key, $request, $default=null, $type= 'none', $resetPage=true)
- Fonctions membres publiques inherited from JModel
 getDbo ()
 getName ()
 getState ($property=null, $default=null)
 getTable ($name= '', $prefix= 'Table', $options=array())
 setDbo (&$db)
 setState ($property, $value=null)
- Fonctions membres publiques inherited from JObject
 __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)
 toString ()

Fonctions membres protégées

 _getListQuery ()
 getListQuery ()
 getStoreId ($id= '')
 populateState ($ordering=null, $direction=null)
- Fonctions membres protégées inherited from JModel
 _getList ($query, $limitstart=0, $limit=0)
 _getListCount ($query)
 _createTable ($name, $prefix= 'Table', $config=array())
 populateState ()
 cleanCache ($group=null, $client_id=0)

Attributs protégés

 $cache = array()
 $context = null
 $filter_fields = array()
 $query = array()
- Attributs protégés inherited from JModel
 $__state_set = null
 $_db
 $name
 $option = null
 $state
 $event_clean_cache = null
- Attributs protégés inherited from JObject
 $_errors = array()

Additional Inherited Members

- Fonctions membres publiques statiques inherited from JModel
static addIncludePath ($path= '', $prefix= '')
static addTablePath ($path)
static getInstance ($type, $prefix= '', $config=array())
- Fonctions membres protégées statiques inherited from JModel
static _createFileName ($type, $parts=array())

Documentation des constructeurs et destructeur


Documentation des fonctions membres

JModelList::_getListQuery ( )
protected

Method to cache the last query constructed.

This method ensures that the query is constructed only once for a given state of the model.

Renvoie:
JDatabaseQuery A JDatabaseQuery object
Depuis:
11.1

Réimplémentée dans InstallerModelLanguages.

Références $query.

JModelList::getPagination ( )

Method to get a JPagination object for the data set.

Renvoie:
JPagination A JPagination object for the data set.
Depuis:
11.1

Réimplémentée dans ContentModelCategory, CacheModelCache, et InstallerModelDatabase.

Références $limit, et jimport().

+ Voici le graphe d'appel pour cette fonction :

JModelList::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:
11.1

Réimplémentée dans ContentModelArticles.

Références $limit, et $total.

JModelList::getStoreId (   $id = '')
protected
JModelList::getTotal ( )

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

Renvoie:
integer The total number of items available in the data set.
Depuis:
11.1

Réimplémentée dans LanguagesModelInstalled, ModulesModelPositions, FinderModelSearch, CacheModelCache, LanguagesModelOverrides, et CheckinModelCheckin.

Références $query, et $total.

JModelList::getUserStateFromRequest (   $key,
  $request,
  $default = null,
  $type = 'none',
  $resetPage = true 
)

Gets the value of a user state variable and sets it in the session

This is the same as the method in JApplication except that this also can optionally force you back to the first page when a filter has changed

Paramètres:
string$keyThe key of the user state variable.
string$requestThe name of the variable passed in a request.
string$defaultThe default value for the variable if not found. Optional.
string$typeFilter for the variable, for valid values see JFilterInput::clean(). Optional.
boolean$resetPageIf true, the limitstart in request is set to zero
Renvoie:
The request user state.
Depuis:
11.1

Références $app, $key, $type, JFactory\getApplication(), JRequest\getVar(), null, et JRequest\setVar().

+ Voici le graphe d'appel pour cette fonction :

JModelList::populateState (   $ordering = null,
  $direction = null 
)
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:
11.1

Réimplémentée dans FinderModelSearch, FinderModelIndex, FinderModelMaps, BannersModelBanners, UsersModelNotes, ContactModelCategory, MenusModelMenus, WeblinksModelCategory, ContactModelFeatured, NewsfeedsModelCategory, TemplatesModelTemplates, LanguagesModelOverrides, FinderModelFilters, InstallerModelLanguages, ContentModelCategory, UsersModelDebugGroup, UsersModelDebugUser, LanguagesModelInstalled, CategoriesModelCategories, ContactModelContacts, ContentModelArticles, ContentModelArticles, MenusModelItems, WeblinksModelWeblinks, NewsfeedsModelNewsfeeds, ModulesModelModules, UsersModelUsers, LanguagesModelLanguages, PluginsModelPlugins, BannersModelTracks, InstallerModelManage, InstallerModelUpdate, RedirectModelLinks, MessagesModelMessages, BannersModelClients, CacheModelCache, TemplatesModelStyles, SearchModelSearches, UsersModelGroups, ModulesModelPositions, UsersModelLevels, ContactModelCategories, ContentModelCategories, NewsfeedsModelCategories, WeblinksModelCategories, ContentModelArchive, ContentModelFeatured, InstallerModelDatabase, InstallerModelDiscover, CheckinModelCheckin, et ModulesModelSelect.

Références $app, $direction, $limit, $ordering, et JFactory\getApplication().

+ Voici le graphe d'appel pour cette fonction :


Documentation des données membres

JModelList::$cache = array()
protected
JModelList::$context = null
protected

Réimplémentée dans FinderModelSearch, et FinderModelSuggestions.

JModelList::$filter_fields = array()
protected
JModelList::$query = array()
protected

Réimplémentée dans FinderModelSearch.


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