Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
format_topics\output\courseformat\content Class Reference

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

Inheritance diagram for format_topics\output\courseformat\content:
core_courseformat\output\local\content core\output\named_templatable renderable templatable

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_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 = false
 Topic format has add section after each topic.
 
string $sectionclass
 the section format class
 
string $sectionnavigationclass
 section navigation class name
 
string $sectionselectorclass
 section selector class name
 

Detailed Description

Base class to render a course content.

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$outputtypically, the renderer that's calling this function
Return values
stdClassdata 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$outputtypically, the renderer that's calling this function
Return values
stdClassdata 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$outputtypically, the renderer that's calling this function
Return values
arraydata context for a mustache template

◆ 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$rendererThe renderer requesting the template name
Return values
string

Implemented in core\output\sticky_footer, core_courseformat\output\local\content\cm\title, and qbank_viewquestionname\output\questionname.

Member Data Documentation

◆ $hasaddsection

bool format_topics\output\courseformat\content::$hasaddsection = false
protected

Topic format has add section after each topic.

The responsible for the buttons is core_courseformat\output\local\content\section.


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