Inheritance diagram for mod_lesson_renderer:

Public Member Functions
	__call ($method, $arguments)
	Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.

	add_action_handler (component_action $action, $id=null)
	Adds a JS action for the element with the provided id.

	add_first_page_links (lesson $lesson)
	Return HTML to display add first page links.

	add_page_links (lesson $lesson, $prevpageid=false)
	Returns HTML to display the add page links.

	continue_links (lesson $lesson, $lastpageseenid)
	Returns HTML to display a continue button.

	dependancy_errors ($dependentlesson, $errors)
	Returns HTML to display dependancy errors.

	display_edit_collapsed (lesson $lesson, $pageid)
	Returns HTML to display a collapsed edit form.

	display_edit_full (lesson $lesson, $pageid, $prevpageid, $single=false)
	Returns HTML to display the full edit page.

	display_eol_page (lesson $lesson, $data)
	Returns the HTML for displaying the end of lesson page.

	display_page (lesson $lesson, lesson_page $page, $attempt)
	Returns HTML to display a page to the user.

	footer ()
	Returns the footer.

	get_compact_logo_url ($maxwidth=300, $maxheight=300)
	Return the site's compact logo URL, if any.

	get_logo_url ($maxwidth=null, $maxheight=200)
	Return the site's logo URL, if any.

	get_page ()
	Returns the moodle page object.

	has_started ()
	Returns true is output has already started, and false if not.

	header ($lesson, $cm, $currenttab='', $extraeditbuttons=false, $lessonpageid=null, $extrapagetitle=null)
	Returns the header for the lesson module.

	image_url ($imagename, $component='moodle')
	Return the moodle_url for an image.

	lesson_inaccessible ($message)
	Returns HTML for a lesson inaccessible message.

	login_prompt (lesson $lesson, $failedattempt=false)
	Returns HTML to prompt the user to log in.

	message ($message, single_button $button=null)
	Returns HTML to display a message.

	ongoing_score (lesson $lesson)
	Prints the on going message to the user.

	page_action_links (lesson_page $page, $printmove, $printaddpage=false)
	Returns HTML to display action links for a page.

	paragraph ($contents, $class='')
	Returns a P tag containing contents.

	pix_url ($imagename, $component='moodle')
	Return the direct URL for an image from the pix folder.

	progress_bar (lesson $lesson, $progress=null)
	Returns HTML to display a progress bar of progression through a lesson.

	render (renderable $widget)
	Renders the provided widget and returns the HTML to display it.

	render_edit_action_area (\mod_lesson\output\edit_action_area $editarea)
	Render the edit action area.

	render_edit_action_buttons (\mod_lesson\output\edit_action_buttons $editbuttons)
	Render the edit action buttons.

	render_from_template ($templatename, $context)
	Renders a template by name with the given context.

	render_override_action_menu (\mod_lesson\output\override_action_menu $overrideactionmenu)
	Render the override action menu.

	render_report_action_menu (\mod_lesson\output\report_action_menu $reportmenu)
	Render the report action menu.

	should_display_main_logo ($headinglevel=1)
	Whether we should display the main logo.

	should_display_navbar_logo ()
	Whether we should display the logo in the navbar.

	slideshow_end ()
	Returns HTML to show the end of a slideshow.

	slideshow_start (lesson $lesson)
	Returns HTML to show the start of a slideshow.

Static Public Member Functions
static	prepare_classes ($classes)
	Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.

Protected Member Functions
	get_mustache ()
	Return an instance of the mustache class.

Protected Attributes
xhtml_container_stack	$opencontainers
	The xhtml_container_stack to use.

renderer_base core_renderer	$output
	A reference to the current renderer.

moodle_page	$page
	The Moodle page the renderer has been created to assist with.

string	$target
	The requested rendering target.

array	$templatecache = []
	$templatecache The mustache template cache.

Member Function Documentation

◆ add_first_page_links()

mod_lesson_renderer::add_first_page_links ( lesson $lesson )

Return HTML to display add first page links.

Parameters

lesson $lesson

Return values

string

◆ add_page_links()

mod_lesson_renderer::add_page_links	(	lesson	$lesson,
			$prevpageid = false )

Returns HTML to display the add page links.

Parameters

lesson	$lesson
int	$prevpageid

Return values

string

◆ continue_links()

mod_lesson_renderer::continue_links	(	lesson	$lesson,
			$lastpageseenid )

Returns HTML to display a continue button.

Parameters

lesson	$lesson
int	$lastpageseen

Return values

string

◆ dependancy_errors()

mod_lesson_renderer::dependancy_errors	(		$dependentlesson,
			$errors )

Returns HTML to display dependancy errors.

Parameters

object	$dependentlesson
array	$errors

Return values

string

◆ display_edit_collapsed()

mod_lesson_renderer::display_edit_collapsed	(	lesson	$lesson,
			$pageid )

Returns HTML to display a collapsed edit form.

Parameters

lesson	$lesson
int	$pageid

Return values

string

◆ display_edit_full()

mod_lesson_renderer::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

Return values

string

◆ display_eol_page()

mod_lesson_renderer::display_eol_page	(	lesson	$lesson,
			$data )

Returns the HTML for displaying the end of lesson page.

Parameters

lesson	$lesson	lesson instance
stdclass	$data	lesson data to be rendered

Return values

string HTML contents

◆ display_page()

mod_lesson_renderer::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

Return values

string

◆ footer()

mod_lesson_renderer::footer ( )

Returns the footer.

Return values

string

◆ header()

mod_lesson_renderer::header	(	$lesson,
		$cm,
		$currenttab = '',
		$extraeditbuttons = false,
		$lessonpageid = null,
		$extrapagetitle = null )

Returns the header for the lesson module.

Parameters

lesson	$lesson	a lesson object.
string	$currenttab	current tab that is shown.
bool	$extraeditbuttons	if extra edit buttons should be displayed.
int	$lessonpageid	id of the lesson page that needs to be displayed.
string	$extrapagetitle	String to appent to the page title.

Return values

string

◆ lesson_inaccessible()

mod_lesson_renderer::lesson_inaccessible ( $message )

Returns HTML for a lesson inaccessible message.

Parameters

string $message

Return values

<type>

◆ login_prompt()

mod_lesson_renderer::login_prompt	(	lesson	$lesson,
			$failedattempt = false )

Returns HTML to prompt the user to log in.

Parameters

lesson	$lesson
bool	$failedattempt

Return values

string

◆ message()

mod_lesson_renderer::message	(		$message,
		single_button	$button = null )

Returns HTML to display a message.

Parameters

string	$message
single_button	$button

Return values

string

◆ ongoing_score()

mod_lesson_renderer::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.

Return values

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

Return values

string

◆ page_action_links()

mod_lesson_renderer::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

Return values

string

◆ paragraph()

mod_lesson_renderer::paragraph	(		$contents,
			$class = '' )

Returns a P tag containing contents.

Parameters

string	$contents
string	$class

◆ progress_bar()

mod_lesson_renderer::progress_bar	(	lesson	$lesson,
			$progress = null )

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

Parameters

lesson	$lesson
int	$progress	optional, if empty it will be calculated

Return values

string

◆ render_edit_action_area()

mod_lesson_renderer::render_edit_action_area ( \mod_lesson\output\edit_action_area $editarea )

Render the edit action area.

Parameters

mod_lesson\output\edit_action_area $editarea The edit area.

Return values

string The rendered edit action area.

◆ render_edit_action_buttons()

mod_lesson_renderer::render_edit_action_buttons ( \mod_lesson\output\edit_action_buttons $editbuttons )

Render the edit action buttons.

Parameters

mod_lesson\output\edit_action_buttons $editbuttons The editbuttons

Return values

string The rendered edit action buttons.

◆ render_override_action_menu()

mod_lesson_renderer::render_override_action_menu ( \mod_lesson\output\override_action_menu $overrideactionmenu )

Render the override action menu.

Parameters

mod_lesson\output\override_action_menu $overrideactionmenu The overrideactionmenu

Return values

string The rendered override action menu.

◆ render_report_action_menu()

mod_lesson_renderer::render_report_action_menu ( \mod_lesson\output\report_action_menu $reportmenu )

Render the report action menu.

Parameters

mod\lesson\output\report_action_menu $reportmenu The reportmenu.

Return values

string The rendered report action menu.

◆ slideshow_start()

mod_lesson_renderer::slideshow_start ( lesson $lesson )

Returns HTML to show the start of a slideshow.

Parameters

lesson $lesson

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

mod/lesson/renderer.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Function Documentation

◆ add_first_page_links()

◆ add_page_links()

◆ continue_links()

◆ dependancy_errors()

◆ display_edit_collapsed()

◆ display_edit_full()

◆ display_eol_page()

◆ display_page()

◆ footer()

◆ header()

◆ lesson_inaccessible()

◆ login_prompt()

◆ message()

◆ ongoing_score()

◆ page_action_links()

◆ paragraph()

◆ progress_bar()

◆ render_edit_action_area()

◆ render_edit_action_buttons()

◆ render_override_action_menu()

◆ render_report_action_menu()

◆ slideshow_start()