Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
/completion/ -> completion_criteria_completion.php (source)

[Source view]

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

Completion data for a specific user, course and critieria

Author: Aaron Barnes <aaronb@catalyst.net.nz>
Copyright: 2009 Catalyst IT Ltd
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 173 lines (5 kb)
Included or required:0 times
Referenced: 2 times
Includes or requires: 0 files

Defines 1 class

completion_criteria_completion:: (7 methods):
  fetch()
  fetch_all()
  is_complete()
  mark_complete()
  attach_criteria()
  get_criteria()
  get_status()


Class: completion_criteria_completion  - X-Ref

Completion data for a specific user, course and critieria

fetch($params)   X-Ref
Finds and returns a data_object instance based on params.

param: array $params associative arrays varname=>value
return: data_object instance of data_object or false if none found.

fetch_all($params)   X-Ref
Finds and returns all data_object instances based on params.

param: array $params associative arrays varname=>value
return: array array of data_object insatnces or false if none found.

is_complete()   X-Ref
Return status of this criteria completion

return: bool

mark_complete($timecompleted = null)   X-Ref
Mark this criteria complete for the associated user

This method creates a course_completion_crit_compl record

param: int $timecompleted Time completed (optional).
return: int id of completion record.

attach_criteria(completion_criteria $criteria)   X-Ref
Attach a preloaded criteria object to this object

param: $criteria   object  completion_criteria

get_criteria()   X-Ref
Return the associated criteria with this completion
If nothing attached, load from the db

return: completion_criteria

get_status()   X-Ref
Return criteria status text for display in reports {@link completion_criteria::get_status()}

return: string