core_courseformat\output\local\content Class Reference

Inheritance diagram for core_courseformat\output\local\content:

Public Member Functions
	__construct (course_format $format)
	Constructor.
	export_for_template (renderer_base $output)
	Function to export the renderer data in a format that is suitable for a mustache template.
	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.
	get_sections_to_display (course_modinfo $modinfo)
	Return an array of sections to display.

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
	if uses add section
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

Constructor & Destructor Documentation

__construct()

core_courseformat\output\local\content::__construct

(

course_format

$format

)

Constructor.

Parameters

course_format

$format

the coruse format

Member Function Documentation

export_for_template() [1/2]

core\output\templatable::export_for_template ( renderer_base $output )

inherited

Function to export the renderer data in a format that is suitable for a mustache template.

This means:

1. No complex types - only stdClass, array, int, string, float, bool
2. Any additional info that is required for the template is pre-calculated (e.g. capability checks).

Parameters

renderer_base

$output

Used to do a final render of any components that need to be rendered for export.

Return values

stdClass|array

Implemented in core\output\action_menu, core\output\actions\component_action, core\output\activity_header, core\output\checkbox_toggleall, core\output\choicelist, core\output\chooser, core\output\chooser_item, core\output\chooser_section, core\output\comboboxsearch, core\output\context_header, core\output\custom_menu_item, core\output\dynamic_tabs, core\output\help_icon, core\output\initials_bar, core\output\paging_bar, core\output\pix_icon, core\output\pix_icon_font, core\output\progress_bar, core\output\select_menu, core\output\single_select, core\output\tabobject, core\output\tabtree, core\output\task_indicator, core\output\url_select, core_calendar\output\humandate, core_calendar\output\humantimeperiod, core_course\output\actionbar\group_selector_button, core_course\output\actionbar\group_selector_dropdown_form, core_course\output\actionbar\initials_dropdown_form, core_course\output\actionbar\user_selector_button, core_course\output\activity_completion, core_course\output\activity_dates, core_course\output\activity_icon, core_course\output\activitychooserbutton, core_course\output\completion_action_bar, core_courseformat\output\local\content\basecontrolmenu, core_courseformat\output\local\content\cm\controlmenu, core_courseformat\output\local\content\cm, core_courseformat\output\local\content\section, core_courseformat\output\local\overview\activityname, core_courseformat\output\local\overview\overviewtable, core_grades\output\penalty_indicator, core_question\output\add_bank_list, core_question\output\qbank_action_menu, core_question\output\question_bank_filter_ui, core_question\output\question_bank_list, core_question\output\question_category_selector, core_question\output\question_version_info, core_question\output\question_version_selection, core_question\output\switch_question_bank, core_question\output\view_banks, core_reportbuilder\output\custom_report, core_reportbuilder\output\dynamictabs\access, core_reportbuilder\output\dynamictabs\audience, core_reportbuilder\output\dynamictabs\editor, core_reportbuilder\output\dynamictabs\schedules, core_reportbuilder\output\report_action, and core_reportbuilder\output\system_report.

export_for_template() [2/2]

core_courseformat\output\local\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

export_sections()

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

protected

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

)

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_sections_to_display()

core_courseformat\output\local\content::get_sections_to_display ( course_modinfo $modinfo )

protected

Return an array of sections to display.

This method is used to differentiate between display a specific section or a list of them.

Parameters

course_modinfo

$modinfo

the current course modinfo object

Return values

section_info[]

an array of section_info to display

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\choicelist, core\output\comboboxsearch, core_course\output\actionbar\group_selector_button, core_course\output\actionbar\group_selector_dropdown_form, core_course\output\actionbar\user_selector_button, core_courseformat\output\local\overview\activityname, and core_courseformat\output\local\overview\overviewtable.

---

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

• course/format/classes/output/local/content.php