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/privacy/ -> provider.php (source)

[Source view]

Differences Between: [Versions 400 and 401] [Versions 400 and 402] [Versions 400 and 403]

Privacy class for requesting user data.

Copyright: 2018 Adrian Greeve <adrian@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 300 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

provider:: (7 methods):
  get_metadata()
  get_course_completion_join_sql()
  add_course_completion_users_to_userlist()
  get_activity_completion_info()
  get_course_completion_info()
  delete_completion()
  delete_completion_by_approved_userlist()


Class: provider  - X-Ref

Privacy class for requesting user data.

get_metadata(collection $collection)   X-Ref
Returns meta data about this system.

return: collection A listing of user data stored through this system.
param: collection $collection The initialised collection to add items to.

get_course_completion_join_sql(int $userid, string $prefix, string $joinfield)   X-Ref
Get join sql to retrieve courses the user is in.

return: array The join, where, and params for this join.
param: int $userid The user ID
param: string $prefix A unique prefix for these joins.
param: string $joinfield A field to join these tables to. Joins to course ID.

add_course_completion_users_to_userlist(userlist $userlist)   X-Ref
Find users' course completion by context and add to the provided userlist.

param: userlist $userlist The userlist to add to.

get_activity_completion_info(\stdClass $user, \stdClass $course, $cm)   X-Ref
Returns activity completion information about a user.

return: \stdClass Activity completion information.
param: \stdClass $user The user to return information about.
param: \stdClass $course The course the user is in.
param: \stdClass $cm Course module information.

get_course_completion_info(\stdClass $user, \stdClass $course)   X-Ref
Returns course completion information for a user.

return: \stdClass Course completion information.
param: \stdClass $user The user that we are getting completion information for.
param: \stdClass $course The course we are interested in.

delete_completion(\stdClass $user = null, int $courseid = null, int $cmid = null)   X-Ref
Delete completion information for users.

param: \stdClass $user The user. If provided will delete completion information for just this user. Else all users.
param: int $courseid The course id. Provide this if you want course completion and activity completion deleted.
param: int $cmid The course module id. Provide this if you only want activity completion deleted.

delete_completion_by_approved_userlist(approved_userlist $userlist, int $courseid = null, int $cmid = null)   X-Ref
Delete completion information for users within an approved userlist.

param: approved_userlist $userlist The approved userlist of users to delete completion information for.
param: int $courseid The course id. Provide this if you want course completion and activity completion deleted.
param: int $cmid The course module id. Provide this if you only want activity completion deleted.