MoodleQuickForm_advcheckbox Class Reference

Inheritance diagram for MoodleQuickForm_advcheckbox:

Collaboration diagram for MoodleQuickForm_advcheckbox:

Public Member Functions
	MoodleQuickForm_advcheckbox ($elementName=null, $elementLabel=null, $text=null, $attributes=null, $values=null)
	setHelpButton ($helpbuttonargs, $function='helpbutton')
	getHelpButton ()
	toHtml ()
	getFrozenHtml ()
Data Fields
	$_helpbutton = ''
	$_group

---

Detailed Description

HTML class for a advcheckbox type element

default behavior special for Moodle is to return '0' if not checked '1' for checked.

*

Author:

Jamie Pratt public

Definition at line 13 of file advcheckbox.php.

---

Member Function Documentation

getFrozenHtml

(

)

Returns the disabled field. Accessibility: the return "[ ]" from parent class is not acceptable for screenreader users, and we DO want a label.

Returns:

string

Reimplemented from HTML_QuickForm_advcheckbox.

Definition at line 101 of file advcheckbox.php.

Here is the call graph for this function:

getHelpButton

(

)

get html for help button

public

Returns:

string html for help button

Definition at line 87 of file advcheckbox.php.

MoodleQuickForm_advcheckbox	(	$	elementName = null,
		$	elementLabel = null,
		$	text = null,
		$	attributes = null,
		$	values = null
	)

Class constructor

Parameters:

string	$elementName	(optional)Input field name attribute
string	$elementLabel	(optional)Input field label
string	$text	(optional)Text to put after the checkbox
mixed	$attributes	(optional)Either a typical HTML attribute string or an associative array
mixed	$values	(optional)Values to pass if checked or not checked

Since:

1.0 public

Returns:

void

Definition at line 41 of file advcheckbox.php.

Here is the call graph for this function:

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 78 of file advcheckbox.php.

Here is the call graph for this function:

toHtml

(

)

Returns the checkbox element in HTML and the additional hidden element in HTML

public

Returns:

string

Reimplemented from HTML_QuickForm_advcheckbox.

Definition at line 91 of file advcheckbox.php.

---

Field Documentation

string $_group

Group to which this checkbox belongs (for select all/select none button)

Definition at line 25 of file advcheckbox.php.

$_helpbutton = ''

Definition at line 19 of file advcheckbox.php.

---

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

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