Merge branch 'MDL-78528-master' of https://github.com/sarjona/moodle

mgleeson · Aug 10, 2023 · 44787c3 · 44787c3
2 parents 4ef1f2f + a2db074
commit 44787c3
Show file tree

Hide file tree

Showing 28 changed files with 906 additions and 519 deletions.
diff --git a/completion/classes/defaultedit_form.php b/completion/classes/defaultedit_form.php
@@ -27,6 +27,25 @@ class core_completion_defaultedit_form extends core_completion_edit_base_form {
     /** @var array */
     protected $_modnames;
 
+    public function __construct(
+        $action = null,
+        $customdata = null,
+        $method = 'post',
+        $target = '',
+        $attributes = null,
+        $editable = true,
+        $ajaxformdata = null
+    ) {
+        $this->modules = $customdata['modules'];
+        if ($modname = $this->get_module_name()) {
+            // Set the form suffix to the module name so that the form identifier is unique for each module type.
+            $this->set_suffix('_' . $modname);
+        }
+
+        parent::__construct($action, $customdata, $method, $target, $attributes, $editable, $ajaxformdata);
+    }
+
+
     /**
      * Returns list of types of selected modules
      *
@@ -66,7 +85,7 @@ protected function get_module_form() {
             throw new \moodle_exception('noformdesc');
         }
 
-        list($module, $context, $cw, $cmrec, $data) = prepare_new_moduleinfo_data($course, $modname, 0);
+        list($module, $context, $cw, $cmrec, $data) = prepare_new_moduleinfo_data($course, $modname, 0, $this->get_suffix());
         $data->return = 0;
         $data->sr = 0;
         $data->add = $modname;
@@ -75,6 +94,7 @@ protected function get_module_form() {
         $mformclassname = 'mod_'.$modname.'_mod_form';
         $PAGE->start_collecting_javascript_requirements();
         $this->_moduleform = new $mformclassname($data, 0, $cmrec, $course);
+        $this->_moduleform->set_suffix('_' . $modname);
         $PAGE->end_collecting_javascript_requirements();
 
         return $this->_moduleform;
@@ -101,7 +121,12 @@ public function definition() {
             $modnames = array_keys($this->get_module_names());
             $modname = $modnames[0];
             // Pre-fill the form with the current completion rules of the first selected module type.
-            list($module, $context, $cw, $cmrec, $data) = prepare_new_moduleinfo_data($this->course, $modname, 0);
+            list($module, $context, $cw, $cmrec, $data) = prepare_new_moduleinfo_data(
+                $this->course,
+                $modname,
+                0,
+                $this->get_suffix()
+            );
             $data = (array)$data;
             $modform->data_preprocessing($data);
             // Unset fields that will conflict with this form and set data to this form.
@@ -121,4 +146,12 @@ public function definition() {
     protected function get_cm(): ?\stdClass {
         return null;
     }
+
+    /**
+     * This method has been overridden because the form identifier must be unique for each module type.
+     * Otherwise, the form will display the same data for each module type once it's submitted.
+     */
+    protected function get_form_identifier() {
+        return parent::get_form_identifier() . $this->get_suffix();
+    }
 }
diff --git a/completion/classes/edit_base_form.php b/completion/classes/edit_base_form.php
@@ -111,6 +111,19 @@ protected function add_completion_rules() {
             $moduleform->_form = $this->_form;
             if ($customcompletionelements = $moduleform->add_completion_rules()) {
                 $this->hascustomrules = true;
+                foreach ($customcompletionelements as $customcompletionelement) {
+                    // Instead of checking for the suffix at the end of the element name, we need to check for its presence
+                    // because some modules, like SCORM, are adding things at the end.
+                    if (!str_contains($customcompletionelement, $this->get_suffix())) {
+                        debugging(
+                            'Custom completion rule '  . $customcompletionelement . ' of module ' . $modnames[0] .
+                            ' has wrong suffix and has been removed from the form. This has to be fixed by the developer',
+                            DEBUG_DEVELOPER
+                        );
+                        $moduleform->_form->removeElement($customcompletionelement);
+                    }
+                }
+
             }
             return $customcompletionelements;
         } catch (Exception $e) {
@@ -198,7 +211,9 @@ public function definition() {
             $mform->addElement('static', 'qwerty', '', get_string('hiddenrules', 'completion', join(', ', $conflicts)));
         }
 
-        $this->add_action_buttons();
+        // Whether to show the cancel button or not in the form.
+        $displaycancel = $this->_customdata['displaycancel'] ?? true;
+        $this->add_action_buttons($displaycancel);
     }
 
     /**