core_courseformat\output\local\overview\overviewtable Class Reference

Inheritance diagram for core_courseformat\output\local\overview\overviewtable:

Public Member Functions
	__construct (protected stdClass stdClass $course, protected string string $modname,)
	Constructor.
	export_for_template (renderer_base $output)
	Function to export the renderer data in a format that is suitable for a mustache template.
	get_template_name (renderer_base $renderer)
	Get the template name.

Constructor & Destructor Documentation

__construct()

core_courseformat\output\local\overview\overviewtable::__construct	(	protected stdClass stdClass	$course,
		protected string string	$modname )

Constructor.

Parameters

stdClass	$course	the course object.
string	$modname	the module name (or "resources" for generic resources overview).

Parameters

$course	the course object
$modname	the module name (or "resources" for generic resources overview)

Member Function Documentation

export_for_template()

core_courseformat\output\local\overview\overviewtable::export_for_template

(

renderer_base

$output

)

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

Implements core\output\templatable.

get_template_name()

core_courseformat\output\local\overview\overviewtable::get_template_name

(

renderer_base

$renderer

)

Get the template name.

Parameters

renderer_base

$renderer

Renderer base.

Return values

string

Implements core\output\named_templatable.

---

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

• course/format/classes/output/local/overview/overviewtable.php