MoodleQuickForm_selectwithlink Class Reference

Inheritance diagram for MoodleQuickForm_selectwithlink:

Collaboration diagram for MoodleQuickForm_selectwithlink:

Public Member Functions
	MoodleQuickForm_selectwithlink ($elementName=null, $elementLabel=null, $options=null, $attributes=null, $linkdata=null)
	setHiddenLabel ($hiddenLabel)
	toHtml ()
	setHelpButton ($helpbuttonargs, $function='helpbutton')
	getHelpButton ()
	removeOption ($value)
	removeOptions ()
	getElementTemplateType ()
	exportValue (&$submitValues, $assoc=false)
Data Fields
	$_helpbutton = ''
	$_hiddenLabel = false
	$_link = null
	$_linklabel = null
	$_linkreturn = null

---

Detailed Description

HTML class for a select type element

Author:

Jamie Pratt public

Definition at line 10 of file selectwithlink.php.

---

Member Function Documentation

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"

Reimplemented from HTML_QuickForm_select.

Definition at line 138 of file selectwithlink.php.

Here is the call graph for this function:

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.

Returns:

string

Definition at line 127 of file selectwithlink.php.

getHelpButton

(

)

get html for help button

public

Returns:

string html for help button

Definition at line 84 of file selectwithlink.php.

MoodleQuickForm_selectwithlink	(	$	elementName = null,
		$	elementLabel = null,
		$	options = null,
		$	attributes = null,
		$	linkdata = null
	)

Definition at line 22 of file selectwithlink.php.

Here is the call graph for this function:

removeOption

(

$

value

)

Removes an OPTION from the SELECT

Parameters:

string

$value

Value for the OPTION to remove

Since:

1.0 public

Returns:

void

Definition at line 95 of file selectwithlink.php.

removeOptions

(

)

Removes all OPTIONs from the SELECT

Parameters:

string

$value

Value for the OPTION to remove

Since:

1.0 public

Returns:

void

Definition at line 116 of file selectwithlink.php.

setHelpButton	(	$	helpbuttonargs,
		$	function = 'helpbutton'
	)

set html for help button

public

Parameters:

array	$help	array of arguments to make a help button
string	$function	function name to call to get html

Definition at line 75 of file selectwithlink.php.

Here is the call graph for this function:

setHiddenLabel

(

$

hiddenLabel

)

Definition at line 36 of file selectwithlink.php.

toHtml

(

)

Returns the SELECT in HTML

Since:

1.0 public

Returns:

string

Reimplemented from HTML_QuickForm_select.

Definition at line 39 of file selectwithlink.php.

Here is the call graph for this function:

---

Field Documentation

$_helpbutton = ''

Definition at line 16 of file selectwithlink.php.

$_hiddenLabel = false

Definition at line 17 of file selectwithlink.php.

$_link = null

Definition at line 18 of file selectwithlink.php.

$_linklabel = null

Definition at line 19 of file selectwithlink.php.

$_linkreturn = null

Definition at line 20 of file selectwithlink.php.

---

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

• C:/xampp/htdocs/moodle/lib/form/selectwithlink.php