format_topics\output\courseformat\content Class Reference

Base class to render a course content. More...

Inheritance diagram for format_topics\output\courseformat\content:

Public Member Functions
	export_for_template (\renderer_base $output)
	Export this data so it can be used as the context for a mustache template (core/inplace_editable).
	export_for_template (renderer_base $output)
	Export this data so it can be used as the context for a mustache template (core/inplace_editable).
	get_page_header_action (\renderer_base $output)
	Retrieves the action menu for the page header of the local content section.
	get_template_name (\renderer_base $renderer)
	Get the name of the template to use for this templatable.

Protected Member Functions
	export_sections (\renderer_base $output)
	Export sections array data.

Protected Attributes
string	$addsectionclass
	the add section output class name
string	$bulkedittoolsclass
	bulk editor bar toolbox
core_courseformat base	$format
	the course format class
bool	$hasaddsection = true
	Topic format has also add section after each topic.
string	$sectionclass
	the section format class
string	$sectioncontrolmenuclass
	the section control menu class
string	$sectionnavigationclass
	section navigation class name
string	$sectionselectorclass
	section selector class name

Detailed Description

Base class to render a course content.

Copyright

2020 Ferran Recio ferra.nosp@m.n@mo.nosp@m.odle..nosp@m.com

License

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

Member Function Documentation

export_for_template() [1/2]

core_courseformat\output\local\content::export_for_template ( \renderer_base $output )

inherited

Export this data so it can be used as the context for a mustache template (core/inplace_editable).

Parameters

renderer_base

$output

typically, the renderer that's calling this function

Return values

stdClass

data context for a mustache template

export_for_template() [2/2]

format_topics\output\courseformat\content::export_for_template

(

renderer_base

$output

)

Export this data so it can be used as the context for a mustache template (core/inplace_editable).

Parameters

renderer_base

$output

typically, the renderer that's calling this function

Return values

stdClass

data context for a mustache template

Implements templatable.

export_sections()

core_courseformat\output\local\content::export_sections ( \renderer_base $output )

protectedinherited

Export sections array data.

Parameters

renderer_base

$output

typically, the renderer that's calling this function

Return values

array

data context for a mustache template

get_page_header_action()

core_courseformat\output\local\content::get_page_header_action ( \renderer_base $output )

inherited

Retrieves the action menu for the page header of the local content section.

Parameters

renderer_base

$output

The renderer object used for rendering the action menu.

Return values

string|null

The rendered action menu HTML, null if page no action menu is available.

get_template_name()

core\output\named_templatable::get_template_name ( \renderer_base $renderer )

inherited

Get the name of the template to use for this templatable.

Parameters

renderer_base

$renderer

The renderer requesting the template name

Return values

string

Implemented in core\output\local\dropdown\dialog, core\output\local\dropdown\status, core\output\sticky_footer, core_courseformat\output\local\content\cm\title, mod_quiz\output\list_of_attempts, and qbank_viewquestionname\output\questionname.

---

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

• course/format/topics/classes/output/courseformat/content.php