Drop down for question categories. More...

Inheritance diagram for MoodleQuickForm_questioncategory:

Public Member Functions
	__construct ($elementName=null, $elementLabel=null, $options=null, $attributes=null)
	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_questioncategory ($elementName=null, $elementLabel=null, $options=null, $attributes=null)
	Old syntax of class constructor.

	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	$_options = array('top'=>false, 'currentcat'=>0, 'nochildrenof' => -1)
	default options for question categories

array	$_values = null
	Default values of the SELECT.

bool	$showchoose = false
	add choose option

Detailed Description

Drop down for question categories.

HTML class for a drop down element to select a question category.

Copyright: 2007 Tim Hunt

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

Constructor & Destructor Documentation

◆ __construct()

MoodleQuickForm_questioncategory::__construct	(	$elementName = null,
		$elementLabel = null,
		$options = null,
		$attributes = null )

Constructor.

Parameters

string	$elementName	Select name attribute
mixed	$elementLabel	Label(s) for the select
array	$options	additional options. Recognised options are courseid, published and only_editable, corresponding to the arguments of question_category_options from moodlelib.php.
mixed	$attributes	Either a typical HTML attribute string or an associative array

Member Function Documentation

◆ addOptGroup()

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

inherited

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 )

inherited

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 )

inherited

Function to export the renderer data in a format that is suitable for a mustache template.

This means:

No complex types - only stdClass, array, int, string, float, bool
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 )

inherited

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 ( )

inherited

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 ( )

inherited

Returns the value of field without HTML tags.

Return values

string

◆ getHelpButton()

MoodleQuickForm_selectgroups::getHelpButton ( )

inherited

get html for help button

Return values

string html for help button

◆ getMultiple()

MoodleQuickForm_selectgroups::getMultiple ( )

inherited

Returns the select mutiple attribute.

Return values

bool	true if multiple select, false otherwise

◆ getName()

MoodleQuickForm_selectgroups::getName ( )

inherited

Returns the element name.

Return values

string

◆ getPrivateName()

MoodleQuickForm_selectgroups::getPrivateName ( )

inherited

Returns the element name (possibly with brackets appended)

Return values

string

◆ getSelected()

MoodleQuickForm_selectgroups::getSelected ( )

inherited

Returns an array of the selected values.

Return values

array of selected values

◆ getSize()

MoodleQuickForm_selectgroups::getSize ( )

inherited

Returns the select field size.

Return values

int

◆ getValue()

MoodleQuickForm_selectgroups::getValue ( )

inherited

Returns an array of the selected values.

Return values

array of selected values

◆ loadArrayOptGroups()

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

inherited

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 )

inherited

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_questioncategory()

MoodleQuickForm_questioncategory::MoodleQuickForm_questioncategory	(	$elementName = null,
		$elementLabel = null,
		$options = null,
		$attributes = null )

Old syntax of class constructor.

Deprecated in PHP7.

Deprecated: since Moodle 3.1

◆ MoodleQuickForm_selectgroups()

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

inherited

Old syntax of class constructor.

Deprecated in PHP7.

Deprecated: since Moodle 3.1

◆ onQuickFormEvent()

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

inherited

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 )

inherited

Sets label to be hidden.

Parameters

bool $hiddenLabel sets if label should be hidden

◆ setMultiple()

MoodleQuickForm_selectgroups::setMultiple ( $multiple )

inherited

Sets the select mutiple attribute.

Parameters

bool $multiple Whether the select supports multi-selections

◆ setName()

MoodleQuickForm_selectgroups::setName ( $name )

inherited

Sets the input field name.

Parameters

string $name Input field name attribute

◆ setSelected()

MoodleQuickForm_selectgroups::setSelected ( $values )

inherited

Sets the default values of the select box.

Parameters

mixed $values Array or comma delimited string of selected values

◆ setSize()

MoodleQuickForm_selectgroups::setSize ( $size )

inherited

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

Parameters

int $size Size of select field

◆ setValue()

MoodleQuickForm_selectgroups::setValue ( $value )

inherited

Sets the value of the form element.

Parameters

mixed $value Array or comma delimited string of selected values

◆ toHtml()

MoodleQuickForm_selectgroups::toHtml ( )

inherited

Returns the SELECT in HTML.

Return values

string

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

lib/form/questioncategory.php

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addOptGroup()

◆ addOption()

◆ export_for_template()

◆ exportValue()

◆ getElementTemplateType()

◆ getFrozenHtml()

◆ getHelpButton()

◆ getMultiple()

◆ getName()

◆ getPrivateName()

◆ getSelected()

◆ getSize()

◆ getValue()

◆ loadArrayOptGroups()

◆ loadArrayOptions()

◆ MoodleQuickForm_questioncategory()

◆ MoodleQuickForm_selectgroups()

◆ onQuickFormEvent()

◆ setHiddenLabel()

◆ setMultiple()

◆ setName()

◆ setSelected()

◆ setSize()

◆ setValue()

◆ toHtml()