Inheritance diagram for mod_lesson_renderer:

Collaboration diagram for mod_lesson_renderer:

Public Member Functions
	header ($lesson, $cm, $currenttab= '', $extraeditbuttons=false, $lessonpageid=null)
	footer ()
	lesson_inaccessible ($message)
	login_prompt (lesson $lesson, $failedattempt=false)
	dependancy_errors ($dependentlesson, $errors)
	message ($message, single_button $button=null)
	continue_links (lesson $lesson, $lastpageseenid)
	display_page (lesson $lesson, lesson_page $page, $attempt)
	display_edit_collapsed (lesson $lesson, $pageid)
	display_edit_full (lesson $lesson, $pageid, $prevpageid, $single=false)
	add_page_links (lesson $lesson, $prevpageid=false)
	add_first_page_links (lesson $lesson)
	page_action_links (lesson_page $page, $printmove, $printaddpage=false)
	ongoing_score (lesson $lesson)
	progress_bar (lesson $lesson)
	slideshow_start (lesson $lesson)
	slideshow_end ()
	paragraph ($contents, $class='')
	add_highscores_form (lesson $lesson)

Detailed Description

Definition at line 29 of file renderer.php.

Member Function Documentation

add_first_page_links ( lesson $ lesson )

Return HTML to display add first page links

Parameters:

lesson $lesson

Returns:: string

Definition at line 357 of file renderer.php.

Here is the call graph for this function:

add_highscores_form ( lesson $ lesson )

Returns HTML to display add_highscores_form

Parameters:

lesson $lesson

Returns:: string

Definition at line 581 of file renderer.php.

Here is the call graph for this function:

add_page_links	(	lesson $	lesson,
		$	prevpageid = `false`
	)

Returns HTML to display the add page links

Parameters:

lesson	$lesson
int	$prevpageid

Returns:: string

Definition at line 333 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

continue_links	(	lesson $	lesson,
		$	lastpageseenid
	)

Returns HTML to display a continue button

Parameters:

lesson	$lesson
int	$lastpageseen

Returns:: string

Definition at line 162 of file renderer.php.

Here is the call graph for this function:

dependancy_errors	(	$	dependentlesson,
		$	errors
	)

Returns HTML to display dependancy errors

Parameters:

object	$dependentlesson
array	$errors

Returns:: string

Definition at line 132 of file renderer.php.

display_edit_collapsed	(	lesson $	lesson,
		$	pageid
	)

Returns HTML to display a collapsed edit form

Parameters:

lesson	$lesson
int	$pageid

Returns:: string

Definition at line 201 of file renderer.php.

Here is the call graph for this function:

display_edit_full	(	lesson $	lesson,
		$	pageid,
		$	prevpageid,
		$	single = `false`
	)

Returns HTML to display the full edit page

Parameters:

lesson	$lesson
int	$pageid
int	$prevpageid
bool	$single

Returns:: string

Definition at line 247 of file renderer.php.

Here is the call graph for this function:

display_page	(	lesson $	lesson,
		lesson_page $	page,
		$	attempt
	)

Returns HTML to display a page to the user

Parameters:

lesson	$lesson
lesson_page	$page
object	$attempt

Returns:: string

Definition at line 185 of file renderer.php.

Here is the call graph for this function:

footer ( )

Returns the footer

Returns:: string

Definition at line 78 of file renderer.php.

header	(	$	lesson,
		$	cm,
		$	currenttab = `''`,
		$	extraeditbuttons = `false`,
		$	lessonpageid = `null`
	)

Returns the header for the lesson module

Parameters:

lesson	$lesson
string	$currenttab
bool	$extraeditbuttons
int	$lessonpageid

Returns:: string

Header setup

Definition at line 39 of file renderer.php.

Here is the call graph for this function:

lesson_inaccessible ( $ message )

Returns HTML for a lesson inaccessible message

Parameters:

string $message

Returns:: <type>

Definition at line 88 of file renderer.php.

Here is the call graph for this function:

login_prompt	(	lesson $	lesson,
		$	failedattempt = `false`
	)

Returns HTML to prompt the user to log in

Parameters:

lesson	$lesson
bool	$failedattempt

Returns:: string

Definition at line 105 of file renderer.php.

Here is the call graph for this function:

message	(	$	message,
		single_button $	button = `null`
	)

Returns HTML to display a message

Parameters:

string	$message
single_button	$button

Returns:: string

Definition at line 146 of file renderer.php.

ongoing_score ( lesson $ lesson )

Prints the on going message to the user.

With custom grading On, displays points earned out of total points possible thus far. With custom grading Off, displays number of correct answers out of total attempted.

Parameters:

object $lesson The lesson that the user is taking.

Returns:: void Prints the on going message to the user.

With custom grading On, displays points earned out of total points possible thus far. With custom grading Off, displays number of correct answers out of total attempted.

Parameters:

lesson $lesson

Returns:: string

Definition at line 452 of file renderer.php.

Here is the call graph for this function:

page_action_links	(	lesson_page $	page,
		$	printmove,
		$	printaddpage = `false`
	)

Returns HTML to display action links for a page

Parameters:

lesson_page	$page
bool	$printmove
bool	$printaddpage

Returns:: string

Definition at line 390 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

paragraph	(	$	contents,
		$	class = `''`
	)

Returns a P tag containing contents

Parameters:

string	$contents
string	$class

Definition at line 569 of file renderer.php.

Here is the call graph for this function:

progress_bar ( lesson $ lesson )

Returns HTML to display a progress bar of progression through a lesson

Parameters:

lesson $lesson

Returns:: string

Definition at line 483 of file renderer.php.

Here is the call graph for this function:

slideshow_end ( )

Returns HTML to show the end of a slideshow

Definition at line 561 of file renderer.php.

Here is the call graph for this function:

slideshow_start ( lesson $ lesson )

Returns HTML to show the start of a slideshow

Parameters:

lesson $lesson

Definition at line 552 of file renderer.php.

Here is the call graph for this function:

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

C:/xampp/htdocs/moodle/mod/lesson/renderer.php

Public Member Functions

Detailed Description

Member Function Documentation