core_availability\output\availability_info Class Reference

Base class to render availability info. More...

Inheritance diagram for core_availability\output\availability_info:

Public Member Functions
	__construct (core_availability_multiple_messages $renderable)
	Constructor.
	export_for_template (\renderer_base $output)
	Export this data so it can be used as the context for a mustache template.

Protected Member Functions
	get_item_base_template ()
	Get the item base template.
	get_item_header (core_availability_multiple_messages $availability)
	Get the item header.
	get_item_template (core_availability_multiple_messages $availability)
	Get the item template.

Protected Attributes
core_availability_multiple_messages	$availabilitymessages
	availabilitymessages the course format class

Detailed Description

Base class to render availability info.

Copyright

2021 Bas Brands bas@m.nosp@m.oodl.nosp@m.e.com

License

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

Constructor & Destructor Documentation

__construct()

core_availability\output\availability_info::__construct

(

core_availability_multiple_messages

$renderable

)

Constructor.

Parameters

core_availability_multiple_messages

$renderable

the availability messages

Member Function Documentation

export_for_template()

core_availability\output\availability_info::export_for_template

(

\renderer_base

$output

)

Export this data so it can be used as the context for a mustache template.

Parameters

renderer_base

$output

typically, the renderer that's calling this function

Return values

stdClass

data context for a mustache template

get_item_base_template()

core_availability\output\availability_info::get_item_base_template ( )

protected

Get the item base template.

Return values

stdClass

the template base

get_item_header()

core_availability\output\availability_info::get_item_header ( core_availability_multiple_messages $availability )

protected

Get the item header.

Depending on availability configuration this will return a string from a combined string identifier. For example: list_root_and_hidden, list_and, list_root_or_hidden, list_root_or, etc.

Parameters

core_availability_multiple_messages

$availability

the availability messages

Return values

string

the item header

get_item_template()

core_availability\output\availability_info::get_item_template ( core_availability_multiple_messages $availability )

protected

Get the item template.

Parameters

core_availability_multiple_messages

$availability

the availability messages

Return values

stdClass

the template

---

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

• availability/classes/output/availability_info.php