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.
/mod/resource/classes/completion/ -> custom_completion.php (source)

[Source view]

(no description)

File Size: 92 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

custom_completion:: (5 methods):
  get_state()
  get_defined_custom_rules()
  get_custom_rule_descriptions()
  manual_completion_always_shown()
  get_sort_order()


Class: custom_completion  - X-Ref

Activity custom completion subclass for the resource.

Class for defining mod_resource's custom completion rules and fetching the completion statuses
of the custom completion rules for a given resource instance and a user.

get_state(string $rule)   X-Ref
Fetches the completion state for a given completion rule.

param: string $rule The completion rule.
return: int The completion state.

get_defined_custom_rules()   X-Ref
Fetch the list of custom completion rules that this module defines.

return: array

get_custom_rule_descriptions()   X-Ref
Returns an associative array of the descriptions of custom completion rules.

return: array

manual_completion_always_shown()   X-Ref
Show the manual completion or not regardless of the course's showcompletionconditions setting.

return: bool

get_sort_order()   X-Ref
Returns an array of all completion rules, in the order they should be displayed to users.

return: array