The core course renderer. More...

Inheritance diagram for core_course_renderer:

Public Member Functions
	__construct (moodle_page $page, $target)
	Override the constructor so that we can initialise the string cache. 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...

	add_new_course_button ()
	Returns HTML to the "add new course" button for the page. More...

	availability_info ($text, $additionalclasses='')
	Displays availability info for a course section or course module. More...

	course_activitychooser ($courseid)
	Build the HTML for the module chooser javascript popup. More...

	course_category ($category)
	Renders HTML to display particular course category - list of it's subcategories and courses. More...

	course_category_tree (array $ignored)
	Renderers a structured array of courses and categories into a nice XHTML tree structure. More...

	course_info_box (stdClass $course)
	Renders course info box. More...

	course_modchooser ($modules, $course)
	Build the HTML for the module chooser javascript popup. More...

	course_search_form ($value='', $format='plain')
	Renders html to display a course search form. More...

	course_section_add_cm_control ($course, $section, $sectionreturn=null, $displayoptions=array())
	Renders HTML for the menus to add activities and resources to the current course. More...

	course_section_cm ($course, &$completioninfo, cm_info $mod, $sectionreturn, $displayoptions=array())
	Renders HTML to display one course module in a course section. More...

	course_section_cm_availability (cm_info $mod, $displayoptions=array())
	Renders HTML to show course module availability information (for someone who isn't allowed to see the activity itself, or for staff) More...

	course_section_cm_completion ($course, &$completioninfo, cm_info $mod, $displayoptions=array())
	Renders html for completion box on course page. More...

	course_section_cm_edit_actions ($actions, cm_info $mod=null, $displayoptions=array())
	Renders HTML for displaying the sequence of course module editing buttons. More...

	course_section_cm_list ($course, $section, $sectionreturn=null, $displayoptions=array())
	Renders HTML to display a list of course modules in a course section Also displays "move here" controls in Javascript-disabled mode. More...

	course_section_cm_list_item ($course, &$completioninfo, cm_info $mod, $sectionreturn, $displayoptions=array())
	Renders HTML to display one course module for display within a section. More...

	course_section_cm_name (cm_info $mod, $displayoptions=array())
	Renders html to display a name with the link to the course module on a course page. More...

	course_section_cm_name_title (cm_info $mod, $displayoptions=array())
	Renders html to display a name with the link to the course module on a course page. More...

	course_section_cm_text (cm_info $mod, $displayoptions=array())
	Renders html to display the module content on the course page (i.e. More...

	course_section_cm_unavailable_error_message (cm_info $cm)
	Message displayed to the user when they try to access unavailable activity following URL. More...

	coursecat_ajax ()
	Serves requests to /course/category.ajax.php. More...

	courses_list ($courses, $showcategoryname=false, $additionalclasses=null, $paginationurl=null, $totalcount=null, $page=0, $perpage=null)
	Displays a custom list of courses with paging bar if necessary. More...

	frontpage ()
	Outputs contents for frontpage as configured in $CFG->frontpage or $CFG->frontpageloggedin. More...

	frontpage_available_courses ()
	Returns HTML to print list of available courses for the frontpage. More...

	frontpage_categories_list ()
	Returns HTML to print tree of course categories (with number of courses) for the frontpage. More...

	frontpage_combo_list ()
	Returns HTML to print tree with course categories and courses for the frontpage. More...

	frontpage_my_courses ()
	Returns HTML to print list of courses user is enrolled to for the frontpage. More...

	frontpage_section1 ()
	Output frontpage summary text and frontpage modules (stored as section 1 in site course) 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...

	hubinfo ($hubinfo)
	Hub information (logo - name - description - link) 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...

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

	render_activity_navigation (\core_course\output\activity_navigation $page)
	Renders the activity navigation. More...

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

	render_modchooser (renderable $modchooser)
	Render a modchooser. More...

	search_courses ($searchcriteria)
	Renders html to display search result page. More...

	sendingbackupinfo ($backupfile)
	Display waiting information about backup size during uploading backup process. 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...

	tagged_courses ($tagid, $exclusivemode=true, $ctx=0, $rec=true, $displayoptions=null)
	Renders html to print list of courses tagged with particular tag. 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...

Public Attributes
const	COURSECAT_SHOW_COURSES_AUTO = 15

const	COURSECAT_SHOW_COURSES_COLLAPSED = 10

const	COURSECAT_SHOW_COURSES_COUNT = 5

const	COURSECAT_SHOW_COURSES_EXPANDED = 20

const	COURSECAT_SHOW_COURSES_EXPANDED_WITH_CAT = 30

const	COURSECAT_SHOW_COURSES_NONE = 0

const	COURSECAT_TYPE_CATEGORY = 0

const	COURSECAT_TYPE_COURSE = 1

Protected Member Functions
	add_modchoosertoggle ()

	course_category_name (coursecat_helper $chelper, core_course_list_element $course)
	Returns HTML to display course category name. More...

	course_category_tree_category (stdClass $category, $depth=1)
	Renderers a category for use with course_category_tree. More...

	course_contacts (core_course_list_element $course)
	Returns HTML to display course contacts. More...

	course_custom_fields (core_course_list_element $course)
	Returns HTML to display course custom fields. More...

	course_enrolment_icons (core_course_list_element $course)
	Returns HTML to display course enrolment icons. More...

	course_modchooser_module ($module, $classes=array('option'))
	Return the HTML for the specified module adding any required classes. More...

	course_modchooser_module_types ($modules)
	Build the HTML for a specified set of modules. More...

	course_modchooser_title ($title, $identifier=null)

	course_name (coursecat_helper $chelper, core_course_list_element $course)
	Returns HTML to display course name. More...

	course_overview_files (core_course_list_element $course)
	Returns HTML to display course overview files. More...

	course_section_cm_classes (cm_info $mod)
	Returns the CSS classes for the activity name/content. More...

	course_summary (coursecat_helper $chelper, core_course_list_element $course)
	Returns HTML to display course summary. More...

	coursecat_category (coursecat_helper $chelper, $coursecat, $depth)
	Returns HTML to display a course category as a part of a tree. More...

	coursecat_category_content (coursecat_helper $chelper, $coursecat, $depth)
	Returns HTML to display the subcategories and courses in the given category. More...

	coursecat_coursebox (coursecat_helper $chelper, $course, $additionalclasses='')
	Displays one course in the list of courses. More...

	coursecat_coursebox_content (coursecat_helper $chelper, $course)
	Returns HTML to display course content (summary, course contacts and optionally category name) More...

	coursecat_courses (coursecat_helper $chelper, $courses, $totalcount=null)
	Renders the list of courses. More...

	coursecat_include_js ()
	Make sure that javascript file for AJAX expanding of courses and categories content is included.

	coursecat_subcategories (coursecat_helper $chelper, $coursecat, $depth)
	Renders the list of subcategories in a category. More...

	coursecat_tree (coursecat_helper $chelper, $coursecat)
	Returns HTML to display a tree of subcategories and courses in the given category. More...

	frontpage_news ($forum)
	Output news for the frontpage (extract from site-wide news forum) More...

	frontpage_part ($skipdivid, $contentsdivid, $header, $contents)
	Renders part of frontpage with a skip link (i.e. More...

	frontpage_remote_course (stdClass $course)
	Returns HTML to display one remote course. More...

	frontpage_remote_host ($host)
	Returns HTML to display one remote host. More...

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

	is_cm_conditionally_hidden (cm_info $mod)
	Checks if course module has any conditions that may make it unavailable for all or some of the students. More...

Protected Attributes
bool	$categoryexpandedonload = false
	Whether a category content is being initially rendered with children. More...

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.

stdClass	$strings
	A cache of strings.

string	$target
	The requested rendering target.

Detailed Description

The core course renderer.

Can be retrieved with the following: $renderer = $PAGE->get_renderer('core','course');

Constructor & Destructor Documentation

◆ __construct()

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

Override the constructor so that we can initialise the string cache.

Parameters

moodle_page	$page
string	$target

Reimplemented from plugin_renderer_base.

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

◆ add_modchoosertoggle()

core_course_renderer::add_modchoosertoggle ( )

protected

Deprecated:: since 3.2

◆ add_new_course_button()

core_course_renderer::add_new_course_button ( )

Returns HTML to the "add new course" button for the page.

Return values

string

◆ availability_info()

core_course_renderer::availability_info	(	$text,
		$additionalclasses = `''`
	)

Displays availability info for a course section or course module.

Parameters

string	$text
string	$additionalclasses

Return values

string

◆ course_activitychooser()

core_course_renderer::course_activitychooser ( $courseid )

Build the HTML for the module chooser javascript popup.

Parameters

int $courseid The course id to fetch modules for.

Return values

string

◆ course_category()

core_course_renderer::course_category ( $category )

Renders HTML to display particular course category - list of it's subcategories and courses.

Invoked from /course/index.php

Parameters

int | stdClass | core_course_category $category

◆ course_category_name()

core_course_renderer::course_category_name	(	coursecat_helper	$chelper,
		core_course_list_element	$course
	)

protected

Returns HTML to display course category name.

Parameters

coursecat_helper	$chelper
core_course_list_element	$course

Return values

string

◆ course_category_tree()

core_course_renderer::course_category_tree ( array $ignored )

final

Renderers a structured array of courses and categories into a nice XHTML tree structure.

Deprecated:: since 2.5

Please see http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5

Parameters

array $ignored argument ignored

Return values

string

◆ course_category_tree_category()

core_course_renderer::course_category_tree_category	(	stdClass	$category,
			$depth = `1`
	)

finalprotected

Renderers a category for use with course_category_tree.

Deprecated:: since 2.5

Please see http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5

Parameters

array	$category
int	$depth

Return values

string

◆ course_contacts()

core_course_renderer::course_contacts ( core_course_list_element $course )

protected

Returns HTML to display course contacts.

Parameters

core_course_list_element $course

Return values

string

◆ course_custom_fields()

core_course_renderer::course_custom_fields ( core_course_list_element $course )

protected

Returns HTML to display course custom fields.

Parameters

core_course_list_element $course

Return values

string

◆ course_enrolment_icons()

core_course_renderer::course_enrolment_icons ( core_course_list_element $course )

protected

Returns HTML to display course enrolment icons.

Parameters

core_course_list_element $course

Return values

string

◆ course_info_box()

core_course_renderer::course_info_box ( stdClass $course )

Renders course info box.

Parameters

stdClass $course

Return values

string

◆ course_modchooser()

core_course_renderer::course_modchooser	(	$modules,
		$course
	)

Build the HTML for the module chooser javascript popup.

Parameters

array $modules A set of modules as returned form

See also: get_module_metadata

Parameters

object $course The course that will be displayed

Return values

string The composed HTML for the module

◆ course_modchooser_module()

core_course_renderer::course_modchooser_module	(	$module,
		$classes = `array('option')`
	)

protected

Return the HTML for the specified module adding any required classes.

Parameters

object	$module	An object containing the title, and link. An icon, and help text may optionally be specified. If the module contains subtypes in the types option, then these will also be displayed.
array	$classes	Additional classes to add to the encompassing div element

Return values

string The composed HTML for the module

◆ course_modchooser_module_types()

core_course_renderer::course_modchooser_module_types ( $modules )

protected

Build the HTML for a specified set of modules.

Parameters

array $modules A set of modules as used by the course_modchooser_module function

Return values

string The composed HTML for the module

◆ course_name()

core_course_renderer::course_name	(	coursecat_helper	$chelper,
		core_course_list_element	$course
	)

protected

Returns HTML to display course name.

Parameters

coursecat_helper	$chelper
core_course_list_element	$course

Return values

string

◆ course_overview_files()

core_course_renderer::course_overview_files ( core_course_list_element $course )

protected

Returns HTML to display course overview files.

Parameters

core_course_list_element $course

Return values

string

◆ course_search_form()

core_course_renderer::course_search_form	(	$value = `''`,
		$format = `'plain'`
	)

Renders html to display a course search form.

Parameters

string	$value	default value to populate the search field
string	$format	display format - 'plain' (default), 'short' or 'navbar'

Return values

string

◆ course_section_add_cm_control()

core_course_renderer::course_section_add_cm_control	(	$course,
		$section,
		$sectionreturn = `null`,
		$displayoptions = `array()`
	)

Renders HTML for the menus to add activities and resources to the current course.

Parameters

stdClass	$course
int	$section	relative section number (field course_sections.section)
int	$sectionreturn	The section to link back to
array	$displayoptions	additional display options, for example blocks add option 'inblock' => true, suggesting to display controls vertically

Return values

string

◆ course_section_cm()

core_course_renderer::course_section_cm	(		$course,
		&	$completioninfo,
		cm_info	$mod,
			$sectionreturn,
			$displayoptions = `array()`
	)

Renders HTML to display one course module in a course section.

This includes link, content, availability, completion info and additional information that module type wants to display (i.e. number of unread forum posts)

This function calls: core_course_renderer::course_section_cm_name() core_course_renderer::course_section_cm_text() core_course_renderer::course_section_cm_availability() core_course_renderer::course_section_cm_completion() course_get_cm_edit_actions() core_course_renderer::course_section_cm_edit_actions()

Parameters

stdClass	$course
completion_info	$completioninfo
cm_info	$mod
int \| null	$sectionreturn
array	$displayoptions

Return values

string

◆ course_section_cm_availability()

core_course_renderer::course_section_cm_availability	(	cm_info	$mod,
			$displayoptions = `array()`
	)

Renders HTML to show course module availability information (for someone who isn't allowed to see the activity itself, or for staff)

Parameters

cm_info	$mod
array	$displayoptions

Return values

string

◆ course_section_cm_classes()

core_course_renderer::course_section_cm_classes ( cm_info $mod )

protected

Returns the CSS classes for the activity name/content.

For items which are hidden, unavailable or stealth but should be displayed to current user ($mod->is_visible_on_course_page()), we show those as dimmed. Students will also see as dimmed activities names that are not yet available but should still be displayed (without link) with availability info.

Parameters

cm_info $mod

Return values

array array of two elements ($linkclasses, $textclasses)

◆ course_section_cm_completion()

core_course_renderer::course_section_cm_completion	(		$course,
		&	$completioninfo,
		cm_info	$mod,
			$displayoptions = `array()`
	)

Renders html for completion box on course page.

If completion is disabled, returns empty string If completion is automatic, returns an icon of the current completion state If completion is manual, returns a form (with an icon inside) that allows user to toggle completion

Parameters

stdClass	$course	course object
completion_info	$completioninfo	completion info for the course, it is recommended to fetch once for all modules in course/section for performance
cm_info	$mod	module to show completion for
array	$displayoptions	display options, not used in core

Return values

string

◆ course_section_cm_edit_actions()

core_course_renderer::course_section_cm_edit_actions	(		$actions,
		cm_info	$mod = `null`,
			$displayoptions = `array()`
	)

Renders HTML for displaying the sequence of course module editing buttons.

See also: course_get_cm_edit_actions()

Parameters

action_link[]	$actions	Array of action_link objects
cm_info	$mod	The module we are displaying actions for.
array	$displayoptions	additional display options: ownerselector => A JS/CSS selector that can be used to find an cm node. If specified the owning node will be given the class 'action-menu-shown' when the action menu is being displayed. constraintselector => A JS/CSS selector that can be used to find the parent node for which to constrain the action menu to when it is being displayed. donotenhance => If set to true the action menu that gets displayed won't be enhanced by JS.

Return values

string

◆ course_section_cm_list()

core_course_renderer::course_section_cm_list	(	$course,
		$section,
		$sectionreturn = `null`,
		$displayoptions = `array()`
	)

Renders HTML to display a list of course modules in a course section Also displays "move here" controls in Javascript-disabled mode.

This function calls core_course_renderer::course_section_cm()

Parameters

stdClass	$course	course object
int \| stdClass \| section_info	$section	relative section number or section object
int	$sectionreturn	section number to return to
int	$displayoptions

Return values

void

◆ course_section_cm_list_item()

core_course_renderer::course_section_cm_list_item	(		$course,
		&	$completioninfo,
		cm_info	$mod,
			$sectionreturn,
			$displayoptions = `array()`
	)

Renders HTML to display one course module for display within a section.

This function calls: core_course_renderer::course_section_cm()

Parameters

stdClass	$course
completion_info	$completioninfo
cm_info	$mod
int \| null	$sectionreturn
array	$displayoptions

Return values

String

◆ course_section_cm_name()

core_course_renderer::course_section_cm_name	(	cm_info	$mod,
			$displayoptions = `array()`
	)

Renders html to display a name with the link to the course module on a course page.

If module is unavailable for user but still needs to be displayed in the list, just the name is returned without a link

Note, that for course modules that never have separate pages (i.e. labels) this function return an empty string

Parameters

cm_info	$mod
array	$displayoptions

Return values

string

◆ course_section_cm_name_title()

core_course_renderer::course_section_cm_name_title	(	cm_info	$mod,
			$displayoptions = `array()`
	)

Renders html to display a name with the link to the course module on a course page.

If module is unavailable for user but still needs to be displayed in the list, just the name is returned without a link

Note, that for course modules that never have separate pages (i.e. labels) this function return an empty string

Parameters

cm_info	$mod
array	$displayoptions

Return values

string

◆ course_section_cm_text()

core_course_renderer::course_section_cm_text	(	cm_info	$mod,
			$displayoptions = `array()`
	)

Renders html to display the module content on the course page (i.e.

text of the labels)

Parameters

cm_info	$mod
array	$displayoptions

Return values

string

◆ course_section_cm_unavailable_error_message()

core_course_renderer::course_section_cm_unavailable_error_message ( cm_info $cm )

Message displayed to the user when they try to access unavailable activity following URL.

This method is a very simplified version of course_section_cm() to be part of the error notification only. It also does not check if module is visible on course page or not.

The message will be displayed inside notification!

Parameters

cm_info $cm

Return values

string

◆ course_summary()

core_course_renderer::course_summary	(	coursecat_helper	$chelper,
		core_course_list_element	$course
	)

protected

Returns HTML to display course summary.

Parameters

coursecat_helper	$chelper
core_course_list_element	$course

Return values

string

◆ coursecat_ajax()

core_course_renderer::coursecat_ajax ( )

Serves requests to /course/category.ajax.php.

In this renderer implementation it may expand the category content or course content.

Return values

string

Exceptions

coding_exception

◆ coursecat_category()

core_course_renderer::coursecat_category	(	coursecat_helper	$chelper,
			$coursecat,
			$depth
	)

protected

Returns HTML to display a course category as a part of a tree.

This is an internal function, to display a particular category and all its contents use core_course_renderer::course_category()

Parameters

coursecat_helper	$chelper	various display options
core_course_category	$coursecat
int	$depth	depth of this category in the current tree

Return values

string

◆ coursecat_category_content()

core_course_renderer::coursecat_category_content	(	coursecat_helper	$chelper,
			$coursecat,
			$depth
	)

protected

Returns HTML to display the subcategories and courses in the given category.

This method is re-used by AJAX to expand content of not loaded category

Parameters

coursecat_helper	$chelper	various display options
core_course_category	$coursecat
int	$depth	depth of the category in the current tree

Return values

string

◆ coursecat_coursebox()

core_course_renderer::coursecat_coursebox	(	coursecat_helper	$chelper,
			$course,
			$additionalclasses = `''`
	)

protected

Displays one course in the list of courses.

This is an internal function, to display an information about just one course please use core_course_renderer::course_info_box()

Parameters

coursecat_helper	$chelper	various display options
core_course_list_element \| stdClass	$course
string	$additionalclasses	additional classes to add to the main tag (usually depend on the course position in list - first/last/even/odd)

Return values

string

◆ coursecat_coursebox_content()

core_course_renderer::coursecat_coursebox_content	(	coursecat_helper	$chelper,
			$course
	)

protected

Returns HTML to display course content (summary, course contacts and optionally category name)

This method is called from coursecat_coursebox() and may be re-used in AJAX

Parameters

coursecat_helper	$chelper	various display options
stdClass \| core_course_list_element	$course

Return values

string

◆ coursecat_courses()

core_course_renderer::coursecat_courses	(	coursecat_helper	$chelper,
			$courses,
			$totalcount = `null`
	)

protected

Renders the list of courses.

This is internal function, please use core_course_renderer::courses_list() or another public method from outside of the class

If list of courses is specified in $courses; the argument $chelper is only used to retrieve display options and attributes, only methods get_show_courses(), get_courses_display_option() and get_and_erase_attributes() are called.

Parameters

coursecat_helper	$chelper	various display options
array	$courses	the list of courses to display
int \| null	$totalcount	total number of courses (affects display mode if it is AUTO or pagination if applicable), defaulted to count($courses)

Return values

string

◆ coursecat_subcategories()

core_course_renderer::coursecat_subcategories	(	coursecat_helper	$chelper,
			$coursecat,
			$depth
	)

protected

Renders the list of subcategories in a category.

Parameters

coursecat_helper	$chelper	various display options
core_course_category	$coursecat
int	$depth	depth of the category in the current tree

Return values

string

◆ coursecat_tree()

core_course_renderer::coursecat_tree	(	coursecat_helper	$chelper,
			$coursecat
	)

protected

Returns HTML to display a tree of subcategories and courses in the given category.

Parameters

coursecat_helper	$chelper	various display options
core_course_category	$coursecat	top category (this category's name and description will NOT be added to the tree)

Return values

string

◆ courses_list()

core_course_renderer::courses_list	(	$courses,
		$showcategoryname = `false`,
		$additionalclasses = `null`,
		$paginationurl = `null`,
		$totalcount = `null`,
		$page = `0`,
		$perpage = `null`
	)

Displays a custom list of courses with paging bar if necessary.

If $paginationurl is specified but $totalcount is not, the link 'View more' appears under the list.

If both $paginationurl and $totalcount are specified, and $totalcount is bigger than count($courses), a paging bar is displayed above and under the courses list.

Parameters

array	$courses	array of course records (or instances of core_course_list_element) to show on this page
bool	$showcategoryname	whether to add category name to the course description
string	$additionalclasses	additional CSS classes to add to the div.courses
moodle_url	$paginationurl	url to view more or url to form links to the other pages in paging bar
int	$totalcount	total number of courses on all pages, if omitted $paginationurl will be displayed as 'View more' link
int	$page	current page number (defaults to 0 referring to the first page)
int	$perpage	number of records per page (defaults to $CFG->coursesperpage)

Return values

string

◆ frontpage()

core_course_renderer::frontpage ( )

Outputs contents for frontpage as configured in $CFG->frontpage or $CFG->frontpageloggedin.

Return values

string

◆ frontpage_available_courses()

core_course_renderer::frontpage_available_courses ( )

Returns HTML to print list of available courses for the frontpage.

Return values

string

◆ frontpage_categories_list()

core_course_renderer::frontpage_categories_list ( )

Returns HTML to print tree of course categories (with number of courses) for the frontpage.

Return values

string

◆ frontpage_combo_list()

core_course_renderer::frontpage_combo_list ( )

Returns HTML to print tree with course categories and courses for the frontpage.

Return values

string

◆ frontpage_my_courses()

core_course_renderer::frontpage_my_courses ( )

Returns HTML to print list of courses user is enrolled to for the frontpage.

Also lists remote courses or remote hosts if MNET authorisation is used

Return values

string

◆ frontpage_news()

core_course_renderer::frontpage_news ( $forum )

protected

Output news for the frontpage (extract from site-wide news forum)

Parameters

stdClass $forum record from db table 'forum' that represents the site news forum

Return values

string

◆ frontpage_part()

core_course_renderer::frontpage_part	(	$skipdivid,
		$contentsdivid,
		$header,
		$contents
	)

protected

Renders part of frontpage with a skip link (i.e.

"My courses", "Site news", etc.)

Parameters

string	$skipdivid
string	$contentsdivid
string	$header	Header of the part
string	$contents	Contents of the part

Return values

string

◆ frontpage_remote_course()

core_course_renderer::frontpage_remote_course ( stdClass $course )

protected

Returns HTML to display one remote course.

Parameters

stdClass $course remote course information, contains properties: id, remoteid, shortname, fullname, hostid, summary, summaryformat, cat_name, hostname

Return values

string

◆ frontpage_remote_host()

core_course_renderer::frontpage_remote_host ( $host )

protected

Returns HTML to display one remote host.

Parameters

array $host host information, contains properties: name, url, count

Return values

string

◆ frontpage_section1()

core_course_renderer::frontpage_section1 ( )

Output frontpage summary text and frontpage modules (stored as section 1 in site course)

This may be disabled in settings

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

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

◆ hubinfo()

core_course_renderer::hubinfo ( $hubinfo )

Hub information (logo - name - description - link)

Parameters

object $hubinfo

Return values

string html code

◆ 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

◆ is_cm_conditionally_hidden()

core_course_renderer::is_cm_conditionally_hidden ( cm_info $mod )

protected

Checks if course module has any conditions that may make it unavailable for all or some of the students.

This function is internal and is only used to create CSS classes for the module name/text

Parameters

cm_info $mod

Return values

bool

◆ 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

◆ 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_activity_navigation()

core_course_renderer::render_activity_navigation ( \core_course\output\activity_navigation $page )

Renders the activity navigation.

Defer to template.

Parameters

core_course::output::activity_navigation $page

Return values

string html for the page

◆ 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

◆ render_modchooser()

core_course_renderer::render_modchooser ( renderable $modchooser )

Render a modchooser.

Parameters

renderable $modchooser The chooser.

Return values

string

◆ search_courses()

core_course_renderer::search_courses ( $searchcriteria )

Renders html to display search result page.

Parameters

array $searchcriteria may contain elements: search, blocklist, modulelist, tagid

Return values

string

◆ sendingbackupinfo()

core_course_renderer::sendingbackupinfo ( $backupfile )

Display waiting information about backup size during uploading backup process.

Parameters

object $backupfile the backup stored_file

Return values

$html string

◆ 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

◆ tagged_courses()

core_course_renderer::tagged_courses	(	$tagid,
		$exclusivemode = `true`,
		$ctx = `0`,
		$rec = `true`,
		$displayoptions = `null`
	)

Renders html to print list of courses tagged with particular tag.

Parameters

int	$tagid	id of the tag
bool	$exclusivemode	if set to true it means that no other entities tagged with this tag are displayed on the page and the per-page limit may be bigger
int	$fromctx	context id where the link was displayed, may be used by callbacks to display items in the same context first
int	$ctx	context id where to search for records
bool	$rec	search in subcontexts as well
array	$displayoptions

Return values

string empty string if no courses are marked with this tag or rendered list of courses

Member Data Documentation

◆ $categoryexpandedonload

bool core_course_renderer::$categoryexpandedonload = false

protected

Whether a category content is being initially rendered with children.

This is mainly used by the core_course_renderer::corsecat_tree() to render the appropriate action for the Expand/Collapse all link on page load.

◆ $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/renderer.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __call()

◆ add_action_handler()

◆ add_modchoosertoggle()

◆ add_new_course_button()

◆ availability_info()

◆ course_activitychooser()

◆ course_category()

◆ course_category_name()

◆ course_category_tree()

◆ course_category_tree_category()

◆ course_contacts()

◆ course_custom_fields()

◆ course_enrolment_icons()

◆ course_info_box()

◆ course_modchooser()

◆ course_modchooser_module()

◆ course_modchooser_module_types()

◆ course_name()

◆ course_overview_files()

◆ course_search_form()

◆ course_section_add_cm_control()

◆ course_section_cm()

◆ course_section_cm_availability()

◆ course_section_cm_classes()

◆ course_section_cm_completion()

◆ course_section_cm_edit_actions()

◆ course_section_cm_list()

◆ course_section_cm_list_item()

◆ course_section_cm_name()

◆ course_section_cm_name_title()

◆ course_section_cm_text()

◆ course_section_cm_unavailable_error_message()

◆ course_summary()

◆ coursecat_ajax()

◆ coursecat_category()

◆ coursecat_category_content()

◆ coursecat_coursebox()

◆ coursecat_coursebox_content()

◆ coursecat_courses()

◆ coursecat_subcategories()

◆ coursecat_tree()

◆ courses_list()

◆ frontpage()

◆ frontpage_available_courses()

◆ frontpage_categories_list()

◆ frontpage_combo_list()

◆ frontpage_my_courses()

◆ frontpage_news()

◆ frontpage_part()

◆ frontpage_remote_course()

◆ frontpage_remote_host()

◆ frontpage_section1()

◆ get_compact_logo_url()

◆ get_logo_url()

◆ get_mustache()

◆ has_started()

◆ hubinfo()

◆ image_url()

◆ is_cm_conditionally_hidden()

◆ pix_url()

◆ prepare_classes()

◆ render()

◆ render_activity_navigation()

◆ render_from_template()

◆ render_modchooser()

◆ search_courses()

◆ sendingbackupinfo()

◆ should_display_main_logo()

◆ should_display_navbar_logo()

◆ tagged_courses()

Member Data Documentation