Class: Quinoa_Pager

Source Location: /Quinoa/Pager.php

Class Overview

Author(s):

Marcello Duarte <marcello.duarte@gmail.com>

Version:

0.0.21 2007-09-23

Copyright:

2007

Class Details

[line 47]
Quinoa_Pager helps you create a pager for your recordlist
start is the index of the first item of the present page of the recordlist
totalOfRecords is the total of results of your recordlist
maximumOfRecords is the total of items you want displayed in the present page
maximumVisiblePages is maximum number of pages you want displayed PHP version 5. Copyright (c) 2007, Freeconcept, Lda.

Quinoa_Pager helps you create a pager for your recordlist
start is the index of the first item of the present page of the recordlist
totalOfRecords is the total of results of your recordlist
maximumOfRecords is the total of items you want displayed in the present page
maximumVisiblePages is maximum number of pages you want displayed PHP version 5.x Copyright (c) 2007, Freeconcept, Lda. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the Freeconcept, Lda. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Tags:

since:	File available since Release 0.0.1
link:	http://www.quinoaframework.org
version:	0.0.21 2007-09-23
copyright:	2007
author:	Marcello Duarte <marcello.duarte@gmail.com>

[ Top ]

Class Variables

$_maximumOfRecords =

[line 55]

Maximum number of records to be displayed in each page

Tags:

access:

protected

Type:

integer

[ Top ]

$_maximumVisiblePages =

[line 76]

Maximum number of pages visible at a time

Tags:

access:

protected

Type:

integer

[ Top ]

$_start =

[line 69]

Starting index of the set

Tags:

access:

protected

Type:

integer

[ Top ]

$_totalOfRecords =

[line 62]

Total of records without considering starting and ending of the set

Tags:

access:

protected

Type:

integer

[ Top ]

Class Methods

constructor __construct [line 86]

Quinoa_Pager __construct(
integer
$totalOfRecords, [integer
$start = 0], [integer
$maximumOfRecords = 25], [integer
$maximumVisiblePages = 5])

Constructs the Quinoa_Pager object

Tags:

access:

public

Parameters:

integer	$totalOfRecords
integer	$start
integer	$maximumOfRecords
integer	$maximumVisiblePages

[ Top ]

method getFirstPageOfSet [line 131]

integer getFirstPageOfSet(
)

get the first page of a set of pages

Tags:

access:

public

[ Top ]

method getFirstStartOfLastSet [line 141]

integer getFirstStartOfLastSet(
)

get the start index of the first page of the last set of pages

Tags:

access:

public

[ Top ]

method getLastPageOfSet [line 168]

integer getLastPageOfSet(
)

get the last page of the present set of pages

Tags:

access:

public

[ Top ]

method getMaximumOfRecords [line 181]

void getMaximumOfRecords(
)

Tags:

access:

public

[ Top ]

method getMaximumVisiblePages [line 196]

void getMaximumVisiblePages(
)

Tags:

access:

public

[ Top ]

method getNumPages [line 102]

integer getNumPages(
)

Get the number of pages the total of records will need

Tags:

access:

public

[ Top ]

method getPresentPage [line 112]

integer getPresentPage(
)

get the present page

Tags:

access:

public

[ Top ]

method getPresentPageNumRecords [line 122]

integer getPresentPageNumRecords(
)

get the number of records of the present page

Tags:

access:

public

[ Top ]

method getStart [line 191]

void getStart(
)

Tags:

access:

public

[ Top ]

method getTotalOfRecords [line 186]

void getTotalOfRecords(
)

Tags:

access:

public

[ Top ]

method hasNext [line 150]

boolean hasNext(
)

Checks whether the page has another following it

Tags:

access:

public

[ Top ]

method hasPrevious [line 159]

boolean hasPrevious(
)

Checks whether the page has another before it

Tags:

access:

public

[ Top ]

method setMaximumOfRecords [line 201]

void setMaximumOfRecords(
mixed
$maximumOfRecords)

Tags:

access:

public

[ Top ]

method setMaximumVisiblePages [line 216]

void setMaximumVisiblePages(
mixed
$maximumVisiblePages)

Tags:

access:

public

[ Top ]

method setStart [line 211]

void setStart(
mixed
$start)

Tags:

access:

public

[ Top ]

method setTotalOfRecords [line 206]

void setTotalOfRecords(
mixed
$totalOfRecords)

Tags:

access:

public

[ Top ]

Documentation generated on Wed, 03 Oct 2007 14:25:47 +0100 by phpDocumentor 1.3.0RC3