Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
core_completion_external Class Reference

Completion external functions. More...

Inheritance diagram for core_completion_external:

Static Public Member Functions

static get_activities_completion_status ($courseid, $userid)
 Get Activities completion status.
 
static get_activities_completion_status_parameters ()
 Returns description of method parameters.
 
static get_activities_completion_status_returns ()
 Returns description of method result value.
 
static get_course_completion_status ($courseid, $userid)
 Get Course completion status.
 
static get_course_completion_status_parameters ()
 Returns description of method parameters.
 
static get_course_completion_status_returns ()
 Returns description of method result value.
 
static mark_course_self_completed ($courseid)
 Update the course completion status for the current user (if course self-completion is enabled).
 
static mark_course_self_completed_parameters ()
 Describes the parameters for mark_course_self_completed.
 
static mark_course_self_completed_returns ()
 Describes the mark_course_self_completed return value.
 
static override_activity_completion_status ($userid, $cmid, $newstate)
 Update completion status for a user in an activity.
 
static override_activity_completion_status_parameters ()
 Describes the parameters for override_activity_completion_status.
 
static override_activity_completion_status_returns ()
 Describes the override_activity_completion_status return value.
 
static update_activity_completion_status_manually ($cmid, $completed)
 Update completion status for the current user in an activity, only for activities with manual tracking.
 
static update_activity_completion_status_manually_parameters ()
 Describes the parameters for update_activity_completion_status_manually.
 
static update_activity_completion_status_manually_returns ()
 Describes the update_activity_completion_status_manually return value.
 

Detailed Description

Completion external functions.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
Since
Moodle 2.9

Member Function Documentation

◆ get_activities_completion_status()

static core_completion_external::get_activities_completion_status ( $courseid,
$userid )
static

Get Activities completion status.

Parameters
int$courseidID of the Course
int$useridID of the User
Return values
arrayof activities progress and warnings
Exceptions
moodle_exception
Since
Moodle 2.9
Exceptions
moodle_exception

◆ 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
core_external\external_description
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$courseidID of the Course
int$useridID of the User
Return values
arrayof course completion status and warnings
Since
Moodle 2.9
Exceptions
moodle_exception

◆ 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
core_external\external_description
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
int$courseidCourse id
Return values
arrayResult and possible warnings
Since
Moodle 3.0
Exceptions
moodle_exception

◆ 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$useridUser id
int$cmidCourse module id
int$newstateActivity completion
Return values
arrayArray containing the current (updated) completion status.
Since
Moodle 3.4
Exceptions
moodle_exception

◆ 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$cmidCourse module id
bool$completedActivity completed or not
Return values
arrayResult and possible warnings
Since
Moodle 2.9
Exceptions
moodle_exception

◆ 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: