mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-21 00:12:56 +02:00
Code Issues Projects Releases Wiki Activity

MDL-71144 mod_glossary: Deprecate glossary_get_completion_state()

Browse Source
This commit is contained in:
Shamim Rezaie 2021-03-31 00:02:46 +11:00
parent c9fa4f9cd7
commit 5f9aa4d35f
2 changed files with 63 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
mod/glossary/deprecatedlib.php Normal file
View File

@ -0,0 +1,61 @@
<?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_glossary functions.
*
* @package mod_glossary
* @copyright 2021 Shamim Rezaie <shamim@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
/**
* Obtains the automatic completion state for this glossary based on any conditions
* in glossary settings.
*
* @deprecated since Moodle 3.11
* @todo MDL-71196 Final deprecation in Moodle 4.3
* @see \mod_glossary\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 glossary_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().
// Get glossary details.
if (!($glossary = $DB->get_record('glossary', array('id' => $cm->instance)))) {
throw new Exception("Can't find glossary {$cm->instance}");
}
$result = $type; // Default return value.
if ($glossary->completionentries) {
$value = $glossary->completionentries <=
$DB->count_records('glossary_entries', array('glossaryid' => $glossary->id, 'userid' => $userid, 'approved' => 1));
if ($type == COMPLETION_AND) {
$result = $result && $value;
} else {
$result = $result || $value;
}
}
return $result;
}

38
mod/glossary/lib.php
View File

@ -49,6 +49,8 @@ define('GLOSSARY_CONTINUOUS', 'continuous');
define('GLOSSARY_DICTIONARY', 'dictionary');
define('GLOSSARY_FULLWITHOUTAUTHOR', 'fullwithoutauthor');
require_once(__DIR__ . '/deprecatedlib.php');
/// STANDARD FUNCTIONS ///////////////////////////////////////////////////////////
/**
* @global object
@ -3095,42 +3097,6 @@ function glossary_supports($feature) {
}
}
/**
* Obtains the automatic completion state for this glossary based on any conditions
* in glossary settings.
*
* @global object
* @global object
* @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 glossary_get_completion_state($course,$cm,$userid,$type) {
global $CFG, $DB;
// Get glossary details
if (!($glossary=$DB->get_record('glossary',array('id'=>$cm->instance)))) {
throw new Exception("Can't find glossary {$cm->instance}");
}
$result=$type; // Default return value
if ($glossary->completionentries) {
$value = $glossary->completionentries <=
$DB->count_records('glossary_entries',array('glossaryid'=>$glossary->id, 'userid'=>$userid, 'approved'=>1));
if ($type == COMPLETION_AND) {
$result = $result && $value;
} else {
$result = $result || $value;
}
}
return $result;
}
function glossary_extend_navigation($navigation, $course, $module, $cm) {
global $CFG, $DB;