A single-select combobox widget that is functionally similar to an HTML select element. More...

Inheritance diagram for core\output\select_menu:

Public Member Functions
	__construct (string $name, array $options, string $selected=null)
	select_menu constructor.

	export_for_template (renderer_base $output)
	Export for template.

	set_label (string $label, array $attributes=[])
	Sets the select menu's label.

Protected Member Functions
	flatten_options ()
	Flatten the options for Mustache.

Protected Attributes
string	$label
	The combobox label.

array	$labelattributes = []
	Button label's attributes.

string	$name
	Name of the combobox element.

array	$options
	List of options.

string null	$selected
	The value of the preselected option.

Detailed Description

A single-select combobox widget that is functionally similar to an HTML select element.

Constructor & Destructor Documentation

core\output\select_menu::__construct	(	string	$name,
		array	$options,
		string	$selected = null )

select_menu constructor.

Parameters

string	$name	Name of the combobox element
array	$options	List of options in an associative array format like ['val' => 'Option']. Supports grouped options as well.
string \| null	$selected	The value of the preselected option.

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

Export for template.

Parameters

renderer_base $output The renderer.

Return values

stdClass

Implements templatable.

core\output\select_menu::flatten_options ( )

protected

Flatten the options for Mustache.

Return values

array

core\output\select_menu::set_label	(	string	$label,
		array	$attributes = [] )

Sets the select menu's label.

Parameters

string	$label	The label.
array	$attributes	List of attributes to apply on the label element.

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