core\output\actions\confirm_action Class Reference

Inheritance diagram for core\output\actions\confirm_action:

Public Member Functions
	__construct ($message, $callback=null, $continuelabel=null, $cancellabel=null)
	Constructs the confirm action object.
	export_for_template (renderer_base $output)
	Export for template.

Public Attributes
string	$event
	$event The DOM event that will trigger this action when caught
string	$jsfunction = false
	A function name to call when the button is clicked The JS function you create must have two arguments:
array	$jsfunctionargs = []
	An array of arguments to pass to the JS function.

Constructor & Destructor Documentation

__construct()

core\output\actions\confirm_action::__construct	(		$message,
			$callback = null,
			$continuelabel = null,
			$cancellabel = null )

Constructs the confirm action object.

Parameters

string	$message	The message to display to the user when they are shown the confirm dialogue.
string	$callback	Deprecated since 2.7
string	$continuelabel	The string to use for he continue button
string	$cancellabel	The string to use for the cancel button

Member Function Documentation

export_for_template()

core\output\actions\component_action::export_for_template ( renderer_base $output )

inherited

Export for template.

Parameters

renderer_base

$output

The renderer.

Return values

stdClass

Implements core\output\templatable.

Member Data Documentation

$jsfunction

string core\output\actions\component_action::$jsfunction = false

inherited

A function name to call when the button is clicked The JS function you create must have two arguments:

1. The event object
2. An object/array of arguments ($jsfunctionargs)

---

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

• lib/classes/output/actions/confirm_action.php