Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/completion/classes/ -> api.php (source)

[Source view]

Differences Between: [Versions 310 and 400] [Versions 311 and 400] [Versions 39 and 400]

Contains class containing completion API.

Copyright: 2017 Mark Nelson <markn@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 190 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

api:: (2 methods):
  update_completion_date_event()
  mark_course_completions_activity_criteria()


Class: api  - X-Ref

Class containing completion API.

update_completion_date_event($cmid, $modulename, $instanceorid, $completionexpectedtime)   X-Ref
Creates, updates or deletes an event for the expected completion date.

return: bool
param: int $cmid The course module id
param: string $modulename The name of the module (eg. assign, quiz)
param: \stdClass|int $instanceorid The instance object or ID.
param: int|null $completionexpectedtime The time completion is expected, null if not set

mark_course_completions_activity_criteria($userdata = null)   X-Ref
Mark users who completed course based on activity criteria.

return: int Completion record id if $userdata is set, 0 else.
param: array $userdata If set only marks specified user in given course else checks all courses/users.