Representation of a suggested bulk action.
More...
|
Action const | TYPE_NEGATIVE = 'notuseful' |
| type notuseful.
|
|
Action const | TYPE_NEUTRAL = 'neutral' |
| type neutral.
|
|
Action const | TYPE_POSITIVE = 'useful' |
| type useful.
|
|
|
renderable | $actionlink = null |
|
string | $actionname = null |
|
string | $text = null |
|
string string | $type = '' |
| Store the action type.
|
|
moodle_url | $url = null |
|
Representation of a suggested bulk action.
- Copyright
- 2019 David Monllao
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
◆ __construct()
core_analytics\bulk_action::__construct |
( |
| $actionname, |
|
|
moodle_url | $actionurl, |
|
|
pix_icon | $icon, |
|
|
| $text, |
|
|
| $primary = false, |
|
|
| $attributes = array(), |
|
|
| $type = false ) |
Prediction action constructor.
- Parameters
-
string | $actionname | They should match a-zA-Z_0-9-, as we apply a PARAM_ALPHANUMEXT filter |
moodle_url | $actionurl | The final URL where the user should be forwarded. |
pix_icon | $icon | Link icon |
string | $text | Link text |
bool | $primary | Primary button or secondary. |
array | $attributes | Link attributes |
string | false | $type | |
- Return values
-
◆ get_action_link()
core_analytics\action::get_action_link |
( |
| ) |
|
|
inherited |
Returns the link to the action.
- Return values
-
◆ get_action_name()
core_analytics\action::get_action_name |
( |
| ) |
|
|
inherited |
Returns the action name.
- Return values
-
◆ get_text()
core_analytics\action::get_text |
( |
| ) |
|
|
inherited |
Returns the action text.
- Return values
-
◆ get_type()
core_analytics\action::get_type |
( |
| ) |
|
|
inherited |
Returns the type of action.
- Return values
-
string | The positiveness of the action (self\TYPE_POSITIVE, self\TYPE_NEGATIVE or self\TYPE_NEUTRAL) |
◆ get_url()
core_analytics\action::get_url |
( |
| ) |
|
|
inherited |
Returns the url to the action.
- Return values
-
◆ set_type()
core_analytics\action::set_type |
( |
| $type = false | ) |
|
|
inherited |
Sets the type of the action according to its positiveness.
- Exceptions
-
- Parameters
-
The documentation for this class was generated from the following file:
- analytics/classes/bulk_action.php