Class mr_html_paging

Description

MR HTML Paging

Provides a paging bar and a results per page selector.

Located in /html/paging.php (line 40)

mr_readonly
   |
   --mr_html_paging
Variable Summary
Method Summary
mr_html_paging __construct (mr_preferences $preferences,  $url)
int get_limitfrom ()
mixed get_limitnum ()
mr_html_paging set_page (int $page)
mr_html_paging set_perpageopts ([mixed $options = NULL])
mr_html_paging set_total (int $total)
string __toString ()
Variables
int $page = 0 (line 63)

Current page number

  • access: protected
int $perpage = 50 (line 70)

The number of enteries per page

  • access: protected
mixed $perpageopts = false (line 77)

Per page options

  • access: protected
mr_preferences $preferences (line 91)

Preferences

  • access: protected
mixed $REQUEST_PAGE = 'tpage' (line 44)

Page request param

  • access: public
mixed $REQUEST_PERPAGE = 'tperpage' (line 49)

Page request param

  • access: public
int $total = 0 (line 56)

The total number of entries available to be paged through

  • access: protected
moodle_url $url (line 84)

Base URL

  • access: protected
Methods
Constructor __construct (line 99)

Constructor

  • access: public
mr_html_paging __construct (mr_preferences $preferences,  $url)
  • mr_preferences $preferences: Preferences to store paging information
  • moodle_url $url: Current URL
get_limitfrom (line 193)

Get limitfrom SQL value

  • access: public
int get_limitfrom ()
get_limitnum (line 202)

Get limitnum SQL value

  • access: public
mixed get_limitnum ()
set_export (line 177)

Set the export instance

This will set the limitfrom and limitnum appropriately for exporting

  • access: public
mr_html_paging set_export (mr_file_export $export)
set_page (line 136)

Set the page

  • access: public
mr_html_paging set_page (int $page)
  • int $page
set_perpage (line 147)

Set perpage

  • access: public
mr_html_paging set_perpage (int $size)
  • int $size: Page size
set_perpageopts (line 158)

Perpage options

  • access: public
mr_html_paging set_perpageopts ([mixed $options = NULL])
  • mixed $options: An array of options or false or NULL for default set of options
set_total (line 125)

Set total

  • access: public
mr_html_paging set_total (int $total)
  • int $total: The total
__toString (line 115)

Convert this table into a simple string

  • access: public
string __toString ()

Inherited Methods

Inherited From mr_readonly

mr_readonly::__call()

Documentation generated on Thu, 28 Jun 2012 16:33:49 -0700 by phpDocumentor 1.4.3