Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/course/classes/analytics/target/ -> course_completion.php (source)

[Source view]

Course completion target.

Copyright: 2019 Victor Deniz <victor@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 114 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

course_completion:: (4 methods):
  get_name()
  classes_description()
  is_valid_analysable()
  calculate_sample()


Class: course_completion  - X-Ref

Course completion target.

get_name()   X-Ref
Returns the name.

If there is a corresponding '_help' string this will be shown as well.

return: \lang_string

classes_description()   X-Ref
Returns descriptions for each of the values the target calculation can return.

return: string[]

is_valid_analysable(\core_analytics\analysable $course, $fortraining = true)   X-Ref
Discards courses that are not yet ready to be used for training or prediction.

param: \core_analytics\analysable $course
param: bool $fortraining
return: true|string

calculate_sample($sampleid, \core_analytics\analysable $course, $starttime = false, $endtime = false)   X-Ref
Course completion sets the target value.

param: int $sampleid
param: \core_analytics\analysable $course
param: int $starttime
param: int $endtime
return: float|null 0 -> course not completed, 1 -> course completed