paging_bar Class Reference

Complex components aggregating simpler components. More...

Inheritance diagram for paging_bar:

Collaboration diagram for paging_bar:

Public Member Functions
	__construct ($totalcount, $page, $perpage, $baseurl, $pagevar= 'page')
	prepare (renderer_base $output, moodle_page $page, $target)
Data Fields
	$maxdisplay = 18
	$totalcount
	$page
	$perpage
	$baseurl
	$pagevar
	$previouslink = null
	$nextlink = null
	$firstlink = null
	$lastlink = null
	$pagelinks = array()

---

Detailed Description

Complex components aggregating simpler components.

Component representing a paging bar.

Copyright:

2009 Nicolas Connault http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Since:

Moodle 2.0

Definition at line 1952 of file outputcomponents.php.

---

Constructor & Destructor Documentation

__construct	(	$	totalcount,
		$	page,
		$	perpage,
		$	baseurl,
		$	pagevar = 'page'
	)

Constructor paging_bar with only the required params.

Parameters:

int	$totalcount	The total number of entries available to be paged through
int	$page	The page you are currently viewing
int	$perpage	The number of entries that should be shown per page
string | moodle_url	$baseurl	url of the current page, the $pagevar parameter is added
string	$pagevar	name of page parameter that holds the page number

Definition at line 2008 of file outputcomponents.php.

---

Member Function Documentation

prepare	(	renderer_base $	output,
		moodle_page $	page,
		$	target
	)

Returns:

void

Definition at line 2019 of file outputcomponents.php.

Here is the call graph for this function:

Here is the caller graph for this function:

---

Field Documentation

$baseurl

Definition at line 1973 of file outputcomponents.php.

$firstlink = null

Definition at line 1989 of file outputcomponents.php.

$lastlink = null

Definition at line 1993 of file outputcomponents.php.

$maxdisplay = 18

Definition at line 1956 of file outputcomponents.php.

$nextlink = null

Definition at line 1985 of file outputcomponents.php.

$page

Definition at line 1964 of file outputcomponents.php.

$pagelinks = array()

Definition at line 1997 of file outputcomponents.php.

$pagevar

Definition at line 1977 of file outputcomponents.php.

$perpage

Definition at line 1968 of file outputcomponents.php.

$previouslink = null

Definition at line 1981 of file outputcomponents.php.

$totalcount

Definition at line 1960 of file outputcomponents.php.

---

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

• C:/xampp/htdocs/moodle/lib/outputcomponents.php