Class PaginatedResult

Description

Stores information of a result that spans across multiple pages.

Located in /src/PaginatedResult.php (line 9)


	
			
Method Summary
PaginatedResult __construct (integer $totalResults, integer $startIndex, integer $itemsPerPage, array $results)
integer getCurrentPage ()
integer getItemsPerPage ()
integer getPages ()
array getResults ()
integer getStartIndex ()
integer getTotalResults ()
Methods
Constructor __construct (line 47)

Create a PaginatedResult object.

  • access: public
PaginatedResult __construct (integer $totalResults, integer $startIndex, integer $itemsPerPage, array $results)
  • integer $totalResults: Number of total results.
  • integer $startIndex: Index of the first result element.
  • integer $itemsPerPage: Number of items per page.
  • array $results: An array of results.
getCurrentPage (line 77)

Returns the current page.

  • return: Current page number.
  • access: public
integer getCurrentPage ()
getItemsPerPage (line 86)

Returns the number of items per page.

  • return: Number of items per page.
  • access: public
integer getItemsPerPage ()
getPages (line 95)

Returns the number total pages.

  • return: Total pages.
  • access: public
integer getPages ()
getResults (line 104)

Returns the array of results.

  • return: An array of result elements.
  • access: public
array getResults ()
getStartIndex (line 68)

Returns the index of the first result element.

  • return: Index of the first element.
  • access: public
integer getStartIndex ()
getTotalResults (line 59)

Returns the number of total results.

  • return: Number of total results.
  • access: public
integer getTotalResults ()

Documentation generated on Mon, 22 Dec 2008 16:57:40 +0100 by phpDocumentor 1.4.1