MDL-71189 core_completion: Adding completion sort order to activities

This implements sort ordering for all completion conditions, in
activities which support custom completion conditions.

mod/assign/classes/completion/custom_completion.php

@@ -78,5 +78,17 @@ class custom_completion extends activity_custom_completion {
             'completionsubmit' => get_string('completiondetail:submit', 'assign')
         ];
     }
-}
 
+    /**
+     * Returns an array of all completion rules, in the order they should be displayed to users.
+     *
+     * @return array
+     */
+    public function get_sort_order(): array {
+        return [
+            'completionview',
+            'completionsubmit',
+            'completionusegrade',
+        ];
+    }
+}

mod/choice/classes/completion/custom_completion.php

@@ -69,4 +69,16 @@ class custom_completion extends activity_custom_completion {
             'completionsubmit' => get_string('completiondetail:submit', 'choice')
         ];
     }
+
+    /**
+     * Returns an array of all completion rules, in the order they should be displayed to users.
+     *
+     * @return array
+     */
+    public function get_sort_order(): array {
+        return [
+            'completionview',
+            'completionsubmit',
+        ];
+    }
 }

mod/data/classes/completion/custom_completion.php

@@ -69,4 +69,17 @@ class custom_completion extends activity_custom_completion {
             'completionentries' => get_string('completiondetail:entries', 'data', $entries),
         ];
     }
+
+    /**
+     * Returns an array of all completion rules, in the order they should be displayed to users.
+     *
+     * @return array
+     */
+    public function get_sort_order(): array {
+        return [
+            'completionview',
+            'completionentries',
+            'completionusegrade',
+        ];
+    }
 }

mod/feedback/classes/completion/custom_completion.php

@@ -67,4 +67,16 @@ class custom_completion extends activity_custom_completion {
             'completionsubmit' => get_string('completiondetail:submit', 'feedback')
         ];
     }
+
+    /**
+     * Returns an array of all completion rules, in the order they should be displayed to users.
+     *
+     * @return array
+     */
+    public function get_sort_order(): array {
+        return [
+            'completionview',
+            'completionsubmit',
+        ];
+    }
 }

mod/forum/classes/completion/custom_completion.php

@@ -99,4 +99,19 @@ class custom_completion extends activity_custom_completion {
             'completionposts' => get_string('completiondetail:posts', 'forum', $completionposts),
         ];
     }
+
+    /**
+     * Returns an array of all completion rules, in the order they should be displayed to users.
+     *
+     * @return array
+     */
+    public function get_sort_order(): array {
+        return [
+            'completionview',
+            'completiondiscussions',
+            'completionreplies',
+            'completionposts',
+            'completionusegrade',
+        ];
+    }
 }

mod/glossary/classes/completion/custom_completion.php

@@ -73,4 +73,17 @@ class custom_completion extends activity_custom_completion {
             'completionentries' => get_string('completiondetail:entries', 'glossary', $completionentries),
         ];
     }
+
+    /**
+     * Returns an array of all completion rules, in the order they should be displayed to users.
+     *
+     * @return array
+     */
+    public function get_sort_order(): array {
+        return [
+            'completionview',
+            'completionentries',
+            'completionusegrade',
+        ];
+    }
 }

mod/label/classes/completion/custom_completion.php

@@ -70,4 +70,14 @@ class custom_completion extends activity_custom_completion {
     public function manual_completion_always_shown(): bool {
         return true;
     }
+
+    /**
+     * Returns an array of all completion rules, in the order they should be displayed to users.
+     *
+     * @return array
+     */
+    public function get_sort_order(): array {
+        // This module only supports manual completion.
+        return [];
+    }
 }

mod/lesson/classes/completion/custom_completion.php

@@ -91,4 +91,18 @@ class custom_completion extends activity_custom_completion {
             'completionendreached' => get_string('completiondetail:reachend', 'lesson'),
         ];
     }
+
+    /**
+     * Returns an array of all completion rules, in the order they should be displayed to users.
+     *
+     * @return array
+     */
+    public function get_sort_order(): array {
+        return [
+            'completionview',
+            'completiontimespent',
+            'completionendreached',
+            'completionusegrade',
+        ];
+    }
 }

mod/quiz/classes/completion/custom_completion.php

@@ -159,4 +159,18 @@ class custom_completion extends activity_custom_completion {
             'completionminattempts' => get_string('completiondetail:minattempts', 'mod_quiz', $minattempts),
         ];
     }
+
+    /**
+     * Returns an array of all completion rules, in the order they should be displayed to users.
+     *
+     * @return array
+     */
+    public function get_sort_order(): array {
+        return [
+            'completionview',
+            'completionminattempts',
+            'completionusegrade',
+            'completionpassorattemptsexhausted',
+        ];
+    }
 }

mod/resource/classes/completion/custom_completion.php

@@ -79,4 +79,14 @@ class custom_completion extends activity_custom_completion {
 
         return in_array($display, $displaytypes);
     }
+
+    /**
+     * Returns an array of all completion rules, in the order they should be displayed to users.
+     *
+     * @return array
+     */
+    public function get_sort_order(): array {
+        // This module only supports manual completion.
+        return [];
+    }
 }

mod/scorm/classes/completion/custom_completion.php

@@ -202,4 +202,20 @@ class custom_completion extends activity_custom_completion {
             'completionstatusallscos' => get_string('completiondetail:allscos', 'scorm'),
         ];
     }
+
+    /**
+     * Returns an array of all completion rules, in the order they should be displayed to users.
+     *
+     * @return array
+     */
+    public function get_sort_order(): array {
+        return [
+            'completionview',
+            'completionstatusallscos',
+            'completionstatusrequired',
+            'completionusegrade',
+            'completionscorerequired',
+        ];
+    }
 }
+

mod/survey/classes/completion/custom_completion.php

@@ -67,4 +67,16 @@ class custom_completion extends activity_custom_completion {
             'completionsubmit' => get_string('completiondetail:submit', 'survey')
         ];
     }
+
+    /**
+     * Returns an array of all completion rules, in the order they should be displayed to users.
+     *
+     * @return array
+     */
+    public function get_sort_order(): array {
+        return [
+            'completionview',
+            'completionsubmit',
+        ];
+    }
 }

mod/url/classes/completion/custom_completion.php

@@ -82,4 +82,13 @@ class custom_completion extends activity_custom_completion {
         return in_array($display, $displaytypes);
     }
 
+    /**
+     * Returns an array of all completion rules, in the order they should be displayed to users.
+     *
+     * @return array
+     */
+    public function get_sort_order(): array {
+        // This module only supports manual completion.
+        return [];
+    }
 }