lesson_page_type_branchtable Class Reference

Inheritance diagram for lesson_page_type_branchtable:

Collaboration diagram for lesson_page_type_branchtable:

Public Member Functions
	get_typeid ()
	get_typestring ()
	get_jumps ()
	get_idstring ()
	display ($renderer, $attempt)
	check_answer ()
	display_answers ($table)
	get_grayout ()
	report_answers ($answerpage, $answerdata, $useranswer, $pagestats, &$i, &$n)
	update ($properties)
	add_page_link ($previd)
	is_unseen ($param)
Static Public Member Functions
static	get_jumptooptions ($firstpage, $lesson)
Protected Member Functions
	get_displayinmenublock ()
Protected Attributes
	$type = lesson_page::TYPE_STRUCTURE
	$typeid = LESSON_PAGE_BRANCHTABLE
	$typeidstring = 'branchtable'
	$string = null
	$jumpto = null

---

Detailed Description

Definition at line 32 of file branchtable.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 255 of file branchtable.php.

check_answer

(

)

This method MUST be overridden by all question page types, or page types that wish to score a page.

The structure of result should always be the same so it is a good idea when overriding this method on a page type to call $result = parent::check_answer(); before modifying it as required.

Returns:

stdClass

Reimplemented from lesson_page.

Definition at line 148 of file branchtable.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 102 of file branchtable.php.

Here is the call graph for this function:

display_answers

(

$

table

)

Definition at line 202 of file branchtable.php.

Here is the call graph for this function:

get_displayinmenublock

(

)

[protected]

Set to true if this page should display in the menu block

Returns:

bool

Reimplemented from lesson_page.

Definition at line 260 of file branchtable.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 230 of file branchtable.php.

get_idstring

(

)

Definition at line 99 of file branchtable.php.

get_jumps

(

)

Gets an array of the jumps used by the answers of this page

Returns:

array

Reimplemented from lesson_page.

Definition at line 55 of file branchtable.php.

Here is the call graph for this function:

static get_jumptooptions	(	$	firstpage,
		$	lesson
	)		[static]

Definition at line 75 of file branchtable.php.

Here is the call graph for this function:

Here is the caller graph for this function:

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 40 of file branchtable.php.

get_typestring

(

)

This method should return the string that describes the pagetype

Returns:

string

Reimplemented from lesson_page.

Definition at line 43 of file branchtable.php.

is_unseen

(

$

param

)

Returns true if a page has been viewed before

Parameters:

array | int

$param

Either an array of pages that have been seen or the number of retakes a user has had

Returns:

bool

Reimplemented from lesson_page.

Definition at line 263 of file branchtable.php.

Here is the call graph for this function:

report_answers	(	$	answerpage,
		$	answerdata,
		$	useranswer,
		$	pagestats,
		&$	i,
		&$	n
	)

Formats the answers of this page for a report

Parameters:

object	$answerpage
object	$answerdata
object	$useranswer
array	$pagestats
int	$i	Count of first level answers
int	$n	Count of second level answers

Returns:

object The answer page for this

Reimplemented from lesson_page.

Definition at line 233 of file branchtable.php.

Here is the call graph for this function:

update

(

$

properties

)

Definition at line 246 of file branchtable.php.

---

Field Documentation

$jumpto = null [protected]

Definition at line 38 of file branchtable.php.

$string = null [protected]

Definition at line 37 of file branchtable.php.

$type = lesson_page::TYPE_STRUCTURE [protected]

Reimplemented from lesson_page.

Definition at line 34 of file branchtable.php.

$typeid = LESSON_PAGE_BRANCHTABLE [protected]

Definition at line 35 of file branchtable.php.

$typeidstring = 'branchtable' [protected]

Definition at line 36 of file branchtable.php.

---

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

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