Joomla! Documentation™

The "API16" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description

Method to get a JPagination object for the data set.

Syntax

getPagination()

Returns

object A 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');
        $limit = (int) $this->getState('list.limit') - (int) $this->getState('list.links');
        $page = new JPagination($this->getTotal(), (int) $this->getState('list.start'), $limit);

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

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