Open Journal Systems  3.0.0
 All Classes Namespaces Functions Variables Groups Pages
DBResultRange Class Reference

Public Member Functions

 DBResultRange ($count, $page=1)
 
 getCount ()
 
 getPage ()
 
 isValid ()
 
 setCount ($count)
 
 setPage ($page)
 

Public Attributes

 $count
 
 $page
 

Detailed Description

Container class for range information when retrieving a result set.

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

Member Function Documentation

DBResultRange::DBResultRange (   $count,
  $page = 1 
)

Constructor. Initialize the DBResultRange.

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

References $count, and $page.

DBResultRange::getCount ( )

Returns the count of items in this range to display.

Returns
int

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

References $count.

DBResultRange::getPage ( )

Returns the count of pages to skip.

Returns
int

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

References $page.

DBResultRange::isValid ( )

Checks to see if the DBResultRange is valid.

Returns
boolean

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

DBResultRange::setCount (   $count)

Set the count of items in this range to display.

Parameters
$countint

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

References $count.

DBResultRange::setPage (   $page)

Set the count of pages to skip.

Parameters
$pageint

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

References $page.

Member Data Documentation

DBResultRange::$count

The number of items to display

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

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

DBResultRange::$page

The number of pages to skip

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

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


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