API17:JModelList
From Joomla! Documentation
(Difference between revisions)
(Layout updates) |
(Updated to r1448:247ba8d88526) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| + | =={{JVer|11.1}} JModelList== | ||
| + | ===Description=== | ||
| + | {{Description:JModelList}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[Description:JModelList|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JModelList|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| + | !Visibility | ||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
| + | |public | ||
|[[JModelList::__construct/11.1|__construct]] | |[[JModelList::__construct/11.1|__construct]] | ||
|Constructor. | |Constructor. | ||
|- | |- | ||
| + | |public | ||
|[[JModelList::getItems/11.1|getItems]] | |[[JModelList::getItems/11.1|getItems]] | ||
|Method to get an array of data items. | |Method to get an array of data items. | ||
|- | |- | ||
| + | |public | ||
|[[JModelList::getPagination/11.1|getPagination]] | |[[JModelList::getPagination/11.1|getPagination]] | ||
|Method to get a object for the data set. | |Method to get a object for the data set. | ||
|- | |- | ||
| + | |public | ||
|[[JModelList::getstart/11.1|getstart]] | |[[JModelList::getstart/11.1|getstart]] | ||
|Method to get the starting number of items for the data set. | |Method to get the starting number of items for the data set. | ||
|- | |- | ||
| + | |public | ||
|[[JModelList::getTotal/11.1|getTotal]] | |[[JModelList::getTotal/11.1|getTotal]] | ||
|Method to get the total number of items for the data set. | |Method to get the total number of items for the data set. | ||
|- | |- | ||
| + | |public | ||
|[[JModelList::getUserStateFromRequest/11.1|getUserStateFromRequest]] | |[[JModelList::getUserStateFromRequest/11.1|getUserStateFromRequest]] | ||
|Gets the value of a user state variable and sets it in the session This is the same as the method in except that this also can optionally force you back to the first page when a filter has changed. | |Gets the value of a user state variable and sets it in the session This is the same as the method in except that this also can optionally force you back to the first page when a filter has changed. | ||
|- | |- | ||
| + | |protected | ||
|[[JModelList::getListQuery/11.1|getListQuery]] | |[[JModelList::getListQuery/11.1|getListQuery]] | ||
|Method to get a object for retrieving the data set from a database. | |Method to get a object for retrieving the data set from a database. | ||
|- | |- | ||
| + | |protected | ||
|[[JModelList::getStoreId/11.1|getStoreId]] | |[[JModelList::getStoreId/11.1|getStoreId]] | ||
|Method to get a store id based on the model configuration state. | |Method to get a store id based on the model configuration state. | ||
|- | |- | ||
| + | |protected | ||
|[[JModelList::populateState/11.1|populateState]] | |[[JModelList::populateState/11.1|populateState]] | ||
|Method to auto-populate the model state. | |Method to auto-populate the model state. | ||
|- | |- | ||
|} | |} | ||
| + | * '''Defined in''' libraries/joomla/application/component/modellist.php | ||
| + | * '''Extends''' [[JModel/11.1|JModel]] | ||
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.application.component.modellist' );</source> | <source lang="php">jimport( 'joomla.application.component.modellist' );</source> | ||
===See also=== | ===See also=== | ||
| − | * JModelList source code | + | * {{JVer|11.1}} '''JModelList source code''' on [[jplatform:application/component/modellist.php|BitBucket]] |
| − | * [[JModelList|Other versions of | + | * {{JVer|11.1}} Subpackage [[Subpackage Application/11.1|Application]] |
| + | * [[JModelList|Other versions of JModelList]] | ||
{{SeeAlso:JModelList}} | {{SeeAlso:JModelList}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JModelList|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JModelList|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | === | + | ===User contributed notes=== |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 63: | Line 70: | ||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JModelList]]</noinclude> | <noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JModelList]]</noinclude> | ||
Revision as of 18:06, 27 April 2011
JModelList
Description
Description:JModelList [Edit Descripton]
Methods
| Visibility | Method name | Description |
|---|---|---|
| public | __construct | Constructor. |
| public | getItems | Method to get an array of data items. |
| public | getPagination | Method to get a object for the data set. |
| public | getstart | Method to get the starting number of items for the data set. |
| public | getTotal | Method to get the total number of items for the data set. |
| public | getUserStateFromRequest | Gets the value of a user state variable and sets it in the session This is the same as the method in except that this also can optionally force you back to the first page when a filter has changed. |
| protected | getListQuery | Method to get a object for retrieving the data set from a database. |
| protected | getStoreId | Method to get a store id based on the model configuration state. |
| protected | populateState | Method to auto-populate the model state. |
- Defined in libraries/joomla/application/component/modellist.php
- Extends JModel
Importing
jimport( 'joomla.application.component.modellist' );
See also
- JModelList source code on BitBucket
- Subpackage Application
- Other versions of JModelList
SeeAlso:JModelList [Edit See Also]
User contributed notes
<CodeExamplesForm />
