tool_lp_course_competency_rule_form_element Class Reference

Course competency rule element. More...

Inheritance diagram for tool_lp_course_competency_rule_form_element:

Public Member Functions
	__construct ($elementName=null, $elementLabel=null, $options=array(), $attributes=null)
	Constructor. More...
	export_for_template (renderer_base $output)
	Function to export the renderer data in a format that is suitable for a mustache template. More...
	exportValue (&$submitValues, $assoc=false)
	We check the options and return only the values that could have been selected. More...
	getElementTemplateType ()
	Slightly different container template when frozen. More...
	getHelpButton ()
	get html for help button More...
	MoodleQuickForm_select ($elementName=null, $elementLabel=null, $options=null, $attributes=null)
	Old syntax of class constructor. More...
	removeOption ($value)
	Removes an OPTION from the SELECT. More...
	removeOptions ()
	Removes all OPTIONs from the SELECT.
	setHiddenLabel ($hiddenLabel)
	Sets label to be hidden. More...
	toHtml ()
	Returns HTML for select form element. More...

Public Attributes
string	$_helpbutton =''
	html for help button, if empty then no help
bool	$_hiddenLabel =false
	if true label will be hidden

Detailed Description

Course competency rule element.

Copyright

2016 Damyon Wiese

License

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

Constructor & Destructor Documentation

__construct()

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

Constructor.

Parameters

string	$elementName	Element name
mixed	$elementLabel	Label(s) for an element
array	$options	Options to control the element's display
mixed	$attributes	Either a typical HTML attribute string or an associative array.

Reimplemented from MoodleQuickForm_select.

Member Function Documentation

export_for_template()

MoodleQuickForm_select::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:

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.

Reimplemented in MoodleQuickForm_tags, and MoodleQuickForm_autocomplete.

exportValue()

MoodleQuickForm_select::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

Reimplemented in MoodleQuickForm_tags, MoodleQuickForm_modvisible, and MoodleQuickForm_autocomplete.

getElementTemplateType()

MoodleQuickForm_select::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

getHelpButton()

MoodleQuickForm_select::getHelpButton ( )

inherited

get html for help button

Return values

string

html for help button

MoodleQuickForm_select()

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

inherited

Old syntax of class constructor.

Deprecated in PHP7.

Deprecated:

since Moodle 3.1

removeOption()

MoodleQuickForm_select::removeOption (   $value )

inherited

Removes an OPTION from the SELECT.

Parameters

string

$value

Value for the OPTION to remove

Return values

void

setHiddenLabel()

MoodleQuickForm_select::setHiddenLabel (   $hiddenLabel )

inherited

Sets label to be hidden.

Parameters

bool

$hiddenLabel

sets if label should be hidden

toHtml()

MoodleQuickForm_select::toHtml ( )

inherited

Returns HTML for select form element.

Return values

string

Reimplemented in MoodleQuickForm_tags, and MoodleQuickForm_autocomplete.

---

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

• admin/tool/lp/classes/course_competency_rule_form_element.php