completionlib.php File Reference

Contains classes, functions and constants used during the tracking of activity completion for users. More...

Classes
class	completion_info

Functions
	completion_can_view_data ($userid, $course=null)
	Utility function for checking if the logged in user can view another's completion data for a particular course. More...
	completion_cron_aggregate ($method, $data, &$state)
	Aggregate criteria status's as per configured aggregation method. More...

Variables
const	COMPLETION_AGGREGATION_ALL 1
	Course completion criteria aggregation method.
const	COMPLETION_AGGREGATION_ANY 2
	Course completion criteria aggregation method.
const	COMPLETION_AND true
	Completion details should be ANDed together and you should return true if none apply.
const	COMPLETION_COMPLETE 1
	The user has completed this activity. More...
const	COMPLETION_COMPLETE_FAIL 3
	The user has completed this activity but their grade is less than the pass mark This is a completion state value (course_modules_completion/completionstate)
const	COMPLETION_COMPLETE_PASS 2
	The user has completed this activity with a grade above the pass mark. More...
const	COMPLETION_DISABLED 0
	The completion system is not enabled in this site/course.
const	COMPLETION_ENABLED 1
	Include the required completion libraries. More...
const	COMPLETION_GRADECHANGE -2
	The user's grade has changed, so their new state might be COMPLETION_COMPLETE_PASS or COMPLETION_COMPLETE_FAIL. More...
const	COMPLETION_INCOMPLETE 0
	The user has not completed this activity. More...
const	COMPLETION_NOT_VIEWED 0
	User has not viewed this activity. More...
const	COMPLETION_OR false
	Completion details should be ORed together and you should return false if none apply.
const	COMPLETION_TRACKING_AUTOMATIC 2
	Automatic completion tracking (system ticks box) is enabled for this activity This is a completion tracking option per-activity (course_modules/completion)
const	COMPLETION_TRACKING_MANUAL 1
	Manual completion tracking (user ticks box) is enabled for this activity This is a completion tracking option per-activity (course_modules/completion)
const	COMPLETION_TRACKING_NONE 0
	Completion tracking is disabled for this activity This is a completion tracking option per-activity (course_modules/completion)
const	COMPLETION_UNKNOWN -1
	The effect of this change to completion status is unknown. More...
const	COMPLETION_VIEW_NOT_REQUIRED 0
	User does not need to view this activity Whether view is required to create an activity (course_modules/completionview)
const	COMPLETION_VIEW_REQUIRED 1
	User must view this activity. More...
const	COMPLETION_VIEWED 1
	User has viewed this activity. More...

Detailed Description

Contains classes, functions and constants used during the tracking of activity completion for users.

Completion top-level options (admin setting enablecompletion)