Class JPagination

Pagination Class. Provides a common interface for content pagination for the Joomla! CMS.

Package: Joomla\Libraries\Pagination
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 1.5
Located at cms/pagination/pagination.php

Methods summary

`public`	# `__construct( integer $total, integer $limitstart, integer $limit, string $prefix = '', JApplicationCms $app = null )` Constructor. Constructor. Parameters `$total` `integer` - $total The total number of items. `$limitstart` `integer` - $limitstart The offset of the item to start at. `$limit` `integer` - $limit The number of items to display per page. `$prefix` `string` - $prefix The prefix used for request variables. `$app` `JApplicationCms` - $app The application object Since 1.5
`public mixed`	# `setAdditionalUrlParam( string $key, mixed $value )` Method to set an additional URL parameter to be added to all pagination class generated links. Method to set an additional URL parameter to be added to all pagination class generated links. Parameters `$key` `string` - $key The name of the URL parameter for which to set a value. `$value` `mixed` - $value The value to set for the URL parameter. Returns `mixed` - The old value for the parameter. Since 1.6
`public mixed`	# `getAdditionalUrlParam( string $key )` Method to get an additional URL parameter (if it exists) to be added to all pagination class generated links. Method to get an additional URL parameter (if it exists) to be added to all pagination class generated links. Parameters `$key` `string` - $key The name of the URL parameter for which to get the value. Returns `mixed` - The value if it exists or null if it does not. Since 1.6
`public integer`	# `getRowOffset( integer $index )` Return the rationalised offset for a row with a given index. Return the rationalised offset for a row with a given index. Parameters `$index` `integer` - $index The row index Returns `integer` - Rationalised offset for a row with a given index. Since 1.5
`public stdClass`	# `getData( )` Return the pagination data object, only creating it if it doesn't already exist. Return the pagination data object, only creating it if it doesn't already exist. Returns `stdClass` - Pagination data object. Since 1.5
`public string`	# `getPagesCounter( )` Create and return the pagination pages counter string, ie. Page 2 of 4. Create and return the pagination pages counter string, ie. Page 2 of 4. Returns `string` - Pagination pages counter string. Since 1.5
`public string`	# `getResultsCounter( )` Create and return the pagination result set counter string, e.g. Results 1-10 of 42 Create and return the pagination result set counter string, e.g. Results 1-10 of 42 Returns `string` - Pagination result set counter string. Since 1.5
`public string`	# `getPagesLinks( )` Create and return the pagination page list string, ie. Previous, Next, 1 2 3 ... x. Create and return the pagination page list string, ie. Previous, Next, 1 2 3 ... x. Returns `string` - Pagination page list string. Since 1.5
`public string`	# `getPaginationLinks( string $layoutId = 'joomla.pagination.links', array $options = array() )` Get the pagination links Get the pagination links Parameters `$layoutId` `string` - $layoutId Layout to render the links `$options` `array` - $options Optional array with settings for the layout Returns `string` - Pagination links. Since 3.3
`public array`	# `getPaginationPages( )` Create and return the pagination pages list, ie. Previous, Next, 1 2 3 ... x. Create and return the pagination pages list, ie. Previous, Next, 1 2 3 ... x. Returns `array` - Pagination pages list. Since 3.3
`public string`	# `getListFooter( )` Return the pagination footer. Return the pagination footer. Returns `string` - Pagination footer. Since 1.5
`public string`	# `getLimitBox( )` Creates a dropdown box for selecting how many records to show per page. Creates a dropdown box for selecting how many records to show per page. Returns `string` - The HTML for the limit # input box. Since 1.5
`public string`	# `orderUpIcon( integer $i, boolean $condition = true, string $task = 'orderup', string $alt = 'JLIB_HTML_MOVE_UP', boolean $enabled = true, string $checkbox = 'cb' )` Return the icon to move an item UP. Return the icon to move an item UP. Parameters `$i` `integer` - $i The row index. `$condition` `boolean` - $condition True to show the icon. `$task` `string` - $task The task to fire. `$alt` `string` - $alt The image alternative text string. `$enabled` `boolean` - $enabled An optional setting for access control on the action. `$checkbox` `string` - $checkbox An optional prefix for checkboxes. Returns `string` - Either the icon to move an item up or a space. Since 1.5
`public string`	# `orderDownIcon( integer $i, integer $n, boolean $condition = true, string $task = 'orderdown', string $alt = 'JLIB_HTML_MOVE_DOWN', boolean $enabled = true, string $checkbox = 'cb' )` Return the icon to move an item DOWN. Return the icon to move an item DOWN. Parameters `$i` `integer` - $i The row index. `$n` `integer` - $n The number of items in the list. `$condition` `boolean` - $condition True to show the icon. `$task` `string` - $task The task to fire. `$alt` `string` - $alt The image alternative text string. `$enabled` `boolean` - $enabled An optional setting for access control on the action. `$checkbox` `string` - $checkbox An optional prefix for checkboxes. Returns `string` - Either the icon to move an item down or a space. Since 1.5
`protected string`	# `_list_footer( array $list )` Create the HTML for a list footer Create the HTML for a list footer Parameters `$list` `array` - $list Pagination list data structure. Returns `string` - HTML for a list footer Since 1.5
`protected string`	# `_list_render( array $list )` Create the html for a list footer Create the html for a list footer Parameters `$list` `array` - $list Pagination list data structure. Returns `string` - HTML for a list start, previous, next,end Since 1.5
`protected string`	# `_item_active( JPaginationObject $item )` Method to create an active pagination link to the item Method to create an active pagination link to the item Parameters `$item` `JPaginationObject` - $item The object with which to make an active link. Returns `string` - HTML link Since 1.5 Note As of 4.0 this method will proxy to `JLayoutHelper::render('joomla.pagination.link', ['data' => $item, 'active' => true])`
`protected string`	# `_item_inactive( JPaginationObject $item )` Method to create an inactive pagination string Method to create an inactive pagination string Parameters `$item` `JPaginationObject` - $item The item to be processed Returns `string` Since 1.5 Note As of 4.0 this method will proxy to `JLayoutHelper::render('joomla.pagination.link', ['data' => $item, 'active' => false])`
`protected stdClass`	# `_buildDataObject( )` Create and return the pagination data object. Create and return the pagination data object. Returns `stdClass` - Pagination data object. Since 1.5
`public`	# `set( string $property, mixed $value = null )` Modifies a property of the object, creating it if it does not already exist. Modifies a property of the object, creating it if it does not already exist. Deprecated 4.0 Access the properties directly. Parameters `$property` `string` - $property The name of the property. `$value` `mixed` - $value The value of the property to set. Since 3.0
`public mixed`	# `get( string $property, mixed $default = null )` Returns a property of the object or the default value if the property is not set. Returns a property of the object or the default value if the property is not set. Deprecated 4.0 Access the properties directly. Parameters `$property` `string` - $property The name of the property. `$default` `mixed` - $default The default value. Returns `mixed` - The value of the property. Since 3.0

Magic methods summary

Properties summary

`public integer`	`$limitstart`	# The record number to start displaying from. The record number to start displaying from. Since 1.5
`public integer`	`$limit`	# Number of rows to display per page. Number of rows to display per page. Since 1.5
`public integer`	`$total`	# Total number of rows. Total number of rows. Since 1.5
`public integer`	`$prefix`	# Prefix used for request variables. Prefix used for request variables. Since 1.6
`public integer`	`$pagesStart`	# Value pagination object begins at Value pagination object begins at Since 3.0
`public integer`	`$pagesStop`	# Value pagination object ends at Value pagination object ends at Since 3.0
`public integer`	`$pagesCurrent`	# Current page Current page Since 3.0
`public integer`	`$pagesTotal`	# Total number of pages Total number of pages Since 3.0
`protected boolean`	`$viewall`	# View all flag View all flag Since 3.0
`protected array`	`$additionalUrlParams`	# Additional URL parameters to be added to the pagination URLs generated by the class. These may be useful for filters and extra values when dealing with lists and GET requests. Additional URL parameters to be added to the pagination URLs generated by the class. These may be useful for filters and extra values when dealing with lists and GET requests. Since 3.0
`protected JApplicationCms`	`$app`	# The application object The application object Since 3.4
`protected object`	`$data`	# Pagination data object Pagination data object Since 3.4

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JPagination

Methods summary

Parameters

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Note

Parameters

Returns

Since

Note

Returns

Since

Deprecated

Parameters

Since

Deprecated

Parameters

Returns

Since

Magic methods summary

Properties summary

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since