PagingInfo Class Reference

Public Member Functions
	PagingInfo ($pageSize)
	setTotalCount ($totalCount)
	getTotalCount ()
	setPage ($page)
	getPage ()
	getPageSize ()
	getPageCount ()
	setIndex ($index)
	getIndex ()
	isOnFirstPage ()
	isOnLastPage ()

Public Attributes
	$_pageSize = 10
	$_index = 0
	$_totalCount = 0

Detailed Description

PagingInfo contains information about a paged list.

wCMF - wemove Content Management Framework Copyright (C) 2005-2014 wemove digital solutions GmbH

Licensed under the terms of any of the following licenses at your choice:

• GNU Lesser General Public License (LGPL) http://www.gnu.org/licenses/lgpl.html
• Eclipse Public License (EPL) http://www.eclipse.org/org/documents/epl-v10.php

See the license.txt file distributed with this work for additional information.

Id:

class.PagingInfo.php 1462 2014-02-04 23:52:27Z iherwig

Author

ingo herwig ingo@.nosp@m.wemo.nosp@m.ve.co.nosp@m.m

Definition at line 27 of file class.PagingInfo.php.

Member Function Documentation

PagingInfo::PagingInfo

(

$pageSize

)

Creates a PagingInfo object.

Parameters

pageSize

The pageSize (-1 to set no page size)

Definition at line 37 of file class.PagingInfo.php.

PagingInfo::setTotalCount

(

$totalCount

)

Set the number of list items.

Parameters

totalCount

The number of list items.

Definition at line 46 of file class.PagingInfo.php.

PagingInfo::getTotalCount

(

)

Get the number of list items.

Returns

The number of list items.

Definition at line 55 of file class.PagingInfo.php.

References $_totalCount.

PagingInfo::setPage

(

$page

)

Set the current page (1-based).

Parameters

page	The current page.

Definition at line 64 of file class.PagingInfo.php.

PagingInfo::getPage

(

)

Get the current page (1-based).

Returns

The current page.

Definition at line 73 of file class.PagingInfo.php.

Referenced by isOnFirstPage(), and isOnLastPage().

PagingInfo::getPageSize

(

)

Get the size of a pages.

Returns

The size of a pages.

Definition at line 82 of file class.PagingInfo.php.

References $_pageSize.

PagingInfo::getPageCount

(

)

Get the number of pages.

Returns

The number of pages.

Definition at line 91 of file class.PagingInfo.php.

Referenced by isOnLastPage().

PagingInfo::setIndex

(

$index

)

Set the current index (0-based).

Parameters

index

The current list index.

Definition at line 100 of file class.PagingInfo.php.

Referenced by AsyncPagingController\executeKernel().

PagingInfo::getIndex

(

)

Get the current index (0-based).

Definition at line 108 of file class.PagingInfo.php.

References $_index.

PagingInfo::isOnFirstPage

(

)

Determine if we are on the first page.

Returns

True/false.

Definition at line 117 of file class.PagingInfo.php.

References getPage().

Here is the call graph for this function:

PagingInfo::isOnLastPage

(

)

Determine if we are on the first page.

Returns

True/false.

Definition at line 126 of file class.PagingInfo.php.

References getPage(), and getPageCount().

Here is the call graph for this function:

Member Data Documentation

PagingInfo::$_pageSize = 10

Definition at line 29 of file class.PagingInfo.php.

Referenced by getPageSize().

PagingInfo::$_index = 0

Definition at line 30 of file class.PagingInfo.php.

Referenced by getIndex().

PagingInfo::$_totalCount = 0

Definition at line 31 of file class.PagingInfo.php.

Referenced by getTotalCount().

---

The documentation for this class was generated from the following file:

• C:/Users/ingo/Daten/web/htdocs/wcmf3.x/SVN/framework/wcmf/lib/persistence/class.PagingInfo.php