MoodleQuickForm_selectgroups Class Reference

select type form element More...

Inheritance diagram for MoodleQuickForm_selectgroups:

Public Member Functions
	__construct ($elementName=null, $elementLabel=null, $optgrps=null, $attributes=null, $showchoose=false)
	Class constructor.
	addOptGroup ($text, $value, $attributes=null)
	Adds a new OPTION to the SELECT.
	addOption ($optgroup, $text, $value, $attributes=null)
	Adds a new OPTION to an optgroup.
	export_for_template (renderer_base $output)
	Function to export the renderer data in a format that is suitable for a mustache template.
	exportValue (&$submitValues, $assoc=false)
	We check the options and return only the values that could have been selected.
	getElementTemplateType ()
	Slightly different container template when frozen.
	getFrozenHtml ()
	Returns the value of field without HTML tags.
	getHelpButton ()
	get html for help button
	getMultiple ()
	Returns the select mutiple attribute.
	getName ()
	Returns the element name.
	getPrivateName ()
	Returns the element name (possibly with brackets appended)
	getSelected ()
	Returns an array of the selected values.
	getSize ()
	Returns the select field size.
	getValue ()
	Returns an array of the selected values.
	loadArrayOptGroups ($arr, $values=null)
	Loads the options from an associative array.
	loadArrayOptions ($optgroup, $arr, $values=null)
	Loads the options from an associative array.
	MoodleQuickForm_selectgroups ($elementName=null, $elementLabel=null, $optgrps=null, $attributes=null, $showchoose=false)
	Old syntax of class constructor.
	onQuickFormEvent ($event, $arg, &$caller)
	Called by HTML_QuickForm whenever form event is made on this element.
	setHiddenLabel ($hiddenLabel)
	Sets label to be hidden.
	setMultiple ($multiple)
	Sets the select mutiple attribute.
	setName ($name)
	Sets the input field name.
	setSelected ($values)
	Sets the default values of the select box.
	setSize ($size)
	Sets the select field size, only applies to 'multiple' selects.
	setValue ($value)
	Sets the value of the form element.
	toHtml ()
	Returns the SELECT in HTML.

Public Attributes
string	$_helpbutton =''
	html for help button, if empty then no help
bool	$_hiddenLabel =false
	if true label will be hidden
array	$_optGroups = array()
	Contains the select optgroups.
array	$_values = null
	Default values of the SELECT.
bool	$showchoose = false
	add choose option

Detailed Description

select type form element

Class to dynamically create an HTML SELECT with all options grouped in optgroups

Copyright

2007 Jamie Pratt me@ja.nosp@m.miep.nosp@m..org

License

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

Constructor & Destructor Documentation

__construct()

MoodleQuickForm_selectgroups::__construct	(		$elementName = null,
			$elementLabel = null,
			$optgrps = null,
			$attributes = null,
			$showchoose = false )

Class constructor.

Parameters

string	$elementName	Select name attribute
mixed	$elementLabel	Label(s) for the select
array	$optgrps	Data to be used to populate options
mixed	$attributes	Either a typical HTML attribute string or an associative array
bool	$showchoose	add standard moodle "Choose..." option as first item

Member Function Documentation

addOptGroup()

MoodleQuickForm_selectgroups::addOptGroup	(		$text,
			$value,
			$attributes = null )

Adds a new OPTION to the SELECT.

Parameters

string	$text	Display text for the OPTION
string	$value	Value for the OPTION
mixed	$attributes	Either a typical HTML attribute string or an associative array

addOption()

MoodleQuickForm_selectgroups::addOption	(		$optgroup,
			$text,
			$value,
			$attributes = null )

Adds a new OPTION to an optgroup.

Parameters

string	$optgroup	name of the option group
string	$text	Display text for the OPTION
string	$value	Value for the OPTION
mixed	$attributes	Either a typical HTML attribute string or an associative array

export_for_template()

MoodleQuickForm_selectgroups::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 templatable.

exportValue()

MoodleQuickForm_selectgroups::exportValue	(	&	$submitValues,
			$assoc = false )

We check the options and return only the values that could have been selected.

We also return a scalar value if select is not "multiple"

Parameters

array	$submitValues	submitted values
bool	$assoc	if true the retured value is associated array

Return values

mixed

getElementTemplateType()

MoodleQuickForm_selectgroups::getElementTemplateType

(

)

Slightly different container template when frozen.

Don't want to use a label tag with a for attribute in that case for the element label but instead use a div. Templates are defined in renderer constructor.

Return values

string

getFrozenHtml()

MoodleQuickForm_selectgroups::getFrozenHtml

(

)

Returns the value of field without HTML tags.

Return values

string

getHelpButton()

MoodleQuickForm_selectgroups::getHelpButton

(

)

get html for help button

Return values

string

html for help button

getMultiple()

MoodleQuickForm_selectgroups::getMultiple

(

)

Returns the select mutiple attribute.

Return values

bool	true if multiple select, false otherwise

getName()

MoodleQuickForm_selectgroups::getName

(

)

Returns the element name.

Return values

string

getPrivateName()

MoodleQuickForm_selectgroups::getPrivateName

(

)

Returns the element name (possibly with brackets appended)

Return values

string

getSelected()

MoodleQuickForm_selectgroups::getSelected

(

)

Returns an array of the selected values.

Return values

array

of selected values

getSize()

MoodleQuickForm_selectgroups::getSize

(

)

Returns the select field size.

Return values

int

getValue()

MoodleQuickForm_selectgroups::getValue

(

)

Returns an array of the selected values.

Return values

array

of selected values

loadArrayOptGroups()

MoodleQuickForm_selectgroups::loadArrayOptGroups	(		$arr,
			$values = null )

Loads the options from an associative array.

Parameters

array	$arr	Associative array of options
mixed	$values	(optional) Array or comma delimited string of selected values

Return values

PEAR_Error|bool

on error or true

Exceptions

PEAR_Error

loadArrayOptions()

MoodleQuickForm_selectgroups::loadArrayOptions	(		$optgroup,
			$arr,
			$values = null )

Loads the options from an associative array.

Parameters

string	$optgroup	name of the options group
array	$arr	Associative array of options
mixed	$values	(optional) Array or comma delimited string of selected values

Return values

PEAR_Error|bool

on error or true

Exceptions

PEAR_Error

MoodleQuickForm_selectgroups()

MoodleQuickForm_selectgroups::MoodleQuickForm_selectgroups	(		$elementName = null,
			$elementLabel = null,
			$optgrps = null,
			$attributes = null,
			$showchoose = false )

Old syntax of class constructor.

Deprecated in PHP7.

Deprecated

since Moodle 3.1

onQuickFormEvent()

MoodleQuickForm_selectgroups::onQuickFormEvent	(		$event,
			$arg,
		&	$caller )

Called by HTML_QuickForm whenever form event is made on this element.

Parameters

string	$event	Name of event
mixed	$arg	event arguments
object	$caller	calling object

Return values

bool

setHiddenLabel()

MoodleQuickForm_selectgroups::setHiddenLabel

(

$hiddenLabel

)

Sets label to be hidden.

Parameters

bool

$hiddenLabel

sets if label should be hidden

setMultiple()

MoodleQuickForm_selectgroups::setMultiple

(

$multiple

)

Sets the select mutiple attribute.

Parameters

bool

$multiple

Whether the select supports multi-selections

setName()

MoodleQuickForm_selectgroups::setName

(

$name

)

Sets the input field name.

Parameters

string

$name

Input field name attribute

setSelected()

MoodleQuickForm_selectgroups::setSelected

(

$values

)

Sets the default values of the select box.

Parameters

mixed

$values

Array or comma delimited string of selected values

setSize()

MoodleQuickForm_selectgroups::setSize

(

$size

)

Sets the select field size, only applies to 'multiple' selects.

Parameters

int

$size

Size of select field

setValue()

MoodleQuickForm_selectgroups::setValue

(

$value

)

Sets the value of the form element.

Parameters

mixed

$value

Array or comma delimited string of selected values

toHtml()

MoodleQuickForm_selectgroups::toHtml

(

)

Returns the SELECT in HTML.

Return values

string

---

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

• lib/form/selectgroups.php