Completion external functions.
More...
Completion external functions.
- Copyright
- 2015 Juan Leyva juan@.nosp@m.mood.nosp@m.le.co.nosp@m.m
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- Since
- Moodle 2.9
◆ get_activities_completion_status()
static core_completion_external::get_activities_completion_status |
( |
| $courseid, |
|
|
| $userid ) |
|
static |
Get Activities completion status.
- Parameters
-
int | $courseid | ID of the Course |
int | $userid | ID of the User |
- Return values
-
array | of activities progress and warnings |
- Exceptions
-
- Since
- Moodle 2.9
- Exceptions
-
◆ get_activities_completion_status_parameters()
static core_completion_external::get_activities_completion_status_parameters |
( |
| ) |
|
|
static |
Returns description of method parameters.
- Return values
-
external_function_parameters | |
- Since
- Moodle 2.9
◆ get_activities_completion_status_returns()
static core_completion_external::get_activities_completion_status_returns |
( |
| ) |
|
|
static |
Returns description of method result value.
- Return values
-
- Since
- Moodle 2.9
◆ get_course_completion_status()
static core_completion_external::get_course_completion_status |
( |
| $courseid, |
|
|
| $userid ) |
|
static |
Get Course completion status.
- Parameters
-
int | $courseid | ID of the Course |
int | $userid | ID of the User |
- Return values
-
array | of course completion status and warnings |
- Since
- Moodle 2.9
- Exceptions
-
◆ get_course_completion_status_parameters()
static core_completion_external::get_course_completion_status_parameters |
( |
| ) |
|
|
static |
Returns description of method parameters.
- Return values
-
external_function_parameters | |
- Since
- Moodle 2.9
◆ get_course_completion_status_returns()
static core_completion_external::get_course_completion_status_returns |
( |
| ) |
|
|
static |
Returns description of method result value.
- Return values
-
- Since
- Moodle 2.9
◆ mark_course_self_completed()
static core_completion_external::mark_course_self_completed |
( |
| $courseid | ) |
|
|
static |
Update the course completion status for the current user (if course self-completion is enabled).
- Parameters
-
- Return values
-
array | Result and possible warnings |
- Since
- Moodle 3.0
- Exceptions
-
◆ mark_course_self_completed_parameters()
static core_completion_external::mark_course_self_completed_parameters |
( |
| ) |
|
|
static |
Describes the parameters for mark_course_self_completed.
- Return values
-
external_function_parameters | |
- Since
- Moodle 3.0
◆ mark_course_self_completed_returns()
static core_completion_external::mark_course_self_completed_returns |
( |
| ) |
|
|
static |
Describes the mark_course_self_completed return value.
- Return values
-
external_single_structure | |
- Since
- Moodle 3.0
◆ override_activity_completion_status()
static core_completion_external::override_activity_completion_status |
( |
| $userid, |
|
|
| $cmid, |
|
|
| $newstate ) |
|
static |
Update completion status for a user in an activity.
- Parameters
-
int | $userid | User id |
int | $cmid | Course module id |
int | $newstate | Activity completion |
- Return values
-
array | Array containing the current (updated) completion status. |
- Since
- Moodle 3.4
- Exceptions
-
◆ override_activity_completion_status_parameters()
static core_completion_external::override_activity_completion_status_parameters |
( |
| ) |
|
|
static |
Describes the parameters for override_activity_completion_status.
- Return values
-
external_external_function_parameters | |
- Since
- Moodle 3.4
◆ override_activity_completion_status_returns()
static core_completion_external::override_activity_completion_status_returns |
( |
| ) |
|
|
static |
Describes the override_activity_completion_status return value.
- Return values
-
external_single_structure | |
- Since
- Moodle 3.4
◆ update_activity_completion_status_manually()
static core_completion_external::update_activity_completion_status_manually |
( |
| $cmid, |
|
|
| $completed ) |
|
static |
Update completion status for the current user in an activity, only for activities with manual tracking.
- Parameters
-
int | $cmid | Course module id |
bool | $completed | Activity completed or not |
- Return values
-
array | Result and possible warnings |
- Since
- Moodle 2.9
- Exceptions
-
◆ update_activity_completion_status_manually_parameters()
static core_completion_external::update_activity_completion_status_manually_parameters |
( |
| ) |
|
|
static |
Describes the parameters for update_activity_completion_status_manually.
- Return values
-
external_function_parameters | |
- Since
- Moodle 2.9
◆ update_activity_completion_status_manually_returns()
static core_completion_external::update_activity_completion_status_manually_returns |
( |
| ) |
|
|
static |
Describes the update_activity_completion_status_manually return value.
- Return values
-
external_single_structure | |
- Since
- Moodle 2.9
The documentation for this class was generated from the following file:
- completion/classes/external.php