DBResultRange Class Reference

Public Member Functions
	__construct ($count, $page=1, $offset=null)
	getCount ()
	getOffset ()
	getPage ()
	isValid ()
	setCount ($count)
	setOffset ($offset)
	setPage ($page)

Data Fields
	$count
	$offset
	$page

Detailed Description

Container class for range information when retrieving a result set.

Definition at line 17 of file DBResultRange.inc.php.

Constructor & Destructor Documentation

__construct()

DBResultRange::__construct	(		$count,
			$page = 1,
			$offset = null
	)

Constructor. Initialize the DBResultRange.

Definition at line 31 of file DBResultRange.inc.php.

References $count, $offset, and $page.

Member Function Documentation

getCount()

DBResultRange::getCount

(

)

Returns the count of items in this range to display.

Returns

int

Definition at line 66 of file DBResultRange.inc.php.

References $count.

getOffset()

DBResultRange::getOffset

(

)

Returns the offset of items in this range to display.

Returns

int

Definition at line 82 of file DBResultRange.inc.php.

References $offset.

getPage()

DBResultRange::getPage

(

)

Returns the count of pages to skip.

Returns

int

Definition at line 50 of file DBResultRange.inc.php.

References $page.

isValid()

DBResultRange::isValid

(

)

Checks to see if the DBResultRange is valid.

Returns

boolean

Definition at line 41 of file DBResultRange.inc.php.

setCount()

DBResultRange::setCount

(

$count

)

Set the count of items in this range to display.

Parameters

$count

int

Definition at line 74 of file DBResultRange.inc.php.

References $count.

setOffset()

DBResultRange::setOffset

(

$offset

)

Set the offset of items in this range to display.

Parameters

$offset

int

Definition at line 90 of file DBResultRange.inc.php.

References $offset.

setPage()

DBResultRange::setPage

(

$page

)

Set the count of pages to skip.

Parameters

$page

int

Definition at line 58 of file DBResultRange.inc.php.

References $page.

Field Documentation

$count

DBResultRange::$count

The number of items to display

Definition at line 19 of file DBResultRange.inc.php.

Referenced by __construct(), getCount(), and setCount().

$offset

DBResultRange::$offset

Optional offset if pagination is not used.

Definition at line 25 of file DBResultRange.inc.php.

Referenced by __construct(), getOffset(), and setOffset().

$page

DBResultRange::$page

The number of pages to skip

Definition at line 22 of file DBResultRange.inc.php.

Referenced by __construct(), getPage(), and setPage().

---

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

• DBResultRange.inc.php