[ Index ]

PHP Cross Reference of Eventum

title

Body

[close]

/include/ -> class.pager.php (summary)

(no description)

File Size: 212 lines (9 kb)
Included or required: 2 times
Referenced: 0 times
Includes or requires: 1 file
 include/class.error_handler.php

Defines 1 class

Pager:: (4 methods):
  getTotalRows()
  _buildQueryString()
  getLinks()
  getPortion()


Class: Pager  - X-Ref

Class to manage paginated links on the frontend pages.

getTotalRows($stmt)   X-Ref
Returns the total number of rows for a specific query. It is used to
calculate the total number of pages of data.

param: string $stmt The SQL statement
return: int The total number of rows

_buildQueryString()   X-Ref
Returns the query string to be used on the paginated links

return: string The query string

getLinks($row, $total_rows, $per_page, $show_links = "all", $show_blank = "off", $link_str = -1)   X-Ref
Returns an array with the paginated links, one in each item.

param: int $row Current page number (starts from zero)
param: int $total_rows Total number of rows, as returned by Pager::getTotalRows()
param: int $per_page Maximum number of rows per page
param: string $show_links An option to show 'Next'/'Previous' links, page numbering links or both ('sides', 'pages' or 'all')
param: string $show_blank An option to show 'Next'/'Previous' strings even if there are no appropriate next or previous pages
param: array $link_str The strings to be used instead of the default 'Next >>' and '<< Previous'
return: array The list of paginated links

getPortion($array, $current, $target_size = 20)   X-Ref
Returns a portion of an array of links, as returned by the Pager::getLinks()
function. This is especially useful for preventing a huge list of links
on the paginated list.

param: array $array The full list of paginated links
param: int $current The current page number
param: int $target_size The maximum number of paginated links
return: array The list of paginated links



Generated: Wed Dec 19 21:21:33 2007 Cross-referenced by PHPXref 0.7