This is the API documentation for concrete5 version 5.6 and earlier. View Current API Documentation

Class Concrete5_Helper_Pagination

Class to paginate record sets.

Direct known subclasses

PaginationHelper

Package: Helpers
Category: Concrete
Copyright: Copyright (c) 2003-2008 Concrete5. (http://www.concrete5.org)
License: MIT License
Author: Tony Trupp tony@concrete5.org
Located at core/helpers/pagination.php

Methods summary

public
# reset( )
public
# init( $page_num, $num_results = 0, $URL = '', $size = 20, $jsFunctionCall = '' )
protected
# getBaseURL( $url = false )
public
public
# recalc( $num_results )
public
# getLIMIT( )
public
public
public
public
public
public
public
public
public
public
# getNext( $linkText = false, $wrapper = 'span' )
public
public
# getPrevious( $linkText = false, $wrapper = 'span' )
public
public
# getPages( $wrapper = 'span', $shownElements = 9 )
public
# limitResultsToPage( $results = array() )
public
# getJSFunctionCall( $pageNum )

Properties summary

public integer $current_page
# 0
public integer $page_size
# 20
public integer $result_offset
# 0
public integer $number_of_pages
# 0
public integer $result_count
# 0
public integer $result_lower
# 0
public integer $result_upper
# 0
public string $classOff
# 'ltgray'
public string $classOn
# ''
public string $classCurrent
# 'currentPage active'
public string $URL
# ''
public string $jsFunctionCall
# ''
public $queryStringPagingVariable
# PAGING_STRING
public array $additionalVars
# array()