core_course\output\actionbar\initials_dropdown_form Class Reference

Inheritance diagram for core_course\output\actionbar\initials_dropdown_form:

Public Member Functions
	__construct (protected stdClass $course, protected string $targeturl, protected string $firstinitial='', protected string $lastinitial='', protected string $firstinitialparam='sifirst', protected string $lastinitialparam='silast', protected array $additionalparams=[])
	The class constructor.
	export_for_template (renderer_base $output)
	Function to export the renderer data in a format that is suitable for a mustache template.

Constructor & Destructor Documentation

__construct()

core_course\output\actionbar\initials_dropdown_form::__construct	(	protected stdClass	$course,
		protected string	$targeturl,
		protected string	$firstinitial = '',
		protected string	$lastinitial = '',
		protected string	$firstinitialparam = 'sifirst',
		protected string	$lastinitialparam = 'silast',
		protected array	$additionalparams = [] )

The class constructor.

Parameters

stdClass	$course	The course object.
string	$targeturl	The target URL to send the form to.
string	$firstinitial	The selected first initial.
string	$lastinitial	The selected last initial.
string	$firstinitialparam	The parameter name for the first initial.
string	$lastinitialparam	The parameter name for the last initial.
array	$additionalparams	Any additional parameters required for the form submission URL.

Member Function Documentation

export_for_template()

core_course\output\actionbar\initials_dropdown_form::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.

---

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

• course/classes/output/actionbar/initials_dropdown_form.php