API17

JModelList: Difference between revisions

From Joomla! Documentation

← Older edit
Doxiki2 (talk | contribs)
Bots
18,905 edits
Layout updates
m preparing for archive only
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
<span class="editsection" style="font-size:76%;">
=={{JVer|11.1}} JModelList==
<nowiki>[</nowiki>[[Description:JModelList|Edit Descripton]]<nowiki>]</nowiki>
===Description===
</span>
 
{{Description:JModelList}}
 
===Defined in===
libraries/joomla/application/component/modellist.php
* see source code in [[jplatform:application/component/modellist.php|BitBucket]]
===Subpackage===
[[Subpackage Application/11.1|Application]]
===Extends===
[[JModel/11.1|JModel]]
===Extended by===
===Methods===
===Methods===
{| class="wikitable sortable"
{| class="wikitable sortable"
|-
|-
!Visibility
!Method name
!Method name
!Description
!Description
|-
|-
|[[JModelList::__construct/11.1|__construct]]
|public
|[[API17:JModelList::__construct|__construct]]
|Constructor.  
|Constructor.  
|-
|-
|[[JModelList::getItems/11.1|getItems]]
|public
|[[API17:JModelList::getItems|getItems]]
|Method to get an array of data items.  
|Method to get an array of data items.  
|-
|-
|[[JModelList::getPagination/11.1|getPagination]]
|public
|[[API17:JModelList::getPagination|getPagination]]
|Method to get a  object for the data set.  
|Method to get a  object for the data set.  
|-
|-
|[[JModelList::getstart/11.1|getstart]]
|public
|[[API17:JModelList::getstart|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.  
|-
|-
|[[JModelList::getTotal/11.1|getTotal]]
|public
|[[API17:JModelList::getTotal|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.  
|-
|-
|[[JModelList::getUserStateFromRequest/11.1|getUserStateFromRequest]]
|public
|[[API17:JModelList::getUserStateFromRequest|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.  
|-
|-
|[[JModelList::getListQuery/11.1|getListQuery]]
|protected
|[[API17:JModelList::getListQuery|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.  
|-
|-
|[[JModelList::getStoreId/11.1|getStoreId]]
|protected
|[[API17:JModelList::getStoreId|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.  
|-
|-
|[[JModelList::populateState/11.1|populateState]]
|protected
|[[API17:JModelList::populateState|populateState]]
|Method to auto-populate the model state.  
|Method to auto-populate the model state.  
|-
|-
|}
|}
* '''Defined in''' libraries/joomla/application/component/modellist.php
* '''Extends''' [[API17:JModel|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 in [[jplatform:application/component/modellist.php|BitBucket]]
* {{JVer|11.1}} '''JModelList source code''' on [[jplatform:application/component/modellist.php|BitBucket]]
* [[JModelList|Other versions of this class]]
* {{JVer|11.1}} Subpackage [[API17:Subpackage Application|Application]]
{{SeeAlso:JModelList}}
* [[API17:JModelList|Other versions of JModelList]]
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JModelList|Edit See Also]]<nowiki>]</nowiki>
 
</span>
===User contributed notes===
===Examples===
=== Code Examples ===
<CodeExamplesForm />
<dpl>
<dpl>
noresultsheader=\n
noresultsheader=\n
category=JModelList
category=JModelList
category=CodeExample
namespace=CodeExample
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 11.1]][[Category:Archived pages API17]]</noinclude>

Latest revision as of 03:28, 25 March 2017

Joomla 11.1 JModelList

Description

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


User contributed notes

Code Examples


Retrieved from "https://docs.sandbox.joomla.org/index.php?title=API17:JModelList&oldid=385722"