API15

JModelList/getPagination: Difference between revisions

From Joomla! Documentation

m removing red link to edit, no existant pages
m preparing for archive only
 
Line 49: Line 49:


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=getPagination
  category=getPagination
  category=JModelList
  category=JModelList
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*

Latest revision as of 00:58, 25 March 2017

Description

Method to get a JPagination object for the data set.

[<! removed edit link to red link >]

<! removed transcluded page call, red link never existed >

Syntax

getPagination()


Returns

object A JPagination object for the data set.

Defined in

libraries/joomla/application/component/modellist.php

Importing

jimport( 'joomla.application.component.modellist' );

Source Body

public function getPagination()
{
        // Get a storage key.
        $store = $this->_getStoreId('getPagination');

        // Try to load the data from internal storage.
        if (!empty($this->_cache[$store])) {
                return $this->_cache[$store];
        }

        // Create the pagination object.
        jimport('joomla.html.pagination');
        $page = new JPagination($this->getTotal(), (int) $this->getState('list.start'), (int) $this->getState('list.limit'));

        // Add the object to the internal cache.
        $this->_cache[$store] = $page;

        return $this->_cache[$store];
}

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

Code Examples