Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
mod_lesson_renderer Class Reference
Inheritance diagram for mod_lesson_renderer:
plugin_renderer_base renderer_base

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

◆ __call()

plugin_renderer_base::__call ( $method,
$arguments )
inherited

Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.

Parameters
string$method
array$arguments
Return values
mixed

◆ add_action_handler()

renderer_base::add_action_handler ( component_action $action,
$id = null )
inherited

Adds a JS action for the element with the provided id.

This method adds a JS event for the provided component action to the page and then returns the id that the event has been attached to. If no id has been provided then a new ID is generated by html_writer::random_id()

Parameters
component_action$action
string$id
Return values
stringid of element, either original submitted or random new if not supplied

◆ 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$lessonlesson instance
stdclass$datalesson data to be rendered
Return values
stringHTML 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

◆ get_compact_logo_url()

renderer_base::get_compact_logo_url ( $maxwidth = 300,
$maxheight = 300 )
inherited

Return the site's compact logo URL, if any.

Parameters
int$maxwidthThe maximum width, or null when the maximum width does not matter.
int$maxheightThe maximum height, or null when the maximum height does not matter.
Return values
moodle_url|false

◆ get_logo_url()

renderer_base::get_logo_url ( $maxwidth = null,
$maxheight = 200 )
inherited

Return the site's logo URL, if any.

Parameters
int$maxwidthThe maximum width, or null when the maximum width does not matter.
int$maxheightThe maximum height, or null when the maximum height does not matter.
Return values
moodle_url|false

◆ get_mustache()

renderer_base::get_mustache ( )
protectedinherited

Return an instance of the mustache class.

Since
2.9
Return values
Mustache_Engine

◆ has_started()

renderer_base::has_started ( )
inherited

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

Return values
booleantrue if the header has been printed.

◆ header()

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

Returns the header for the lesson module.

Parameters
lesson$lessona lesson object.
string$currenttabcurrent tab that is shown.
bool$extraeditbuttonsif extra edit buttons should be displayed.
int$lessonpageidid of the lesson page that needs to be displayed.
string$extrapagetitleString to appent to the page title.
Return values
string

◆ image_url()

renderer_base::image_url ( $imagename,
$component = 'moodle' )
inherited

Return the moodle_url for an image.

The exact image location and extension is determined automatically by searching for gif|png|jpg|jpeg, please note there can not be diferent images with the different extension. The imagename is for historical reasons a relative path name, it may be changed later for core images. It is recommended to not use subdirectories in plugin and theme pix directories.

There are three types of images: 1/ theme images - stored in theme/mytheme/pix/, use component 'theme' 2/ core images - stored in /pix/, overridden via theme/mytheme/pix_core/ 3/ plugin images - stored in mod/mymodule/pix, overridden via theme/mytheme/pix_plugins/mod/mymodule/, example: image_url('comment', 'mod_glossary')

Parameters
string$imagenamethe pathname of the image
string$componentfull plugin name (aka component) or 'theme'
Return values
moodle_url

◆ 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$lessonThe lesson that the user is taking.
Return values
voidPrints 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

◆ pix_url()

renderer_base::pix_url ( $imagename,
$component = 'moodle' )
inherited

Return the direct URL for an image from the pix folder.

Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.

Deprecated
since Moodle 3.3
Parameters
string$imagenamethe name of the icon.
string$componentspecification of one plugin like in get_string()
Return values
moodle_url

◆ prepare_classes()

static renderer_base::prepare_classes ( $classes)
staticinherited

Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.

Parameters
mixed$classesSpace-separated string or array of classes
Return values
stringHTML class attribute value

◆ 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$progressoptional, if empty it will be calculated
Return values
string

◆ render()

plugin_renderer_base::render ( renderable $widget)
inherited

Renders the provided widget and returns the HTML to display it.

Parameters
renderable$widgetinstance with renderable interface
Return values
string

Reimplemented from renderer_base.

Reimplemented in core_courseformat\output\section_renderer, and tool_policy\output\renderer.

◆ 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$editareaThe edit area.
Return values
stringThe 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$editbuttonsThe editbuttons
Return values
stringThe rendered edit action buttons.

◆ render_from_template()

renderer_base::render_from_template ( $templatename,
$context )
inherited

Renders a template by name with the given context.

The provided data needs to be array/stdClass made up of only simple types. Simple types are array,stdClass,bool,int,float,string

Since
2.9
Parameters
array | stdClass$contextContext containing data for the template.
Return values
string|boolean

◆ 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$overrideactionmenuThe overrideactionmenu
Return values
stringThe 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$reportmenuThe reportmenu.
Return values
stringThe rendered report action menu.

◆ should_display_main_logo()

renderer_base::should_display_main_logo ( $headinglevel = 1)
inherited

Whether we should display the main logo.

Deprecated
since Moodle 4.0
Todo
final deprecation. To be removed in Moodle 4.4 MDL-73165.
Parameters
int$headinglevelThe heading level we want to check against.
Return values
bool

◆ should_display_navbar_logo()

renderer_base::should_display_navbar_logo ( )
inherited

Whether we should display the logo in the navbar.

We will when there are no main logos, and we have compact logo.

Return values
bool

◆ slideshow_start()

mod_lesson_renderer::slideshow_start ( lesson $lesson)

Returns HTML to show the start of a slideshow.

Parameters
lesson$lesson

Member Data Documentation

◆ $output

renderer_base core_renderer plugin_renderer_base::$output
protectedinherited

A reference to the current renderer.

The renderer provided here will be determined by the page but will in 90% of cases by the core_renderer


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