This is a convenience renderer which can be used by section based formats to reduce code duplication. More...

Inheritance diagram for format_section_renderer_base:

Public Member Functions
	__construct (moodle_page $page, $target)
	Constructor method, calls the parent constructor. More...

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

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

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

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

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

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

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

	print_multiple_section_page ($course, $sections, $mods, $modnames, $modnamesused)
	Output the html for a multiple section page. More...

	print_single_section_page ($course, $sections, $mods, $modnames, $modnamesused, $displaysection)
	Output the html for a single section page . More...

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

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

	section_availability ($section)
	Displays availability information for the section (hidden, not available unles, etc.) More...

	section_title ($section, $course)
	Generate the section title, wraps it in a link to the section page if page is to be displayed on a separate page. More...

	section_title_without_link ($section, $course)
	Generate the section title to be displayed on the section page, without a link. More...

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

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

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

Protected Member Functions
	change_number_sections ($course, $sectionreturn=null)
	Returns controls in the bottom of the page to increase/decrease number of sections. More...

	course_activity_clipboard ($course, $sectionno=null)
	Show if something is on on the course clipboard (moving around) More...

	end_section_list ()
	Generate the closing container html for a list of sections. More...

	format_summary_text ($section)
	Generate html for a section summary text. More...

	get_mustache ()
	Return an instance of the mustache class. More...

	get_nav_links ($course, $sections, $sectionno)
	Generate next/previous section links for naviation. More...

	page_title ()
	Generate the title for this section page. More...

	section_activity_summary ($section, $course, $mods)
	Generate a summary of the activites in a section. More...

	section_availability_message ($section, $canviewhidden)
	If section is not visible, display the message about that ('Not available until...', that sort of thing). More...

	section_edit_control_items ($course, $section, $onsectionpage=false)
	Generate the edit control items of a section. More...

	section_edit_control_menu ($controls, $course, $section)
	Generate the edit control action menu. More...

	section_edit_controls ()

	section_footer ()
	Generate the display of the footer part of a section. More...

	section_header ($section, $course, $onsectionpage, $sectionreturn=null)
	Generate the display of the header part of a section before course modules are included. More...

	section_hidden ($sectionno, $courseorid=null)
	Generate the html for a hidden section. More...

	section_left_content ($section, $course, $onsectionpage)
	Generate the content to displayed on the left part of a section before course modules are included. More...

	section_nav_selection ($course, $sections, $displaysection)
	Generate the html for the 'Jump to' menu on a single section page. More...

	section_right_content ($section, $course, $onsectionpage)
	Generate the content to displayed on the right part of a section before course modules are included. More...

	section_summary ($section, $course, $mods)
	Generate a summary of a section for display on the 'course index page'. More...

	start_section_list ()
	Generate the starting container html for a list of sections. More...

	stealth_section_footer ()
	Generate footer html of a stealth section. More...

	stealth_section_header ($sectionno)
	Generate the header html of a stealth section. More...

Protected Attributes
core_course_renderer	$courserenderer
	contains instance of core course renderer

xhtml_container_stack	$opencontainers
	The xhtml_container_stack to use.

renderer_base core_renderer	$output
	A reference to the current renderer. More...

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

string	$target
	The requested rendering target.

Detailed Description

This is a convenience renderer which can be used by section based formats to reduce code duplication.

It is not necessary for all course formats to use this and its likely to change in future releases.

Copyright: 2012 Dan Poltawski

License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Since: Moodle 2.3

Constructor & Destructor Documentation

◆ __construct()

format_section_renderer_base::__construct	(	moodle_page	$page,
			$target
	)

Constructor method, calls the parent constructor.

Parameters

moodle_page	$page
string	$target	one of rendering target constants

Reimplemented from plugin_renderer_base.

Reimplemented in format_topics_renderer.

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

string id of element, either original submitted or random new if not supplied

◆ change_number_sections()

format_section_renderer_base::change_number_sections	(	$course,
		$sectionreturn = `null`
	)

protected

Returns controls in the bottom of the page to increase/decrease number of sections.

Parameters

stdClass	$course
int \| null	$sectionreturn

Return values

string

◆ course_activity_clipboard()

format_section_renderer_base::course_activity_clipboard	(	$course,
		$sectionno = `null`
	)

protected

Show if something is on on the course clipboard (moving around)

Parameters

stdClass	$course	The course entry from DB
int	$sectionno	The section number in the course which is being displayed

Return values

string HTML to output.

◆ end_section_list()

format_section_renderer_base::end_section_list ( )

abstractprotected

Generate the closing container html for a list of sections.

Return values

string HTML to output.

Reimplemented in format_weeks_renderer, and format_topics_renderer.

◆ format_summary_text()

format_section_renderer_base::format_summary_text ( $section )

protected

Generate html for a section summary text.

Parameters

stdClass $section The course_section entry from DB

Return values

string HTML to output.

◆ 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	$maxwidth	The maximum width, or null when the maximum width does not matter.
int	$maxheight	The 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	$maxwidth	The maximum width, or null when the maximum width does not matter.
int	$maxheight	The 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

◆ get_nav_links()

format_section_renderer_base::get_nav_links	(	$course,
		$sections,
		$sectionno
	)

protected

Generate next/previous section links for naviation.

Parameters

stdClass	$course	The course entry from DB
array	$sections	The course_sections entries from the DB
int	$sectionno	The section number in the course which is being displayed

Return values

array associative array with previous and next section link

◆ has_started()

renderer_base::has_started ( )

inherited

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

Return values

boolean true if the header has been printed.

◆ 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	$imagename	the pathname of the image
string	$component	full plugin name (aka component) or 'theme'

Return values

moodle_url

◆ page_title()

format_section_renderer_base::page_title ( )

abstractprotected

Generate the title for this section page.

Return values

string the page title

Reimplemented in format_weeks_renderer, and format_topics_renderer.

◆ 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	$imagename	the name of the icon.
string	$component	specification 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 $classes Space-separated string or array of classes

Return values

string HTML class attribute value

◆ print_multiple_section_page()

format_section_renderer_base::print_multiple_section_page	(	$course,
		$sections,
		$mods,
		$modnames,
		$modnamesused
	)

Output the html for a multiple section page.

Parameters

stdClass	$course	The course entry from DB
array	$sections	(argument not used)
array	$mods	(argument not used)
array	$modnames	(argument not used)
array	$modnamesused	(argument not used)

◆ print_single_section_page()

format_section_renderer_base::print_single_section_page	(	$course,
		$sections,
		$mods,
		$modnames,
		$modnamesused,
		$displaysection
	)

Output the html for a single section page .

Parameters

stdClass	$course	The course entry from DB
array	$sections	(argument not used)
array	$mods	(argument not used)
array	$modnames	(argument not used)
array	$modnamesused	(argument not used)
int	$displaysection	The section number in the course which is being displayed

◆ render()

plugin_renderer_base::render ( renderable $widget )

inherited

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

Parameters

renderable $widget instance with renderable interface

Return values

string

Reimplemented from renderer_base.

Reimplemented in tool_policy\output\renderer.

◆ 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 $context Context containing data for the template.

Return values

string|boolean

◆ section_activity_summary()

format_section_renderer_base::section_activity_summary	(	$section,
		$course,
		$mods
	)

protected

Generate a summary of the activites in a section.

Parameters

stdClass	$section	The course_section entry from DB
stdClass	$course	the course record from DB
array	$mods	(argument not used)

Return values

string HTML to output.

◆ section_availability()

format_section_renderer_base::section_availability ( $section )

Displays availability information for the section (hidden, not available unles, etc.)

Parameters

section_info $section

Return values

string

◆ section_availability_message()

format_section_renderer_base::section_availability_message	(	$section,
		$canviewhidden
	)

protected

If section is not visible, display the message about that ('Not available until...', that sort of thing).

Otherwise, returns blank.

For users with the ability to view hidden sections, it shows the information even though you can view the section and also may include slightly fuller information (so that teachers can tell when sections are going to be unavailable etc). This logic is the same as for activities.

Parameters

section_info	$section	The course_section entry from DB
bool	$canviewhidden	True if user can view hidden sections

Return values

string HTML to output

◆ section_edit_control_items()

format_section_renderer_base::section_edit_control_items	(	$course,
		$section,
		$onsectionpage = `false`
	)

protected

Generate the edit control items of a section.

Parameters

stdClass	$course	The course entry from DB
stdClass	$section	The course_section entry from DB
bool	$onsectionpage	true if being printed on a section page

Return values

array of edit control items

Reimplemented in format_topics_renderer.

◆ section_edit_control_menu()

format_section_renderer_base::section_edit_control_menu	(	$controls,
		$course,
		$section
	)

protected

Generate the edit control action menu.

Parameters

array	$controls	The edit control items from section_edit_control_items
stdClass	$course	The course entry from DB
stdClass	$section	The course_section entry from DB

Return values

string HTML to output.

◆ section_edit_controls()

format_section_renderer_base::section_edit_controls ( )

protected

Deprecated:: since Moodle 3.0 MDL-48947 - Use format_section_renderer_base::section_edit_control_items() instead

◆ section_footer()

format_section_renderer_base::section_footer ( )

protected

Generate the display of the footer part of a section.

Return values

string HTML to output.

◆ section_header()

format_section_renderer_base::section_header	(	$section,
		$course,
		$onsectionpage,
		$sectionreturn = `null`
	)

protected

Generate the display of the header part of a section before course modules are included.

Parameters

stdClass	$section	The course_section entry from DB
stdClass	$course	The course entry from DB
bool	$onsectionpage	true if being printed on a single-section page
int	$sectionreturn	The section to return to after an action

Return values

string HTML to output.

◆ section_hidden()

format_section_renderer_base::section_hidden	(	$sectionno,
		$courseorid = `null`
	)

protected

Generate the html for a hidden section.

Parameters

int	$sectionno	The section number in the course which is being displayed
int \| stdClass	$courseorid	The course to get the section name for (object or just course id)

Return values

string HTML to output.

◆ section_left_content()

format_section_renderer_base::section_left_content	(	$section,
		$course,
		$onsectionpage
	)

protected

Generate the content to displayed on the left part of a section before course modules are included.

Parameters

stdClass	$section	The course_section entry from DB
stdClass	$course	The course entry from DB
bool	$onsectionpage	true if being printed on a section page

Return values

string HTML to output.

◆ section_nav_selection()

format_section_renderer_base::section_nav_selection	(	$course,
		$sections,
		$displaysection
	)

protected

Generate the html for the 'Jump to' menu on a single section page.

Parameters

stdClass	$course	The course entry from DB
array	$sections	The course_sections entries from the DB
	$displaysection	the current displayed section number.

Return values

string HTML to output.

◆ section_right_content()

format_section_renderer_base::section_right_content	(	$section,
		$course,
		$onsectionpage
	)

protected

Generate the content to displayed on the right part of a section before course modules are included.

Parameters

stdClass	$section	The course_section entry from DB
stdClass	$course	The course entry from DB
bool	$onsectionpage	true if being printed on a section page

Return values

string HTML to output.

◆ section_summary()

format_section_renderer_base::section_summary	(	$section,
		$course,
		$mods
	)

protected

Generate a summary of a section for display on the 'course index page'.

Parameters

stdClass	$section	The course_section entry from DB
stdClass	$course	The course entry from DB
array	$mods	(argument not used)

Return values

string HTML to output.

◆ section_title()

format_section_renderer_base::section_title	(	$section,
		$course
	)

Generate the section title, wraps it in a link to the section page if page is to be displayed on a separate page.

Parameters

stdClass	$section	The course_section entry from DB
stdClass	$course	The course entry from DB

Return values

string HTML to output.

Reimplemented in format_weeks_renderer, and format_topics_renderer.

◆ section_title_without_link()

format_section_renderer_base::section_title_without_link	(	$section,
		$course
	)

Generate the section title to be displayed on the section page, without a link.

Parameters

stdClass	$section	The course_section entry from DB
stdClass	$course	The course entry from DB

Return values

string HTML to output.

Reimplemented in format_weeks_renderer, and format_topics_renderer.

◆ should_display_main_logo()

renderer_base::should_display_main_logo ( $headinglevel = 1 )

inherited

Whether we should display the main logo.

Parameters

int $headinglevel The 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

◆ start_section_list()

format_section_renderer_base::start_section_list ( )

abstractprotected

Generate the starting container html for a list of sections.

Return values

string HTML to output.

Reimplemented in format_weeks_renderer, and format_topics_renderer.

◆ stealth_section_footer()

format_section_renderer_base::stealth_section_footer ( )

protected

Generate footer html of a stealth section.

Return values

string HTML to output.

◆ stealth_section_header()

format_section_renderer_base::stealth_section_header ( $sectionno )

protected

Generate the header html of a stealth section.

Parameters

int $sectionno The section number in the course which is being displayed

Return values

string HTML to output.

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:

course/format/renderer.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __call()

◆ add_action_handler()

◆ change_number_sections()

◆ course_activity_clipboard()

◆ end_section_list()

◆ format_summary_text()

◆ get_compact_logo_url()

◆ get_logo_url()

◆ get_mustache()

◆ get_nav_links()

◆ has_started()

◆ image_url()

◆ page_title()

◆ pix_url()

◆ prepare_classes()

◆ print_multiple_section_page()

◆ print_single_section_page()

◆ render()

◆ render_from_template()

◆ section_activity_summary()

◆ section_availability()

◆ section_availability_message()

◆ section_edit_control_items()

◆ section_edit_control_menu()

◆ section_edit_controls()

◆ section_footer()

◆ section_header()

◆ section_hidden()

◆ section_left_content()

◆ section_nav_selection()

◆ section_right_content()

◆ section_summary()

◆ section_title()

◆ section_title_without_link()

◆ should_display_main_logo()

◆ should_display_navbar_logo()

◆ start_section_list()

◆ stealth_section_footer()

◆ stealth_section_header()

Member Data Documentation

◆ $output