mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-03-14 12:40:01 +01:00
Code Issues Projects Releases Wiki Activity

MDL-71144 mod_survey: Deprecate survey_get_completion_state()

Browse Source
This commit is contained in:
Shamim Rezaie 2021-03-31 00:33:22 +11:00
parent 5f9aa4d35f
commit b4c8f0f8a6
2 changed files with 55 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
mod/survey/deprecatedlib.php Normal file
View File

@ -0,0 +1,54 @@
<?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_survey functions.
*
* @package mod_survey
* @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 survey based on the condition
* in feedback settings.
*
* @deprecated since Moodle 3.11
* @todo MDL-71196 Final deprecation in Moodle 4.3
* @see \mod_survey\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, $type if conditions not set.
*/
function survey_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 survey details.
$survey = $DB->get_record('survey', array('id' => $cm->instance), '*', MUST_EXIST);
// If completion option is enabled, evaluate it and return true/false.
if ($survey->completionsubmit) {
$params = array('userid' => $userid, 'survey' => $survey->id);
return $DB->record_exists('survey_answers', $params);
} else {
// Completion option is not enabled so just return $type.
return $type;
}
}

27
mod/survey/lib.php
View File

@ -55,6 +55,7 @@ define("SURVEY_COLLES_PREFERRED_ACTUAL", "3");
define("SURVEY_ATTLS", "4");
define("SURVEY_CIQ", "5");
require_once(__DIR__ . '/deprecatedlib.php');
// STANDARD FUNCTIONS ////////////////////////////////////////////////////////
/**
@ -1029,32 +1030,6 @@ function survey_save_answers($survey, $answersrawdata, $course, $context) {
$event->trigger();
}
/**
* Obtains the automatic completion state for this survey based on the condition
* in feedback settings.
*
* @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, $type if conditions not set.
*/
function survey_get_completion_state($course, $cm, $userid, $type) {
global $DB;
// Get survey details.
$survey = $DB->get_record('survey', array('id' => $cm->instance), '*', MUST_EXIST);
// If completion option is enabled, evaluate it and return true/false.
if ($survey->completionsubmit) {
$params = array('userid' => $userid, 'survey' => $survey->id);
return $DB->record_exists('survey_answers', $params);
} else {
// Completion option is not enabled so just return $type.
return $type;
}
}
/**
* Check if the module has any update that affects the current user since a given time.
*