[Summary view]

Differences Between: [Versions 311 and 403]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * List of deprecated mod_data functions.
  19   *
  20   * @package   mod_data
  21   * @copyright 2021 Jun Pataleta
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  /**
  26   * Obtains the automatic completion state for this database item based on any conditions
  27   * on its settings. The call for this is in completion lib where the modulename is appended
  28   * to the function name. This is why there are unused parameters.
  29   *
  30   * @deprecated since Moodle 3.11
  31   * @todo MDL-71196 Final deprecation in Moodle 4.3
  32   * @see \mod_data\completion\custom_completion
  33   * @since Moodle 3.3
  34   * @param stdClass $course Course
  35   * @param cm_info|stdClass $cm course-module
  36   * @param int $userid User ID
  37   * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
  38   * @return bool True if completed, false if not, $type if conditions not set.
  39   */
  40  function data_get_completion_state($course, $cm, $userid, $type) {
  41      global $DB, $PAGE;
  42  
  43      // No need to call debugging here. Deprecation debugging notice already being called in \completion_info::internal_get_state().
  44  
  45      $result = $type; // Default return value
  46      // Get data details.
  47      if (isset($PAGE->cm->id) && $PAGE->cm->id == $cm->id) {
  48          $data = $PAGE->activityrecord;
  49      } else {
  50          $data = $DB->get_record('data', array('id' => $cm->instance), '*', MUST_EXIST);
  51      }
  52      // If completion option is enabled, evaluate it and return true/false.
  53      if ($data->completionentries) {
  54          $numentries = data_numentries($data, $userid);
  55          // Check the number of entries required against the number of entries already made.
  56          if ($numentries >= $data->completionentries) {
  57              $result = true;
  58          } else {
  59              $result = false;
  60          }
  61      }
  62      return $result;
  63  }