MoodleQuickForm_cancel Class Reference

HTML class for a submit cancel type element. More...

Inheritance diagram for MoodleQuickForm_cancel:

Public Member Functions
	__construct ($elementName=null, $value=null, $attributes=null)
	constructor
	export_for_template (renderer_base $output)
	Function to export the renderer data in a format that is suitable for a mustache template.
	freeze ()
	Freeze the element so that only its value is returned.
	getElementTemplateType ()
	Slightly different container template when frozen.
	getFrozenHtml ()
	Returns the value of field without HTML tags.
	MoodleQuickForm_cancel ($elementName=null, $value=null, $attributes=null)
	Old syntax of class constructor.
	MoodleQuickForm_submit ($elementName=null, $value=null, $attributes=null, $primary=null)
	Old syntax of class constructor.
	onQuickFormEvent ($event, $arg, &$caller)
	Called by HTML_QuickForm whenever form event is made on this element.

Protected Attributes
string	$customclassoverride
	Any class apart from 'btn' would be overridden with this content.
bool	$primary
	$primary Is this button a primary button?

Detailed Description

HTML class for a submit cancel type element.

Overloaded MoodleQuickForm_submit with default behavior modified to cancel a form.

Copyright

2007 Jamie Pratt me@ja.nosp@m.miep.nosp@m..org

License

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

Constructor & Destructor Documentation

__construct()

MoodleQuickForm_cancel::__construct	(		$elementName = null,
			$value = null,
			$attributes = null )

constructor

Parameters

string	$elementName	(optional) name of the checkbox
string	$value	(optional) value for the button
mixed	$attributes	(optional) Either a typical HTML attribute string or an associative array

Member Function Documentation

export_for_template()

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

getElementTemplateType()

MoodleQuickForm_submit::getElementTemplateType ( )

inherited

Slightly different container template when frozen.

Don't want to display a submit button if the form is frozen.

Return values

string

getFrozenHtml()

MoodleQuickForm_cancel::getFrozenHtml

(

)

Returns the value of field without HTML tags.

Return values

string

MoodleQuickForm_cancel()

MoodleQuickForm_cancel::MoodleQuickForm_cancel	(		$elementName = null,
			$value = null,
			$attributes = null )

Old syntax of class constructor.

Deprecated in PHP7.

Deprecated

since Moodle 3.1

MoodleQuickForm_submit()

MoodleQuickForm_submit::MoodleQuickForm_submit ( $elementName = null, $value = null, $attributes = null, $primary = null )

inherited

Old syntax of class constructor.

Deprecated in PHP7.

Deprecated

since Moodle 3.1

onQuickFormEvent()

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

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

Reimplemented from MoodleQuickForm_submit.

Member Data Documentation

$customclassoverride

string MoodleQuickForm_submit::$customclassoverride

protectedinherited

Any class apart from 'btn' would be overridden with this content.

By default, submit buttons will utilize the btn-primary OR btn-secondary classes. However there are cases where we require a submit button with different stylings (e.g. btn-link). In these cases, $customclassoverride will override the defaults mentioned previously and utilize the provided class(es).

$customclassoverride Custom class override for the input element

---

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

• lib/form/cancel.php