Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
- Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
- PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.
/completion/classes/ -> edit_base_form.php (source)
Differences Between: [Versions 310 and 403] [Versions 311 and 403] [Versions 39 and 403] [Versions 400 and 403] [Versions 401 and 403] [Versions 402 and 403]
(no description)
| File Size: | 317 lines (12 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
core_completion_edit_base_form:: (14 methods):
get_module_name()
support_views()
support_grades()
add_custom_completion()
add_completion_rules()
completion_rule_enabled()
add_completiongrade_rules()
get_modules_with_hidden_rules()
definition()
get_cm()
definition_after_data()
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| get_module_name() X-Ref |
| Get the module name. If the form have more than one modules, it will return the first one. return: string|null The module name or null if there is no modules associated to this form. |
| 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(string $function) X-Ref |
| If all selected modules are of the same module type, adds custom completion rules from this module type return: array |
| add_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 param: array $data Input data (not yet validated) return: bool True if one or more rules is enabled, false if none are; |
| add_completiongrade_rules() X-Ref |
| If all selected modules are of the same module type, adds custom completion rules from this module type return: array |
| 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 |
| get_cm() X-Ref |
| Return the course module of the form, if any. return: cm_info|null |
| definition_after_data() X-Ref |
| Each module which defines definition_after_data() must call this method. |
| validation($data, $files) X-Ref |
| Form validation param: array $data array of ("fieldname"=>value) of submitted data param: array $files array of uploaded files "element_name"=>tmp_file_path return: array of "element_name"=>"error_description" if there are errors, |
| 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 |
