MDL-71144 mod_quiz: Deprecate quiz_get_completion_state()

2021-04-22 21:28:09 +10:00
parent e88a9462d1
commit 7bdff82066
3 changed files with 176 additions and 96 deletions
@@ -0,0 +1,134 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * List of deprecated mod_quiz functions.
+ *
+ * @package   mod_quiz
+ * @copyright 2021 Shamim Rezaie <[email protected]>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+/**
+ * Internal function used in quiz_get_completion_state. Check passing grade (or no attempts left) requirement for completion.
+ *
+ * @deprecated since Moodle 3.11
+ * @todo MDL-71196 Final deprecation in Moodle 4.3
+ * @see \mod_quiz\completion\custom_completion
+ * @param stdClass $course
+ * @param cm_info|stdClass $cm
+ * @param int $userid
+ * @param stdClass $quiz
+ * @return bool True if the passing grade (or no attempts left) requirement is disabled or met.
+ * @throws coding_exception
+ */
+function quiz_completion_check_passing_grade_or_all_attempts($course, $cm, $userid, $quiz) {
+    global $CFG;
+
+    debugging('quiz_completion_check_passing_grade_or_all_attempts has been deprecated.', DEBUG_DEVELOPER);
+
+    if (!$quiz->completionpass) {
+        return true;
+    }
+
+    // Check for passing grade.
+    require_once($CFG->libdir . '/gradelib.php');
+    $item = grade_item::fetch(array('courseid' => $course->id, 'itemtype' => 'mod',
+            'itemmodule' => 'quiz', 'iteminstance' => $cm->instance, 'outcomeid' => null));
+    if ($item) {
+        $grades = grade_grade::fetch_users_grades($item, array($userid), false);
+        if (!empty($grades[$userid]) && $grades[$userid]->is_passed($item)) {
+            return true;
+        }
+    }
+
+    // If a passing grade is required and exhausting all available attempts is not accepted for completion,
+    // then this quiz is not complete.
+    if (!$quiz->completionattemptsexhausted) {
+        return false;
+    }
+
+    // Check if all attempts are used up.
+    $attempts = quiz_get_user_attempts($quiz->id, $userid, 'finished', true);
+    if (!$attempts) {
+        return false;
+    }
+    $lastfinishedattempt = end($attempts);
+    $context = context_module::instance($cm->id);
+    $quizobj = quiz::create($quiz->id, $userid);
+    $accessmanager = new quiz_access_manager($quizobj, time(),
+            has_capability('mod/quiz:ignoretimelimits', $context, $userid, false));
+
+    return $accessmanager->is_finished(count($attempts), $lastfinishedattempt);
+}
+
+/**
+ * Internal function used in quiz_get_completion_state. Check minimum attempts requirement for completion.
+ *
+ * @deprecated since Moodle 3.11
+ * @todo MDL-71196 Final deprecation in Moodle 4.3
+ * @see \mod_quiz\completion\custom_completion
+ * @param int $userid
+ * @param stdClass $quiz
+ * @return bool True if minimum attempts requirement is disabled or met.
+ */
+function quiz_completion_check_min_attempts($userid, $quiz) {
+
+    debugging('quiz_completion_check_min_attempts has been deprecated.', DEBUG_DEVELOPER);
+
+    if (empty($quiz->completionminattempts)) {
+        return true;
+    }
+
+    // Check if the user has done enough attempts.
+    $attempts = quiz_get_user_attempts($quiz->id, $userid, 'finished', true);
+    return $quiz->completionminattempts <= count($attempts);
+}
+
+/**
+ * Obtains the automatic completion state for this quiz on any conditions
+ * in quiz settings, such as if all attempts are used or a certain grade is achieved.
+ *
+ * @deprecated since Moodle 3.11
+ * @todo MDL-71196 Final deprecation in Moodle 4.3
+ * @see \mod_quiz\completion\custom_completion
+ * @param stdClass $course Course
+ * @param cm_info|stdClass $cm Course-module
+ * @param int $userid User ID
+ * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
+ * @return bool True if completed, false if not. (If no conditions, then return
+ *   value depends on comparison type)
+ */
+function quiz_get_completion_state($course, $cm, $userid, $type) {
+    global $DB;
+
+    // No need to call debugging here. Deprecation debugging notice already being called in \completion_info::internal_get_state().
+
+    $quiz = $DB->get_record('quiz', array('id' => $cm->instance), '*', MUST_EXIST);
+    if (!$quiz->completionattemptsexhausted && !$quiz->completionpass && !$quiz->completionminattempts) {
+        return $type;
+    }
+
+    if (!quiz_completion_check_passing_grade_or_all_attempts($course, $cm, $userid, $quiz)) {
+        return false;
+    }
+
+    if (!quiz_completion_check_min_attempts($userid, $quiz)) {
+        return false;
+    }
+
+    return true;
+}
@@ -69,6 +69,8 @@ define('QUIZ_NAVMETHOD_SEQ',  'sequential');
 define('QUIZ_EVENT_TYPE_OPEN', 'open');
 define('QUIZ_EVENT_TYPE_CLOSE', 'close');

+require_once(__DIR__ . '/deprecatedlib.php');
+
 /**
 * Given an object containing all the necessary data,
 * (defined by the form in mod_form.php) this function
@@ -1893,102 +1895,6 @@ function quiz_get_navigation_options() {
    );
 }

-/**
- * Internal function used in quiz_get_completion_state. Check passing grade (or no attempts left) requirement for completion.
- *
- * @param object $course
- * @param object $cm
- * @param int $userid
- * @param object $quiz
- * @return bool True if the passing grade (or no attempts left) requirement is disabled or met.
- * @throws coding_exception
- */
-function quiz_completion_check_passing_grade_or_all_attempts($course, $cm, $userid, $quiz) {
-    global $CFG;
-
-    if (!$quiz->completionpass) {
-        return true;
-    }
-
-    // Check for passing grade.
-    require_once($CFG->libdir . '/gradelib.php');
-    $item = grade_item::fetch(array('courseid' => $course->id, 'itemtype' => 'mod',
-        'itemmodule' => 'quiz', 'iteminstance' => $cm->instance, 'outcomeid' => null));
-    if ($item) {
-        $grades = grade_grade::fetch_users_grades($item, array($userid), false);
-        if (!empty($grades[$userid]) && $grades[$userid]->is_passed($item)) {
-            return true;
-        }
-    }
-
-    // If a passing grade is required and exhausting all available attempts is not accepted for completion,
-    // then this quiz is not complete.
-    if (!$quiz->completionattemptsexhausted) {
-        return false;
-    }
-
-    // Check if all attempts are used up.
-    $attempts = quiz_get_user_attempts($quiz->id, $userid, 'finished', true);
-    if (!$attempts) {
-        return false;
-    }
-    $lastfinishedattempt = end($attempts);
-    $context = context_module::instance($cm->id);
-    $quizobj = quiz::create($quiz->id, $userid);
-    $accessmanager = new quiz_access_manager($quizobj, time(),
-        has_capability('mod/quiz:ignoretimelimits', $context, $userid, false));
-
-    return $accessmanager->is_finished(count($attempts), $lastfinishedattempt);
-}
-
-/**
- * Internal function used in quiz_get_completion_state. Check minimum attempts requirement for completion.
- *
- * @param int $userid
- * @param object $quiz
- * @return bool True if minimum attempts requirement is disabled or met.
- * @throws coding_exception
- */
-function quiz_completion_check_min_attempts($userid, $quiz) {
-    if (empty($quiz->completionminattempts)) {
-        return true;
-    }
-
-    // Check if the user has done enough attempts.
-    $attempts = quiz_get_user_attempts($quiz->id, $userid, 'finished', true);
-    return $quiz->completionminattempts <= count($attempts);
-}
-
-/**
- * Obtains the automatic completion state for this quiz on any conditions
- * in quiz settings, such as if all attempts are used or a certain grade is achieved.
- *
- * @param object $course Course
- * @param object $cm Course-module
- * @param int $userid User ID
- * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
- * @return bool True if completed, false if not. (If no conditions, then return
- *   value depends on comparison type)
- */
-function quiz_get_completion_state($course, $cm, $userid, $type) {
-    global $DB;
-
-    $quiz = $DB->get_record('quiz', array('id' => $cm->instance), '*', MUST_EXIST);
-    if (!$quiz->completionattemptsexhausted && !$quiz->completionpass && !$quiz->completionminattempts) {
-        return $type;
-    }
-
-    if (!quiz_completion_check_passing_grade_or_all_attempts($course, $cm, $userid, $quiz)) {
-        return false;
-    }
-
-    if (!quiz_completion_check_min_attempts($userid, $quiz)) {
-        return false;
-    }
-
-    return true;
-}
-
 /**
 * Check if the module has any update that affects the current user since a given time.
 *
@@ -253,6 +253,16 @@ class mod_quiz_lib_testcase extends advanced_testcase {

        // Check the results.
        $this->assertFalse(quiz_get_completion_state($course, $cm, $failstudent->id, 'return'));
+
+        $this->assertDebuggingCalledCount(7, [
+            'quiz_completion_check_passing_grade_or_all_attempts has been deprecated.',
+            'quiz_completion_check_passing_grade_or_all_attempts has been deprecated.',
+            'quiz_completion_check_passing_grade_or_all_attempts has been deprecated.',
+            'quiz_completion_check_min_attempts has been deprecated.',
+            'quiz_completion_check_passing_grade_or_all_attempts has been deprecated.',
+            'quiz_completion_check_passing_grade_or_all_attempts has been deprecated.',
+            'quiz_completion_check_passing_grade_or_all_attempts has been deprecated.',
+        ]);
    }

    /**
@@ -306,6 +316,18 @@ class mod_quiz_lib_testcase extends advanced_testcase {

        // Check the results. Quiz is completed by $exhauststudent because there are no remaining attempts.
        $this->assertTrue(quiz_get_completion_state($course, $cm, $exhauststudent->id, 'return'));
+
+        $this->assertDebuggingCalledCount(9, [
+            'quiz_completion_check_passing_grade_or_all_attempts has been deprecated.',
+            'quiz_completion_check_passing_grade_or_all_attempts has been deprecated.',
+            'quiz_completion_check_passing_grade_or_all_attempts has been deprecated.',
+            'quiz_completion_check_min_attempts has been deprecated.',
+            'quiz_completion_check_passing_grade_or_all_attempts has been deprecated.',
+            'quiz_completion_check_passing_grade_or_all_attempts has been deprecated.',
+            'quiz_completion_check_passing_grade_or_all_attempts has been deprecated.',
+            'quiz_completion_check_passing_grade_or_all_attempts has been deprecated.',
+            'quiz_completion_check_min_attempts has been deprecated.',
+        ]);
    }

    /**
@@ -346,6 +368,13 @@ class mod_quiz_lib_testcase extends advanced_testcase {

        // Check the results. Quiz is completed by $student because two attempts were done.
        $this->assertTrue(quiz_get_completion_state($course, $cm, $student->id, 'return'));
+
+        $this->assertDebuggingCalledCount(4, [
+            'quiz_completion_check_passing_grade_or_all_attempts has been deprecated.',
+            'quiz_completion_check_min_attempts has been deprecated.',
+            'quiz_completion_check_passing_grade_or_all_attempts has been deprecated.',
+            'quiz_completion_check_min_attempts has been deprecated.',
+        ]);
    }

    /**
@@ -392,6 +421,17 @@ class mod_quiz_lib_testcase extends advanced_testcase {

        // Check the results. Quiz is completed by $student because two attempts were done AND a passing grade was obtained.
        $this->assertTrue(quiz_get_completion_state($course, $cm, $student->id, 'return'));
+
+        $this->assertDebuggingCalledCount(8, [
+            'quiz_completion_check_passing_grade_or_all_attempts has been deprecated.',
+            'quiz_completion_check_min_attempts has been deprecated.',
+            'quiz_completion_check_passing_grade_or_all_attempts has been deprecated.',
+            'quiz_completion_check_min_attempts has been deprecated.',
+            'quiz_completion_check_passing_grade_or_all_attempts has been deprecated.',
+            'quiz_completion_check_min_attempts has been deprecated.',
+            'quiz_completion_check_passing_grade_or_all_attempts has been deprecated.',
+            'quiz_completion_check_min_attempts has been deprecated.',
+        ]);
    }

    public function test_quiz_get_user_attempts() {