Inheritance diagram for moodle_list:

Public Member Functions
	__construct ($type='ul', $attributes='', $editable=false, $pageurl=null, $page=0, $pageparamname= 'page', $itemsperpage=20)
	to_html ($indent=0, $extraargs=array())
	find_item ($id, $suppresserror=false)
	add_item ($item)
	set_parent ($parent)
	list_from_records ($paged=false, $offset=0)
	get_records ()
	display_page_numbers ()
	get_items_peers ($itemid)
	get_child_ids ()
	move_item_up_down ($direction, $id)
	reorder_peers ($peers)
	move_item_left ($id)
	move_item_right ($id)
	process_actions ($left, $right, $moveup, $movedown)
	item_is_first_on_page ($itemid)
	item_is_last_on_page ($itemid)
Data Fields
	$attributes
	$listitemclassname = 'list_item'
	$items = array()
	$type
	$parentitem = null
	$table
	$fieldnamesparent = 'parent'
	$records = array()
	$editable
	$childparent
	$page = 0
	$firstitem = 1
	$lastitem = 999999
	$pagecount
	$paged = false
	$offset = 0
	$pageurl
	$pageparamname

Detailed Description

Definition at line 47 of file listlib.php.

Constructor & Destructor Documentation

__construct	(	$	type = `'ul'`,
		$	attributes = `''`,
		$	editable = `false`,
		$	pageurl = `null`,
		$	page = `0`,
		$	pageparamname = `'page'`,
		$	itemsperpage = `20`
	)

Constructor.

Parameters:

string	$type
string	$attributes
boolean	$editable
moodle_url	$pageurl	url for this page
integer	$page	if 0 no pagination. (These three params only used in top level list.)
string	$pageparamname	name of url param that is used for passing page no
integer	$itemsperpage	no of top level items.

Definition at line 93 of file listlib.php.

Member Function Documentation

add_item ( $ item )

Definition at line 179 of file listlib.php.

display_page_numbers ( )

display list of page numbers for navigation

Definition at line 255 of file listlib.php.

find_item	(	$	id,
		$	suppresserror = `false`
	)

Recurse down the tree and find an item by it's id.

Parameters:

integer	$id
boolean	$suppresserror	error if not item found?

Returns:: list_item *copy* or null if item is not found

Definition at line 157 of file listlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

get_child_ids ( )

Returns an array of ids of child items.

Returns:: array peer ids

Definition at line 292 of file listlib.php.

get_items_peers ( $ itemid )

Returns an array of ids of peers of an item.

Parameters:

int	itemid - if given, restrict records to those with this parent id.

Returns:: array peer ids

Definition at line 281 of file listlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

get_records ( ) [abstract]

Should be overriden to return an array of records of list items.

Reimplemented in question_category_list.

Here is the caller graph for this function:

item_is_first_on_page ( $ itemid )

Parameters:

integer $itemid an item id.

Returns:: boolean Is the item with the given id the first top-level item on the current page?

Definition at line 444 of file listlib.php.

Here is the caller graph for this function:

item_is_last_on_page ( $ itemid )

Parameters:

integer $itemid an item id.

Returns:: boolean Is the item with the given id the last top-level item on the current page?

Definition at line 454 of file listlib.php.

Here is the caller graph for this function:

list_from_records	(	$	paged = `false`,
		$	offset = `0`
	)

Produces a hierarchical tree of list items from a flat array of records. 'parent' field is expected to point to a parent record. records are already sorted. If the parent field doesn't point to another record in the array then this is a top level list

Parameters:

integer $offset how many list toplevel items are there in lists before this one