moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-05 08:56:36 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-71144 mod_data: Deprecate data_get_completion_state()

Browse source
This commit is contained in:
Jun Pataleta 2021-03-30 09:53:19 +08:00 • committed by Shamim Rezaie
parent 9dfc27cc33
commit 8e79ddef3b
2 changed files with 67 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

63
mod/data/deprecatedlib.php Normal file
View file

@ -0,0 +1,63 @@
<?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_data functions.
*
* @package mod_data
* @copyright 2021 Jun Pataleta
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
/**
* Obtains the automatic completion state for this database item based on any conditions
* on its settings. The call for this is in completion lib where the modulename is appended
* to the function name. This is why there are unused parameters.
*
* @deprecated since Moodle 3.11
* @todo MDL-71196 Final deprecation in Moodle 4.3
* @see \mod_data\completion\custom_completion
* @since Moodle 3.3
* @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, $type if conditions not set.
*/
function data_get_completion_state($course, $cm, $userid, $type) {
global $DB, $PAGE;
// No need to call debugging here. Deprecation debugging notice already being called in \completion_info::internal_get_state().
$result = $type; // Default return value
// Get data details.
if (isset($PAGE->cm->id) && $PAGE->cm->id == $cm->id) {
$data = $PAGE->activityrecord;
} else {
$data = $DB->get_record('data', array('id' => $cm->instance), '*', MUST_EXIST);
}
// If completion option is enabled, evaluate it and return true/false.
if ($data->completionentries) {
$numentries = data_numentries($data, $userid);
// Check the number of entries required against the number of entries already made.
if ($numentries >= $data->completionentries) {
$result = true;
} else {
$result = false;
}
}
return $result;
}

41
mod/data/lib.php
View file

@ -35,6 +35,9 @@ define ('DATA_TIMEMODIFIED', -4);
define ('DATA_TAGS', -5); define ('DATA_TAGS', -5);
define ('DATA_CAP_EXPORT', 'mod/data:viewalluserpresets'); define ('DATA_CAP_EXPORT', 'mod/data:viewalluserpresets');
// Users having assigned the default role "Non-editing teacher" can export database records
// Using the mod/data capability "viewalluserpresets" existing in Moodle 1.9.x.
// In Moodle >= 2, new roles may be introduced and used instead.
define('DATA_PRESET_COMPONENT', 'mod_data'); define('DATA_PRESET_COMPONENT', 'mod_data');
define('DATA_PRESET_FILEAREA', 'site_presets'); define('DATA_PRESET_FILEAREA', 'site_presets');
@ -43,9 +46,7 @@ define('DATA_PRESET_CONTEXT', SYSCONTEXTID);
define('DATA_EVENT_TYPE_OPEN', 'open'); define('DATA_EVENT_TYPE_OPEN', 'open');
define('DATA_EVENT_TYPE_CLOSE', 'close'); define('DATA_EVENT_TYPE_CLOSE', 'close');
// Users having assigned the default role "Non-editing teacher" can export database records require_once(__DIR__ . '/deprecatedlib.php');
// Using the mod/data capability "viewalluserpresets" existing in Moodle 1.9.x.
// In Moodle >= 2, new roles may be introduced and used instead.
/** /**
* @package mod_data * @package mod_data
@ -4469,40 +4470,6 @@ function data_update_completion_state($data, $course, $cm) {
} }
} }
/**
* Obtains the automatic completion state for this database item based on any conditions
* on its settings. The call for this is in completion lib where the modulename is appended
* to the function name. This is why there are unused parameters.
*
* @since Moodle 3.3
* @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, $type if conditions not set.
*/
function data_get_completion_state($course, $cm, $userid, $type) {
global $DB, $PAGE;
$result = $type; // Default return value
// Get data details.
if (isset($PAGE->cm->id) && $PAGE->cm->id == $cm->id) {
$data = $PAGE->activityrecord;
} else {
$data = $DB->get_record('data', array('id' => $cm->instance), '*', MUST_EXIST);
}
// If completion option is enabled, evaluate it and return true/false.
if ($data->completionentries) {
$numentries = data_numentries($data, $userid);
// Check the number of entries required against the number of entries already made.
if ($numentries >= $data->completionentries) {
$result = true;
} else {
$result = false;
}
}
return $result;
}
/** /**
* Mark the activity completed (if required) and trigger the course_module_viewed event. * Mark the activity completed (if required) and trigger the course_module_viewed event.
* *