MoodleQuickForm_warning Class Reference

Inheritance diagram for MoodleQuickForm_warning:

Public Member Functions
	__construct ($elementName=null, $elementClass='notifyproblem', $text=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...
	getElementTemplateType ()
	Gets the type of form element. More...
	getHelpButton ()
	get html for help button More...
	MoodleQuickForm_warning ($elementName=null, $elementClass='notifyproblem', $text=null)
	Old syntax of class constructor. More...
	toHtml ()
	Returns HTML for this form element. More...

Public Attributes
string	$_class =''
	class assigned to field, default is notifyproblem
string	$_elementTemplateType ='warning'
	Form element type.
string	$_helpbutton =''
	html for help button, if empty then no help

Constructor & Destructor Documentation

__construct()

MoodleQuickForm_warning::__construct	(		$elementName = null,
			$elementClass = 'notifyproblem',
			$text = null
	)

constructor

Parameters

string	$elementName	(optional) name of the field
string	$elementClass	(optional) show as warning or notification => 'notifyproblem'
string	$text	(optional) Text to put in warning field

Member Function Documentation

export_for_template()

MoodleQuickForm_warning::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.

getElementTemplateType()

MoodleQuickForm_warning::getElementTemplateType

(

)

Gets the type of form element.

Return values

string

getHelpButton()

MoodleQuickForm_warning::getHelpButton

(

)

get html for help button

Return values

string

html for help button

MoodleQuickForm_warning()

MoodleQuickForm_warning::MoodleQuickForm_warning	(		$elementName = null,
			$elementClass = 'notifyproblem',
			$text = null
	)

Old syntax of class constructor.

Deprecated in PHP7.

Deprecated:

since Moodle 3.1

toHtml()

MoodleQuickForm_warning::toHtml

(

)

Returns HTML for this form element.

Return values

string

---

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

• lib/form/warning.php