Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Public Attributes | List of all members
confirm_action Class Reference
Inheritance diagram for confirm_action:
component_action templatable

Public Member Functions

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

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: More...
 
array $jsfunctionargs = array()
 An array of arguments to pass to the JS function.
 

Constructor & Destructor Documentation

◆ __construct()

confirm_action::__construct (   $message,
  $callback = null,
  $continuelabel = null,
  $cancellabel = null 
)

Constructs the confirm action object.

Parameters
string$messageThe message to display to the user when they are shown the confirm dialogue.
string$callbackDeprecated since 2.7
string$continuelabelThe string to use for he continue button
string$cancellabelThe string to use for the cancel button

Member Function Documentation

◆ export_for_template()

component_action::export_for_template ( renderer_base  $output)
inherited

Export for template.

Parameters
renderer_base$outputThe renderer.
Return values
stdClass

Implements templatable.

Member Data Documentation

◆ $jsfunction

string 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: