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.

Differences Between: [Versions 310 and 400] [Versions 311 and 400] [Versions 39 and 400] [Versions 400 and 403]

Base form for changing completion rules

Copyright: 2017 Marina Glancy
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 291 lines (12 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

core_completion_edit_base_form:: (9 methods):
  support_views()
  support_grades()
  add_custom_completion_rules()
  completion_rule_enabled()
  get_modules_with_hidden_rules()
  definition()
  validation()
  has_custom_completion_rules()
  get_data()


Class: core_completion_edit_base_form  - X-Ref

Base form for changing completion rules. Used in bulk editing activity completion and editing default activity completion

support_views()   X-Ref
Returns true if all selected modules support tracking view.

return: bool

support_grades()   X-Ref
Returns true if all selected modules support grading.

return: bool

add_custom_completion_rules()   X-Ref
If all selected modules are of the same module type, adds custom completion rules from this module type

return: array

completion_rule_enabled($data)   X-Ref
Checks if at least one of the custom completion rules is enabled

return: bool True if one or more rules is enabled, false if none are;
param: array $data Input data (not yet validated)

get_modules_with_hidden_rules()   X-Ref
Returns list of modules that have automatic completion rules that are not shown on this form
(because they are not present in at least one other selected module).

return: array

definition()   X-Ref
Form definition


validation($data, $files)   X-Ref
Form validation

return: array of "element_name"=>"error_description" if there are errors,
param: array $data array of ("fieldname"=>value) of submitted data
param: array $files array of uploaded files "element_name"=>tmp_file_path

has_custom_completion_rules()   X-Ref
Returns if this form has custom completion rules. This is only possible if all selected modules have the same
module type and this module type supports custom completion rules

return: bool

get_data()   X-Ref
Return submitted data if properly submitted or returns NULL if validation fails or
if there is no submitted data.

return: object submitted data; NULL if not valid or not submitted or cancelled