lesson_page_type_cluster Class Reference

Inheritance diagram for lesson_page_type_cluster:

Collaboration diagram for lesson_page_type_cluster:

Public Member Functions
	display ($renderer, $attempt)
	get_typeid ()
	get_typestring ()
	get_idstring ()
	get_grayout ()
	callback_on_view ($canmanage)
	override_next_page ()
	add_page_link ($previd)
	valid_page_and_view (&$validpages, &$pageviews)
Protected Attributes
	$type = lesson_page::TYPE_STRUCTURE
	$typeidstring = 'cluster'
	$typeid = LESSON_PAGE_CLUSTER
	$string = null
	$jumpto = null

---

Detailed Description

Definition at line 32 of file cluster.php.

---

Member Function Documentation

add_page_link

(

$

previd

)

Can be set to true if the page requires a static link to create a new instance instead of simply being included in the dropdown

Parameters:

int

$previd

Returns:

bool

Reimplemented from lesson_page.

Definition at line 73 of file cluster.php.

Here is the call graph for this function:

callback_on_view

(

$

canmanage

)

This is a callback method that can be override and gets called when ever a page is viewed

Parameters:

bool

$canmanage

True if the user has the manage cap

Returns:

mixed

Reimplemented from lesson_page.

Definition at line 59 of file cluster.php.

Here is the call graph for this function:

display	(	$	renderer,
		$	attempt
	)

This method gets called to display the page to the user taking the lesson

Parameters:

object	$renderer
object	$attempt

Returns:

string

Reimplemented from lesson_page.

Definition at line 40 of file cluster.php.

get_grayout

(

)

Determines if this page should be grayed out on the management/report screens

Returns:

int 0 or 1

Reimplemented from lesson_page.

Definition at line 56 of file cluster.php.

get_idstring

(

)

Definition at line 53 of file cluster.php.

get_typeid

(

)

This method should return the integer used to identify the page type within the database and throughout code. This maps back to the defines used in 1.x

Returns:

int

Reimplemented from lesson_page.

Definition at line 44 of file cluster.php.

get_typestring

(

)

This method should return the string that describes the pagetype

Returns:

string

Reimplemented from lesson_page.

Definition at line 47 of file cluster.php.

override_next_page

(

)

A callback method that allows a page to override the next page a user will see during when this page is being completed.

Returns:

false|int

Reimplemented from lesson_page.

Definition at line 69 of file cluster.php.

Here is the call graph for this function:

valid_page_and_view	(	&$	validpages,
		&$	pageviews
	)

This method is used to determine if this page is a valid page

Parameters:

array	$validpages
array	$pageviews

Returns:

int The next page id to check

Reimplemented from lesson_page.

Definition at line 78 of file cluster.php.

Here is the call graph for this function:

---

Field Documentation

$jumpto = null [protected]

Definition at line 38 of file cluster.php.

$string = null [protected]

Definition at line 37 of file cluster.php.

$type = lesson_page::TYPE_STRUCTURE [protected]

Reimplemented from lesson_page.

Definition at line 34 of file cluster.php.

$typeid = LESSON_PAGE_CLUSTER [protected]

Definition at line 36 of file cluster.php.

$typeidstring = 'cluster' [protected]

Definition at line 35 of file cluster.php.

---

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

• C:/xampp/htdocs/moodle/mod/lesson/pagetypes/cluster.php