Docs For Class Pager

build [line 492]

void build(
)

Generate or refresh the links and paged data after a call to setOptions()

Access: public

[ Top ]

errorMessage [line 1519]

string errorMessage(
int
$code)

Return a textual error message for a PAGER error code

Return: error message
Access: public

Parameters:

int $code — error code

[ Top ]

getCurrentPageID [line 636]

integer getCurrentPageID(
)

Returns ID of current page

Return: ID of current page

[ Top ]

getLinks [line 621]

array getLinks(
[integer
$pageID = null], [string
$next_html = ''])

Returns back/next/first/last and page links, both as ordered and associative array.

NB: in original PEAR::Pager this method accepted two parameters, $back_html and $next_html. Now the only parameter accepted is an integer ($pageID), since the html text for prev/next links can be set in the factory. If a second parameter is provided, then the method act as it previously did. This hack was done to mantain backward compatibility only.

Return: back/next/first/last and page links

Overridden in child classes as:

Pager_Jumping::getLinks(): Returns back/next/first/last and page links, both as ordered and associative array.

Pager_Sliding::getLinks(): Returns back/next/first/last and page links, both as ordered and associative array.

Parameters:

integer	`$pageID`	—	Optional pageID. If specified, links for that page are provided instead of current one. [ADDED IN NEW PAGER VERSION]
string	`$next_html`	—	HTML to put inside the next link [deprecated: use the factory instead]

[ Top ]

getNextPageID [line 650]

mixed getNextPageID(
)

Returns next page ID. If current page is last page this function returns FALSE

Return: Next page ID

[ Top ]

getOffsetByPageId [line 571]

array getOffsetByPageId(
[integer
$pageid = null])

Returns offsets for given pageID. Eg, if you pass it pageID one and your perPage limit is 10 it will return (1, 10). PageID of 2 would give you (11, 20).

Return: First and last offsets
Access: public

Parameters:

integer $pageid — PageID to get offsets for

[ Top ]

getOption [line 1482]

mixed getOption(
string
$name)

Return the current value of a given option

Return: option value

Parameters:

string $name — option name

[ Top ]

getOptions [line 1500]

array getOptions(
)

Return an array with all the current pager options

Return: list of all the pager options

[ Top ]

getPageData [line 529]

array getPageData(
[$pageID
$pageID = null])

Returns an array of current pages data

Return: Page data
Access: public

Parameters:

$pageID $pageID — Desired page ID (optional)

[ Top ]

getPageIdByOffset [line 551]

int getPageIdByOffset(
$index
$index)

Returns pageID for given offset

Return: PageID for given offset

Overridden in child classes as:

Pager_Jumping::getPageIdByOffset(): Returns pageID for given offset

Pager_Sliding::getPageIdByOffset(): "Overload" PEAR::Pager method. VOID. Not needed here...

Parameters:

$index $index — Offset to get pageID for

[ Top ]

getPageRangeByPageId [line 595]

array getPageRangeByPageId(
integer
$pageID)

Return: First and last offsets

Overridden in child classes as:

Pager_Jumping::getPageRangeByPageId(): Given a PageId, it returns the limits of the range of pages displayed.

Pager_Sliding::getPageRangeByPageId(): Given a PageId, it returns the limits of the range of pages displayed.

Parameters:

integer $pageID — PageID to get offsets for

[ Top ]

getPageSelectBox [line 1204]

string getPageSelectBox(
[array
$params = array()], [string
$extraAttributes = ''])

Returns a string with a XHTML SELECT menu with the page numbers, useful as an alternative to the links

Return: xhtml select box
Access: public

Parameters:

string	`$extraAttributes`	—	(html attributes) Tag attributes or HTML attributes (id="foo" pairs), will be inserted in the <select> tag
array	`$params`	—	- 'optionText': text to show in each option. Use '%d' where you want to see the number of pages selected. 'autoSubmit': if TRUE, add some js code to submit the form on the onChange event

[ Top ]

getPerPageSelectBox [line 1180]

string getPerPageSelectBox(
[integer
$start = 5], [integer
$end = 30], [integer
$step = 5], [boolean
$showAllData = false], [array
$extraParams = array()])

Returns a string with a XHTML SELECT menu,

useful for letting the user choose how many items per page should be displayed. If parameter useSessions is TRUE, this value is stored in a session var. The string isn't echoed right now so you can use it with template engines.

Return: xhtml select box
Access: public

Parameters:

integer	`$start`	—
integer	`$end`	—
integer	`$step`	—
boolean	`$showAllData`	—	If true, perPage is set equal to totalItems.
array	`$extraParams`	—	(or string $optionText for BC reasons) 'optionText': text to show in each option. Use '%d' where you want to see the number of pages selected. 'attributes': (html attributes) Tag attributes or HTML attributes (id="foo" pairs), will be inserted in the <select> tag

[ Top ]

getPreviousPageID [line 664]

mixed getPreviousPageID(
)

Returns previous page ID. If current page is first page this function returns FALSE

Return: Previous pages' ID

[ Top ]

isFirstPage [line 703]

bool isFirstPage(
)

Returns whether current page is first page

Return: First page or not

[ Top ]

isLastPage [line 716]

bool isLastPage(
)

Returns whether current page is last page

Return: Last page or not

[ Top ]

isLastPageComplete [line 729]

bool isLastPageComplete(
)

Returns whether last page is complete

Return: Last age complete or not

[ Top ]

numItems [line 677]

int numItems(
)

Returns number of items

Return: Number of items

[ Top ]

numPages [line 690]

int numPages(
)

Returns number of pages

Return: Number of pages

[ Top ]

setOptions [line 1395]

integer setOptions(
mixed
$options)

Set and sanitize options

Return: error code (PAGER_OK on success)
Access: public

Parameters:

mixed $options — An associative array of option names and their values.

[ Top ]

Class: Pager_Common

Class Overview

Author(s):

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$links = ''

$linkTags = ''

$range = array()

Method Detail

build [line 492]

errorMessage [line 1519]

Parameters:

getCurrentPageID [line 636]

getLinks [line 621]

Parameters:

getNextPageID [line 650]

getOffsetByPageId [line 571]

Parameters:

getOption [line 1482]

Parameters:

getOptions [line 1500]

getPageData [line 529]

Parameters:

getPageIdByOffset [line 551]

Parameters:

getPageRangeByPageId [line 595]

Parameters:

getPageSelectBox [line 1204]

Parameters:

getPerPageSelectBox [line 1180]

Parameters:

getPreviousPageID [line 664]

isFirstPage [line 703]

isLastPage [line 716]

isLastPageComplete [line 729]

numItems [line 677]

numPages [line 690]

setOptions [line 1395]

Parameters: