Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Public Attributes | Protected Attributes | List of all members
gradereport_history\output\user_button Class Reference

A button that is used to select users for a form. More...

Inheritance diagram for gradereport_history\output\user_button:
single_button renderable renderable

Public Member Functions

 __construct (\moodle_url $url, $label, $method='post')
 Initialises the new select_user_button. More...
 
 add_action (component_action $action)
 Add action to the button. More...
 
 add_confirm_action ($confirmmessage)
 Shortcut for adding a JS confirm dialog when the button is clicked. More...
 
 export_for_template (renderer_base $output)
 Export data. More...
 
 set_attribute ($name, $value)
 Sets an attribute for the HTML button tag. More...
 

Public Attributes

string $actionid
 Action id.
 
array $actions = array()
 List of attached actions.
 
string $class = 'singlebutton'
 Wrapping div class.
 
bool $disabled = false
 True if button disabled, false if normal.
 
string $formid
 Form id.
 
string $label
 Button label.
 
string $method = 'post'
 Form submit method post or get.
 
array $params
 $params URL Params
 
bool $primary = false
 True if button is primary button. More...
 
string $tooltip = null
 Button tooltip.
 
moodle_url $url
 Target url.
 

Protected Attributes

array $attributes = []
 

Detailed Description

A button that is used to select users for a form.

Since
Moodle 2.8
Author
Adam Olley adam..nosp@m.olle.nosp@m.y@net.nosp@m.spot.nosp@m..com..nosp@m.au
License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

◆ __construct()

gradereport_history\output\user_button::__construct ( \moodle_url  $url,
  $label,
  $method = 'post' 
)

Initialises the new select_user_button.

Parameters
moodle_url$url
string$labelThe text to display in the button
string$methodEither post or get

Member Function Documentation

◆ add_action()

single_button::add_action ( component_action  $action)
inherited

Add action to the button.

Parameters
component_action$action

◆ add_confirm_action()

single_button::add_confirm_action (   $confirmmessage)
inherited

Shortcut for adding a JS confirm dialog when the button is clicked.

The message must be a yes/no question.

Parameters
string$confirmmessageThe yes/no confirmation question. If "Yes" is clicked, the original action will occur.

◆ export_for_template()

single_button::export_for_template ( renderer_base  $output)
inherited

Export data.

Parameters
renderer_base$outputRenderer.
Return values
stdClass

◆ set_attribute()

single_button::set_attribute (   $name,
  $value 
)
inherited

Sets an attribute for the HTML button tag.

Parameters
string$nameThe attribute name
mixed$valueThe value
Return values
null

Member Data Documentation

◆ $primary

bool single_button::$primary = false
inherited

True if button is primary button.

Used for styling.


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