Badge award criteria – award on activity completion.
More...
|
| __construct ($record) |
| The base constructor.
|
|
| config_form_criteria ($data) |
| Add appropriate criteria elements.
|
|
| config_options (&$mform, $param) |
| Add appropriate parameter elements to the criteria form.
|
|
| delete () |
| Delete this criterion.
|
|
| get_completed_criteria_sql () |
| Returns array with sql code and parameters returning all ids of users who meet this particular criterion.
|
|
| get_details ($short='') |
| Get criteria description for displaying to users.
|
|
| get_options (&$mform) |
| Add appropriate new criteria options to the form.
|
|
| get_params ($cid) |
| Return criteria parameters.
|
|
| get_title () |
| Return criteria title.
|
|
| make_clone ($newbadgeid) |
| Saves intial criteria records with required parameters set up.
|
|
| mark_complete ($userid) |
| Mark this criteria as complete for a user.
|
|
| review ($userid, $filtered=false) |
| Review this criteria and decide if it has been completed.
|
|
| save ($params=array()) |
| Saves intial criteria records with required parameters set up.
|
|
|
static | build ($params) |
| Factory method for creating criteria class object.
|
|
static | is_enabled () |
| Allow some specific criteria types to be disabled based on config.
|
|
|
integer | $badgeid |
| ID of a badge this criterion belongs to.
|
|
int | $criteriatype = BADGE_CRITERIA_TYPE_ACTIVITY |
|
string | $description |
| Criterion HTML/plain text description.
|
|
integer | $descriptionformat |
| Format of the criterion description.
|
|
integer | $id |
| ID of the criterion.
|
|
integer | $method |
| Aggregation method [BADGE_CRITERIA_AGGREGATION_ANY, BADGE_CRITERIA_AGGREGATION_ALL].
|
|
| $optional_params = array('bydate') |
|
array | $params = array() |
| Any additional parameters.
|
|
| $required_param = 'module' |
|
Badge award criteria – award on activity completion.
◆ __construct()
award_criteria_activity::__construct |
( |
| $params | ) |
|
◆ build()
static award_criteria::build |
( |
| $params | ) |
|
|
staticinherited |
Factory method for creating criteria class object.
- Parameters
-
array | $params | associative arrays varname => value |
- Return values
-
◆ config_form_criteria()
award_criteria::config_form_criteria |
( |
| $data | ) |
|
|
inherited |
◆ config_options()
award_criteria::config_options |
( |
& | $mform, |
|
|
| $param ) |
|
inherited |
◆ delete()
award_criteria::delete |
( |
| ) |
|
|
inherited |
◆ get_completed_criteria_sql()
award_criteria_activity::get_completed_criteria_sql |
( |
| ) |
|
Returns array with sql code and parameters returning all ids of users who meet this particular criterion.
- Return values
-
array | list($join, $where, $params) |
Reimplemented from award_criteria.
◆ get_details()
award_criteria_activity::get_details |
( |
| $short = '' | ) |
|
Get criteria description for displaying to users.
- Return values
-
Reimplemented from award_criteria.
◆ get_options()
award_criteria_activity::get_options |
( |
& | $mform | ) |
|
Add appropriate new criteria options to the form.
Reimplemented from award_criteria.
◆ get_params()
award_criteria::get_params |
( |
| $cid | ) |
|
|
inherited |
◆ get_title()
award_criteria::get_title |
( |
| ) |
|
|
inherited |
Return criteria title.
- Return values
-
◆ is_enabled()
static award_criteria::is_enabled |
( |
| ) |
|
|
staticinherited |
◆ mark_complete()
award_criteria::mark_complete |
( |
| $userid | ) |
|
|
inherited |
Mark this criteria as complete for a user.
- Parameters
-
int | $userid | User whose criteria is completed. |
◆ review()
award_criteria_activity::review |
( |
| $userid, |
|
|
| $filtered = false ) |
Review this criteria and decide if it has been completed.
- Parameters
-
int | $userid | User whose criteria completion needs to be reviewed. |
bool | $filtered | An additional parameter indicating that user list has been reduced and some expensive checks can be skipped. |
- Return values
-
bool | Whether criteria is complete |
Reimplemented from award_criteria.
◆ save()
award_criteria::save |
( |
| $params = array() | ) |
|
|
inherited |
The documentation for this class was generated from the following file:
- badges/criteria/award_criteria_activity.php