|
string | $actionid |
| Action id.
|
|
array | $actions = [] |
| 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
|
|
string | $tooltip = null |
| Button tooltip.
|
|
moodle_url | $url |
| Target url.
|
|
const | BUTTON_DANGER = 'danger' |
| Possible button types - Danger.
|
|
const | BUTTON_INFO = 'info' |
| Possible button types - Info.
|
|
const | BUTTON_PRIMARY = 'primary' |
| Possible button types - Primary.
|
|
const | BUTTON_SECONDARY = 'secondary' |
| Possible button types - Secondary.
|
|
const | BUTTON_SUCCESS = 'success' |
| Possible button types - Success.
|
|
const | BUTTON_TYPES |
| Possible button types.
|
|
const | BUTTON_WARNING = 'warning' |
| Possible button types - Warning.
|
|
|
array | $attributes = [] |
|
string | $type |
| Type of button (from defined types).
|
|
◆ __construct()
core\output\single_button::__construct |
( |
moodle_url | $url, |
|
|
| $label, |
|
|
| $method = 'post', |
|
|
string | $type = self::BUTTON_SECONDARY, |
|
|
| $attributes = [] ) |
Constructor.
- Parameters
-
moodle_url | $url | |
string | $label | button text |
string | $method | get or post submit method |
string | $type | whether this is a primary button or another type, used for styling |
array | $attributes | Attributes for the HTML button tag |
◆ __get()
core\output\single_button::__get |
( |
| $name | ) |
|
Magic method getter.
- Parameters
-
- Return values
-
◆ __set()
core\output\single_button::__set |
( |
| $name, |
|
|
| $value ) |
Magic setter method.
- Parameters
-
◆ add_action()
Add action to the button.
- Parameters
-
◆ add_confirm_action()
core\output\single_button::add_confirm_action |
( |
| $confirmmessage | ) |
|
Shortcut for adding a JS confirm dialog when the button is clicked.
The message must be a yes/no question.
- Parameters
-
string | $confirmmessage | The yes/no confirmation question. If "Yes" is clicked, the original action will occur. |
◆ export_for_template()
core\output\single_button::export_for_template |
( |
renderer_base | $output | ) |
|
Export data.
- Parameters
-
renderer_base | $output | Renderer. |
- Return values
-
◆ set_attribute()
core\output\single_button::set_attribute |
( |
| $name, |
|
|
| $value ) |
Sets an attribute for the HTML button tag.
- Parameters
-
string | $name | The attribute name |
mixed | $value | The value |
- Return values
-
◆ $type
string core\output\single_button::$type |
|
protected |
Type of button (from defined types).
Used for styling.
◆ BUTTON_TYPES
const core\output\single_button::BUTTON_TYPES |
Initial value:= [
self::BUTTON_PRIMARY,
self::BUTTON_SECONDARY,
self::BUTTON_SUCCESS,
self::BUTTON_DANGER,
self::BUTTON_WARNING,
self::BUTTON_INFO,
]
Possible button types.
From boostrap.
The documentation for this class was generated from the following file:
- lib/classes/output/single_button.php