mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-01-17 21:49:15 +01:00
Code Issues Projects Releases Wiki Activity

MDL-82457 mod_survey: Remove mod survey from Moodle 5.0

Browse Source
This commit is contained in:
Laurent David 2024-10-31 10:43:25 +01:00
parent 0888a6d324
commit 9d94ea58b6
60 changed files with 15 additions and 8773 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.upgradenotes/MDL-82457-2024103109431645.yml Normal file
View File

@ -0,0 +1,5 @@
issueNumber: MDL-82457
notes:
mod:
- message: Remove mod_survey for Moodle 5.0
type: removed

9
lib/db/upgrade.php
View File

@ -1303,5 +1303,14 @@ function xmldb_main_upgrade($oldversion) {
upgrade_main_savepoint(true, 2024112900.02);
}
// Moodle 5.0 Upgrade.
// Remove survey.
if ($oldversion < 2024120500.01) {
if (!file_exists($CFG->dirroot . "/mod/survey/version.php")) {
uninstall_plugin('mod', 'survey');
}
// Main savepoint reached.
upgrade_main_savepoint(true, 2024120500.01);
}
return true;
}

11
mod/survey/amd/build/validation.min.js vendored
View File

@ -1,11 +0,0 @@
define("mod_survey/validation",["exports","core/str","core/notification"],(function(_exports,_str,_notification){var obj;
/**
* Javascript to handle survey validation.
*
* @module mod_survey/validation
* @copyright 2017 Dan Poltawski <dan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since 3.3
*/Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.ensureRadiosChosen=void 0,_notification=(obj=_notification)&&obj.__esModule?obj:{default:obj};_exports.ensureRadiosChosen=formid=>{const form=document.getElementById(formid);form.addEventListener("submit",(e=>{0!==form.querySelectorAll('input[type="radio"][data-survey-default="true"]:checked').length&&(_notification.default.alert((0,_str.get_string)("error"),(0,_str.get_string)("questionsnotanswered","survey"),(0,_str.get_string)("ok")),e.preventDefault())}))}}));
//# sourceMappingURL=validation.min.js.map

1
mod/survey/amd/build/validation.min.js.map
View File

@ -1 +0,0 @@
{"version":3,"file":"validation.min.js","sources":["../src/validation.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Javascript to handle survey validation.\n *\n * @module mod_survey/validation\n * @copyright 2017 Dan Poltawski <dan@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n * @since 3.3\n */\nimport {get_string as getString} from 'core/str';\nimport Notification from 'core/notification';\n\n/**\n * Prevents form submission until all radio buttons are chosen, displays\n * modal error if any choices are missing.\n *\n * @param {String} formid HTML id of form\n */\nexport const ensureRadiosChosen = (formid) => {\n const form = document.getElementById(formid);\n form.addEventListener('submit', (e) => {\n const optionsToSet = form.querySelectorAll('input[type=\"radio\"][data-survey-default=\"true\"]:checked');\n if (optionsToSet.length !== 0) {\n Notification.alert(\n getString('error'),\n getString('questionsnotanswered', 'survey'),\n getString('ok'),\n );\n e.preventDefault();\n }\n });\n};\n"],"names":["formid","form","document","getElementById","addEventListener","e","querySelectorAll","length","alert","preventDefault"],"mappings":";;;;;;;;gMAgCmCA,eACzBC,KAAOC,SAASC,eAAeH,QACrCC,KAAKG,iBAAiB,UAAWC,IAED,IADPJ,KAAKK,iBAAiB,2DAC1BC,+BACAC,OACT,mBAAU,UACV,mBAAU,uBAAwB,WAClC,mBAAU,OAEdH,EAAEI"}

46
mod/survey/amd/src/validation.js
View File

@ -1,46 +0,0 @@
// 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/>.
/**
* Javascript to handle survey validation.
*
* @module mod_survey/validation
* @copyright 2017 Dan Poltawski <dan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since 3.3
*/
import {get_string as getString} from 'core/str';
import Notification from 'core/notification';
/**
* Prevents form submission until all radio buttons are chosen, displays
* modal error if any choices are missing.
*
* @param {String} formid HTML id of form
*/
export const ensureRadiosChosen = (formid) => {
const form = document.getElementById(formid);
form.addEventListener('submit', (e) => {
const optionsToSet = form.querySelectorAll('input[type="radio"][data-survey-default="true"]:checked');
if (optionsToSet.length !== 0) {
Notification.alert(
getString('error'),
getString('questionsnotanswered', 'survey'),
getString('ok'),
);
e.preventDefault();
}
});
};

127
mod/survey/backup/moodle1/lib.php
View File

@ -1,127 +0,0 @@
<?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/>.
/**
* Provides support for the conversion of moodle1 backup to the moodle2 format
*
* @package mod_survey
* @copyright 2011 Rossiani Wijaya <rwijaya@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
/**
* Survey conversion handler
*/
class moodle1_mod_survey_handler extends moodle1_mod_handler {
/** @var moodle1_file_manager */
protected $fileman = null;
/** @var int cmid */
protected $moduleid = null;
/**
* Declare the paths in moodle.xml we are able to convert
*
* The method returns list of {@link convert_path} instances.
* For each path returned, the corresponding conversion method must be
* defined.
*
* Note that the path /MOODLE_BACKUP/COURSE/MODULES/MOD/SURVEY does not
* actually exist in the file. The last element with the module name was
* appended by the moodle1_converter class.
*
* @return array of {@link convert_path} instances
*/
public function get_paths() {
return array(
new convert_path(
'survey', '/MOODLE_BACKUP/COURSE/MODULES/MOD/SURVEY',
array(
'newfields' => array(
'introformat' => 0,
),
)
),
);
}
/**
* This is executed every time we have one /MOODLE_BACKUP/COURSE/MODULES/MOD/SURVEY
* data available
*/
public function process_survey($data) {
global $CFG;
// get the course module id and context id
$instanceid = $data['id'];
$cminfo = $this->get_cminfo($instanceid);
$this->moduleid = $cminfo['id'];
$contextid = $this->converter->get_contextid(CONTEXT_MODULE, $this->moduleid);
// replay upgrade step 2009042002
if ($CFG->texteditors !== 'textarea') {
$data['intro'] = text_to_html($data['intro'], false, false, true);
$data['introformat'] = FORMAT_HTML;
}
// get a fresh new file manager for this instance
$this->fileman = $this->converter->get_file_manager($contextid, 'mod_survey');
// convert course files embedded into the intro
$this->fileman->filearea = 'intro';
$this->fileman->itemid = 0;
$data['intro'] = moodle1_converter::migrate_referenced_files($data['intro'], $this->fileman);
// write survey.xml
$this->open_xml_writer("activities/survey_{$this->moduleid}/survey.xml");
$this->xmlwriter->begin_tag('activity', array('id' => $instanceid, 'moduleid' => $this->moduleid,
'modulename' => 'survey', 'contextid' => $contextid));
$this->xmlwriter->begin_tag('survey', array('id' => $instanceid));
foreach ($data as $field => $value) {
if ($field <> 'id') {
$this->xmlwriter->full_tag($field, $value);
}
}
return $data;
}
/**
* This is executed when we reach the closing </MOD> tag of our 'survey' path
*/
public function on_survey_end() {
// finish survey.xml
$this->xmlwriter->end_tag('survey');
$this->xmlwriter->end_tag('activity');
$this->close_xml_writer();
// write inforef.xml
$this->open_xml_writer("activities/survey_{$this->moduleid}/inforef.xml");
$this->xmlwriter->begin_tag('inforef');
$this->xmlwriter->begin_tag('fileref');
foreach ($this->fileman->get_fileids() as $fileid) {
$this->write_xml('file', array('id' => $fileid));
}
$this->xmlwriter->end_tag('fileref');
$this->xmlwriter->end_tag('inforef');
$this->close_xml_writer();
}
}

70
mod/survey/backup/moodle2/backup_survey_activity_task.class.php
View File

@ -1,70 +0,0 @@
<?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/>.
/**
* Defines backup_survey_activity_task class
*
* @package mod_survey
* @category backup
* @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
require_once($CFG->dirroot . '/mod/survey/backup/moodle2/backup_survey_stepslib.php');
/**
* Provides all the settings and steps to perform one complete backup of the activity
*/
class backup_survey_activity_task extends backup_activity_task {
/**
* No specific settings for this activity
*/
protected function define_my_settings() {
}
/**
* Defines a backup step to store the instance data in the survey.xml file
*/
protected function define_my_steps() {
$this->add_step(new backup_survey_activity_structure_step('survey_structure', 'survey.xml'));
}
/**
* Encodes URLs to the index.php and view.php scripts
*
* @param string $content some HTML text that eventually contains URLs to the activity instance scripts
* @return string the content with the URLs encoded
*/
public static function encode_content_links($content) {
global $CFG;
$base = preg_quote($CFG->wwwroot,"/");
// Link to the list of surveys
$search="/(".$base."\/mod\/survey\/index.php\?id\=)([0-9]+)/";
$content= preg_replace($search, '$@SURVEYINDEX*$2@$', $content);
// Link to survey view by moduleid
$search="/(".$base."\/mod\/survey\/view.php\?id\=)([0-9]+)/";
$content= preg_replace($search, '$@SURVEYVIEWBYID*$2@$', $content);
return $content;
}
}

79
mod/survey/backup/moodle2/backup_survey_stepslib.php
View File

@ -1,79 +0,0 @@
<?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/>.
/**
* @package mod_survey
* @subpackage backup-moodle2
* @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
/**
* Define all the backup steps that will be used by the backup_survey_activity_task
*/
/**
* Define the complete survey structure for backup, with file and id annotations
*/
class backup_survey_activity_structure_step extends backup_activity_structure_step {
protected function define_structure() {
// To know if we are including userinfo
$userinfo = $this->get_setting_value('userinfo');
// Define each element separated
$survey = new backup_nested_element('survey', array('id'), array(
'name', 'intro', 'introformat', 'template',
'questions', 'days', 'timecreated', 'timemodified', 'completionsubmit'));
$answers = new backup_nested_element('answers');
$answer = new backup_nested_element('answer', array('id'), array(
'userid', 'question', 'time', 'answer1',
'answer2'));
$analysis = new backup_nested_element('analysis');
$analys = new backup_nested_element('analys', array('id'), array(
'userid', 'notes'));
// Build the tree
$survey->add_child($answers);
$answers->add_child($answer);
$survey->add_child($analysis);
$analysis->add_child($analys);
// Define sources
$survey->set_source_table('survey', array('id' => backup::VAR_ACTIVITYID));
$answer->set_source_table('survey_answers', array('survey' => backup::VAR_PARENTID));
$analys->set_source_table('survey_analysis', array('survey' => backup::VAR_PARENTID));
// Define id annotations
$answer->annotate_ids('user', 'userid');
$analys->annotate_ids('user', 'userid');
// Define file annotations
$survey->annotate_files('mod_survey', 'intro', null); // This file area hasn't itemid
// Return the root element (survey), wrapped into standard activity structure
return $this->prepare_activity_structure($survey);
}
}

114
mod/survey/backup/moodle2/restore_survey_activity_task.class.php
View File

@ -1,114 +0,0 @@
<?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/>.
/**
* @package mod_survey
* @subpackage backup-moodle2
* @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
require_once($CFG->dirroot . '/mod/survey/backup/moodle2/restore_survey_stepslib.php'); // Because it exists (must)
/**
* survey restore task that provides all the settings and steps to perform one
* complete restore of the activity
*/
class restore_survey_activity_task extends restore_activity_task {
/**
* Define (add) particular settings this activity can have
*/
protected function define_my_settings() {
// No particular settings for this activity
}
/**
* Define (add) particular steps this activity can have
*/
protected function define_my_steps() {
// survey only has one structure step
$this->add_step(new restore_survey_activity_structure_step('survey_structure', 'survey.xml'));
}
/**
* Define the contents in the activity that must be
* processed by the link decoder
*/
public static function define_decode_contents() {
$contents = array();
$contents[] = new restore_decode_content('survey', array('intro'), 'survey');
return $contents;
}
/**
* Define the decoding rules for links belonging
* to the activity to be executed by the link decoder
*/
public static function define_decode_rules() {
$rules = array();
$rules[] = new restore_decode_rule('SURVEYVIEWBYID', '/mod/survey/view.php?id=$1', 'course_module');
$rules[] = new restore_decode_rule('SURVEYINDEX', '/mod/survey/index.php?id=$1', 'course');
return $rules;
}
/**
* Define the restore log rules that will be applied
* by the {@link restore_logs_processor} when restoring
* survey logs. It must return one array
* of {@link restore_log_rule} objects
*/
public static function define_restore_log_rules() {
$rules = array();
$rules[] = new restore_log_rule('survey', 'add', 'view.php?id={course_module}', '{survey}');
$rules[] = new restore_log_rule('survey', 'update', 'view.php?id={course_module}', '{survey}');
$rules[] = new restore_log_rule('survey', 'view', 'view.php?id={course_module}', '{survey}');
$rules[] = new restore_log_rule('survey', 'download', 'download.php?id={course_module}&type=[type]&group=[group]', '{survey}');
$rules[] = new restore_log_rule('survey', 'view report', 'report.php?id={course_module}', '{survey}');
$rules[] = new restore_log_rule('survey', 'submit', 'view.php?id={course_module}', '{survey}');
$rules[] = new restore_log_rule('survey', 'view graph', 'view.php?id={course_module}', '{survey}');
$rules[] = new restore_log_rule('survey', 'view form', 'view.php?id={course_module}', '{survey}');
return $rules;
}
/**
* Define the restore log rules that will be applied
* by the {@link restore_logs_processor} when restoring
* course logs. It must return one array
* of {@link restore_log_rule} objects
*
* Note this rules are applied when restoring course logs
* by the restore final task, but are defined here at
* activity level. All them are rules not linked to any module instance (cmid = 0)
*/
public static function define_restore_log_rules_for_course() {
$rules = array();
$rules[] = new restore_log_rule('survey', 'view all', 'index.php?id={course}', null);
return $rules;
}
}

95
mod/survey/backup/moodle2/restore_survey_stepslib.php
View File

@ -1,95 +0,0 @@
<?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/>.
/**
* @package mod_survey
* @subpackage backup-moodle2
* @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
/**
* Define all the restore steps that will be used by the restore_survey_activity_task
*/
/**
* Structure step to restore one survey activity
*/
class restore_survey_activity_structure_step extends restore_activity_structure_step {
protected function define_structure() {
$paths = array();
$userinfo = $this->get_setting_value('userinfo');
$paths[] = new restore_path_element('survey', '/activity/survey');
if ($userinfo) {
$paths[] = new restore_path_element('survey_answer', '/activity/survey/answers/answer');
$paths[] = new restore_path_element('survey_analys', '/activity/survey/analysis/analys');
}
// Return the paths wrapped into standard activity structure
return $this->prepare_activity_structure($paths);
}
protected function process_survey($data) {
global $DB;
$data = (object)$data;
$oldid = $data->id;
$data->course = $this->get_courseid();
// Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
// See MDL-9367.
// insert the survey record
$newitemid = $DB->insert_record('survey', $data);
// immediately after inserting "activity" record, call this
$this->apply_activity_instance($newitemid);
}
protected function process_survey_analys($data) {
global $DB;
$data = (object)$data;
$oldid = $data->id;
$data->survey = $this->get_new_parentid('survey');
$data->userid = $this->get_mappingid('user', $data->userid);
$newitemid = $DB->insert_record('survey_analysis', $data);
// No need to save this mapping as far as nothing depend on it
// (child paths, file areas nor links decoder)
}
protected function process_survey_answer($data) {
global $DB;
$data = (object)$data;
$oldid = $data->id;
$data->survey = $this->get_new_parentid('survey');
$data->userid = $this->get_mappingid('user', $data->userid);
$newitemid = $DB->insert_record('survey_answers', $data);
// No need to save this mapping as far as nothing depend on it
// (child paths, file areas nor links decoder)
}
protected function after_execute() {
// Add survey related files, no need to match by itemname (just internally handled context)
$this->add_related_files('mod_survey', 'intro', null);
}
}

46
mod/survey/classes/analytics/indicator/activity_base.php
View File

@ -1,46 +0,0 @@
<?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/>.
/**
* Activity base class.
*
* @package mod_survey
* @copyright 2017 onwards Ankit Agarwal <ankit.agrr@gmail.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace mod_survey\analytics\indicator;
defined('MOODLE_INTERNAL') || die();
/**
* Activity base class.
*
* @package mod_survey
* @copyright 2017 onwards Ankit Agarwal <ankit.agrr@gmail.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
abstract class activity_base extends \core_analytics\local\indicator\community_of_inquiry_activity {
/**
* No need to fetch grades.
*
* @param \core_analytics\course $course
* @return void
*/
public function fetch_student_grades(\core_analytics\course $course) {
}
}

56
mod/survey/classes/analytics/indicator/cognitive_depth.php
View File

@ -1,56 +0,0 @@
<?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/>.
/**
* Cognitive depth indicator - survey.
*
* @package mod_survey
* @copyright 2017 David Monllao {@link http://www.davidmonllao.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace mod_survey\analytics\indicator;
defined('MOODLE_INTERNAL') || die();
/**
* Cognitive depth indicator - survey.
*
* @package mod_survey
* @copyright 2017 David Monllao {@link http://www.davidmonllao.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class cognitive_depth extends activity_base {
/**
* Returns the name.
*
* If there is a corresponding '_help' string this will be shown as well.
*
* @return \lang_string
*/
public static function get_name(): \lang_string {
return new \lang_string('indicator:cognitivedepth', 'mod_survey');
}
public function get_indicator_type() {
return self::INDICATOR_COGNITIVE;
}
public function get_cognitive_depth_level(\cm_info $cm) {
return self::COGNITIVE_LEVEL_2;
}
}

56
mod/survey/classes/analytics/indicator/social_breadth.php
View File

@ -1,56 +0,0 @@
<?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/>.
/**
* Social breadth indicator - survey.
*
* @package mod_survey
* @copyright 2017 David Monllao {@link http://www.davidmonllao.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace mod_survey\analytics\indicator;
defined('MOODLE_INTERNAL') || die();
/**
* Social breadth indicator - survey.
*
* @package mod_survey
* @copyright 2017 David Monllao {@link http://www.davidmonllao.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class social_breadth extends activity_base {
/**
* Returns the name.
*
* If there is a corresponding '_help' string this will be shown as well.
*
* @return \lang_string
*/
public static function get_name(): \lang_string {
return new \lang_string('indicator:socialbreadth', 'mod_survey');
}
public function get_indicator_type() {
return self::INDICATOR_SOCIAL;
}
public function get_social_breadth_level(\cm_info $cm) {
return self::SOCIAL_LEVEL_1;
}
}

82
mod/survey/classes/completion/custom_completion.php
View File

@ -1,82 +0,0 @@
<?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/>.
declare(strict_types=1);
namespace mod_survey\completion;
use core_completion\activity_custom_completion;
/**
* Activity custom completion subclass for the survey activity.
*
* Class for defining mod_survey's custom completion rules and fetching the completion statuses
* of the custom completion rules for a given survey instance and a user.
*
* @package mod_survey
* @copyright Simey Lameze <simey@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class custom_completion extends activity_custom_completion {
/**
* Fetches the completion state for a given completion rule.
*
* @param string $rule The completion rule.
* @return int The completion state.
*/
public function get_state(string $rule): int {
global $DB;
$this->validate_rule($rule);
// Survey only supports completionsubmit as a custom rule.
$status = $DB->record_exists('survey_answers', ['survey' => $this->cm->instance, 'userid' => $this->userid]);
return $status ? COMPLETION_COMPLETE : COMPLETION_INCOMPLETE;
}
/**
* Fetch the list of custom completion rules that this module defines.
*
* @return array
*/
public static function get_defined_custom_rules(): array {
return ['completionsubmit'];
}
/**
* Returns an associative array of the descriptions of custom completion rules.
*
* @return array
*/
public function get_custom_rule_descriptions(): array {
return [
'completionsubmit' => get_string('completiondetail:submit', 'survey')
];
}
/**
* Returns an array of all completion rules, in the order they should be displayed to users.
*
* @return array
*/
public function get_sort_order(): array {
return [
'completionview',
'completionsubmit',
];
}
}

39
mod/survey/classes/event/course_module_instance_list_viewed.php
View File

@ -1,39 +0,0 @@
<?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/>.
/**
* The mod_survey instance list viewed event.
*
* @package mod_survey
* @copyright 2014 Rajesh Taneja <rajesh@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace mod_survey\event;
defined('MOODLE_INTERNAL') || die();
/**
* The mod_survey instance list viewed event class.
*
* @package mod_survey
* @since Moodle 2.7
* @copyright 2014 Rajesh Taneja <rajesh@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class course_module_instance_list_viewed extends \core\event\course_module_instance_list_viewed {
// No code required here as the parent class handles it all.
}

75
mod/survey/classes/event/course_module_viewed.php
View File

@ -1,75 +0,0 @@
<?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/>.
/**
* The mod_survey course module viewed event.
*
* @package mod_survey
* @copyright 2014 Rajesh Taneja <rajesh@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace mod_survey\event;
defined('MOODLE_INTERNAL') || die();
/**
* The mod_survery course module viewed event.
*
* @property-read array $other {
* Extra information about the event.
*
* - string viewed: what was viewed
* }
*
* @package mod_survey
* @since Moodle 2.7
* @copyright 2014 Rajesh Taneja <rajesh@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class course_module_viewed extends \core\event\course_module_viewed {
/**
* Set basic properties for the event.
*/
protected function init() {
$this->data['objecttable'] = 'survey';
$this->data['crud'] = 'r';
$this->data['edulevel'] = self::LEVEL_PARTICIPATING;
}
/**
* Custom validation.
*
* @throws \coding_exception
* @return void
*/
protected function validate_data() {
parent::validate_data();
if (empty($this->other['viewed'])) {
throw new \coding_exception('Other must contain the key viewed.');
}
}
public static function get_objectid_mapping() {
return array('db' => 'survey', 'restore' => 'survey');
}
public static function get_other_mapping() {
// No need to map 'viewed'.
return false;
}
}

109
mod/survey/classes/event/report_downloaded.php
View File

@ -1,109 +0,0 @@
<?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/>.
/**
* The mod_survey report downloaded event.
*
* @package mod_survey
* @copyright 2014 Rajesh Taneja <rajesh@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace mod_survey\event;
defined('MOODLE_INTERNAL') || die();
/**
* The mod_survey report downloaded event class.
*
* @property-read array $other {
* Extra information about the event.
*
* - string type: Type of report format downloaded.
* - int groupid: (optional) report for groupid.
* }
*
* @package mod_survey
* @since Moodle 2.7
* @copyright 2014 Rajesh Taneja <rajesh@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class report_downloaded extends \core\event\base {
/**
* Set basic properties for the event.
*/
protected function init() {
$this->data['objecttable'] = 'survey';
$this->data['crud'] = 'r';
$this->data['edulevel'] = self::LEVEL_TEACHING;
}
/**
* Return localised event name.
*
* @return string
*/
public static function get_name() {
return get_string('eventreportdownloaded', 'mod_survey');
}
/**
* Returns description of what happened.
*
* @return string
*/
public function get_description() {
return "The user with id '$this->userid' downloaded the report for the survey with course module id '$this->contextinstanceid'.";
}
/**
* Get URL related to the action.
*
* @return \moodle_url
*/
public function get_url() {
$params = array('id' => $this->contextinstanceid, 'type' => $this->other['type']);
if (isset($this->other['groupid'])) {
$params['group'] = $this->other['groupid'];
}
return new \moodle_url("/mod/survey/download.php", $params);
}
/**
* Custom validation.
*
* @throws \coding_exception
* @return void
*/
protected function validate_data() {
parent::validate_data();
if (empty($this->other['type'])) {
throw new \coding_exception('The \'type\' value must be set in other.');
}
}
public static function get_objectid_mapping() {
return array('db' => 'survey', 'restore' => 'survey');
}
public static function get_other_mapping() {
$othermapped = array();
$othermapped['groupid'] = array('db' => 'groups', 'restore' => 'group');
return $othermapped;
}
}

97
mod/survey/classes/event/report_viewed.php
View File

@ -1,97 +0,0 @@
<?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/>.
/**
* The mod_survey report viewed event.
*
* @package mod_survey
* @copyright 2014 Rajesh Taneja <rajesh@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace mod_survey\event;
defined('MOODLE_INTERNAL') || die();
/**
* The mod_survey report viewed event class.
*
* @property-read array $other {
* Extra information about the event.
*
* - string action: (optional) report view.
* - int groupid: (optional) report for groupid.
* }
*
* @package mod_survey
* @since Moodle 2.7
* @copyright 2014 Rajesh Taneja <rajesh@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class report_viewed extends \core\event\base {
/**
* Set basic properties for the event.
*/
protected function init() {
$this->data['objecttable'] = 'survey';
$this->data['crud'] = 'r';
$this->data['edulevel'] = self::LEVEL_TEACHING;
}
/**
* Return localised event name.
*
* @return string
*/
public static function get_name() {
return get_string('eventreportviewed', 'mod_survey');
}
/**
* Returns description of what happened.
*
* @return string
*/
public function get_description() {
return "The user with id '$this->userid' viewed the report for the survey with course module id '$this->contextinstanceid'.";
}
/**
* Get URL related to the action.
*
* @return \moodle_url
*/
public function get_url() {
$params = array();
$params['id'] = $this->contextinstanceid;
if (isset($this->other['action'])) {
$params['action'] = $this->other['action'];
}
return new \moodle_url("/mod/survey/report.php", $params);
}
public static function get_objectid_mapping() {
return array('db' => 'survey', 'restore' => 'survey');
}
public static function get_other_mapping() {
$othermapped = array();
$othermapped['groupid'] = array('db' => 'groups', 'restore' => 'group');
return $othermapped;
}
}

99
mod/survey/classes/event/response_submitted.php
View File

@ -1,99 +0,0 @@
<?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/>.
/**
* The mod_survey response submitted event.
*
* @package mod_survey
* @copyright 2014 Rajesh Taneja <rajesh@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace mod_survey\event;
defined('MOODLE_INTERNAL') || die();
/**
* The mod_survey response submitted event class.
*
* @property-read array $other {
* Extra information about the event.
*
* - int surveyid: ID of survey for which response was submitted.
* }
*
* @package mod_survey
* @since Moodle 2.7
* @copyright 2014 Rajesh Taneja <rajesh@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class response_submitted extends \core\event\base {
/**
* Set basic properties for the event.
*/
protected function init() {
$this->data['crud'] = 'c';
$this->data['edulevel'] = self::LEVEL_PARTICIPATING;
}
/**
* Return localised event name.
*
* @return string
*/
public static function get_name() {
return get_string('eventresponsesubmitted', 'mod_survey');
}
/**
* Returns description of what happened.
*
* @return string
*/
public function get_description() {
return "The user with id '$this->userid' submitted a response for the survey with course module id '$this->contextinstanceid'.";
}
/**
* Get URL related to the action.
*
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url("/mod/survey/view.php", array('id' => $this->contextinstanceid));
}
/**
* Custom validation.
*
* @throws \coding_exception
* @return void
*/
protected function validate_data() {
parent::validate_data();
if (empty($this->other['surveyid'])) {
throw new \coding_exception('The \'surveyid\' value must be set in other.');
}
}
public static function get_other_mapping() {
$othermapped = array();
$othermapped['surveyid'] = array('db' => 'survey', 'restore' => 'survey');
return $othermapped;
}
}

394
mod/survey/classes/external.php
View File

@ -1,394 +0,0 @@
<?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/>.
/**
* Survey external API
*
* @package mod_survey
* @category external
* @copyright 2015 Juan Leyva <juan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 3.0
*/
use core_course\external\helper_for_get_mods_by_courses;
use core_external\external_api;
use core_external\external_function_parameters;
use core_external\external_multiple_structure;
use core_external\external_single_structure;
use core_external\external_value;
use core_external\external_warnings;
use core_external\util;
defined('MOODLE_INTERNAL') || die;
require_once($CFG->dirroot . '/mod/survey/lib.php');
/**
* Survey external functions
*
* @package mod_survey
* @category external
* @copyright 2015 Juan Leyva <juan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 3.0
*/
class mod_survey_external extends external_api {
/**
* Describes the parameters for get_surveys_by_courses.
*
* @return external_function_parameters
* @since Moodle 3.0
*/
public static function get_surveys_by_courses_parameters() {
return new external_function_parameters (
array(
'courseids' => new external_multiple_structure(
new external_value(PARAM_INT, 'course id'), 'Array of course ids', VALUE_DEFAULT, array()
),
)
);
}
/**
* Returns a list of surveys in a provided list of courses,
* if no list is provided all surveys that the user can view will be returned.
*
* @param array $courseids the course ids
* @return array of surveys details
* @since Moodle 3.0
*/
public static function get_surveys_by_courses($courseids = array()) {
global $CFG, $USER, $DB;
$returnedsurveys = array();
$warnings = array();
$params = self::validate_parameters(self::get_surveys_by_courses_parameters(), array('courseids' => $courseids));
$mycourses = array();
if (empty($params['courseids'])) {
$mycourses = enrol_get_my_courses();
$params['courseids'] = array_keys($mycourses);
}
// Ensure there are courseids to loop through.
if (!empty($params['courseids'])) {
list($courses, $warnings) = util::validate_courses($params['courseids'], $mycourses);
// Get the surveys in this course, this function checks users visibility permissions.
// We can avoid then additional validate_context calls.
$surveys = get_all_instances_in_courses("survey", $courses);
foreach ($surveys as $survey) {
$context = context_module::instance($survey->coursemodule);
if (empty(trim($survey->intro))) {
$tempo = $DB->get_field("survey", "intro", array("id" => $survey->template));
$survey->intro = get_string($tempo, "survey");
}
// Entry to return.
$surveydetails = helper_for_get_mods_by_courses::standard_coursemodule_element_values(
$survey, 'mod_survey', 'moodle/course:manageactivities', 'mod/survey:participate');
if (has_capability('mod/survey:participate', $context)) {
$surveydetails['template'] = $survey->template;
$surveydetails['days'] = $survey->days;
$surveydetails['questions'] = $survey->questions;
$surveydetails['surveydone'] = survey_already_done($survey->id, $USER->id) ? 1 : 0;
}
if (has_capability('moodle/course:manageactivities', $context)) {
$surveydetails['timecreated'] = $survey->timecreated;
$surveydetails['timemodified'] = $survey->timemodified;
}
$returnedsurveys[] = $surveydetails;
}
}
$result = array();
$result['surveys'] = $returnedsurveys;
$result['warnings'] = $warnings;
return $result;
}
/**
* Describes the get_surveys_by_courses return value.
*
* @return external_single_structure
* @since Moodle 3.0
*/
public static function get_surveys_by_courses_returns() {
return new external_single_structure(
array(
'surveys' => new external_multiple_structure(
new external_single_structure(array_merge(
helper_for_get_mods_by_courses::standard_coursemodule_elements_returns(true),
[
'template' => new external_value(PARAM_INT, 'Survey type', VALUE_OPTIONAL),
'days' => new external_value(PARAM_INT, 'Days', VALUE_OPTIONAL),
'questions' => new external_value(PARAM_RAW, 'Question ids', VALUE_OPTIONAL),
'surveydone' => new external_value(PARAM_INT, 'Did I finish the survey?', VALUE_OPTIONAL),
'timecreated' => new external_value(PARAM_INT, 'Time of creation', VALUE_OPTIONAL),
'timemodified' => new external_value(PARAM_INT, 'Time of last modification', VALUE_OPTIONAL),
]
), 'Surveys')
),
'warnings' => new external_warnings(),
)
);
}
/**
* Returns description of method parameters
*
* @return external_function_parameters
* @since Moodle 3.0
*/
public static function view_survey_parameters() {
return new external_function_parameters(
array(
'surveyid' => new external_value(PARAM_INT, 'survey instance id')
)
);
}
/**
* Trigger the course module viewed event and update the module completion status.
*
* @param int $surveyid the survey instance id
* @return array of warnings and status result
* @since Moodle 3.0
* @throws moodle_exception
*/
public static function view_survey($surveyid) {
global $DB, $USER;
$params = self::validate_parameters(self::view_survey_parameters(),
array(
'surveyid' => $surveyid
));
$warnings = array();
// Request and permission validation.
$survey = $DB->get_record('survey', array('id' => $params['surveyid']), '*', MUST_EXIST);
list($course, $cm) = get_course_and_cm_from_instance($survey, 'survey');
$context = context_module::instance($cm->id);
self::validate_context($context);
require_capability('mod/survey:participate', $context);
$viewed = survey_already_done($survey->id, $USER->id) ? 'graph' : 'form';
// Trigger course_module_viewed event and completion.
survey_view($survey, $course, $cm, $context, $viewed);
$result = array();
$result['status'] = true;
$result['warnings'] = $warnings;
return $result;
}
/**
* Returns description of method result value
*
* @return \core_external\external_description
* @since Moodle 3.0
*/
public static function view_survey_returns() {
return new external_single_structure(
array(
'status' => new external_value(PARAM_BOOL, 'status: true if success'),
'warnings' => new external_warnings()
)
);
}
/**
* Returns description of method parameters
*
* @return external_function_parameters
* @since Moodle 3.0
*/
public static function get_questions_parameters() {
return new external_function_parameters(
array(
'surveyid' => new external_value(PARAM_INT, 'survey instance id')
)
);
}
/**
* Get the complete list of questions for the survey, including subquestions.
*
* @param int $surveyid the survey instance id
* @return array of warnings and the question list
* @since Moodle 3.0
* @throws moodle_exception
*/
public static function get_questions($surveyid) {
global $DB, $USER;
$params = self::validate_parameters(self::get_questions_parameters(),
array(
'surveyid' => $surveyid
));
$warnings = array();
// Request and permission validation.
$survey = $DB->get_record('survey', array('id' => $params['surveyid']), '*', MUST_EXIST);
list($course, $cm) = get_course_and_cm_from_instance($survey, 'survey');
$context = context_module::instance($cm->id);
self::validate_context($context);
require_capability('mod/survey:participate', $context);
$mainquestions = survey_get_questions($survey);
foreach ($mainquestions as $question) {
if ($question->type >= 0) {
// Parent is used in subquestions.
$question->parent = 0;
$questions[] = survey_translate_question($question);
// Check if the question has subquestions.
if ($question->multi) {
$subquestions = survey_get_subquestions($question);
foreach ($subquestions as $sq) {
$sq->parent = $question->id;
$questions[] = survey_translate_question($sq);
}
}
}
}
$result = array();
$result['questions'] = $questions;
$result['warnings'] = $warnings;
return $result;
}
/**
* Returns description of method result value
*
* @return \core_external\external_description
* @since Moodle 3.0
*/
public static function get_questions_returns() {
return new external_single_structure(
array(
'questions' => new external_multiple_structure(
new external_single_structure(
array(
'id' => new external_value(PARAM_INT, 'Question id'),
'text' => new external_value(PARAM_RAW, 'Question text'),
'shorttext' => new external_value(PARAM_RAW, 'Question short text'),
'multi' => new external_value(PARAM_RAW, 'Subquestions ids'),
'intro' => new external_value(PARAM_RAW, 'The question intro'),
'type' => new external_value(PARAM_INT, 'Question type'),
'options' => new external_value(PARAM_RAW, 'Question options'),
'parent' => new external_value(PARAM_INT, 'Parent question (for subquestions)'),
), 'Questions'
)
),
'warnings' => new external_warnings()
)
);
}
/**
* Describes the parameters for submit_answers.
*
* @return external_function_parameters
* @since Moodle 3.0
*/
public static function submit_answers_parameters() {
return new external_function_parameters(
array(
'surveyid' => new external_value(PARAM_INT, 'Survey id'),
'answers' => new external_multiple_structure(
new external_single_structure(
array(
'key' => new external_value(PARAM_RAW, 'Answer key'),
'value' => new external_value(PARAM_RAW, 'Answer value')
)
)
),
)
);
}
/**
* Submit the answers for a given survey.
*
* @param int $surveyid the survey instance id
* @param array $answers the survey answers
* @return array of warnings and status result
* @since Moodle 3.0
* @throws moodle_exception
*/
public static function submit_answers($surveyid, $answers) {
global $DB, $USER;
$params = self::validate_parameters(self::submit_answers_parameters(),
array(
'surveyid' => $surveyid,
'answers' => $answers
));
$warnings = array();
// Request and permission validation.
$survey = $DB->get_record('survey', array('id' => $params['surveyid']), '*', MUST_EXIST);
list($course, $cm) = get_course_and_cm_from_instance($survey, 'survey');
$context = context_module::instance($cm->id);
self::validate_context($context);
require_capability('mod/survey:participate', $context);
if (survey_already_done($survey->id, $USER->id)) {
throw new moodle_exception("alreadysubmitted", "survey");
}
// Build the answers array. Data is cleaned inside the survey_save_answers function.
$answers = array();
foreach ($params['answers'] as $answer) {
$key = $answer['key'];
$answers[$key] = $answer['value'];
}
survey_save_answers($survey, $answers, $course, $context);
$result = array();
$result['status'] = true;
$result['warnings'] = $warnings;
return $result;
}
/**
* Returns description of method result value
*
* @return \core_external\external_description
* @since Moodle 3.0
*/
public static function submit_answers_returns() {
return new external_single_structure(
array(
'status' => new external_value(PARAM_BOOL, 'status: true if success'),
'warnings' => new external_warnings()
)
);
}
}

128
mod/survey/classes/output/actionbar.php
View File

@ -1,128 +0,0 @@
<?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/>.
namespace mod_survey\output;
use moodle_url;
use renderable;
use renderer_base;
use templatable;
use url_select;
/**
* Output the rendered elements for the tertiary nav page action
*
* @package mod_survey
* @copyright 2021 Sujith Haridasan <sujith@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class actionbar implements renderable, templatable {
/**
* The course id.
*
* @var int $id
*/
private $id;
/**
* The action decides the url to navigate to.
*
* @var string $action
*/
private $action;
/**
* Current url.
*
* @var moodle_url $currenturl
*/
private $currenturl;
/**
* actionbar constructor.
*
* @param int $id The course module id.
* @param string $action The action string.
* @param moodle_url $currenturl The current URL.
*/
public function __construct(int $id, string $action, moodle_url $currenturl) {
$this->id = $id;
$this->action = $action;
$this->currenturl = $currenturl;
}
/**
* Create select menu for the reports
*
* @return url_select url_select object.
*/
private function create_select_menu(): url_select {
$menu = [];
$actions = $this->get_available_reports();
foreach ($actions as $action => $straction) {
$url = new moodle_url($this->currenturl, ['id' => $this->id, 'action' => $action]);
$menu[$url->out(false)] = $straction;
}
return new url_select($menu, $this->currenturl->out(false), null, 'surveyresponseselect');
}
/**
* Generate available reports list
*
* @return array The list of available action => action string.
*/
private function get_available_reports(): array {
global $DB;
$cm = get_coursemodule_from_id('survey', $this->id);
$survey = $DB->get_record("survey", ["id" => $cm->instance]);
$actions = [];
if ($survey && ($survey->template != SURVEY_CIQ)) {
$actions['summary'] = get_string('summary', 'survey');
$actions['scales'] = get_string('scales', 'survey');
}
$actions['questions'] = get_string('questions', 'survey');
$actions['students'] = get_string('participants');
return $actions;
}
/**
* Data for the template.
*
* @param renderer_base $output renderer_base object.
* @return array data for the template
*/
public function export_for_template(renderer_base $output): array {
global $PAGE;
$selecturl = $this->create_select_menu();
$data = [
'urlselect' => $selecturl->export_for_template($output)
];
if (has_capability('mod/survey:download', $PAGE->cm->context)) {
$downloadlink = (new moodle_url('/mod/survey/report.php', ['id' => $this->id, 'action' => 'download']))->out(false);
$data['download'] = [
'link' => $downloadlink,
'text' => get_string('downloadresults', 'mod_survey'),
];
}
return $data;
}
}

414
mod/survey/classes/privacy/provider.php
View File

@ -1,414 +0,0 @@
<?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/>.
/**
* Data provider.
*
* @package mod_survey
* @copyright 2018 Frédéric Massart
* @author Frédéric Massart <fred@branchup.tech>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace mod_survey\privacy;
defined('MOODLE_INTERNAL') || die();
use context;
use context_helper;
use context_module;
use core_privacy\local\metadata\collection;
use core_privacy\local\request\approved_contextlist;
use core_privacy\local\request\approved_userlist;
use core_privacy\local\request\helper;
use core_privacy\local\request\transform;
use core_privacy\local\request\userlist;
use core_privacy\local\request\writer;
require_once($CFG->dirroot . '/mod/survey/lib.php');
/**
* Data provider class.
*
* @package mod_survey
* @copyright 2018 Frédéric Massart
* @author Frédéric Massart <fred@branchup.tech>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class provider implements
\core_privacy\local\metadata\provider,
\core_privacy\local\request\core_userlist_provider,
\core_privacy\local\request\plugin\provider {
/**
* Returns metadata.
*
* @param collection $collection The initialised collection to add items to.
* @return collection A listing of user data stored through this system.
*/
public static function get_metadata(collection $collection): collection {
$collection->add_database_table('survey_answers', [
'userid' => 'privacy:metadata:answers:userid',
'question' => 'privacy:metadata:answers:question',
'answer1' => 'privacy:metadata:answers:answer1',
'answer2' => 'privacy:metadata:answers:answer2',
'time' => 'privacy:metadata:answers:time',
], 'privacy:metadata:answers');
$collection->add_database_table('survey_analysis', [
'userid' => 'privacy:metadata:analysis:userid',
'notes' => 'privacy:metadata:analysis:notes',
], 'privacy:metadata:analysis');
return $collection;
}
/**
* Get the list of contexts that contain user information for the specified user.
*
* @param int $userid The user to search.
* @return contextlist $contextlist The contextlist containing the list of contexts used in this plugin.
*/
public static function get_contexts_for_userid(int $userid): \core_privacy\local\request\contextlist {
$contextlist = new \core_privacy\local\request\contextlist();
// While we should not have an analysis without answers, it's safer to gather contexts by looking at both tables.
$sql = "
SELECT DISTINCT ctx.id
FROM {survey} s
JOIN {modules} m
ON m.name = :survey
JOIN {course_modules} cm
ON cm.instance = s.id
AND cm.module = m.id
JOIN {context} ctx
ON ctx.instanceid = cm.id
AND ctx.contextlevel = :modulelevel
LEFT JOIN {survey_answers} sa
ON sa.survey = s.id
AND sa.userid = :userid1
LEFT JOIN {survey_analysis} sy
ON sy.survey = s.id
AND sy.userid = :userid2
WHERE s.template <> 0
AND (sa.id IS NOT NULL
OR sy.id IS NOT NULL)";
$contextlist->add_from_sql($sql, [
'survey' => 'survey',
'modulelevel' => CONTEXT_MODULE,
'userid1' => $userid,
'userid2' => $userid,
]);
return $contextlist;
}
/**
* Get the list of users who have data within a context.
*
* @param userlist $userlist The userlist containing the list of users who have data in this context/plugin combination.
*/
public static function get_users_in_context(userlist $userlist) {
$context = $userlist->get_context();
if (!is_a($context, \context_module::class)) {
return;
}
$params = [
'survey' => 'survey',
'modulelevel' => CONTEXT_MODULE,
'contextid' => $context->id,
];
$sql = "
SELECT sa.userid
FROM {survey} s
JOIN {modules} m
ON m.name = :survey
JOIN {course_modules} cm
ON cm.instance = s.id
AND cm.module = m.id
JOIN {context} ctx
ON ctx.instanceid = cm.id
AND ctx.contextlevel = :modulelevel
JOIN {survey_answers} sa
ON sa.survey = s.id
WHERE ctx.id = :contextid
AND s.template <> 0";
$userlist->add_from_sql('userid', $sql, $params);
$sql = "
SELECT sy.userid
FROM {survey} s
JOIN {modules} m
ON m.name = :survey
JOIN {course_modules} cm
ON cm.instance = s.id
AND cm.module = m.id
JOIN {context} ctx
ON ctx.instanceid = cm.id
AND ctx.contextlevel = :modulelevel
JOIN {survey_analysis} sy
ON sy.survey = s.id
WHERE ctx.id = :contextid
AND s.template <> 0";
$userlist->add_from_sql('userid', $sql, $params);
}
/**
* Export all user data for the specified user, in the specified contexts.
*
* @param approved_contextlist $contextlist The approved contexts to export information for.
*/
public static function export_user_data(approved_contextlist $contextlist) {
global $DB;
$user = $contextlist->get_user();
$userid = $user->id;
$cmids = array_reduce($contextlist->get_contexts(), function($carry, $context) {
if ($context->contextlevel == CONTEXT_MODULE) {
$carry[] = $context->instanceid;
}
return $carry;
}, []);
if (empty($cmids)) {
return;
}
// Export the answers.
list($insql, $inparams) = $DB->get_in_or_equal($cmids, SQL_PARAMS_NAMED);
$sql = "
SELECT sa.*,
sq.id as qid,
sq.text as qtext,
sq.shorttext as qshorttext,
sq.intro as qintro,
sq.options as qoptions,
sq.type as qtype,
cm.id as cmid
FROM {survey_answers} sa
JOIN {survey_questions} sq
ON sq.id = sa.question
JOIN {survey} s
ON s.id = sa.survey
JOIN {modules} m
ON m.name = :survey
JOIN {course_modules} cm
ON cm.instance = s.id
AND cm.module = m.id
WHERE cm.id $insql
AND sa.userid = :userid
ORDER BY s.id, sq.id";
$params = array_merge($inparams, ['survey' => 'survey', 'userid' => $userid]);
$recordset = $DB->get_recordset_sql($sql, $params);
static::recordset_loop_and_export($recordset, 'cmid', [], function($carry, $record) {
$q = survey_translate_question((object) [
'text' => $record->qtext,
'shorttext' => $record->qshorttext,
'intro' => $record->qintro,
'options' => $record->qoptions
]);
$qtype = $record->qtype;
$options = explode(',', $q->options ?? '');
$carry[] = [
'question' => array_merge((array) $q, [
'options' => $qtype > 0 ? $options : '-'
]),
'answer' => [
'actual' => $qtype > 0 && !empty($record->answer1) ? $options[$record->answer1 - 1] : $record->answer1,
'preferred' => $qtype > 0 && !empty($record->answer2) ? $options[$record->answer2 - 1] : $record->answer2,
],
'time' => transform::datetime($record->time),
];
return $carry;
}, function($cmid, $data) use ($user) {
$context = context_module::instance($cmid);
$contextdata = helper::get_context_data($context, $user);
$contextdata = (object) array_merge((array) $contextdata, ['answers' => $data]);
helper::export_context_files($context, $user);
writer::with_context($context)->export_data([], $contextdata);
});
// Export the analysis.
$sql = "
SELECT sy.*, cm.id as cmid
FROM {survey_analysis} sy
JOIN {survey} s
ON s.id = sy.survey
JOIN {modules} m
ON m.name = :survey
JOIN {course_modules} cm
ON cm.instance = s.id
AND cm.module = m.id
WHERE cm.id $insql
AND sy.userid = :userid
ORDER BY s.id";
$params = array_merge($inparams, ['survey' => 'survey', 'userid' => $userid]);
$recordset = $DB->get_recordset_sql($sql, $params);
static::recordset_loop_and_export($recordset, 'cmid', null, function($carry, $record) {
$carry = ['notes' => $record->notes];
return $carry;
}, function($cmid, $data) {
$context = context_module::instance($cmid);
writer::with_context($context)->export_related_data([], 'survey_analysis', (object) $data);
});
}
/**
* Delete all data for all users in the specified context.
*
* @param context $context The specific context to delete data for.
*/
public static function delete_data_for_all_users_in_context(context $context) {
global $DB;
if ($context->contextlevel != CONTEXT_MODULE) {
return;
}
if ($surveyid = static::get_survey_id_from_context($context)) {
$DB->delete_records('survey_answers', ['survey' => $surveyid]);
$DB->delete_records('survey_analysis', ['survey' => $surveyid]);
}
}
/**
* Delete all user data for the specified user, in the specified contexts.
*
* @param approved_contextlist $contextlist The approved contexts and user information to delete information for.
*/
public static function delete_data_for_user(approved_contextlist $contextlist) {
global $DB;
$userid = $contextlist->get_user()->id;
$cmids = array_reduce($contextlist->get_contexts(), function($carry, $context) {
if ($context->contextlevel == CONTEXT_MODULE) {
$carry[] = $context->instanceid;
}
return $carry;
}, []);
if (empty($cmids)) {
return;
}
// Fetch the survey IDs.
list($insql, $inparams) = $DB->get_in_or_equal($cmids, SQL_PARAMS_NAMED);
$sql = "
SELECT s.id
FROM {survey} s
JOIN {modules} m
ON m.name = :survey
JOIN {course_modules} cm
ON cm.instance = s.id
AND cm.module = m.id
WHERE cm.id $insql";
$params = array_merge($inparams, ['survey' => 'survey']);
$surveyids = $DB->get_fieldset_sql($sql, $params);
// Delete all the things.
list($insql, $inparams) = $DB->get_in_or_equal($surveyids, SQL_PARAMS_NAMED);
$params = array_merge($inparams, ['userid' => $userid]);
$DB->delete_records_select('survey_answers', "survey $insql AND userid = :userid", $params);
$DB->delete_records_select('survey_analysis', "survey $insql AND userid = :userid", $params);
}
/**
* Delete multiple users within a single context.
*
* @param approved_userlist $userlist The approved context and user information to delete information for.
*/
public static function delete_data_for_users(approved_userlist $userlist) {
global $DB;
$context = $userlist->get_context();
if ($context->contextlevel != CONTEXT_MODULE) {
return;
}
// Fetch the survey ID.
$sql = "
SELECT s.id
FROM {survey} s
JOIN {modules} m
ON m.name = :survey
JOIN {course_modules} cm
ON cm.instance = s.id
AND cm.module = m.id
WHERE cm.id = :cmid";
$params = [
'survey' => 'survey',
'cmid' => $context->instanceid,
];
$surveyid = $DB->get_field_sql($sql, $params);
$userids = $userlist->get_userids();
// Delete all the things.
list($insql, $params) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED);
$params['surveyid'] = $surveyid;
$DB->delete_records_select('survey_answers', "survey = :surveyid AND userid {$insql}", $params);
$DB->delete_records_select('survey_analysis', "survey = :surveyid AND userid {$insql}", $params);
}
/**
* Get a survey ID from its context.
*
* @param context_module $context The module context.
* @return int
*/
protected static function get_survey_id_from_context(context_module $context) {
$cm = get_coursemodule_from_id('survey', $context->instanceid);
return $cm ? (int) $cm->instance : 0;
}
/**
* Loop and export from a recordset.
*
* @param moodle_recordset $recordset The recordset.
* @param string $splitkey The record key to determine when to export.
* @param mixed $initial The initial data to reduce from.
* @param callable $reducer The function to return the dataset, receives current dataset, and the current record.
* @param callable $export The function to export the dataset, receives the last value from $splitkey and the dataset.
* @return void
*/
protected static function recordset_loop_and_export(\moodle_recordset $recordset, $splitkey, $initial,
callable $reducer, callable $export) {
$data = $initial;
$lastid = null;
foreach ($recordset as $record) {
if ($lastid && $record->{$splitkey} != $lastid) {
$export($lastid, $data);
$data = $initial;
}
$data = $reducer($data, $record);
$lastid = $record->{$splitkey};
}
$recordset->close();
if (!empty($lastid)) {
$export($lastid, $data);
}
}
}

70
mod/survey/classes/search/activity.php
View File

@ -1,70 +0,0 @@
<?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/>.
/**
* Search area for mod_survey activities.
*
* @package mod_survey
* @copyright 2015 David Monllao {@link http://www.davidmonllao.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace mod_survey\search;
defined('MOODLE_INTERNAL') || die();
/**
* Search area for mod_survey activities.
*
* @package mod_survey
* @copyright 2015 David Monllao {@link http://www.davidmonllao.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class activity extends \core_search\base_activity {
/**
* Returns true if this area uses file indexing.
*
* @return bool
*/
public function uses_file_indexing() {
return true;
}
/**
* Returns recordset containing required data for indexing activities.
*
* Overridden to discard records with courseid = 0.
*
* @param int $modifiedfrom timestamp
* @param \context|null $context Context
* @return \moodle_recordset|null Recordset, or null if no possible activities in given context
*/
public function get_document_recordset($modifiedfrom = 0, ?\context $context = null) {
global $DB;
list ($contextjoin, $contextparams) = $this->get_context_restriction_sql(
$context, $this->get_module_name(), 'modtable');
if ($contextjoin === null) {
return null;
}
return $DB->get_recordset_sql('SELECT modtable.* FROM {' . $this->get_module_name() .
'} modtable ' . $contextjoin . ' WHERE modtable.' . static::MODIFIED_FIELD_NAME .
' >= ? AND modtable.course != ? ORDER BY modtable.' . static::MODIFIED_FIELD_NAME .
' ASC',
array_merge($contextparams, [$modifiedfrom, 0]));
}
}

77
mod/survey/db/access.php
View File

@ -1,77 +0,0 @@
<?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/>.
/**
* Plugin capabilities
*
* @package mod_survey
* @copyright 2006 Martin Dougiamas
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
$capabilities = array(
'mod/survey:addinstance' => array(
'riskbitmask' => RISK_XSS,
'captype' => 'write',
'contextlevel' => CONTEXT_COURSE,
'archetypes' => array(
'editingteacher' => CAP_ALLOW,
'manager' => CAP_ALLOW
),
'clonepermissionsfrom' => 'moodle/course:manageactivities'
),
'mod/survey:participate' => array(
'captype' => 'read',
'contextlevel' => CONTEXT_MODULE,
'archetypes' => array(
'student' => CAP_ALLOW,
'teacher' => CAP_ALLOW,
'editingteacher' => CAP_ALLOW,
'manager' => CAP_ALLOW
)
),
'mod/survey:readresponses' => array(
'captype' => 'read',
'contextlevel' => CONTEXT_MODULE,
'archetypes' => array(
'teacher' => CAP_ALLOW,
'editingteacher' => CAP_ALLOW,
'manager' => CAP_ALLOW
)
),
'mod/survey:download' => array(
'captype' => 'read',
'contextlevel' => CONTEXT_MODULE,
'archetypes' => array(
'teacher' => CAP_ALLOW,
'editingteacher' => CAP_ALLOW,
'manager' => CAP_ALLOW
)
)
);

125
mod/survey/db/install.php
View File

@ -1,125 +0,0 @@
<?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/>.
/**
* Survey module installation.
*
* @package mod_survey
* @copyright 2009 Petr Skoda (http://skodak.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
/**
* Perform the post-install procedures.
*/
function xmldb_survey_install() {
global $DB;
// Disable the survey activity module on new installs by default.
$DB->set_field('modules', 'visible', 0, ['name' => 'survey']);
// Insert survey data.
$records = array(
array_combine(array('course', 'template', 'days', 'timecreated', 'timemodified', 'name', 'intro', 'questions'), array(0, 0, 0, 985017600, 985017600, 'collesaname', 'collesaintro', '25,26,27,28,29,30,43,44')),
array_combine(array('course', 'template', 'days', 'timecreated', 'timemodified', 'name', 'intro', 'questions'), array(0, 0, 0, 985017600, 985017600, 'collespname', 'collespintro', '31,32,33,34,35,36,43,44')),
array_combine(array('course', 'template', 'days', 'timecreated', 'timemodified', 'name', 'intro', 'questions'), array(0, 0, 0, 985017600, 985017600, 'collesapname', 'collesapintro', '37,38,39,40,41,42,43,44')),
array_combine(array('course', 'template', 'days', 'timecreated', 'timemodified', 'name', 'intro', 'questions'), array(0, 0, 0, 985017600, 985017600, 'attlsname', 'attlsintro', '65,67,68')),
array_combine(array('course', 'template', 'days', 'timecreated', 'timemodified', 'name', 'intro', 'questions'), array(0, 0, 0, 985017600, 985017600, 'ciqname', 'ciqintro', '69,70,71,72,73')),
);
foreach ($records as $record) {
$DB->insert_record('survey', $record, false);
}
$records = array(
array_combine(array('text', 'shorttext', 'type', 'options'), array('colles1', 'colles1short', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('colles2', 'colles2short', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('colles3', 'colles3short', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('colles4', 'colles4short', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('colles5', 'colles5short', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('colles6', 'colles6short', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('colles7', 'colles7short', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('colles8', 'colles8short', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('colles9', 'colles9short', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('colles10', 'colles10short', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('colles11', 'colles11short', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('colles12', 'colles12short', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('colles13', 'colles13short', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('colles14', 'colles14short', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('colles15', 'colles15short', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('colles16', 'colles16short', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('colles17', 'colles17short', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('colles18', 'colles18short', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('colles19', 'colles19short', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('colles20', 'colles20short', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('colles21', 'colles21short', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('colles22', 'colles22short', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('colles23', 'colles23short', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('colles24', 'colles24short', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'multi', 'intro', 'type', 'options'), array('collesm1', 'collesm1short', '1,2,3,4', 'collesmintro', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'multi', 'intro', 'type', 'options'), array('collesm2', 'collesm2short', '5,6,7,8', 'collesmintro', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'multi', 'intro', 'type', 'options'), array('collesm3', 'collesm3short', '9,10,11,12', 'collesmintro', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'multi', 'intro', 'type', 'options'), array('collesm4', 'collesm4short', '13,14,15,16', 'collesmintro', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'multi', 'intro', 'type', 'options'), array('collesm5', 'collesm5short', '17,18,19,20', 'collesmintro', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'multi', 'intro', 'type', 'options'), array('collesm6', 'collesm6short', '21,22,23,24', 'collesmintro', 1, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'multi', 'intro', 'type', 'options'), array('collesm1', 'collesm1short', '1,2,3,4', 'collesmintro', 2, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'multi', 'intro', 'type', 'options'), array('collesm2', 'collesm2short', '5,6,7,8', 'collesmintro', 2, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'multi', 'intro', 'type', 'options'), array('collesm3', 'collesm3short', '9,10,11,12', 'collesmintro', 2, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'multi', 'intro', 'type', 'options'), array('collesm4', 'collesm4short', '13,14,15,16', 'collesmintro', 2, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'multi', 'intro', 'type', 'options'), array('collesm5', 'collesm5short', '17,18,19,20', 'collesmintro', 2, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'multi', 'intro', 'type', 'options'), array('collesm6', 'collesm6short', '21,22,23,24', 'collesmintro', 2, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'multi', 'intro', 'type', 'options'), array('collesm1', 'collesm1short', '1,2,3,4', 'collesmintro', 3, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'multi', 'intro', 'type', 'options'), array('collesm2', 'collesm2short', '5,6,7,8', 'collesmintro', 3, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'multi', 'intro', 'type', 'options'), array('collesm3', 'collesm3short', '9,10,11,12', 'collesmintro', 3, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'multi', 'intro', 'type', 'options'), array('collesm4', 'collesm4short', '13,14,15,16', 'collesmintro', 3, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'multi', 'intro', 'type', 'options'), array('collesm5', 'collesm5short', '17,18,19,20', 'collesmintro', 3, 'scaletimes5')),
array_combine(array('text', 'shorttext', 'multi', 'intro', 'type', 'options'), array('collesm6', 'collesm6short', '21,22,23,24', 'collesmintro', 3, 'scaletimes5')),
array_combine(array('text', 'type', 'options'), array('howlong', 1, 'howlongoptions')),
array_combine(array('text', 'type'), array('othercomments', 0)),
array_combine(array('text', 'shorttext', 'type', 'options'), array('attls1', 'attls1short', 1, 'scaleagree5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('attls2', 'attls2short', 1, 'scaleagree5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('attls3', 'attls3short', 1, 'scaleagree5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('attls4', 'attls4short', 1, 'scaleagree5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('attls5', 'attls5short', 1, 'scaleagree5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('attls6', 'attls6short', 1, 'scaleagree5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('attls7', 'attls7short', 1, 'scaleagree5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('attls8', 'attls8short', 1, 'scaleagree5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('attls9', 'attls9short', 1, 'scaleagree5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('attls10', 'attls10short', 1, 'scaleagree5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('attls11', 'attls11short', 1, 'scaleagree5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('attls12', 'attls12short', 1, 'scaleagree5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('attls13', 'attls13short', 1, 'scaleagree5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('attls14', 'attls14short', 1, 'scaleagree5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('attls15', 'attls15short', 1, 'scaleagree5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('attls16', 'attls16short', 1, 'scaleagree5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('attls17', 'attls17short', 1, 'scaleagree5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('attls18', 'attls18short', 1, 'scaleagree5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('attls19', 'attls19short', 1, 'scaleagree5')),
array_combine(array('text', 'shorttext', 'type', 'options'), array('attls20', 'attls20short', 1, 'scaleagree5')),
array_combine(array('text', 'shorttext', 'multi', 'intro', 'type', 'options'), array('attlsm1', 'attlsm1', '45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64', 'attlsmintro', 1, 'scaleagree5')),
array_combine(array('text', 'shorttext', 'multi', 'intro', 'type', 'options'), array('-', '-', '-', '-', 0, '-')),
array_combine(array('text', 'shorttext', 'multi', 'intro', 'type', 'options'), array('attlsm2', 'attlsm2', '63,62,59,57,55,49,52,50,48,47', 'attlsmintro', -1, 'scaleagree5')),
array_combine(array('text', 'shorttext', 'multi', 'intro', 'type', 'options'), array('attlsm3', 'attlsm3', '46,54,45,51,60,53,56,58,61,64', 'attlsmintro', -1, 'scaleagree5')),
array_combine(array('text', 'shorttext', 'type'), array('ciq1', 'ciq1short', 0)),
array_combine(array('text', 'shorttext', 'type'), array('ciq2', 'ciq2short', 0)),
array_combine(array('text', 'shorttext', 'type'), array('ciq3', 'ciq3short', 0)),
array_combine(array('text', 'shorttext', 'type'), array('ciq4', 'ciq4short', 0)),
array_combine(array('text', 'shorttext', 'type'), array('ciq5', 'ciq5short', 0)),
);
foreach ($records as $record) {
$DB->insert_record('survey_questions', $record, false);
}
}

77
mod/survey/db/install.xml
View File

@ -1,77 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<XMLDB PATH="mod/survey/db" VERSION="20160615" COMMENT="XMLDB file for Moodle mod/survey"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="../../../lib/xmldb/xmldb.xsd"
>
<TABLES>
<TABLE NAME="survey" COMMENT="Each record is one SURVEY module with its configuration">
<FIELDS>
<FIELD NAME="id" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="true"/>
<FIELD NAME="course" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
<FIELD NAME="template" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
<FIELD NAME="days" TYPE="int" LENGTH="6" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
<FIELD NAME="timecreated" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
<FIELD NAME="timemodified" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
<FIELD NAME="name" TYPE="char" LENGTH="255" NOTNULL="true" SEQUENCE="false"/>
<FIELD NAME="intro" TYPE="text" NOTNULL="true" SEQUENCE="false"/>
<FIELD NAME="introformat" TYPE="int" LENGTH="4" NOTNULL="true" DEFAULT="0" SEQUENCE="false" COMMENT="intro text field format"/>
<FIELD NAME="questions" TYPE="char" LENGTH="255" NOTNULL="true" SEQUENCE="false"/>
<FIELD NAME="completionsubmit" TYPE="int" LENGTH="1" NOTNULL="true" DEFAULT="0" SEQUENCE="false" COMMENT="If this field is set to 1, then the activity will be automatically marked as 'complete' once the user submits the survey."/>
</FIELDS>
<KEYS>
<KEY NAME="primary" TYPE="primary" FIELDS="id"/>
</KEYS>
<INDEXES>
<INDEX NAME="course" UNIQUE="false" FIELDS="course"/>
</INDEXES>
</TABLE>
<TABLE NAME="survey_questions" COMMENT="the questions conforming one survey">
<FIELDS>
<FIELD NAME="id" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="true"/>
<FIELD NAME="text" TYPE="char" LENGTH="255" NOTNULL="true" SEQUENCE="false"/>
<FIELD NAME="shorttext" TYPE="char" LENGTH="30" NOTNULL="true" SEQUENCE="false"/>
<FIELD NAME="multi" TYPE="char" LENGTH="100" NOTNULL="true" SEQUENCE="false"/>
<FIELD NAME="intro" TYPE="char" LENGTH="50" NOTNULL="true" SEQUENCE="false"/>
<FIELD NAME="type" TYPE="int" LENGTH="3" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
<FIELD NAME="options" TYPE="text" NOTNULL="false" SEQUENCE="false"/>
</FIELDS>
<KEYS>
<KEY NAME="primary" TYPE="primary" FIELDS="id"/>
</KEYS>
</TABLE>
<TABLE NAME="survey_answers" COMMENT="the answers to each questions filled by the users">
<FIELDS>
<FIELD NAME="id" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="true"/>
<FIELD NAME="userid" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
<FIELD NAME="survey" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
<FIELD NAME="question" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
<FIELD NAME="time" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
<FIELD NAME="answer1" TYPE="text" NOTNULL="true" SEQUENCE="false"/>
<FIELD NAME="answer2" TYPE="text" NOTNULL="true" SEQUENCE="false"/>
</FIELDS>
<KEYS>
<KEY NAME="primary" TYPE="primary" FIELDS="id"/>
<KEY NAME="survey" TYPE="foreign" FIELDS="survey" REFTABLE="survey" REFFIELDS="id"/>
<KEY NAME="question" TYPE="foreign" FIELDS="question" REFTABLE="survey_questions" REFFIELDS="id"/>
</KEYS>
<INDEXES>
<INDEX NAME="userid" UNIQUE="false" FIELDS="userid"/>
</INDEXES>
</TABLE>
<TABLE NAME="survey_analysis" COMMENT="text about each survey submission">
<FIELDS>
<FIELD NAME="id" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="true"/>
<FIELD NAME="survey" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
<FIELD NAME="userid" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
<FIELD NAME="notes" TYPE="text" NOTNULL="true" SEQUENCE="false"/>
</FIELDS>
<KEYS>
<KEY NAME="primary" TYPE="primary" FIELDS="id"/>
<KEY NAME="survey" TYPE="foreign" FIELDS="survey" REFTABLE="survey" REFFIELDS="id"/>
</KEYS>
<INDEXES>
<INDEX NAME="userid" UNIQUE="false" FIELDS="userid"/>
</INDEXES>
</TABLE>
</TABLES>
</XMLDB>

37
mod/survey/db/log.php
View File

@ -1,37 +0,0 @@
<?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/>.
/**
* Definition of log events
*
* @package mod_survey
* @category log
* @copyright 2010 Petr Skoda (http://skodak.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
$logs = array(
array('module'=>'survey', 'action'=>'add', 'mtable'=>'survey', 'field'=>'name'),
array('module'=>'survey', 'action'=>'update', 'mtable'=>'survey', 'field'=>'name'),
array('module'=>'survey', 'action'=>'download', 'mtable'=>'survey', 'field'=>'name'),
array('module'=>'survey', 'action'=>'view form', 'mtable'=>'survey', 'field'=>'name'),
array('module'=>'survey', 'action'=>'view graph', 'mtable'=>'survey', 'field'=>'name'),
array('module'=>'survey', 'action'=>'view report', 'mtable'=>'survey', 'field'=>'name'),
array('module'=>'survey', 'action'=>'submit', 'mtable'=>'survey', 'field'=>'name'),
);

68
mod/survey/db/services.php
View File

@ -1,68 +0,0 @@
<?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/>.
/**
* Survey external functions and service definitions.
*
* @package mod_survey
* @category external
* @copyright 2015 Juan Leyva <juan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 3.0
*/
defined('MOODLE_INTERNAL') || die;
$functions = array(
'mod_survey_get_surveys_by_courses' => array(
'classname' => 'mod_survey_external',
'methodname' => 'get_surveys_by_courses',
'description' => 'Returns a list of survey instances in a provided set of courses,
if no courses are provided then all the survey instances the user has access to will be returned.',
'type' => 'read',
'capabilities' => '',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
'mod_survey_view_survey' => array(
'classname' => 'mod_survey_external',
'methodname' => 'view_survey',
'description' => 'Trigger the course module viewed event and update the module completion status.',
'type' => 'write',
'capabilities' => 'mod/survey:participate',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
'mod_survey_get_questions' => array(
'classname' => 'mod_survey_external',
'methodname' => 'get_questions',
'description' => 'Get the complete list of questions for the survey, including subquestions.',
'type' => 'read',
'capabilities' => 'mod/survey:participate',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
'mod_survey_submit_answers' => array(
'classname' => 'mod_survey_external',
'methodname' => 'submit_answers',
'description' => 'Submit the answers for a given survey.',
'type' => 'write',
'capabilities' => 'mod/survey:participate',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
);

56
mod/survey/db/upgrade.php
View File

@ -1,56 +0,0 @@
<?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/>.
/**
* This file keeps track of upgrades to the survey module
*
* Sometimes, changes between versions involve
* alterations to database structures and other
* major things that may break installations.
*
* The upgrade function in this file will attempt
* to perform all the necessary actions to upgrade
* your older installation to the current version.
*
* If there's something it cannot do itself, it
* will tell you what you need to do.
*
* The commands in here will all be database-neutral,
* using the methods of database_manager class
*
* Please do not forget to use upgrade_set_timeout()
* before any action that may take longer time to finish.
*
* @package mod_survey
* @copyright 2006 Eloy Lafuente (stronk7)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
function xmldb_survey_upgrade($oldversion) {
// Automatically generated Moodle v4.2.0 release upgrade line.
// Put any upgrade step following this.
// Automatically generated Moodle v4.3.0 release upgrade line.
// Put any upgrade step following this.
// Automatically generated Moodle v4.4.0 release upgrade line.
// Put any upgrade step following this.
// Automatically generated Moodle v4.5.0 release upgrade line.
// Put any upgrade step following this.
return true;
}

31
mod/survey/deprecatedlib.php
View File

@ -1,31 +0,0 @@
<?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
*/
/**
* @deprecated since Moodle 3.11
*/
function survey_get_completion_state() {
$completionclass = \mod_survey\completion\custom_completion::class;
throw new coding_exception(__FUNCTION__ . "() has been removed, please use the '{$completionclass}' class instead");
}

365
mod/survey/download.php
View File

@ -1,365 +0,0 @@
<?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/>.
/**
* This file is responsible for producing the downloadable versions of a survey
* module.
*
* @package mod_survey
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
require_once ("../../config.php");
// Check that all the parameters have been provided.
$id = required_param('id', PARAM_INT); // Course Module ID
$type = optional_param('type', 'xls', PARAM_ALPHA);
$group = optional_param('group', 0, PARAM_INT);
if (! $cm = get_coursemodule_from_id('survey', $id)) {
throw new \moodle_exception('invalidcoursemodule');
}
if (! $course = $DB->get_record("course", array("id"=>$cm->course))) {
throw new \moodle_exception('coursemisconf');
}
$context = context_module::instance($cm->id);
$PAGE->set_url('/mod/survey/download.php', array('id'=>$id, 'type'=>$type, 'group'=>$group));
require_login($course, false, $cm);
require_capability('mod/survey:download', $context) ;
if (! $survey = $DB->get_record("survey", array("id"=>$cm->instance))) {
throw new \moodle_exception('invalidsurveyid', 'survey');
}
$params = array(
'objectid' => $survey->id,
'context' => $context,
'courseid' => $course->id,
'other' => array('type' => $type, 'groupid' => $group)
);
$event = \mod_survey\event\report_downloaded::create($params);
$event->trigger();
/// Check to see if groups are being used in this survey
$groupmode = groups_get_activity_groupmode($cm); // Groups are being used
if ($groupmode and $group) {
$users = get_users_by_capability($context, 'mod/survey:participate', '', '', '', '', $group, null, false);
} else {
$users = get_users_by_capability($context, 'mod/survey:participate', '', '', '', '', '', null, false);
$group = false;
}
// The order of the questions
$order = explode(",", $survey->questions);
// Get the actual questions from the database
$questions = $DB->get_records_list("survey_questions", "id", $order);
// Get an ordered array of questions
$orderedquestions = array();
$virtualscales = false;
foreach ($order as $qid) {
$orderedquestions[$qid] = $questions[$qid];
// Check if this question is using virtual scales
if (!$virtualscales && $questions[$qid]->type < 0) {
$virtualscales = true;
}
}
$nestedorder = array();//will contain the subquestions attached to the main questions
$preparray = array();
foreach ($orderedquestions as $qid=>$question) {
//$orderedquestions[$qid]->text = get_string($question->text, "survey");
if (!empty($question->multi)) {
$actualqids = explode(",", $questions[$qid]->multi);
foreach ($actualqids as $subqid) {
if (!empty($orderedquestions[$subqid]->type)) {
$orderedquestions[$subqid]->type = $questions[$qid]->type;
}
}
} else {
$actualqids = array($qid);
}
if ($virtualscales && $questions[$qid]->type < 0) {
$nestedorder[$qid] = $actualqids;
} else if (!$virtualscales && $question->type >= 0) {
$nestedorder[$qid] = $actualqids;
} else {
//todo andrew this was added by me. Is it correct?
$nestedorder[$qid] = array();
}
}
$reversednestedorder = array();
foreach ($nestedorder as $qid=>$subqidarray) {
foreach ($subqidarray as $subqui) {
$reversednestedorder[$subqui] = $qid;
}
}
//need to get info on the sub-questions from the db and merge the arrays of questions
$allquestions = array_merge($questions, $DB->get_records_list("survey_questions", "id", array_keys($reversednestedorder)));
//array_merge() messes up the keys so reinstate them
$questions = array();
foreach($allquestions as $question) {
$questions[$question->id] = $question;
//while were iterating over the questions get the question text
$questions[$question->id]->text = get_string($questions[$question->id]->text, "survey");
}
unset($allquestions);
// Get and collate all the results in one big array
if (! $surveyanswers = $DB->get_records("survey_answers", array("survey"=>$survey->id), "time ASC")) {
throw new \moodle_exception('cannotfindanswer', 'survey');
}
$results = array();
foreach ($surveyanswers as $surveyanswer) {
if (!$group || isset($users[$surveyanswer->userid])) {
//$questionid = $reversednestedorder[$surveyanswer->question];
$questionid = $surveyanswer->question;
if (!array_key_exists($surveyanswer->userid, $results)) {
$results[$surveyanswer->userid] = array('time'=>$surveyanswer->time);
}
$results[$surveyanswer->userid][$questionid]['answer1'] = $surveyanswer->answer1;
$results[$surveyanswer->userid][$questionid]['answer2'] = $surveyanswer->answer2;
}
}
// Output the file as a valid ODS spreadsheet if required
$coursecontext = context_course::instance($course->id);
$courseshortname = format_string($course->shortname, true, array('context' => $coursecontext));
if ($type == "ods") {
require_once("$CFG->libdir/odslib.class.php");
/// Calculate file name
$downloadfilename = clean_filename(strip_tags($courseshortname.' '.format_string($survey->name, true))).'.ods';
/// Creating a workbook
$workbook = new MoodleODSWorkbook("-");
/// Sending HTTP headers
$workbook->send($downloadfilename);
/// Creating the first worksheet
$myxls = $workbook->add_worksheet(core_text::substr(strip_tags(format_string($survey->name,true)), 0, 31));
$header = array("surveyid","surveyname","userid","firstname","lastname","email","idnumber","time", "notes");
$col=0;
foreach ($header as $item) {
$myxls->write_string(0,$col++,$item);
}
foreach ($nestedorder as $key => $nestedquestions) {
foreach ($nestedquestions as $key2 => $qid) {
$question = $questions[$qid];
if ($question->type == "0" || $question->type == "1" || $question->type == "3" || $question->type == "-1") {
$myxls->write_string(0,$col++,"$question->text");
}
if ($question->type == "2" || $question->type == "3") {
$myxls->write_string(0,$col++,"$question->text (preferred)");
}
}
}
// $date = $workbook->addformat();
// $date->set_num_format('mmmm-d-yyyy h:mm:ss AM/PM'); // ?? adjust the settings to reflect the PHP format below
$row = 0;
foreach ($results as $user => $rest) {
$col = 0;
$row++;
if (! $u = $DB->get_record("user", array("id"=>$user))) {
throw new \moodle_exception('invaliduserid');
}
if ($n = $DB->get_record("survey_analysis", array("survey"=>$survey->id, "userid"=>$user))) {
$notes = $n->notes;
} else {
$notes = "No notes made";
}
$myxls->write_string($row,$col++,$survey->id);
$myxls->write_string($row,$col++,strip_tags(format_text($survey->name,true)));
$myxls->write_string($row,$col++,$user);
$myxls->write_string($row,$col++,$u->firstname);
$myxls->write_string($row,$col++,$u->lastname);
$myxls->write_string($row,$col++,$u->email);
$myxls->write_string($row,$col++,$u->idnumber);
$myxls->write_string($row,$col++, userdate($results[$user]["time"], "%d-%b-%Y %I:%M:%S %p") );
// $myxls->write_number($row,$col++,$results[$user]["time"],$date);
$myxls->write_string($row,$col++,$notes);
foreach ($nestedorder as $key => $nestedquestions) {
foreach ($nestedquestions as $key2 => $qid) {
$question = $questions[$qid];
if ($question->type == "0" || $question->type == "1" || $question->type == "3" || $question->type == "-1") {
$myxls->write_string($row,$col++, $results[$user][$qid]["answer1"] );
}
if ($question->type == "2" || $question->type == "3") {
$myxls->write_string($row, $col++, $results[$user][$qid]["answer2"] );
}
}
}
}
$workbook->close();
exit;
}
// Output the file as a valid Excel spreadsheet if required
if ($type == "xls") {
require_once("$CFG->libdir/excellib.class.php");
/// Calculate file name
$downloadfilename = clean_filename(strip_tags($courseshortname.' '.format_string($survey->name,true))).'.xls';
/// Creating a workbook
$workbook = new MoodleExcelWorkbook("-");
/// Sending HTTP headers
$workbook->send($downloadfilename);
/// Creating the first worksheet
$myxls = $workbook->add_worksheet(core_text::substr(strip_tags(format_string($survey->name,true)), 0, 31));
$header = array("surveyid","surveyname","userid","firstname","lastname","email","idnumber","time", "notes");
$col=0;
foreach ($header as $item) {
$myxls->write_string(0,$col++,$item);
}
foreach ($nestedorder as $key => $nestedquestions) {
foreach ($nestedquestions as $key2 => $qid) {
$question = $questions[$qid];
if ($question->type == "0" || $question->type == "1" || $question->type == "3" || $question->type == "-1") {
$myxls->write_string(0,$col++,"$question->text");
}
if ($question->type == "2" || $question->type == "3") {
$myxls->write_string(0,$col++,"$question->text (preferred)");
}
}
}
// $date = $workbook->addformat();
// $date->set_num_format('mmmm-d-yyyy h:mm:ss AM/PM'); // ?? adjust the settings to reflect the PHP format below
$row = 0;
foreach ($results as $user => $rest) {
$col = 0;
$row++;
if (! $u = $DB->get_record("user", array("id"=>$user))) {
throw new \moodle_exception('invaliduserid');
}
if ($n = $DB->get_record("survey_analysis", array("survey"=>$survey->id, "userid"=>$user))) {
$notes = $n->notes;
} else {
$notes = "No notes made";
}
$myxls->write_string($row,$col++,$survey->id);
$myxls->write_string($row,$col++,strip_tags(format_text($survey->name,true)));
$myxls->write_string($row,$col++,$user);
$myxls->write_string($row,$col++,$u->firstname);
$myxls->write_string($row,$col++,$u->lastname);
$myxls->write_string($row,$col++,$u->email);
$myxls->write_string($row,$col++,$u->idnumber);
$myxls->write_string($row,$col++, userdate($results[$user]["time"], "%d-%b-%Y %I:%M:%S %p") );
// $myxls->write_number($row,$col++,$results[$user]["time"],$date);
$myxls->write_string($row,$col++,$notes);
foreach ($nestedorder as $key => $nestedquestions) {
foreach ($nestedquestions as $key2 => $qid) {
$question = $questions[$qid];
if (($question->type == "0" || $question->type == "1" || $question->type == "3" || $question->type == "-1")
&& array_key_exists($qid, $results[$user]) ){
$myxls->write_string($row,$col++, $results[$user][$qid]["answer1"] );
}
if (($question->type == "2" || $question->type == "3")
&& array_key_exists($qid, $results[$user]) ){
$myxls->write_string($row, $col++, $results[$user][$qid]["answer2"] );
}
}
}
}
$workbook->close();
exit;
}
// Otherwise, return the text file.
// Print header to force download
header("Content-Type: application/download\n");
$downloadfilename = clean_filename(strip_tags($courseshortname.' '.format_string($survey->name,true)));
header("Content-Disposition: attachment; filename=\"$downloadfilename.txt\"");
// Print names of all the fields
echo "surveyid surveyname userid firstname lastname email idnumber time ";
foreach ($nestedorder as $key => $nestedquestions) {
foreach ($nestedquestions as $key2 => $qid) {
$question = $questions[$qid];
if ($question->type == "0" || $question->type == "1" || $question->type == "3" || $question->type == "-1") {
echo "$question->text ";
}
if ($question->type == "2" || $question->type == "3") {
echo "$question->text (preferred) ";
}
}
}
echo "\n";
// Print all the lines of data.
foreach ($results as $user => $rest) {
if (! $u = $DB->get_record("user", array("id"=>$user))) {
throw new \moodle_exception('invaliduserid');
}
echo $survey->id."\t";
echo strip_tags(format_string($survey->name,true))."\t";
echo $user."\t";
echo $u->firstname."\t";
echo $u->lastname."\t";
echo $u->email."\t";
echo $u->idnumber."\t";
echo userdate($results[$user]["time"], "%d-%b-%Y %I:%M:%S %p")."\t";
foreach ($nestedorder as $key => $nestedquestions) {
foreach ($nestedquestions as $key2 => $qid) {
$question = $questions[$qid];
if ($question->type == "0" || $question->type == "1" || $question->type == "3" || $question->type == "-1") {
echo $results[$user][$qid]["answer1"]." ";
}
if ($question->type == "2" || $question->type == "3") {
echo $results[$user][$qid]["answer2"]." ";
}
}
}
echo "\n";
}
exit;

753
mod/survey/graph.php
View File

@ -1,753 +0,0 @@
<?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/>.
/**
* This file is responsible for producing the graph for survey reports
*
* @package mod_survey
* @copyright 2021 Sujith Haridasan <sujith@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
require_once("../../config.php");
require_once("$CFG->libdir/graphlib.php");
require_once("lib.php");
$id = required_param('id', PARAM_INT); // Course Module ID.
$type = required_param('type', PARAM_FILE); // Graph Type.
$group = optional_param('group', 0, PARAM_INT); // Group ID.
$sid = optional_param('sid', false, PARAM_INT); // Student ID.
$qid = optional_param('qid', 0, PARAM_INT); // Group ID.
$url = new moodle_url('/mod/survey/graph.php', array('id' => $id, 'type' => $type));
if ($group !== 0) {
$url->param('group', $group);
}
if ($sid !== false) {
$url->param('sid', $sid);
}
if ($qid !== 0) {
$url->param('qid', $qid);
}
$PAGE->set_url($url);
if (!$cm = get_coursemodule_from_id('survey', $id)) {
throw new \moodle_exception('invalidcoursemodule');
}
if (!$course = $DB->get_record("course", array("id" => $cm->course))) {
throw new \moodle_exception('coursemisconf');
}
if ($sid) {
if (!$user = $DB->get_record("user", array("id" => $sid))) {
throw new \moodle_exception('invaliduserid');
}
}
require_login($course, false, $cm);
$groupmode = groups_get_activity_groupmode($cm); // Groups are being used.
$context = context_module::instance($cm->id);
if (!has_capability('mod/survey:readresponses', $context)) {
if ($type != "student.png" or $sid != $USER->id) {
throw new \moodle_exception('nopermissiontoshow');
} else if ($groupmode and !groups_is_member($group)) {
throw new \moodle_exception('nopermissiontoshow');
}
}
if (!$survey = $DB->get_record("survey", array("id" => $cm->instance))) {
throw new \moodle_exception('invalidsurveyid', 'survey');
}
// Check to see if groups are being used in this survey.
if ($group) {
$users = get_users_by_capability($context, 'mod/survey:participate', '', '', '', '', $group, null, false);
} else if (!empty($cm->groupingid)) {
$groups = groups_get_all_groups($courseid, 0, $cm->groupingid);
$groups = array_keys($groups);
$users = get_users_by_capability($context, 'mod/survey:participate', '', '', '', '', $groups, null, false);
} else {
$users = get_users_by_capability($context, 'mod/survey:participate', '', '', '', '', '', null, false);
$group = false;
}
$stractual = get_string("actual", "survey");
$stractualclass = get_string("actualclass", "survey");
$strpreferred = get_string("preferred", "survey");
$strpreferredclass = get_string("preferredclass", "survey");
if ($sid || isset($user)) {
$stractualstudent = get_string("actualstudent", "survey", fullname($user));
$strpreferredstudent = get_string("preferredstudent", "survey", fullname($user));
}
$virtualscales = false; // Set default value for case clauses.
switch ($type) {
case "question.png":
$question = $DB->get_record("survey_questions", array("id" => $qid));
$question->text = wordwrap(get_string($question->text, "survey"), SURVEY_QLENGTH_WRAP);
$question->options = get_string($question->options, "survey");
$options = explode(",", $question->options);
foreach ($options as $key => $unused) {
$buckets1[$key] = 0;
$buckets2[$key] = 0;
}
if ($aaa = $DB->get_records('survey_answers', array('survey' => $cm->instance, 'question' => $qid))) {
foreach ($aaa as $aa) {
if (!$group or isset($users[$aa->userid])) {
if ($a1 = $aa->answer1) {
$buckets1[$a1 - 1]++;
}
if ($a2 = $aa->answer2) {
$buckets2[$a2 - 1]++;
}
}
}
}
$maxbuckets1 = max($buckets1);
$maxbuckets2 = max($buckets2);
$maxbuckets = ($maxbuckets1 > $maxbuckets2) ? $maxbuckets1 : $maxbuckets2;
$graph = new graph($SURVEY_GWIDTH, $SURVEY_GHEIGHT);
$graph->parameter['title'] = "$question->text";
$graph->x_data = $options;
$graph->y_data['answers1'] = $buckets1;
$graph->y_format['answers1'] = array('colour' => 'ltblue', 'bar' => 'fill', 'legend' => $stractual, 'bar_size' => 0.4);
$graph->y_data['answers2'] = $buckets2;
$graph->y_format['answers2'] = array('colour' => 'ltorange', 'bar' => 'fill', 'legend' => $strpreferred, 'bar_size' => 0.2);
$graph->parameter['legend'] = 'outside-top';
$graph->parameter['legend_border'] = 'black';
$graph->parameter['legend_offset'] = 4;
if (($maxbuckets1 > 0.0) && ($maxbuckets2 > 0.0)) {
$graph->y_order = array('answers1', 'answers2');
} else if ($maxbuckets1 > 0.0) {
$graph->y_order = array('answers1');
} else {
$graph->y_order = array('answers2');
}
$graph->parameter['y_axis_gridlines'] = $maxbuckets + 1;
$graph->parameter['y_resolution_left'] = 1;
$graph->parameter['y_decimal_left'] = 0;
$graph->parameter['x_axis_angle'] = 20;
$graph->parameter['shadow'] = 'none';
$graph->y_tick_labels = null;
$graph->offset_relation = null;
$graph->draw_stack();
break;
case "multiquestion.png":
$question = $DB->get_record("survey_questions", array("id" => $qid));
$question->text = get_string($question->text, "survey");
$question->options = get_string($question->options, "survey");
$options = explode(",", $question->options);
$questionorder = explode(",", $question->multi);
$qqq = $DB->get_records_list("survey_questions", "id", explode(',', $question->multi));
foreach ($questionorder as $i => $val) {
$names[$i] = get_string($qqq["$val"]->shorttext, "survey");
$buckets1[$i] = 0;
$buckets2[$i] = 0;
$count1[$i] = 0;
$count2[$i] = 0;
$indexof[$val] = $i;
$stdev1[$i] = 0;
$stdev2[$i] = 0;
}
$aaa = $DB->get_records_select("survey_answers", "((survey = ?) AND (question in ($question->multi)))",
array($cm->instance));
if ($aaa) {
foreach ($aaa as $a) {
if (!$group or isset($users[$a->userid])) {
$index = $indexof[$a->question];
if ($a->answer1) {
$buckets1[$index] += $a->answer1;
$count1[$index]++;
}
if ($a->answer2) {
$buckets2[$index] += $a->answer2;
$count2[$index]++;
}
}
}
}
foreach ($questionorder as $i => $val) {
if ($count1[$i]) {
$buckets1[$i] = (float) $buckets1[$i] / (float) $count1[$i];
}
if ($count2[$i]) {
$buckets2[$i] = (float) $buckets2[$i] / (float) $count2[$i];
}
}
if ($aaa) {
foreach ($aaa as $a) {
if (!$group or isset($users[$a->userid])) {
$index = $indexof[$a->question];
if ($a->answer1) {
$difference = (float) ($a->answer1 - $buckets1[$index]);
$stdev1[$index] += ($difference * $difference);
}
if ($a->answer2) {
$difference = (float) ($a->answer2 - $buckets2[$index]);
$stdev2[$index] += ($difference * $difference);
}
}
}
}
foreach ($questionorder as $i => $val) {
if ($count1[$i]) {
$stdev1[$i] = sqrt((float) $stdev1[$i] / ((float) $count1[$i]));
}
if ($count2[$i]) {
$stdev2[$i] = sqrt((float) $stdev2[$i] / ((float) $count2[$i]));
}
$buckets1[$i] = $buckets1[$i] - 1;
$buckets2[$i] = $buckets2[$i] - 1;
}
$maxbuckets1 = max($buckets1);
$maxbuckets2 = max($buckets2);
$graph = new graph($SURVEY_GWIDTH, $SURVEY_GHEIGHT);
$graph->parameter['title'] = "$question->text";
$graph->x_data = $names;
$graph->y_data['answers1'] = $buckets1;
$graph->y_format['answers1'] = array('colour' => 'ltblue', 'line' => 'line', 'point' => 'square',
'shadow_offset' => 4, 'legend' => $stractual);
$graph->y_data['answers2'] = $buckets2;
$graph->y_format['answers2'] = array('colour' => 'ltorange', 'line' => 'line', 'point' => 'square',
'shadow_offset' => 4, 'legend' => $strpreferred);
$graph->y_data['stdev1'] = $stdev1;
$graph->y_format['stdev1'] = array('colour' => 'ltltblue', 'bar' => 'fill',
'shadow_offset' => '4', 'legend' => 'none', 'bar_size' => 0.3);
$graph->y_data['stdev2'] = $stdev2;
$graph->y_format['stdev2'] = array('colour' => 'ltltorange', 'bar' => 'fill',
'shadow_offset' => '4', 'legend' => 'none', 'bar_size' => 0.2);
$graph->offset_relation['stdev1'] = 'answers1';
$graph->offset_relation['stdev2'] = 'answers2';
$graph->parameter['bar_size'] = 0.15;
$graph->parameter['legend'] = 'outside-top';
$graph->parameter['legend_border'] = 'black';
$graph->parameter['legend_offset'] = 4;
$graph->y_tick_labels = $options;
if (($maxbuckets1 > 0.0) && ($maxbuckets2 > 0.0)) {
$graph->y_order = array('stdev1', 'answers1', 'stdev2', 'answers2');
} else if ($maxbuckets1 > 0.0) {
$graph->y_order = array('stdev1', 'answers1');
} else {
$graph->y_order = array('stdev2', 'answers2');
}
$graph->parameter['y_max_left'] = count($options) - 1;
$graph->parameter['y_axis_gridlines'] = count($options);
$graph->parameter['y_resolution_left'] = 1;
$graph->parameter['y_decimal_left'] = 1;
$graph->parameter['x_axis_angle'] = 20;
$graph->draw();
break;
case "overall.png":
$qqq = $DB->get_records_list("survey_questions", "id", explode(',', $survey->questions));
foreach ($qqq as $key => $qq) {
if ($qq->multi) {
$qqq[$key]->text = get_string($qq->text, "survey");
$qqq[$key]->options = get_string($qq->options, "survey");
if ($qq->type < 0) {
$virtualscales = true;
}
}
}
foreach ($qqq as $qq) { // If any virtual, then use JUST virtual, else use JUST nonvirtual.
if ($qq->multi) {
if ($virtualscales && $qq->type < 0) {
$question[] = $qq;
} else if (!$virtualscales && $qq->type > 0) {
$question[] = $qq;
}
}
}
$numquestions = count($question);
$options = explode(",", $question[0]->options);
$numoptions = count($options);
for ($i = 0; $i < $numquestions; $i++) {
$names[$i] = $question[$i]->text;
$buckets1[$i] = 0.0;
$buckets2[$i] = 0.0;
$stdev1[$i] = 0.0;
$stdev2[$i] = 0.0;
$count1[$i] = 0;
$count2[$i] = 0;
$subquestions = $question[$i]->multi; // Otherwise next line doesn't work.
$aaa = $DB->get_records_select("survey_answers", "((survey = ?) AND (question in ($subquestions)))",
array($cm->instance));
if ($aaa) {
foreach ($aaa as $a) {
if (!$group or isset($users[$a->userid])) {
if ($a->answer1) {
$buckets1[$i] += $a->answer1;
$count1[$i]++;
}
if ($a->answer2) {
$buckets2[$i] += $a->answer2;
$count2[$i]++;
}
}
}
}
if ($count1[$i]) {
$buckets1[$i] = (float) $buckets1[$i] / (float) $count1[$i];
}
if ($count2[$i]) {
$buckets2[$i] = (float) $buckets2[$i] / (float) $count2[$i];
}
// Calculate the standard devaiations.
if ($aaa) {
foreach ($aaa as $a) {
if (!$group or isset($users[$a->userid])) {
if ($a->answer1) {
$difference = (float) ($a->answer1 - $buckets1[$i]);
$stdev1[$i] += ($difference * $difference);
}
if ($a->answer2) {
$difference = (float) ($a->answer2 - $buckets2[$i]);
$stdev2[$i] += ($difference * $difference);
}
}
}
}
if ($count1[$i]) {
$stdev1[$i] = sqrt((float) $stdev1[$i] / ((float) $count1[$i]));
}
if ($count2[$i]) {
$stdev2[$i] = sqrt((float) $stdev2[$i] / ((float) $count2[$i]));
}
$buckets1[$i] = $buckets1[$i] - 1; // Hack because there should not be ANY 0 values in the data.
$buckets2[$i] = $buckets2[$i] - 1;
}
$maxbuckets1 = max($buckets1);
$maxbuckets2 = max($buckets2);
$graph = new graph($SURVEY_GWIDTH, $SURVEY_GHEIGHT);
$graph->parameter['title'] = strip_tags(format_string($survey->name, true));
$graph->x_data = $names;
$graph->y_data['answers1'] = $buckets1;
$graph->y_format['answers1'] = array('colour' => 'ltblue', 'line' => 'line', 'point' => 'square',
'shadow_offset' => 4, 'legend' => $stractual);
$graph->y_data['answers2'] = $buckets2;
$graph->y_format['answers2'] = array('colour' => 'ltorange', 'line' => 'line', 'point' => 'square',
'shadow_offset' => 4, 'legend' => $strpreferred);
$graph->y_data['stdev1'] = $stdev1;
$graph->y_format['stdev1'] = array('colour' => 'ltltblue', 'bar' => 'fill',
'shadow_offset' => '4', 'legend' => 'none', 'bar_size' => 0.3);
$graph->y_data['stdev2'] = $stdev2;
$graph->y_format['stdev2'] = array('colour' => 'ltltorange', 'bar' => 'fill',
'shadow_offset' => '4', 'legend' => 'none', 'bar_size' => 0.2);
$graph->offset_relation['stdev1'] = 'answers1';
$graph->offset_relation['stdev2'] = 'answers2';
$graph->parameter['legend'] = 'outside-top';
$graph->parameter['legend_border'] = 'black';
$graph->parameter['legend_offset'] = 4;
$graph->y_tick_labels = $options;
if (($maxbuckets1 > 0.0) && ($maxbuckets2 > 0.0)) {
$graph->y_order = array('stdev1', 'answers1', 'stdev2', 'answers2');
} else if ($maxbuckets1 > 0.0) {
$graph->y_order = array('stdev1', 'answers1');
} else {
$graph->y_order = array('stdev2', 'answers2');
}
$graph->parameter['y_max_left'] = $numoptions - 1;
$graph->parameter['y_axis_gridlines'] = $numoptions;
$graph->parameter['y_resolution_left'] = 1;
$graph->parameter['y_decimal_left'] = 1;
$graph->parameter['x_axis_angle'] = 0;
$graph->parameter['x_inner_padding'] = 6;
$graph->draw();
break;
case "student.png":
$qqq = $DB->get_records_list("survey_questions", "id", explode(',', $survey->questions));
foreach ($qqq as $key => $qq) {
if ($qq->multi) {
$qqq[$key]->text = get_string($qq->text, "survey");
$qqq[$key]->options = get_string($qq->options, "survey");
if ($qq->type < 0) {
$virtualscales = true;
}
}
}
foreach ($qqq as $qq) { // If any virtual, then use JUST virtual, else use JUST nonvirtual.
if ($qq->multi) {
if ($virtualscales && $qq->type < 0) {
$question[] = $qq;
} else if (!$virtualscales && $qq->type > 0) {
$question[] = $qq;
}
}
}
$numquestions = count($question);
$options = explode(",", $question[0]->options);
$numoptions = count($options);
for ($i = 0; $i < $numquestions; $i++) {
$names[$i] = $question[$i]->text;
$buckets1[$i] = 0.0;
$buckets2[$i] = 0.0;
$count1[$i] = 0;
$count2[$i] = 0;
$studbuckets1[$i] = 0.0;
$studbuckets2[$i] = 0.0;
$studcount1[$i] = 0;
$studcount2[$i] = 0;
$stdev1[$i] = 0.0;
$stdev2[$i] = 0.0;
$subquestions = $question[$i]->multi; // Otherwise next line doesn't work.
$aaa = $DB->get_records_select("survey_answers", "((survey = ?) AND (question in ($subquestions)))",
array($cm->instance));
if ($aaa) {
foreach ($aaa as $a) {
if (!$group or isset($users[$a->userid])) {
if ($a->userid == $sid) {
if ($a->answer1) {
$studbuckets1[$i] += $a->answer1;
$studcount1[$i]++;
}
if ($a->answer2) {
$studbuckets2[$i] += $a->answer2;
$studcount2[$i]++;
}
}
if ($a->answer1) {
$buckets1[$i] += $a->answer1;
$count1[$i]++;
}
if ($a->answer2) {
$buckets2[$i] += $a->answer2;
$count2[$i]++;
}
}
}
}
if ($count1[$i]) {
$buckets1[$i] = (float) $buckets1[$i] / (float) $count1[$i];
}
if ($count2[$i]) {
$buckets2[$i] = (float) $buckets2[$i] / (float) $count2[$i];
}
if ($studcount1[$i]) {
$studbuckets1[$i] = (float) $studbuckets1[$i] / (float) $studcount1[$i];
}
if ($studcount2[$i]) {
$studbuckets2[$i] = (float) $studbuckets2[$i] / (float) $studcount2[$i];
}
// Calculate the standard devaiations.
foreach ($aaa as $a) {
if (!$group or isset($users[$a->userid])) {
if ($a->answer1) {
$difference = (float) ($a->answer1 - $buckets1[$i]);
$stdev1[$i] += ($difference * $difference);
}
if ($a->answer2) {
$difference = (float) ($a->answer2 - $buckets2[$i]);
$stdev2[$i] += ($difference * $difference);
}
}
}
if ($count1[$i]) {
$stdev1[$i] = sqrt((float) $stdev1[$i] / ((float) $count1[$i]));
}
if ($count2[$i]) {
$stdev2[$i] = sqrt((float) $stdev2[$i] / ((float) $count2[$i]));
}
$buckets1[$i] = $buckets1[$i] - 1; // Hack because there should not be ANY 0 values in the data.
$buckets2[$i] = $buckets2[$i] - 1;
$studbuckets1[$i] = $studbuckets1[$i] - 1;
$studbuckets2[$i] = $studbuckets2[$i] - 1;
}
$maxbuckets1 = max($buckets1);
$maxbuckets2 = max($buckets2);
$graph = new graph($SURVEY_GWIDTH, $SURVEY_GHEIGHT);
$graph->parameter['title'] = strip_tags(format_string($survey->name, true));
$graph->x_data = $names;
$graph->y_data['answers1'] = $buckets1;
$graph->y_format['answers1'] = array('colour' => 'ltblue', 'line' => 'line', 'point' => 'square',
'shadow_offset' => 0.1, 'legend' => $stractualclass);
$graph->y_data['answers2'] = $buckets2;
$graph->y_format['answers2'] = array('colour' => 'ltorange', 'line' => 'line', 'point' => 'square',
'shadow_offset' => 0.1, 'legend' => $strpreferredclass);
$graph->y_data['studanswers1'] = $studbuckets1;
$graph->y_format['studanswers1'] = array('colour' => 'blue', 'line' => 'line', 'point' => 'square',
'shadow_offset' => 4, 'legend' => $stractualstudent);
$graph->y_data['studanswers2'] = $studbuckets2;
$graph->y_format['studanswers2'] = array('colour' => 'orange', 'line' => 'line', 'point' => 'square',
'shadow_offset' => 4, 'legend' => $strpreferredstudent);
$graph->y_data['stdev1'] = $stdev1;
$graph->y_format['stdev1'] = array('colour' => 'ltltblue', 'bar' => 'fill',
'shadow_offset' => 0.1, 'legend' => 'none', 'bar_size' => 0.3);
$graph->y_data['stdev2'] = $stdev2;
$graph->y_format['stdev2'] = array('colour' => 'ltltorange', 'bar' => 'fill',
'shadow_offset' => 0.1, 'legend' => 'none', 'bar_size' => 0.2);
$graph->offset_relation['stdev1'] = 'answers1';
$graph->offset_relation['stdev2'] = 'answers2';
$graph->y_tick_labels = $options;
$graph->parameter['bar_size'] = 0.15;
$graph->parameter['legend'] = 'outside-top';
$graph->parameter['legend_border'] = 'black';
$graph->parameter['legend_offset'] = 4;
if (($maxbuckets1 > 0.0) && ($maxbuckets2 > 0.0)) {
$graph->y_order = array('stdev1', 'stdev2', 'answers1', 'answers2', 'studanswers1', 'studanswers2');
} else if ($maxbuckets1 > 0.0) {
$graph->y_order = array('stdev1', 'answers1', 'studanswers1');
} else {
$graph->y_order = array('stdev2', 'answers2', 'studanswers2');
}
$graph->parameter['y_max_left'] = $numoptions - 1;
$graph->parameter['y_axis_gridlines'] = $numoptions;
$graph->parameter['y_resolution_left'] = 1;
$graph->parameter['y_decimal_left'] = 1;
$graph->parameter['x_axis_angle'] = 20;
$graph->draw();
break;
case "studentmultiquestion.png":
$question = $DB->get_record("survey_questions", array("id" => $qid));
$question->text = get_string($question->text, "survey");
$question->options = get_string($question->options, "survey");
$options = explode(",", $question->options);
$questionorder = explode(",", $question->multi);
$qqq = $DB->get_records_list("survey_questions", "id", explode(',', $question->multi));
foreach ($questionorder as $i => $val) {
$names[$i] = get_string($qqq[$val]->shorttext, "survey");
$buckets1[$i] = 0;
$buckets2[$i] = 0;
$count1[$i] = 0;
$count2[$i] = 0;
$indexof[$val] = $i;
$studbuckets1[$i] = 0.0;
$studbuckets2[$i] = 0.0;
$studcount1[$i] = 0;
$studcount2[$i] = 0;
$stdev1[$i] = 0.0;
$stdev2[$i] = 0.0;
}
$aaa = $DB->get_records_select("survey_answers", "((survey = ?) AND (question in ($question->multi)))",
array($cm->instance));
if ($aaa) {
foreach ($aaa as $a) {
if (!$group or isset($users[$a->userid])) {
$index = $indexof[$a->question];
if ($a->userid == $sid) {
if ($a->answer1) {
$studbuckets1[$index] += $a->answer1;
$studcount1[$index]++;
}
if ($a->answer2) {
$studbuckets2[$index] += $a->answer2;
$studcount2[$index]++;
}
}
if ($a->answer1) {
$buckets1[$index] += $a->answer1;
$count1[$index]++;
}
if ($a->answer2) {
$buckets2[$index] += $a->answer2;
$count2[$index]++;
}
}
}
}
foreach ($questionorder as $i => $val) {
if ($count1[$i]) {
$buckets1[$i] = (float) $buckets1[$i] / (float) $count1[$i];
}
if ($count2[$i]) {
$buckets2[$i] = (float) $buckets2[$i] / (float) $count2[$i];
}
if ($studcount1[$i]) {
$studbuckets1[$i] = (float) $studbuckets1[$i] / (float) $studcount1[$i];
}
if ($studcount2[$i]) {
$studbuckets2[$i] = (float) $studbuckets2[$i] / (float) $studcount2[$i];
}
}
foreach ($aaa as $a) {
if (!$group or isset($users[$a->userid])) {
$index = $indexof[$a->question];
if ($a->answer1) {
$difference = (float) ($a->answer1 - $buckets1[$index]);
$stdev1[$index] += ($difference * $difference);
}
if ($a->answer2) {
$difference = (float) ($a->answer2 - $buckets2[$index]);
$stdev2[$index] += ($difference * $difference);
}
}
}
foreach ($questionorder as $i => $val) {
if ($count1[$i]) {
$stdev1[$i] = sqrt((float) $stdev1[$i] / ((float) $count1[$i]));
}
if ($count2[$i]) {
$stdev2[$i] = sqrt((float) $stdev2[$i] / ((float) $count2[$i]));
}
$buckets1[$i] = $buckets1[$i] - 1; // Hack because there should not be ANY 0 values in the data.
$buckets2[$i] = $buckets2[$i] - 1;
$studbuckets1[$i] = $studbuckets1[$i] - 1;
$studbuckets2[$i] = $studbuckets2[$i] - 1;
}
$maxbuckets1 = max($buckets1);
$maxbuckets2 = max($buckets2);
$graph = new graph($SURVEY_GWIDTH, $SURVEY_GHEIGHT);
$graph->parameter['title'] = "$question->text";
$graph->x_data = $names;
$graph->y_data['answers1'] = $buckets1;
$graph->y_format['answers1'] = array('colour' => 'ltblue', 'line' => 'line', 'point' => 'square',
'shadow_offset' => 0.1, 'legend' => $stractualclass);
$graph->y_data['answers2'] = $buckets2;
$graph->y_format['answers2'] = array('colour' => 'ltorange', 'line' => 'line', 'point' => 'square',
'shadow_offset' => 0.1, 'legend' => $strpreferredclass);
$graph->y_data['studanswers1'] = $studbuckets1;
$graph->y_format['studanswers1'] = array('colour' => 'blue', 'line' => 'line', 'point' => 'square',
'shadow_offset' => 4, 'legend' => $stractualstudent);
$graph->y_data['studanswers2'] = $studbuckets2;
$graph->y_format['studanswers2'] = array('colour' => 'orange', 'line' => 'line', 'point' => 'square',
'shadow_offset' => 4, 'legend' => $strpreferredstudent);
$graph->y_data['stdev1'] = $stdev1;
$graph->y_format['stdev1'] = array('colour' => 'ltltblue', 'bar' => 'fill',
'shadow_offset' => 0.1, 'legend' => 'none', 'bar_size' => 0.3);
$graph->y_data['stdev2'] = $stdev2;
$graph->y_format['stdev2'] = array('colour' => 'ltltorange', 'bar' => 'fill',
'shadow_offset' => 0.1, 'legend' => 'none', 'bar_size' => 0.2);
$graph->offset_relation['stdev1'] = 'answers1';
$graph->offset_relation['stdev2'] = 'answers2';
$graph->parameter['bar_size'] = 0.15;
$graph->parameter['legend'] = 'outside-top';
$graph->parameter['legend_border'] = 'black';
$graph->parameter['legend_offset'] = 4;
$graph->y_tick_labels = $options;
if (($maxbuckets1 > 0.0) && ($maxbuckets2 > 0.0)) {
$graph->y_order = array('stdev1', 'stdev2', 'answers1', 'answers2', 'studanswers1', 'studanswers2');
} else if ($maxbuckets1 > 0.0) {
$graph->y_order = array('stdev1', 'answers1', 'studanswers1');
} else {
$graph->y_order = array('stdev2', 'answers2', 'studanswers2');
}
$graph->parameter['y_max_left'] = count($options) - 1;
$graph->parameter['y_axis_gridlines'] = count($options);
$graph->parameter['y_resolution_left'] = 1;
$graph->parameter['y_decimal_left'] = 1;
$graph->parameter['x_axis_angle'] = 20;
$graph->draw();
break;
default:
break;
}
exit;

91
mod/survey/index.php
View File

@ -1,91 +0,0 @@
<?php
require_once("../../config.php");
require_once("lib.php");
$id = required_param('id', PARAM_INT); // Course Module ID
$PAGE->set_url('/mod/survey/index.php', array('id'=>$id));
if (!$course = $DB->get_record('course', array('id'=>$id))) {
throw new \moodle_exception('invalidcourseid');
}
require_course_login($course);
$PAGE->set_pagelayout('incourse');
$params = array(
'context' => context_course::instance($course->id),
'courseid' => $course->id
);
$event = \mod_survey\event\course_module_instance_list_viewed::create($params);
$event->trigger();
$strsurveys = get_string("modulenameplural", "survey");
$strname = get_string("name");
$strstatus = get_string("status");
$strdone = get_string("done", "survey");
$strnotdone = get_string("notdone", "survey");
$PAGE->navbar->add($strsurveys);
$PAGE->set_title($strsurveys);
$PAGE->set_heading($course->fullname);
echo $OUTPUT->header();
if (!$PAGE->has_secondary_navigation()) {
echo $OUTPUT->heading($strsurveys);
}
if (! $surveys = get_all_instances_in_course("survey", $course)) {
notice(get_string('thereareno', 'moodle', $strsurveys), "../../course/view.php?id=$course->id");
}
$usesections = course_format_uses_sections($course->format);
$table = new html_table();
if ($usesections) {
$strsectionname = course_get_format($course)->get_generic_section_name();
$table->head = array ($strsectionname, $strname, $strstatus);
} else {
$table->head = array ($strname, $strstatus);
}
$currentsection = '';
foreach ($surveys as $survey) {
if (isloggedin() and survey_already_done($survey->id, $USER->id)) {
$ss = $strdone;
} else {
$ss = $strnotdone;
}
$printsection = "";
if ($usesections) {
if ($survey->section !== $currentsection) {
if ($survey->section) {
$printsection = get_section_name($course, $survey->section);
}
if ($currentsection !== "") {
$table->data[] = 'hr';
}
$currentsection = $survey->section;
}
}
//Calculate the href
if (!$survey->visible) {
//Show dimmed if the mod is hidden
$tt_href = "<a class=\"dimmed\" href=\"view.php?id=$survey->coursemodule\">".format_string($survey->name,true)."</a>";
} else {
//Show normal if the mod is visible
$tt_href = "<a href=\"view.php?id=$survey->coursemodule\">".format_string($survey->name,true)."</a>";
}
if ($usesections) {
$table->data[] = array ($printsection, $tt_href, "<a href=\"view.php?id=$survey->coursemodule\">$ss</a>");
} else {
$table->data[] = array ($tt_href, "<a href=\"view.php?id=$survey->coursemodule\">$ss</a>");
}
}
echo "<br />";
echo html_writer::table($table);
echo $OUTPUT->footer();

283
mod/survey/lang/en/survey.php
View File

@ -1,283 +0,0 @@
<?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/>.
/**
* Strings for component 'survey', language 'en', branch 'MOODLE_20_STABLE'
*
* @package mod_survey
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
$string['actual'] = 'Actual';
$string['actualclass'] = 'Class actual';
$string['actualstudent'] = '{$a} actual';
$string['allscales'] = 'All scales, all students';
$string['alreadysubmitted'] = 'You have already submitted this survey';
$string['analysisof'] = 'Analysis of {$a}';
$string['answers'] = 'Answers';
$string['attlsintro'] = 'The purpose of this questionnaire is to help us evaluate your attitudes towards thinking and learning.
There are no \'right\' or \'wrong\' answers; we are interested only in your opinion. Please be assured that your responses will be treated with a high degree of confidentiality, and will not affect your assessment.';
$string['attlsmintro'] = 'In discussion ...';
$string['attlsm1'] = 'Attitudes Towards Thinking and Learning';
$string['attlsm2'] = 'Connected learning';
$string['attlsm3'] = 'Separate learning';
$string['attlsname'] = 'ATTLS (20 item version)';
$string['attls1'] = 'In evaluating what someone says, I focus on the quality of their argument, not on the person who\'s presenting it.';
$string['attls1short'] = 'focus quality of argument';
$string['attls10'] = 'It\'s important for me to remain as objective as possible when I analyze something.';
$string['attls10short'] = 'remain objective';
$string['attls11'] = 'I try to think with people instead of against them.';
$string['attls11short'] = 'think WITH people';
$string['attls12'] = 'I have certain criteria I use in evaluating arguments.';
$string['attls12short'] = 'use criteria to evaluate';
$string['attls13'] = 'I\'m more likely to try to understand someone else\'s opinion than to try to evaluate it.';
$string['attls13short'] = 'try to understand';
$string['attls14'] = 'I try to point out weaknesses in other people\'s thinking to help them clarify their arguments.';
$string['attls14short'] = 'point out weaknesses';
$string['attls15'] = 'I tend to put myself in other people\'s shoes when discussing controversial issues, to see why they think the way they do.';
$string['attls15short'] = 'put myself in their shoes';
$string['attls16'] = 'One could call my way of analysing things \'putting them on trial\' because I am careful to consider all the evidence.';
$string['attls16short'] = 'putting on trial';
$string['attls17'] = 'I value the use of logic and reason over the incorporation of my own concerns when solving problems.';
$string['attls17short'] = 'I value logic most';
$string['attls18'] = 'I can obtain insight into opinions that differ from mine through empathy.';
$string['attls18short'] = 'insight from empathy';
$string['attls19'] = 'When I encounter people whose opinions seem alien to me, I make a deliberate effort to \'extend\' myself into that person, to try to see how they could have those opinions.';
$string['attls19short'] = 'make effort to extend';
$string['attls2'] = 'I like playing devil\'s advocate - arguing the opposite of what someone is saying.';
$string['attls2short'] = 'play devil\'s advocate';
$string['attls20'] = 'I spend time figuring out what\'s \'wrong\' with things. For example, I\'ll look for something in a literary interpretation that isn\'t argued well enough.';
$string['attls20short'] = 'what\'s wrong?';
$string['attls3'] = 'I like to understand where other people are \'coming from\', what experiences have led them to feel the way they do.';
$string['attls3short'] = 'where people come from';
$string['attls4'] = 'The most important part of my education has been learning to understand people who are very different to me.';
$string['attls4short'] = 'understand different people';
$string['attls5'] = 'I feel that the best way for me to achieve my own identity is to interact with a variety of other people.';
$string['attls5short'] = 'interact with variety';
$string['attls6'] = 'I enjoy hearing the opinions of people who come from backgrounds different to mine - it helps me to understand how the same things can be seen in such different ways.';
$string['attls6short'] = 'enjoy hearing opinions';
$string['attls7'] = 'I find that I can strengthen my own position through arguing with someone who disagrees with me.';
$string['attls7short'] = 'strengthen by argue';
$string['attls8'] = 'I am always interested in knowing why people say and believe the things they do.';
$string['attls8short'] = 'know why people do';
$string['attls9'] = 'I often find myself arguing with the authors of books that I read, trying to logically figure out why they\'re wrong.';
$string['attls9short'] = 'argue with authors';
$string['cannotfindanswer'] = 'There are no answers for this survey yet.';
$string['cannotfindquestion'] = 'Question doesn\'t exist';
$string['cannotfindsurveytmpt'] = 'No survey templates found!';
$string['completiondetail:submit'] = 'Submit answers';
$string['completionsubmit'] = 'Make a submission';
$string['ciqintro'] = 'While thinking about recent events in this class, answer the questions below.';
$string['ciqname'] = 'Critical incidents';
$string['ciq1'] = 'At what moment in class were you most engaged as a learner?';
$string['ciq1short'] = 'Most engaged';
$string['ciq2'] = 'At what moment in class were you most distanced as a learner?';
$string['ciq2short'] = 'Most distanced';
$string['ciq3'] = 'What action from anyone in the forums did you find most affirming or helpful?';
$string['ciq3short'] = 'Helpful moment';
$string['ciq4'] = 'What action from anyone in the forums did you find most puzzling or confusing?';
$string['ciq4short'] = 'Confusing moment';
$string['ciq5'] = 'What event surprised you most?';
$string['ciq5short'] = 'Suprising moment';
$string['clicktocontinuecheck'] = 'Click here to check and continue';
$string['collesaintro'] = 'The purpose of this survey is to help us understand how well the online delivery of this unit enabled you to learn.
Each one of the 24 statements below asks about your experience in this unit.
There are no \'right\' or \'wrong\' answers; we are interested only in your opinion. Please be assured that your responses will be treated with a high degree of confidentiality, and will not affect your assessment.
Your carefully considered responses will help us improve the way this unit is presented online in the future.
Thanks very much.';
$string['collesaname'] = 'COLLES (Actual)';
$string['collesapintro'] = 'The purpose of this questionnaire is to help us understand how well the online delivery of this unit enabled you to learn.
Each couple of the 24 statements below asks you to compare your <b>preferred</b> (ideal) and <b>actual</b> experience in this unit.
There are no \'right\' or \'wrong\' answers; we are interested only in your opinion. Please be assured that your responses will be treated with a high degree of confidentiality, and will not affect your assessment.
Your carefully considered responses will help us improve the way this unit is presented online in the future.
Thanks very much.';
$string['collesapname'] = 'COLLES (Preferred and Actual)';
$string['collesmintro'] = 'In this online unit...';
$string['collesm1'] = 'Relevance';
$string['collesm1short'] = 'Relevance';
$string['collesm2'] = 'Reflective thinking';
$string['collesm2short'] = 'Reflective thinking';
$string['collesm3'] = 'Interactivity';
$string['collesm3short'] = 'Interactivity';
$string['collesm4'] = 'Tutor support';
$string['collesm4short'] = 'Tutor support';
$string['collesm5'] = 'Peer support';
$string['collesm5short'] = 'Peer support';
$string['collesm6'] = 'Interpretation';
$string['collesm6short'] = 'Interpretation';
$string['collespintro'] = 'The purpose of this survey is to help us understand what you value in an online learning experience.
Each one of the 24 statements below asks about your <b>preferred</b> (ideal) experience in this unit.
There are no \'right\' or \'wrong\' answers; we are interested only in your opinion. Please be assured that your responses will be treated with a high degree of confidentiality, and will not affect your assessment.
Your carefully considered responses will help us improve the way this unit is presented online in the future.
Thanks very much.';
$string['collespname'] = 'COLLES (Preferred)';
$string['colles1'] = 'my learning focuses on issues that interest me.';
$string['colles1short'] = 'focus on interesting issues';
$string['colles10'] = 'I ask other students to explain their ideas.';
$string['colles10short'] = 'I ask for explanations';
$string['colles11'] = 'other students ask me to explain my ideas.';
$string['colles11short'] = 'I\'m asked to explain';
$string['colles12'] = 'other students respond to my ideas.';
$string['colles12short'] = 'students respond to me';
$string['colles13'] = 'the tutor stimulates my thinking.';
$string['colles13short'] = 'tutor stimulates thinking';
$string['colles14'] = 'the tutor encourages me to participate.';
$string['colles14short'] = 'tutor encourages me';
$string['colles15'] = 'the tutor models good discourse.';
$string['colles15short'] = 'tutor models discourse';
$string['colles16'] = 'the tutor models critical self-reflection.';
$string['colles16short'] = 'tutor models self-reflection';
$string['colles17'] = 'other students encourage my participation.';
$string['colles17short'] = 'students encourage me';
$string['colles18'] = 'other students praise my contribution.';
$string['colles18short'] = 'students praise me';
$string['colles19'] = 'other students value my contribution.';
$string['colles19short'] = 'students value me';
$string['colles2'] = 'what I learn is important for my professional practice.';
$string['colles2short'] = 'important to my practice';
$string['colles20'] = 'other students empathise with my struggle to learn.';
$string['colles20short'] = 'students empathise';
$string['colles21'] = 'I make good sense of other students\' messages.';
$string['colles21short'] = 'I understand other students';
$string['colles22'] = 'other students make good sense of my messages.';
$string['colles22short'] = 'students understand me';
$string['colles23'] = 'I make good sense of the tutor\'s messages.';
$string['colles23short'] = 'I understand the tutor';
$string['colles24'] = 'the tutor makes good sense of my messages.';
$string['colles24short'] = 'tutor understands me';
$string['colles3'] = 'I learn how to improve my professional practice.';
$string['colles3short'] = 'improve my practice';
$string['colles4'] = 'what I learn connects well with my professional practice.';
$string['colles4short'] = 'connects with my practice';
$string['colles5'] = 'I think critically about how I learn.';
$string['colles5short'] = 'I\'m critical of my learning';
$string['colles6'] = 'I think critically about my own ideas.';
$string['colles6short'] = 'I\'m critical of my own ideas';
$string['colles7'] = 'I think critically about other students\' ideas.';
$string['colles7short'] = 'I\'m critical of other students';
$string['colles8'] = 'I think critically about ideas in the readings.';
$string['colles8short'] = 'I\'m critical of readings';
$string['colles9'] = 'I explain my ideas to other students.';
$string['colles9short'] = 'I explain my ideas';
$string['customintro'] = 'Description';
$string['deleteallanswers'] = 'All survey responses';
$string['deleteanalysis'] = 'Response analysis';
$string['done'] = 'Done';
$string['download'] = 'Download';
$string['downloadexcel'] = 'Download data as Excel spreadsheet';
$string['downloadinfo'] = 'You can download the complete raw data for this survey in a form suitable for analysis in Excel, SPSS or other package.';
$string['downloadresults'] = 'Download results';
$string['downloadtext'] = 'Download data as a plain text file';
$string['editingasurvey'] = 'Editing a survey';
$string['errorunabletosavenotes'] = 'An error occurred while saving your notes.';
$string['eventreportdownloaded'] = 'Survey report downloaded';
$string['eventreportviewed'] = 'Survey report viewed';
$string['eventresponsesubmitted'] = 'Survey response submitted';
$string['guestsnotallowed'] = 'Only enrolled users are able to submit surveys';
$string['howlong'] = 'How long did this survey take you to complete?';
$string['howlongoptions'] = 'under 1 min,1-2 min,2-3 min,3-4 min,4-5-min,5-10 min,more than 10';
$string['ifoundthat'] = 'I found that';
$string['indicator:cognitivedepth'] = 'Survey cognitive';
$string['indicator:cognitivedepth_help'] = 'This indicator is based on the cognitive depth reached by the student in a Survey activity.';
$string['indicator:cognitivedepthdef'] = 'Survey cognitive';
$string['indicator:cognitivedepthdef_help'] = 'The participant has reached this percentage of the cognitive engagement offered by the Survey activities during this analysis interval (Levels = No view, View, Submit)';
$string['indicator:cognitivedepthdef_link'] = 'Learning_analytics_indicators#Cognitive_depth';
$string['indicator:socialbreadth'] = 'Survey social';
$string['indicator:socialbreadth_help'] = 'This indicator is based on the social breadth reached by the student in a Survey activity.';
$string['indicator:socialbreadthdef'] = 'Survey social';
$string['indicator:socialbreadthdef_help'] = 'The participant has reached this percentage of the social engagement offered by the Survey activities during this analysis interval (Levels = No participation, Participant alone)';
$string['indicator:socialbreadthdef_link'] = 'Learning_analytics_indicators#Social_breadth';
$string['introtext'] = 'Introduction text';
$string['invalidsurveyid'] = 'Survey ID was incorrect';
$string['invalidtmptid'] = 'Invalid template id';
$string['ipreferthat'] = 'I prefer that';
$string['modulename'] = 'Survey';
$string['modulename_help'] = 'The survey activity module provides a number of verified survey instruments that have been found useful in assessing and stimulating learning in online environments. A teacher can use these to gather data from their students that will help them learn about their class and reflect on their own teaching.
Note that these survey tools are pre-populated with questions. Teachers who wish to create their own survey should use the feedback activity module.';
$string['modulename_link'] = 'mod/survey/view';
$string['modulenameplural'] = 'Surveys';
$string['name'] = 'Name';
$string['newsurveyresponses'] = 'New survey responses';
$string['nobodyyet'] = 'Nobody has yet completed this survey';
$string['notdone'] = 'Not done yet';
$string['notes'] = 'Your private analysis and notes';
$string['othercomments'] = 'Do you have any other comments?';
$string['page-mod-survey-x'] = 'Any survey module page';
$string['peoplecompleted'] = '{$a} people have completed this survey so far';
$string['pluginadministration'] = 'Survey administration';
$string['pluginname'] = 'Survey';
$string['preferred'] = 'Preferred';
$string['preferredclass'] = 'Class preferred';
$string['preferredstudent'] = '{$a} preferred';
$string['privacy:metadata:analysis'] = 'A record of survey answers analysis.';
$string['privacy:metadata:analysis:notes'] = 'Notes saved against a user\'s answers.';
$string['privacy:metadata:analysis:userid'] = 'The ID of the user answering the survey.';
$string['privacy:metadata:answers'] = 'A collection of answers to surveys.';
$string['privacy:metadata:answers:answer1'] = 'Field to store the answer to a question.';
$string['privacy:metadata:answers:answer2'] = 'Additional field to store the answer to a question.';
$string['privacy:metadata:answers:question'] = 'The question.';
$string['privacy:metadata:answers:time'] = 'The time when the answer was posted.';
$string['privacy:metadata:answers:userid'] = 'The ID of the user who submitted their answer.';
$string['question'] = 'Question';
$string['questions'] = 'Questions';
$string['questionsnotanswered'] = 'Some of the multiple choice questions have not been answered.';
$string['report'] = 'Survey report';
$string['responsereports'] = 'Response reports';
$string['responses'] = 'Responses';
$string['savednotes'] = 'Your notes were saved';
$string['scaleagree5'] = 'Strongly disagree,Somewhat disagree,Neither agree nor disagree,Somewhat agree,Strongly agree';
$string['scales'] = 'Scales';
$string['scaletimes5'] = 'Almost never,Seldom,Sometimes,Often,Almost always';
$string['search:activity'] = 'Survey - activity information';
$string['seemoredetail'] = 'Click here to see more detail';
$string['selectedquestions'] = 'Selected questions from a scale, all students';
$string['summary'] = 'Summary';
$string['survey:addinstance'] = 'Add a new survey';
$string['surveycompleted'] = 'You\'ve completed this survey. The graph below shows a summary of your results compared to the class averages.';
$string['surveycompletednograph'] = 'You have completed this survey.';
$string['survey:download'] = 'Download responses';
$string['surveygraph'] = 'Survey graph';
$string['surveyname'] = 'Survey name';
$string['survey:participate'] = 'Respond to survey';
$string['survey:readresponses'] = 'View responses';
$string['surveysaved'] = 'Survey saved';
$string['surveytype'] = 'Survey type';
$string['surveytype_help'] = 'There are 3 available survey types:
* Attitudes to Thinking and Learning Survey (ATTLS) - For measuring the extent to which a person is a \'connected knower\' (tends to find learning more enjoyable, and is often more cooperative, congenial and more willing to build on the ideas of others) or a \'separate knower\' (tends to take a more critical and argumentative stance to learning)
* Critical incidents survey
* Constructivist On-line Learning Environment Survey (COLLES) - For monitoring the extent to which the interactive capacity of the World Wide Web may be exploited for engaging students in dynamic learning practices';
$string['surveytype_link'] = 'mod/survey/mod';
$string['thanksforanswers'] = 'Thanks for answering this survey, {$a}';
$string['time'] = 'Time';
$string['notyetanswered'] = 'Not yet answered';
$string['allquestionrequireanswer'] = 'All questions are required and must be answered.';

1193
mod/survey/lib.php
View File

File diff suppressed because it is too large Load Diff

93
mod/survey/mod_form.php
View File

@ -1,93 +0,0 @@
<?php
if (!defined('MOODLE_INTERNAL')) {
die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page
}
require_once ($CFG->dirroot.'/course/moodleform_mod.php');
class mod_survey_mod_form extends moodleform_mod {
function definition() {
global $CFG, $DB;
$mform =& $this->_form;
$strrequired = get_string('required');
//-------------------------------------------------------------------------------
$mform->addElement('header', 'general', get_string('general', 'form'));
$mform->addElement('text', 'name', get_string('name'), array('size'=>'64'));
if (!empty($CFG->formatstringstriptags)) {
$mform->setType('name', PARAM_TEXT);
} else {
$mform->setType('name', PARAM_CLEANHTML);
}
$mform->addRule('name', null, 'required', null, 'client');
if (!$options = $DB->get_records_menu("survey", array("template"=>0), "name", "id, name")) {
throw new \moodle_exception('cannotfindsurveytmpt', 'survey');
}
foreach ($options as $id => $name) {
$options[$id] = get_string($name, "survey");
}
$options = array(''=>get_string('choose').'...') + $options;
$mform->addElement('select', 'template', get_string("surveytype", "survey"), $options);
$mform->addRule('template', $strrequired, 'required', null, 'client');
$mform->addHelpButton('template', 'surveytype', 'survey');
$this->standard_intro_elements(get_string('customintro', 'survey'));
$this->standard_coursemodule_elements();
//-------------------------------------------------------------------------------
// buttons
$this->add_action_buttons();
}
/**
* Allows module to modify the data returned by form get_data().
* This method is also called in the bulk activity completion form.
*
* Only available on moodleform_mod.
*
* @param stdClass $data the form data to be modified.
*/
public function data_postprocessing($data) {
parent::data_postprocessing($data);
if (!empty($data->completionunlocked)) {
// Turn off completion settings if the checkboxes aren't ticked.
$suffix = $this->get_suffix();
$completion = $data->{'completion' . $suffix};
$autocompletion = !empty($completion) && $completion == COMPLETION_TRACKING_AUTOMATIC;
if (!$autocompletion || empty($data->{'completionsubmit' . $suffix})) {
$data->{'completionsubmit' . $suffix} = 0;
}
}
}
/**
* Add completion rules to form.
* @return array
*/
public function add_completion_rules() {
$mform =& $this->_form;
$suffix = $this->get_suffix();
$completionsubmitel = 'completionsubmit' . $suffix;
$mform->addElement('checkbox', $completionsubmitel, '', get_string('completionsubmit', 'survey'));
// Enable this completion rule by default.
$mform->setDefault($completionsubmitel, 1);
return [$completionsubmitel];
}
/**
* Enable completion rules
* @param array $data
* @return bool
*/
public function completion_rule_enabled($data) {
$suffix = $this->get_suffix();
return !empty($data['completionsubmit' . $suffix]);
}
}

3
mod/survey/pix/monologo.svg
View File

@ -1,3 +0,0 @@
<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" preserveAspectRatio="xMinYMid meet">
<path fill-rule="evenodd" clip-rule="evenodd" d="M5.49902 4C4.11831 4 2.99902 5.11929 2.99902 6.5V17.5C2.99902 18.8807 4.11831 20 5.49902 20H18.5007C19.8814 20 21.0007 18.8807 21.0007 17.5V6.5C21.0007 5.11929 19.8814 4 18.5007 4H5.49902ZM3.99902 6.5C3.99902 5.67157 4.6706 5 5.49902 5H18.5007C19.3292 5 20.0007 5.67157 20.0007 6.5V17.5C20.0007 18.3284 19.3292 19 18.5007 19H5.49902C4.6706 19 3.99902 18.3284 3.99902 17.5V6.5ZM10.666 7.50439C10.666 7.22825 10.4422 7.00439 10.166 7.00439C9.88987 7.00439 9.66602 7.22825 9.66602 7.50439L9.66602 16.5048C9.66602 16.7809 9.88987 17.0048 10.166 17.0048C10.4422 17.0048 10.666 16.7809 10.666 16.5048L10.666 7.50439ZM13.8354 8.98486C14.1116 8.98486 14.3354 9.20872 14.3354 9.48486V16.5048C14.3354 16.7809 14.1116 17.0048 13.8354 17.0048C13.5593 17.0048 13.3354 16.7809 13.3354 16.5048V9.48486C13.3354 9.20872 13.5593 8.98486 13.8354 8.98486ZM6.49707 11.8684C6.77321 11.8684 6.99707 12.0923 6.99707 12.3684L6.99707 16.5049C6.99707 16.781 6.77321 17.0049 6.49707 17.0049C6.22093 17.0049 5.99707 16.781 5.99707 16.5049L5.99707 12.3684C5.99707 12.0923 6.22093 11.8684 6.49707 11.8684ZM17.5044 11.0005C17.7805 11.0005 18.0044 11.2243 18.0044 11.5005V16.5005C18.0044 16.7766 17.7805 17.0005 17.5044 17.0005C17.2283 17.0005 17.0044 16.7766 17.0044 16.5005V11.5005C17.0044 11.2243 17.2283 11.0005 17.5044 11.0005Z" fill="#212529"/>
</svg>
Side by Side

Before

Width:  |  Height:  |  Size: 1.5 KiB

39
mod/survey/renderer.php
View File

@ -1,39 +0,0 @@
<?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/>.
/**
* Output the actionbar for this activity.
*
* @package mod_survey
* @copyright 2021 Sujith Haridasan <sujith@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
/**
* Renderer for the mod_survey tertiary nav
*/
class mod_survey_renderer extends plugin_renderer_base {
/**
* Renders the action bar for the mod_survey report page.
*
* @param \mod_survey\output\actionbar $actionbar Data for the template
* @return bool|string rendered HTML string from the template.
*/
public function response_actionbar(\mod_survey\output\actionbar $actionbar) {
return $this->render_from_template('mod_survey/response_action_bar', $actionbar->export_for_template($this));
}
}

526
mod/survey/report.php
View File

@ -1,526 +0,0 @@
<?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/>.
/**
* This file is responsible for producing the survey reports
*
* @package mod_survey
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
require_once("../../config.php");
require_once("lib.php");
// Check that all the parameters have been provided.
$id = required_param('id', PARAM_INT); // Course Module ID.
$action = optional_param('action', '', PARAM_ALPHA); // What to look at.
$qid = optional_param('qid', 0, PARAM_RAW); // Question IDs comma-separated list.
$student = optional_param('student', 0, PARAM_INT); // Student ID.
$notes = optional_param('notes', '', PARAM_RAW); // Save teachers notes.
$qids = explode(',', $qid);
$qids = clean_param_array($qids, PARAM_INT);
$qid = implode(',', $qids);
if (!$cm = get_coursemodule_from_id('survey', $id)) {
throw new moodle_exception('invalidcoursemodule');
}
if (!$course = $DB->get_record("course", array("id" => $cm->course))) {
throw new moodle_exception('coursemisconf');
}
$url = new moodle_url('/mod/survey/report.php', array('id' => $id));
if ($action !== '') {
$url->param('action', $action);
}
if ($qid !== 0) {
$url->param('qid', $qid);
}
if ($student !== 0) {
$url->param('student', $student);
}
if ($notes !== '') {
$url->param('notes', $notes);
}
$PAGE->set_url($url);
require_login($course, false, $cm);
$context = context_module::instance($cm->id);
require_capability('mod/survey:readresponses', $context);
if (!$survey = $DB->get_record("survey", array("id" => $cm->instance))) {
throw new moodle_exception('invalidsurveyid', 'survey');
}
if (!$template = $DB->get_record("survey", array("id" => $survey->template))) {
throw new moodle_exception('invalidtmptid', 'survey');
}
$showscales = ($template->name != 'ciqname');
$strreport = get_string("report", "survey");
$strsurvey = get_string("modulename", "survey");
$strsurveys = get_string("modulenameplural", "survey");
$strsummary = get_string("summary", "survey");
$strscales = get_string("scales", "survey");
$strquestion = get_string("question", "survey");
$strquestions = get_string("questions", "survey");
$strdownload = get_string("download", "survey");
$strallscales = get_string("allscales", "survey");
$strselectedquestions = get_string("selectedquestions", "survey");
$strseemoredetail = get_string("seemoredetail", "survey");
$strnotes = get_string("notes", "survey");
$PAGE->set_title("$course->shortname: " . format_string($survey->name));
$PAGE->set_heading($course->fullname);
$PAGE->activityheader->set_attrs([
'hidecompletion' => true,
'description' => ''
]);
// Activate the secondary nav tab.
navigation_node::override_active_url(new moodle_url('/mod/survey/report.php', ['id' => $id, 'action' => 'summary']));
$actionbar = new \mod_survey\output\actionbar($id, $action, $url);
echo $OUTPUT->header();
$renderer = $PAGE->get_renderer('mod_survey');
echo $renderer->response_actionbar($actionbar);
// Check to see if groups are being used in this survey.
$groupmode = groups_get_activity_groupmode($cm);
if ($groupmode != NOGROUPS) {
$menuaction = $action == "student" ? "students" : $action;
// Get the current activity group, confirm user can access.
$currentgroup = groups_get_activity_group($cm, true);
if ($currentgroup === 0 && $groupmode == SEPARATEGROUPS && !has_capability('moodle/site:accessallgroups', $context)) {
throw new moodle_exception('notingroup');
}
$groupsactivitymenu = groups_print_activity_menu($cm, new moodle_url('/mod/survey/report.php',
['id' => $cm->id, 'action' => $menuaction, 'qid' => $qid]), true);
} else {
$currentgroup = 0;
$groupsactivitymenu = null;
}
$params = array(
'objectid' => $survey->id,
'context' => $context,
'courseid' => $course->id,
'relateduserid' => $student,
'other' => array('action' => $action, 'groupid' => $currentgroup)
);
$event = \mod_survey\event\report_viewed::create($params);
$event->trigger();
if ($currentgroup) {
$users = get_users_by_capability($context, 'mod/survey:participate', '', '', '', '', $currentgroup, null, false);
} else if (!empty($cm->groupingid)) {
$groups = groups_get_all_groups($courseid, 0, $cm->groupingid);
$groups = array_keys($groups);
$users = get_users_by_capability($context, 'mod/survey:participate', '', '', '', '', $groups, null, false);
} else {
$users = get_users_by_capability($context, 'mod/survey:participate', '', '', '', '', '', null, false);
$group = false;
}
$groupingid = $cm->groupingid;
// Print the menu across the top.
$virtualscales = false;
switch ($action) {
case "summary":
// If survey type is Critical incidents then we don't show summary report.
if ($survey->template == SURVEY_CIQ) {
throw new moodle_exception('cannotviewreport');
}
echo $OUTPUT->heading($strsummary, 3);
if ($groupsactivitymenu) {
echo html_writer::div($groupsactivitymenu, 'mb-2');
}
if (survey_count_responses($survey->id, $currentgroup, $groupingid)) {
echo "<div class='reportsummary'><a href=\"report.php?action=scales&amp;id=$id\">";
survey_print_graph("id=$id&amp;group=$currentgroup&amp;type=overall.png");
echo "</a></div>";
} else {
echo $OUTPUT->notification(get_string("nobodyyet", "survey"), 'info', false);
}
break;
case "scales":
// If survey type is Critical incidents then we don't show scales report.
if ($survey->template == SURVEY_CIQ) {
throw new moodle_exception('cannotviewreport');
}
echo $OUTPUT->heading($strscales, 3);
if ($groupsactivitymenu) {
echo html_writer::div($groupsactivitymenu, 'mb-2');
}
if (!$results = survey_get_responses($survey->id, $currentgroup, $groupingid)) {
echo $OUTPUT->notification(get_string("nobodyyet", "survey"), 'info', false);
} else {
$questions = $DB->get_records_list("survey_questions", "id", explode(',', $survey->questions));
$questionorder = explode(",", $survey->questions);
foreach ($questionorder as $key => $val) {
$question = $questions[$val];
if ($question->type < 0) { // We have some virtual scales. Just show them.
$virtualscales = true;
break;
}
}
foreach ($questionorder as $key => $val) {
$question = $questions[$val];
if ($question->multi) {
if (!empty($virtualscales) && $question->type > 0) { // Don't show non-virtual scales if virtual.
continue;
}
echo "<p class=\"centerpara\"><a title=\"$strseemoredetail\" href=\"report.php?action=questions&amp;id=$id&amp;qid=$question->multi\">";
survey_print_graph("id=$id&amp;qid=$question->id&amp;group=$currentgroup&amp;type=multiquestion.png");
echo "</a></p><br />";
}
}
}
break;
case "questions":
if ($qid) { // Just get one multi-question.
$questions = $DB->get_records_select("survey_questions", "id in ($qid)");
$questionorder = explode(",", $qid);
if ($scale = $DB->get_records("survey_questions", array("multi" => $qid))) {
$scale = array_pop($scale);
echo $OUTPUT->heading("$scale->text - $strselectedquestions", 3);
} else {
echo $OUTPUT->heading($strselectedquestions, 3);
}
} else { // Get all top-level questions.
$questions = $DB->get_records_list("survey_questions", "id", explode(',', $survey->questions));
$questionorder = explode(",", $survey->questions);
echo $OUTPUT->heading($strquestions, 3);
}
if ($groupsactivitymenu) {
echo html_writer::div($groupsactivitymenu, 'mb-2');
}
if (!$results = survey_get_responses($survey->id, $currentgroup, $groupingid)) {
echo $OUTPUT->notification(get_string("nobodyyet", "survey"), 'info', false);
} else {
foreach ($questionorder as $key => $val) {
$question = $questions[$val];
if ($question->type < 0) { // We have some virtual scales. DON'T show them.
$virtualscales = true;
break;
}
}
foreach ($questionorder as $key => $val) {
$question = $questions[$val];
if ($question->type < 0) { // We have some virtual scales. DON'T show them.
continue;
}
$question->text = get_string($question->text, "survey");
if ($question->multi) {
echo $OUTPUT->heading($question->text . ':', 4);
$subquestions = survey_get_subquestions($question);
foreach ($subquestions as $subquestion) {
if ($subquestion->type > 0) {
echo "<p class=\"centerpara\">";
echo "<a title=\"$strseemoredetail\" href=\"report.php?action=question&amp;id=$id&amp;qid=$subquestion->id\">";
survey_print_graph("id=$id&amp;qid=$subquestion->id&amp;group=$currentgroup&amp;type=question.png");
echo "</a></p>";
}
}
} else if ($question->type > 0) {
echo "<p class=\"centerpara\">";
echo "<a title=\"$strseemoredetail\" href=\"report.php?action=question&amp;id=$id&amp;qid=$question->id\">";
survey_print_graph("id=$id&amp;qid=$question->id&amp;group=$currentgroup&amp;type=question.png");
echo "</a></p>";
} else {
$table = new html_table();
$table->head = array($question->text);
$table->align = array("left");
$contents = '<table cellpadding="15" width="100%">';
if ($aaa = survey_get_user_answers($survey->id, $question->id, $currentgroup, "sa.time ASC")) {
foreach ($aaa as $a) {
$contents .= "<tr>";
$contents .= '<td class="fullnamecell">' . fullname($a) . '</td>';
$contents .= '<td valign="top">' . s($a->answer1) . '</td>';
$contents .= "</tr>";
}
}
$contents .= "</table>";
$table->data[] = array($contents);
echo html_writer::table($table);
echo $OUTPUT->spacer(array('height' => 30)); // Should be done with CSS instead.
}
}
}
break;
case "question":
if (!$question = $DB->get_record("survey_questions", array("id" => $qid))) {
throw new \moodle_exception('cannotfindquestion', 'survey');
}
$question->text = get_string($question->text, "survey");
$answers = explode(",", get_string($question->options, "survey"));
echo $OUTPUT->heading("$strquestion: $question->text", 3);
if ($groupsactivitymenu) {
echo html_writer::div($groupsactivitymenu, 'mb-2');
}
$strname = get_string("name", "survey");
$strtime = get_string("time", "survey");
$stractual = get_string("actual", "survey");
$strpreferred = get_string("preferred", "survey");
$strdateformat = get_string("strftimedatetime");
$table = new html_table();
$table->head = array("", $strname, $strtime, $stractual, $strpreferred);
$table->align = array("left", "left", "left", "left", "right");
$table->size = array(35, "", "", "", "");
if ($aaa = survey_get_user_answers($survey->id, $question->id, $currentgroup)) {
foreach ($aaa as $a) {
if ($a->answer1) {
$answer1 = "$a->answer1 - " . $answers[$a->answer1 - 1];
} else {
$answer1 = "&nbsp;";
}
if ($a->answer2) {
$answer2 = "$a->answer2 - " . $answers[$a->answer2 - 1];
} else {
$answer2 = "&nbsp;";
}
$table->data[] = array(
$OUTPUT->user_picture($a, array('courseid' => $course->id)),
"<a href=\"report.php?id=$id&amp;action=student&amp;student=$a->userid\">" . fullname($a) . "</a>",
userdate($a->time),
s($answer1), s($answer2));
}
}
echo html_writer::table($table);
break;
case "students":
echo $OUTPUT->heading(get_string("analysisof", "survey", get_string('participants')), 3);
if ($groupsactivitymenu) {
echo html_writer::div($groupsactivitymenu, 'mb-2');
}
if (!$results = survey_get_responses($survey->id, $currentgroup, $groupingid)) {
echo $OUTPUT->notification(get_string("nobodyyet", "survey"), 'info', false);
} else {
survey_print_all_responses($cm->id, $results, $course->id);
}
break;
case "student":
$user = core_user::get_user($student, '*', MUST_EXIST);
if ($currentgroup && !array_key_exists($user->id, $users)) {
throw new moodle_exception('usernotavailable', 'error');
}
echo $OUTPUT->heading(get_string("analysisof", "survey", fullname($user)), 3);
if ($groupsactivitymenu) {
echo html_writer::div($groupsactivitymenu, 'mb-2');
}
if ($notes != '' and confirm_sesskey()) {
if (survey_get_analysis($survey->id, $user->id)) {
if (!survey_update_analysis($survey->id, $user->id, $notes)) {
echo $OUTPUT->notification(get_string("errorunabletosavenotes", "survey"), "notifyproblem");
} else {
echo $OUTPUT->notification(get_string("savednotes", "survey"), "notifysuccess");
}
} else {
if (!survey_add_analysis($survey->id, $user->id, $notes)) {
echo $OUTPUT->notification(get_string("errorunabletosavenotes", "survey"), "notifyproblem");
} else {
echo $OUTPUT->notification(get_string("savednotes", "survey"), "notifysuccess");
}
}
}
echo "<p class=\"centerpara\">";
echo $OUTPUT->user_picture($user, array('courseid' => $course->id));
echo "</p>";
$questions = $DB->get_records_list("survey_questions", "id", explode(',', $survey->questions));
$questionorder = explode(",", $survey->questions);
if ($showscales) {
// Print overall summary.
echo "<p class=\"centerpara\">";
survey_print_graph("id=$id&amp;sid=$student&amp;type=student.png");
echo "</p>";
// Print scales.
foreach ($questionorder as $key => $val) {
$question = $questions[$val];
if ($question->type < 0) { // We have some virtual scales. Just show them.
$virtualscales = true;
break;
}
}
foreach ($questionorder as $key => $val) {
$question = $questions[$val];
if ($question->multi) {
if ($virtualscales && $question->type > 0) { // Don't show non-virtual scales if virtual.
continue;
}
echo "<p class=\"centerpara\">";
echo "<a title=\"$strseemoredetail\" href=\"report.php?action=questions&amp;id=$id&amp;qid=$question->multi\">";
survey_print_graph("id=$id&amp;qid=$question->id&amp;sid=$student&amp;type=studentmultiquestion.png");
echo "</a></p><br />";
}
}
}
// Print non-scale questions.
foreach ($questionorder as $key => $val) {
$question = $questions[$val];
if ($question->type == 0 or $question->type == 1) {
if ($answer = survey_get_user_answer($survey->id, $question->id, $user->id)) {
$table = new html_table();
$table->head = array(get_string($question->text, "survey"));
$table->align = array("left");
if (!empty($question->options) && $answer->answer1 > 0) {
$answers = explode(',', get_string($question->options, 'survey'));
if ($answer->answer1 <= count($answers)) {
$table->data[] = array(s($answers[$answer->answer1 - 1])); // No html here, just plain text.
} else {
$table->data[] = array(s($answer->answer1)); // No html here, just plain text.
}
} else {
$table->data[] = array(s($answer->answer1)); // No html here, just plain text.
}
echo html_writer::table($table);
echo $OUTPUT->spacer(array('height' => 30));
}
}
}
if ($rs = survey_get_analysis($survey->id, $user->id)) {
$notes = $rs->notes;
} else {
$notes = "";
}
echo "<hr noshade=\"noshade\" size=\"1\" />";
echo "<div class='studentreport'>";
echo "<form action=\"report.php\" method=\"post\">";
echo "<h3>$strnotes:</h3>";
echo "<blockquote>";
echo "<textarea class=\"form-control\" name=\"notes\" rows=\"10\" cols=\"60\">";
p($notes);
echo "</textarea><br />";
echo "<input type=\"hidden\" name=\"action\" value=\"student\" />";
echo "<input type=\"hidden\" name=\"sesskey\" value=\"" . sesskey() . "\" />";
echo "<input type=\"hidden\" name=\"student\" value=\"$student\" />";
echo "<input type=\"hidden\" name=\"id\" value=\"$cm->id\" />";
echo "<input type=\"submit\" class=\"btn btn-primary\" value=\"" . get_string("savechanges") . "\" />";
echo "</blockquote>";
echo "</form>";
echo "</div>";
break;
case "download":
echo $OUTPUT->heading($strdownload, 3);
if ($groupsactivitymenu) {
echo html_writer::div($groupsactivitymenu, 'mb-2');
}
require_capability('mod/survey:download', $context);
$numusers = survey_count_responses($survey->id, $currentgroup, $groupingid);
if ($numusers > 0) {
echo html_writer::tag('p', get_string("downloadinfo", "survey"), array('class' => 'centerpara'));
echo $OUTPUT->container_start('reportbuttons');
$options = array();
$options["id"] = "$cm->id";
$options["group"] = $currentgroup;
$options["type"] = "ods";
echo $OUTPUT->single_button(new moodle_url("download.php", $options), get_string("downloadods"));
$options["type"] = "xls";
echo $OUTPUT->single_button(new moodle_url("download.php", $options), get_string("downloadexcel"));
$options["type"] = "txt";
echo $OUTPUT->single_button(new moodle_url("download.php", $options), get_string("downloadtext"));
echo $OUTPUT->container_end();
} else {
echo $OUTPUT->notification(get_string("nobodyyet", "survey"), 'info', false);
}
break;
default:
throw new moodle_exception('cannotviewreport');
}
echo $OUTPUT->footer();

78
mod/survey/save.php
View File

@ -1,78 +0,0 @@
<?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/>.
/**
* This file is responsible for saving the results of a users survey and displaying
* the final message.
*
* @package mod_survey
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
require_once('../../config.php');
require_once('lib.php');
// Make sure this is a legitimate posting
if (!$formdata = data_submitted() or !confirm_sesskey()) {
throw new \moodle_exception('cannotcallscript');
}
$id = required_param('id', PARAM_INT); // Course Module ID
if (! $cm = get_coursemodule_from_id('survey', $id)) {
throw new \moodle_exception('invalidcoursemodule');
}
if (! $course = $DB->get_record("course", array("id"=>$cm->course))) {
throw new \moodle_exception('coursemisconf');
}
$PAGE->set_url('/mod/survey/save.php', array('id'=>$id));
require_login($course, false, $cm);
$context = context_module::instance($cm->id);
require_capability('mod/survey:participate', $context);
if (! $survey = $DB->get_record("survey", array("id"=>$cm->instance))) {
throw new \moodle_exception('invalidsurveyid', 'survey');
}
$strsurveysaved = get_string('surveysaved', 'survey');
$PAGE->set_title($strsurveysaved);
$PAGE->set_heading($course->fullname);
echo $OUTPUT->header();
echo $OUTPUT->heading(format_string($survey->name));
if (survey_already_done($survey->id, $USER->id)) {
notice(get_string("alreadysubmitted", "survey"), get_local_referer(false));
exit;
}
survey_save_answers($survey, $formdata, $course, $context);
// Print the page and finish up.
notice(get_string("thanksforanswers","survey", $USER->firstname), "$CFG->wwwroot/course/view.php?id=$course->id");
exit;

42
mod/survey/styles.css
View File

@ -1,42 +0,0 @@
.path-mod-survey .smalltext {
font-size: 0.75em;
}
.path-mod-survey .surveytable .rblock label {
display: block;
}
.path-mod-survey .surveytable .foundthat,
.path-mod-survey .surveytable .preferthat {
white-space: nowrap;
}
.path-mod-survey .surveytable .buttoncell {
width: 5%;
}
.path-mod-survey .surveytable .optioncell,
.path-mod-survey .surveytable .questioncell {
width: 50%;
vertical-align: top;
}
.path-mod-survey .surveytable .whitecell {
background-color: white;
}
.path-mod-survey #surveyform th {
font-weight: normal;
text-align: left;
}
.path-mod-survey #surveyform th.hresponse {
text-align: center;
width: 9%;
}
#page-mod-survey-report .fullnamecell {
width: 10%;
vertical-align: top;
white-space: nowrap;
}

72
mod/survey/templates/response_action_bar.mustache
View File

@ -1,72 +0,0 @@
{{!
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/>.
}}
{{!
@template mod_survey/response_action_bar
Actions bar for the reports page UI.
Classes required for JS:
* none
Context variables required for this template:
* see mod/survey/classes/output/actionbar.php
Example context (json):
{
"download": {
"link": "http://foobar",
"text": "foobar site",
"urlselect": {
"id": "url_select123",
"sesskey": "sesskey",
"action": "http://localhost/moodle/course/jumpto.php",
"disabled": false,
"formid": "surveyresponseselect",
"classes": "urlselect",
"options": [
{
"name": "Summary",
"value": "/mod/survey/report.php?id=12&action=summary",
"selected": true
},
{
"name": "Scales",
"value": "/mod/survey/report.php?id=12&action=scales",
"selected": false
},
{
"name": "Questions",
"value": "/mod/survey/report.php?id=12&action=questions",
"selected": false
},
{
"name": "Participants",
"value": "/mod/survey/report.php?id=12&action=students",
"selected": false
}
]
}
}
}
}}
<div class="container-fluid tertiary-navigation">
<div class="row">
{{#urlselect}}
<div class="navitem">
{{>core/url_select}}
</div>
{{/urlselect}}
{{#download}}
<div class="navitem ms-sm-auto">
<a class="btn btn-secondary float-end" href="{{link}}">{{text}}</a>
</div>
{{/download}}
</div>
</div>

73
mod/survey/tests/backup/restore_date_test.php
View File

@ -1,73 +0,0 @@
<?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/>.
namespace mod_survey\backup;
defined('MOODLE_INTERNAL') || die();
global $CFG;
require_once($CFG->libdir . "/phpunit/classes/restore_date_testcase.php");
/**
* Restore date tests.
*
* @package mod_survey
* @copyright 2017 onwards Ankit Agarwal <ankit.agrr@gmail.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class restore_date_test extends \restore_date_testcase {
public function test_restore_dates(): void {
global $DB;
list($course, $survey) = $this->create_course_and_module('survey');
$context = \context_module::instance($survey->cmid);
// Build our questions and responses array.
$realquestions = array();
$questions = survey_get_questions($survey);
$i = 5;
foreach ($questions as $q) {
if ($q->type > 0) {
if ($q->multi) {
$subquestions = survey_get_subquestions($q);
foreach ($subquestions as $sq) {
$key = 'q' . $sq->id;
$realquestions[$key] = $i % 5 + 1;
$i++;
}
} else {
$key = 'q' . $q->id;
$realquestions[$key] = $i % 5 + 1;
$i++;
}
}
}
survey_save_answers($survey, $realquestions, $course, $context);
// We do not want second differences to fail our test because of execution delays.
$DB->set_field('survey_answers', 'time', $this->startdate);
// Do backup and restore.
$newcourseid = $this->backup_and_restore($course);
$newsurvey = $DB->get_record('survey', ['course' => $newcourseid]);
$this->assertFieldsNotRolledForward($survey, $newsurvey, ['timecreated', 'timemodified']);
$answers = $DB->get_records('survey_answers', ['survey' => $newsurvey->id]);
foreach ($answers as $answer) {
$this->assertEquals($this->startdate, $answer->time);
}
}
}

65
mod/survey/tests/behat/survey_completion.feature
View File

@ -1,65 +0,0 @@
@mod @mod_survey @core_completion @javascript
Feature: A teacher can use activity completion to track a student progress
In order to use activity completion
As a teacher
I need to set survey activities and enable activity completion
Background:
Given the following "users" exist:
| username | firstname | lastname | email |
| teacher1 | Teacher | 1 | teacher1@example.com |
| student1 | Student | 1 | student1@example.com |
And the following "courses" exist:
| fullname | shortname | category | enablecompletion |
| Course 1 | C1 | 0 | 1 |
And the following "course enrolments" exist:
| user | course | role |
| teacher1 | C1 | editingteacher |
| student1 | C1 | student |
And I enable "survey" "mod" plugin
And I log in as "teacher1"
Scenario: Require survey view
Given the following "activities" exist:
| activity | name | course | idnumber | template | completion | completionview | completionsubmit |
| survey | Test survey name | C1 | survey1 | 5 | 2 | 1 | 0 |
And I am on the "Test survey name" "survey activity" page
# Teacher view.
And "Test survey name" should have the "View" completion condition
# Student view.
When I am on the "Course 1" course page logged in as student1
And the "View" completion condition of "Test survey name" is displayed as "todo"
And I follow "Test survey name"
And I am on "Course 1" course homepage
Then the "View" completion condition of "Test survey name" is displayed as "done"
Scenario: Require survey submission
Given the following "activities" exist:
| activity | name | course | idnumber | template | completion | completionview | completionsubmit |
| survey | Test survey name | C1 | survey1 | 5 | 2 | 1 | 1 |
And I am on the "Test survey name" "survey activity" page
# Teacher view.
And "Test survey name" should have the "Submit answers" completion condition
# Student view.
When I am on the "Course 1" course page logged in as student1
And the "Submit answers" completion condition of "Test survey name" is displayed as "todo"
And I follow "Test survey name"
And the "Submit answers" completion condition of "Test survey name" is displayed as "todo"
And I press "Submit"
And I am on "Course 1" course homepage
And the "Submit answers" completion condition of "Test survey name" is displayed as "done"
And I follow "Test survey name"
And the "Submit answers" completion condition of "Test survey name" is displayed as "done"
Scenario: A student can manually mark the survey activity as done but a teacher cannot
Given the following "activities" exist:
| activity | name | course | idnumber | completion |
| survey | Test survey name | C1 | survey1 | 1 |
And I am on "Course 1" course homepage
# Teacher view.
And "Test survey name" should have the "Mark as done" completion condition
# Student view.
When I am on the "survey1" Activity page logged in as student1
Then the manual completion button of "Test survey name" is displayed as "Mark as done"
And I toggle the manual completion state of "Test survey name"
And the manual completion button of "Test survey name" is displayed as "Done"

47
mod/survey/tests/behat/survey_critical_incidents.feature
View File

@ -1,47 +0,0 @@
@mod @mod_survey @javascript
Feature: A teacher navigates to response reports of students
If survey activity is configured for critical students
Only questions and particiats pages should be visible under response reports
Background:
Given the following "users" exist:
| username | firstname | lastname | email |
| teacher1 | Teacher | 1 | teacher1@example.com |
| student1 | Student | 1 | student1@example.com |
| student2 | Student | 1 | student2@example.com |
And the following "courses" exist:
| fullname | shortname | category | enablecompletion |
| Course 1 | C1 | 0 | 1 |
And the following "course enrolments" exist:
| user | course | role |
| teacher1 | C1 | editingteacher |
| student1 | C1 | student |
| student2 | C1 | student |
And I enable "survey" "mod" plugin
And the following "activities" exist:
| activity | name | course | idnumber | template |
| survey | Test survey name | C1 | survey1 | 5 |
Scenario: Only questions and participants page should be available under response reports as teacher
Given I am on the "Test survey name" "survey activity" page logged in as student1
And I set the field "At what moment in class were you most engaged as a learner?" to "most engaged as student1"
And I set the field "At what moment in class were you most distanced as a learner?" to "most distanced as student1"
And I set the field "What action from anyone in the forums did you find most affirming or helpful?" to "most helpful student1"
And I set the field "What action from anyone in the forums did you find most puzzling or confusing?" to "most confusing student1"
And I set the field "What event surprised you most?" to "most surprised student1"
And I press "Submit"
And I press "Continue"
And I am on the "Test survey name" "survey activity" page logged in as student2
And I set the field "At what moment in class were you most engaged as a learner?" to "most engaged as student2"
And I set the field "At what moment in class were you most distanced as a learner?" to "most distanced as student2"
And I set the field "What action from anyone in the forums did you find most affirming or helpful?" to "most helpful student2"
And I set the field "What action from anyone in the forums did you find most puzzling or confusing?" to "most confusing student2"
And I set the field "What event surprised you most?" to "most surprised student1"
And I press "Submit"
And I press "Continue"
When I am on the "Test survey name" "survey activity" page logged in as teacher1
And I navigate to "Response reports" in current page administration
Then I should not see "Summary"
And I should not see "Scales"
And I should see "Questions"
And I should see "Participants"

31
mod/survey/tests/behat/survey_description.feature
View File

@ -1,31 +0,0 @@
@mod @mod_survey
Feature: The default introduction is displayed when the activity description is empty
Background:
Given the following "users" exist:
| username | firstname | lastname | email |
| teacher1 | Teacher | 1 | teacher1@example.com |
And the following "courses" exist:
| fullname | shortname | format |
| Course 1 | C1 | topics |
And the following "course enrolments" exist:
| user | course | role |
| teacher1 | C1 | editingteacher |
And I enable "survey" "mod" plugin
And the following "activities" exist:
| activity | name | course | idnumber | template |
| survey | Test survey name | C1 | survey1 | 1 |
Scenario: Display the default survey introduction when activity description is empty
Given I am on the "Test survey name" "survey activity" page logged in as "teacher1"
And I should see "Test survey 1"
When I am on the "Test survey name" "survey activity editing" page
And I set the following fields to these values:
| Description | |
And I press "Save and display"
Then I should see "The purpose of this survey is to help us understand"
And I am on the "Test survey name" "survey activity editing" page
And I set the following fields to these values:
| Survey type | ATTLS (20 item version) |
And I press "Save and display"
And I should see "The purpose of this questionnaire is to help us evaluate"

86
mod/survey/tests/behat/survey_groups.feature
View File

@ -1,86 +0,0 @@
@mod @mod_survey
Feature: Viewing response reports by group
In order to view reponse reports on a large course
As a teacher
I need to filter the users on the response reports by group
Background:
And the following "courses" exist:
| fullname | shortname |
| Test Course 1 | C1 |
And the following "groups" exist:
| name | course | idnumber | participation |
| Group 1 | C1 | G1 | 1 |
| Group 2 | C1 | G2 | 1 |
| Group 3 | C1 | G3 | 0 |
And the following "users" exist:
| username | firstname | lastname | email |
| teacher1 | TeacherG1 | 1 | teacher1@example.com |
| noneditor1 | NoneditorG1 | 1 | noneditor1@example.com |
| noneditor2 | NoneditorNone | 2 | noneditor2@example.com |
| user1 | User1G1 | 1 | user1@example.com |
| user2 | User2G2 | 2 | user2@example.com |
| user3 | User3None | 3 | user3@example.com |
| user4 | User4NPgroup | 4 | user4@example.com |
And the following "course enrolments" exist:
| user | course | role |
| teacher1 | C1 | editingteacher |
| noneditor1 | C1 | teacher |
| noneditor2 | C1 | teacher |
| user1 | C1 | student |
| user2 | C1 | student |
| user3 | C1 | student |
| user4 | C1 | student |
And the following "group members" exist:
| user | group |
| teacher1 | G1 |
| noneditor1 | G1 |
| user1 | G1 |
| user2 | G2 |
| user4 | G3 |
And I enable "survey" "mod" plugin
And the following "activities" exist:
| activity | name | intro | course | idnumber | groupmode | template |
| survey | Separate survey | survey with separate groups | C1 | survey1 | 1 | 5 |
| survey | Visible survey | survey with visible groups | C1 | survey2 | 2 | 5 |
And I am on the "Separate survey" "survey activity" page logged in as user1
And I press "Submit"
And I am on the "Separate survey" "survey activity" page logged in as user2
And I press "Submit"
And I am on the "Separate survey" "survey activity" page logged in as user3
And I press "Submit"
And I am on the "Separate survey" "survey activity" page logged in as user4
And I press "Submit"
And I am on the "Visible survey" "survey activity" page logged in as user1
And I press "Submit"
And I am on the "Visible survey" "survey activity" page logged in as user2
And I press "Submit"
And I am on the "Visible survey" "survey activity" page logged in as user3
And I press "Submit"
And I am on the "Visible survey" "survey activity" page logged in as user4
And I press "Submit"
Scenario Outline: Editing teachers should see all groups on the Results page. Non-editing teachers should see just their own
groups in Separate groups mode, all groups in Visible groups mode.
Given I am on the "<survey>" "survey activity" page logged in as "<user>"
And I follow "Response reports"
Then I <all> see "All participants"
And I <G1> see "Group 1"
And I <G2> see "Group 2"
And I should not see "Group 3"
And I <user1> see "User1G1"
And I <user2> see "User2G2"
And I <user3> see "User3None"
And I <user4> see "User4NPgroup"
Examples:
| survey | user | all | G1 | G2 | user1 | user2 | user3 | user4 |
| survey1 | teacher1 | should | should | should | should | should | should | should |
| survey1 | noneditor1 | should not | should | should not | should | should not | should not | should not |
| survey2 | teacher1 | should | should | should | should | should | should | should |
| survey2 | noneditor1 | should | should | should | should | should not | should not | should not |
| survey2 | noneditor2 | should | should | should | should | should not | should not | should not |
Scenario: Non-editing teacher without access to any groups should not see survey results in separate groups mode
Given I am on the "survey1" "survey activity" page logged in as "noneditor2"
Then I should not see "Response reports"

48
mod/survey/tests/behat/survey_types.feature
View File

@ -1,48 +0,0 @@
@mod @mod_survey
Feature: A teacher can set three types of survey activity
In order to use verified survey instruments
As a teacher
I need to set survey activities and select which survey type suits my needs
Background:
Given the following "users" exist:
| username | firstname | lastname | email |
| teacher1 | Teacher | 1 | teacher1@example.com |
And the following "courses" exist:
| fullname | shortname | format |
| Course 1 | C1 | topics |
And the following "course enrolments" exist:
| user | course | role |
| teacher1 | C1 | editingteacher |
And I enable "survey" "mod" plugin
And I log in as "teacher1"
Scenario: Switching between the three survey types
Given the following "activities" exist:
| activity | name | course | idnumber |
| survey | Test survey name | C1 | survey1 |
And I am on the "Test survey name" "survey activity editing" page
And I set the following fields to these values:
| Survey type | ATTLS (20 item version) |
And I press "Save and display"
Then I should see "Attitudes Towards Thinking and Learning"
And I navigate to "Settings" in current page administration
And I set the following fields to these values:
| Survey type | Critical incidents |
And I press "Save and display"
And I should see "At what moment in class were you most engaged as a learner?"
And I navigate to "Settings" in current page administration
And I set the following fields to these values:
| Survey type | COLLES (Preferred and Actual) |
And I press "Save and display"
And I should see "In this online unit..."
And I should see "my learning focuses on issues that interest me."
Scenario: Survey activity is created via UI
Given I add a survey activity to course "Course 1" section "1"
And I set the following fields to these values:
| Name | Test survey name |
| Description | Test survey description |
| Survey type | ATTLS (20 item version) |
When I press "Save and return to course"
Then I should see "Test survey name"

25
mod/survey/tests/behat/survey_validation.feature
View File

@ -1,25 +0,0 @@
@mod @mod_survey @javascript
Feature: When some answers are not selected, the survey should not be submitted
In order to submit valid responses
As a student
I need to fill values
Background:
Given the following "users" exist:
| username | firstname | lastname | email |
| student1 | Student | 1 | student1@example.com |
And the following "courses" exist:
| fullname | shortname |
| Course 1 | C1 |
And the following "course enrolments" exist:
| user | course | role |
| student1 | C1 | student |
And I enable "survey" "mod" plugin
Scenario: Require survey view
Given the following "activities" exist:
| activity | name | course |
| survey | Test survey name | C1 |
And I am on the "Test survey name" "survey activity" page logged in as "student1"
When I press "Submit"
Then I should see "Some of the multiple choice questions have not been answered." in the "Error" "dialogue"

217
mod/survey/tests/custom_completion_test.php
View File

@ -1,217 +0,0 @@
<?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/>.
/**
* Contains unit tests for core_completion/activity_custom_completion.
*
* @package mod_survey
* @copyright Simey Lameze <simey@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
declare(strict_types=1);
namespace mod_survey;
use advanced_testcase;
use cm_info;
use coding_exception;
use mod_survey\completion\custom_completion;
use moodle_exception;
defined('MOODLE_INTERNAL') || die();
global $CFG;
require_once($CFG->libdir . '/completionlib.php');
/**
* Class for unit testing mod_survey/activity_custom_completion.
*
* @package mod_survey
* @copyright Simey Lameze <simey@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class custom_completion_test extends advanced_testcase {
/**
* Data provider for get_state().
*
* @return array[]
*/
public static function get_state_provider(): array {
return [
'Undefined rule' => [
'somenonexistentrule', COMPLETION_DISABLED, false, null, coding_exception::class
],
'Rule not available' => [
'completionsubmit', COMPLETION_DISABLED, false, null, moodle_exception::class
],
'Rule available, user has not submitted' => [
'completionsubmit', COMPLETION_ENABLED, false, COMPLETION_INCOMPLETE, null
],
'Rule available, user has submitted' => [
'completionsubmit', COMPLETION_ENABLED, true, COMPLETION_COMPLETE, null
],
];
}
/**
* Test for get_state().
*
* @dataProvider get_state_provider
* @param string $rule The custom completion rule.
* @param int $available Whether this rule is available.
* @param bool $submitted
* @param int|null $status Expected status.
* @param string|null $exception Expected exception.
*/
public function test_get_state(string $rule, int $available, ?bool $submitted, ?int $status, ?string $exception): void {
global $DB;
if (!is_null($exception)) {
$this->expectException($exception);
}
// Custom completion rule data for cm_info::customdata.
$customdataval = [
'customcompletionrules' => [
$rule => $available
]
];
// Build a mock cm_info instance.
$mockcminfo = $this->getMockBuilder(cm_info::class)
->disableOriginalConstructor()
->onlyMethods(['__get'])
->getMock();
// Mock the return of the magic getter method when fetching the cm_info object's customdata and instance values.
$mockcminfo->expects($this->any())
->method('__get')
->will($this->returnValueMap([
['customdata', $customdataval],
['instance', 1],
]));
// Mock the DB calls.
$DB = $this->createMock(get_class($DB));
$DB->expects($this->atMost(1))
->method('record_exists')
->willReturn($submitted);
$customcompletion = new custom_completion($mockcminfo, 2);
$this->assertEquals($status, $customcompletion->get_state($rule));
}
/**
* Test for get_defined_custom_rules().
*/
public function test_get_defined_custom_rules(): void {
$rules = custom_completion::get_defined_custom_rules();
$this->assertCount(1, $rules);
$this->assertEquals('completionsubmit', reset($rules));
}
/**
* Test for get_defined_custom_rule_descriptions().
*/
public function test_get_custom_rule_descriptions(): void {
// Get defined custom rules.
$rules = custom_completion::get_defined_custom_rules();
// Build a mock cm_info instance.
$mockcminfo = $this->getMockBuilder(cm_info::class)
->disableOriginalConstructor()
->onlyMethods(['__get'])
->getMock();
// Instantiate a custom_completion object using the mocked cm_info.
$customcompletion = new custom_completion($mockcminfo, 1);
// Get custom rule descriptions.
$ruledescriptions = $customcompletion->get_custom_rule_descriptions();
// Confirm that defined rules and rule descriptions are consistent with each other.
$this->assertEquals(count($rules), count($ruledescriptions));
foreach ($rules as $rule) {
$this->assertArrayHasKey($rule, $ruledescriptions);
}
}
/**
* Test for is_defined().
*/
public function test_is_defined(): void {
// Build a mock cm_info instance.
$mockcminfo = $this->getMockBuilder(cm_info::class)
->disableOriginalConstructor()
->getMock();
$customcompletion = new custom_completion($mockcminfo, 1);
// Rule is defined.
$this->assertTrue($customcompletion->is_defined('completionsubmit'));
// Undefined rule.
$this->assertFalse($customcompletion->is_defined('somerandomrule'));
}
/**
* Data provider for test_get_available_custom_rules().
*
* @return array[]
*/
public static function get_available_custom_rules_provider(): array {
return [
'Completion submit available' => [
COMPLETION_ENABLED, ['completionsubmit']
],
'Completion submit not available' => [
COMPLETION_DISABLED, []
],
];
}
/**
* Test for get_available_custom_rules().
*
* @dataProvider get_available_custom_rules_provider
* @param int $status
* @param array $expected
*/
public function test_get_available_custom_rules(int $status, array $expected): void {
$customdataval = [
'customcompletionrules' => [
'completionsubmit' => $status
]
];
// Build a mock cm_info instance.
$mockcminfo = $this->getMockBuilder(cm_info::class)
->disableOriginalConstructor()
->onlyMethods(['__get'])
->getMock();
// Mock the return of magic getter for the customdata attribute.
$mockcminfo->expects($this->any())
->method('__get')
->with('customdata')
->willReturn($customdataval);
$customcompletion = new custom_completion($mockcminfo, 1);
$this->assertEquals($expected, $customcompletion->get_available_custom_rules());
}
}

139
mod/survey/tests/event/events_test.php
View File

@ -1,139 +0,0 @@
<?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/>.
/**
* Events tests.
*
* @package mod_survey
* @copyright 2014 Rajesh Taneja <rajesh@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace mod_survey\event;
/**
* Events tests class.
*
* @package mod_survey
* @copyright 2014 Rajesh Taneja <rajesh@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class events_test extends \advanced_testcase {
/**
* Setup.
*/
public function setUp(): void {
parent::setUp();
$this->resetAfterTest();
// Survey module is disabled by default, enable it for testing.
$manager = \core_plugin_manager::resolve_plugininfo_class('mod');
$manager::enable_plugin('survey', 1);
}
/**
* Test report downloaded event.
*/
public function test_report_downloaded(): void {
// There is no proper API to call to generate chapters for a book, so what we are
// doing here is simply making sure that the events returns the right information.
$course = $this->getDataGenerator()->create_course();
$survey = $this->getDataGenerator()->create_module('survey', array('course' => $course->id));
$params = array(
'objectid' => $survey->id,
'context' => \context_module::instance($survey->cmid),
'courseid' => $course->id,
'other' => array('type' => 'xls')
);
$event = \mod_survey\event\report_downloaded::create($params);
// Triggering and capturing the event.
$sink = $this->redirectEvents();
$event->trigger();
$events = $sink->get_events();
$this->assertCount(1, $events);
$event = reset($events);
// Checking that the event contains the expected values.
$this->assertInstanceOf('\mod_survey\event\report_downloaded', $event);
$this->assertEquals(\context_module::instance($survey->cmid), $event->get_context());
$this->assertEquals($survey->id, $event->objectid);
$this->assertEventContextNotUsed($event);
}
/**
* Test report viewed event.
*/
public function test_report_viewed(): void {
// There is no proper API to call to generate chapters for a book, so what we are
// doing here is simply making sure that the events returns the right information.
$course = $this->getDataGenerator()->create_course();
$survey = $this->getDataGenerator()->create_module('survey', array('course' => $course->id));
$params = array(
'objectid' => $survey->id,
'context' => \context_module::instance($survey->cmid),
'courseid' => $course->id
);
$event = \mod_survey\event\report_viewed::create($params);
// Triggering and capturing the event.
$sink = $this->redirectEvents();
$event->trigger();
$events = $sink->get_events();
$this->assertCount(1, $events);
$event = reset($events);
// Checking that the event contains the expected values.
$this->assertInstanceOf('\mod_survey\event\report_viewed', $event);
$this->assertEquals(\context_module::instance($survey->cmid), $event->get_context());
$this->assertEquals($survey->id, $event->objectid);
}
/**
* Test response submitted event.
*/
public function test_response_submitted(): void {
// There is no proper API to call to generate chapters for a book, so what we are
// doing here is simply making sure that the events returns the right information.
$course = $this->getDataGenerator()->create_course();
$survey = $this->getDataGenerator()->create_module('survey', array('course' => $course->id));
$params = array(
'context' => \context_module::instance($survey->cmid),
'courseid' => $course->id,
'other' => array('surveyid' => $survey->id)
);
$event = \mod_survey\event\response_submitted::create($params);
// Triggering and capturing the event.
$sink = $this->redirectEvents();
$event->trigger();
$events = $sink->get_events();
$this->assertCount(1, $events);
$event = reset($events);
// Checking that the event contains the expected values.
$this->assertInstanceOf('\mod_survey\event\response_submitted', $event);
$this->assertEquals(\context_module::instance($survey->cmid), $event->get_context());
$this->assertEquals($survey->id, $event->other['surveyid']);
$this->assertEventContextNotUsed($event);
}
}

414
mod/survey/tests/externallib_test.php
View File

@ -1,414 +0,0 @@
<?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/>.
namespace mod_survey;
use core_external\external_api;
use externallib_advanced_testcase;
use mod_survey_external;
defined('MOODLE_INTERNAL') || die();
global $CFG;
require_once($CFG->dirroot . '/webservice/tests/helpers.php');
require_once($CFG->dirroot . '/mod/survey/lib.php');
/**
* Survey module external functions tests
*
* @package mod_survey
* @category external
* @copyright 2015 Juan Leyva <juan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 3.0
*/
class externallib_test extends externallib_advanced_testcase {
/** @var \stdClass course record. */
protected $course;
/** @var \stdClass activity record. */
protected $survey;
/** @var \context_module context instance. */
protected $context;
/** @var \StdClass course module. */
protected $cm;
/** @var \StdClass student record. */
protected $student;
/** @var \StdClass teacher record. */
protected $teacher;
/** @var \StdClass student role. */
protected $studentrole;
/** @var \StdClass teacher role. */
protected $teacherrole;
/**
* Set up for every test
*/
public function setUp(): void {
global $DB;
parent::setUp();
$this->resetAfterTest();
$this->setAdminUser();
// Survey module is disabled by default, enable it for testing.
$manager = \core_plugin_manager::resolve_plugininfo_class('mod');
$manager::enable_plugin('survey', 1);
// Setup test data.
$this->course = $this->getDataGenerator()->create_course();
$this->survey = $this->getDataGenerator()->create_module('survey', array('course' => $this->course->id));
$this->context = \context_module::instance($this->survey->cmid);
$this->cm = get_coursemodule_from_instance('survey', $this->survey->id);
// Create users.
$this->student = self::getDataGenerator()->create_user();
$this->teacher = self::getDataGenerator()->create_user();
// Users enrolments.
$this->studentrole = $DB->get_record('role', array('shortname' => 'student'));
$this->teacherrole = $DB->get_record('role', array('shortname' => 'editingteacher'));
$this->getDataGenerator()->enrol_user($this->student->id, $this->course->id, $this->studentrole->id, 'manual');
$this->getDataGenerator()->enrol_user($this->teacher->id, $this->course->id, $this->teacherrole->id, 'manual');
}
/*
* Test get surveys by courses
*/
public function test_mod_survey_get_surveys_by_courses(): void {
global $DB;
// Create additional course.
$course2 = self::getDataGenerator()->create_course();
// Second survey.
$record = new \stdClass();
$record->course = $course2->id;
$survey2 = self::getDataGenerator()->create_module('survey', $record);
// Force empty intro.
$DB->set_field('survey', 'intro', '', array('id' => $survey2->id));
// Execute real Moodle enrolment as we'll call unenrol() method on the instance later.
$enrol = enrol_get_plugin('manual');
$enrolinstances = enrol_get_instances($course2->id, true);
foreach ($enrolinstances as $courseenrolinstance) {
if ($courseenrolinstance->enrol == "manual") {
$instance2 = $courseenrolinstance;
break;
}
}
$enrol->enrol_user($instance2, $this->student->id, $this->studentrole->id);
self::setUser($this->student);
$returndescription = mod_survey_external::get_surveys_by_courses_returns();
// Create what we expect to be returned when querying the two courses.
// First for the student user.
$expectedfields = array('id', 'coursemodule', 'course', 'name', 'intro', 'introformat', 'introfiles', 'lang',
'template', 'days', 'questions', 'surveydone');
// Add expected coursemodule and data.
$survey1 = $this->survey;
$survey1->coursemodule = $survey1->cmid;
$survey1->introformat = 1;
$survey1->surveydone = 0;
$survey1->section = 0;
$survey1->visible = true;
$survey1->groupmode = 0;
$survey1->groupingid = 0;
$survey1->introfiles = [];
$survey1->lang = '';
$survey2->coursemodule = $survey2->cmid;
$survey2->introformat = 1;
$survey2->surveydone = 0;
$survey2->section = 0;
$survey2->visible = true;
$survey2->groupmode = 0;
$survey2->groupingid = 0;
$tempo = $DB->get_field("survey", "intro", array("id" => $survey2->template));
$survey2->intro = nl2br(get_string($tempo, "survey"));
$survey2->introfiles = [];
$survey2->lang = '';
foreach ($expectedfields as $field) {
$expected1[$field] = $survey1->{$field};
$expected2[$field] = $survey2->{$field};
}
$expectedsurveys = array($expected2, $expected1);
// Call the external function passing course ids.
$result = mod_survey_external::get_surveys_by_courses(array($course2->id, $this->course->id));
$result = external_api::clean_returnvalue($returndescription, $result);
$this->assertEquals($expectedsurveys, $result['surveys']);
$this->assertCount(0, $result['warnings']);
// Call the external function without passing course id.
$result = mod_survey_external::get_surveys_by_courses();
$result = external_api::clean_returnvalue($returndescription, $result);
$this->assertEquals($expectedsurveys, $result['surveys']);
$this->assertCount(0, $result['warnings']);
// Unenrol user from second course and alter expected surveys.
$enrol->unenrol_user($instance2, $this->student->id);
array_shift($expectedsurveys);
// Call the external function without passing course id.
$result = mod_survey_external::get_surveys_by_courses();
$result = external_api::clean_returnvalue($returndescription, $result);
$this->assertEquals($expectedsurveys, $result['surveys']);
// Call for the second course we unenrolled the user from, expected warning.
$result = mod_survey_external::get_surveys_by_courses(array($course2->id));
$this->assertCount(1, $result['warnings']);
$this->assertEquals('1', $result['warnings'][0]['warningcode']);
$this->assertEquals($course2->id, $result['warnings'][0]['itemid']);
// Now, try as a teacher for getting all the additional fields.
self::setUser($this->teacher);
$additionalfields = array('timecreated', 'timemodified', 'section', 'visible', 'groupmode', 'groupingid');
foreach ($additionalfields as $field) {
$expectedsurveys[0][$field] = $survey1->{$field};
}
$result = mod_survey_external::get_surveys_by_courses();
$result = external_api::clean_returnvalue($returndescription, $result);
$this->assertEquals($expectedsurveys, $result['surveys']);
// Admin also should get all the information.
self::setAdminUser();
$result = mod_survey_external::get_surveys_by_courses(array($this->course->id));
$result = external_api::clean_returnvalue($returndescription, $result);
$this->assertEquals($expectedsurveys, $result['surveys']);
// Now, prohibit capabilities.
$this->setUser($this->student);
$contextcourse1 = \context_course::instance($this->course->id);
// Prohibit capability = mod/survey:participate on Course1 for students.
assign_capability('mod/survey:participate', CAP_PROHIBIT, $this->studentrole->id, $contextcourse1->id);
accesslib_clear_all_caches_for_unit_testing();
$surveys = mod_survey_external::get_surveys_by_courses(array($this->course->id));
$surveys = external_api::clean_returnvalue(mod_survey_external::get_surveys_by_courses_returns(), $surveys);
$this->assertFalse(isset($surveys['surveys'][0]['intro']));
}
/**
* Test view_survey
*/
public function test_view_survey(): void {
global $DB;
// Test invalid instance id.
try {
mod_survey_external::view_survey(0);
$this->fail('Exception expected due to invalid mod_survey instance id.');
} catch (\moodle_exception $e) {
$this->assertEquals('invalidrecord', $e->errorcode);
}
// Test not-enrolled user.
$usernotenrolled = self::getDataGenerator()->create_user();
$this->setUser($usernotenrolled);
try {
mod_survey_external::view_survey($this->survey->id);
$this->fail('Exception expected due to not enrolled user.');
} catch (\moodle_exception $e) {
$this->assertEquals('requireloginerror', $e->errorcode);
}
// Test user with full capabilities.
$this->setUser($this->student);
// Trigger and capture the event.
$sink = $this->redirectEvents();
$result = mod_survey_external::view_survey($this->survey->id);
$result = external_api::clean_returnvalue(mod_survey_external::view_survey_returns(), $result);
$this->assertTrue($result['status']);
$events = $sink->get_events();
$this->assertCount(1, $events);
$event = array_shift($events);
// Checking that the event contains the expected values.
$this->assertInstanceOf('\mod_survey\event\course_module_viewed', $event);
$this->assertEquals($this->context, $event->get_context());
$moodlesurvey = new \moodle_url('/mod/survey/view.php', array('id' => $this->cm->id));
$this->assertEquals($moodlesurvey, $event->get_url());
$this->assertEventContextNotUsed($event);
$this->assertNotEmpty($event->get_name());
// Test user with no capabilities.
// We need a explicit prohibit since this capability is only defined in authenticated user and guest roles.
assign_capability('mod/survey:participate', CAP_PROHIBIT, $this->studentrole->id, $this->context->id);
accesslib_clear_all_caches_for_unit_testing();
try {
mod_survey_external::view_survey($this->survey->id);
$this->fail('Exception expected due to missing capability.');
} catch (\moodle_exception $e) {
$this->assertEquals('nopermissions', $e->errorcode);
}
}
/**
* Test get_questions
*/
public function test_get_questions(): void {
global $DB;
// Test user with full capabilities.
$this->setUser($this->student);
// Build our expectation array.
$expectedquestions = array();
$questions = survey_get_questions($this->survey);
foreach ($questions as $q) {
if ($q->type >= 0) {
$expectedquestions[$q->id] = $q;
if ($q->multi) {
$subquestions = survey_get_subquestions($q);
foreach ($subquestions as $sq) {
$expectedquestions[$sq->id] = $sq;
}
}
}
}
$result = mod_survey_external::get_questions($this->survey->id);
$result = external_api::clean_returnvalue(mod_survey_external::get_questions_returns(), $result);
// Check we receive the same questions.
$this->assertCount(0, $result['warnings']);
foreach ($result['questions'] as $q) {
$this->assertEquals(get_string($expectedquestions[$q['id']]->text, 'survey'), $q['text']);
$this->assertEquals(get_string($expectedquestions[$q['id']]->shorttext, 'survey'), $q['shorttext']);
$this->assertEquals($expectedquestions[$q['id']]->multi, $q['multi']);
$this->assertEquals($expectedquestions[$q['id']]->type, $q['type']);
// Parent questions must have parent eq to 0.
if ($q['multi']) {
$this->assertEquals(0, $q['parent']);
$this->assertEquals(get_string($expectedquestions[$q['id']]->options, 'survey'), $q['options']);
}
}
// Test user with no capabilities.
// We need a explicit prohibit since this capability is only defined in authenticated user and guest roles.
assign_capability('mod/survey:participate', CAP_PROHIBIT, $this->studentrole->id, $this->context->id);
accesslib_clear_all_caches_for_unit_testing();
try {
mod_survey_external::get_questions($this->survey->id);
$this->fail('Exception expected due to missing capability.');
} catch (\moodle_exception $e) {
$this->assertEquals('nopermissions', $e->errorcode);
}
}
/**
* Test submit_answers
*/
public function test_submit_answers(): void {
global $DB;
// Test user with full capabilities.
$this->setUser($this->student);
// Build our questions and responses array.
$realquestions = array();
$questions = survey_get_questions($this->survey);
$i = 5;
foreach ($questions as $q) {
if ($q->type >= 0) {
if ($q->multi) {
$subquestions = survey_get_subquestions($q);
foreach ($subquestions as $sq) {
$realquestions[] = array(
'key' => 'q' . $sq->id,
'value' => $i % 5 + 1 // Values between 1 and 5.
);
$i++;
}
} else {
$realquestions[] = array(
'key' => 'q' . $q->id,
'value' => $i % 5 + 1
);
$i++;
}
}
}
$result = mod_survey_external::submit_answers($this->survey->id, $realquestions);
$result = external_api::clean_returnvalue(mod_survey_external::submit_answers_returns(), $result);
$this->assertTrue($result['status']);
$this->assertCount(0, $result['warnings']);
$dbanswers = $DB->get_records_menu('survey_answers', array('survey' => $this->survey->id), '', 'question, answer1');
foreach ($realquestions as $q) {
$id = str_replace('q', '', $q['key']);
$this->assertEquals($q['value'], $dbanswers[$id]);
}
// Submit again, we expect an error here.
try {
mod_survey_external::submit_answers($this->survey->id, $realquestions);
$this->fail('Exception expected due to answers already submitted.');
} catch (\moodle_exception $e) {
$this->assertEquals('alreadysubmitted', $e->errorcode);
}
// Test user with no capabilities.
// We need a explicit prohibit since this capability is only defined in authenticated user and guest roles.
assign_capability('mod/survey:participate', CAP_PROHIBIT, $this->studentrole->id, $this->context->id);
accesslib_clear_all_caches_for_unit_testing();
try {
mod_survey_external::submit_answers($this->survey->id, $realquestions);
$this->fail('Exception expected due to missing capability.');
} catch (\moodle_exception $e) {
$this->assertEquals('nopermissions', $e->errorcode);
}
// Test not-enrolled user.
$usernotenrolled = self::getDataGenerator()->create_user();
$this->setUser($usernotenrolled);
try {
mod_survey_external::submit_answers($this->survey->id, $realquestions);
$this->fail('Exception expected due to not enrolled user.');
} catch (\moodle_exception $e) {
$this->assertEquals('requireloginerror', $e->errorcode);
}
}
}

75
mod/survey/tests/generator/lib.php
View File

@ -1,75 +0,0 @@
<?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/>.
/**
* mod_survey data generator.
*
* @package mod_survey
* @category test
* @copyright 2013 Marina Glancy
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
/**
* mod_survey data generator class.
*
* @package mod_survey
* @category test
* @copyright 2013 Marina Glancy
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class mod_survey_generator extends testing_module_generator {
/**
* Cached list of available templates.
* @var array
*/
private $templates = null;
public function reset() {
$this->templates = null;
parent::reset();
}
public function create_instance($record = null, ?array $options = null) {
global $DB;
if ($this->templates === null) {
$this->templates = $DB->get_records_menu('survey', array('template' => 0), 'name', 'id, name');
}
if (empty($this->templates)) {
throw new moodle_exception('cannotfindsurveytmpt', 'survey');
}
$record = (array)$record;
if (isset($record['template']) && !is_number($record['template'])) {
// Substitute template name with template id.
$record['template'] = array_search($record['template'], $this->templates);
}
if (isset($record['template']) && !array_key_exists($record['template'], $this->templates)) {
throw new moodle_exception('cannotfindsurveytmpt', 'survey');
}
// Add default values for survey.
if (!isset($record['template'])) {
reset($this->templates);
$record['template'] = key($this->templates);
}
return parent::create_instance($record, (array)$options);
}
}

98
mod/survey/tests/generator_test.php
View File

@ -1,98 +0,0 @@
<?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/>.
namespace mod_survey;
/**
* Genarator tests class for mod_survey.
*
* @package mod_survey
* @category test
* @copyright 2013 Marina Glancy
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class generator_test extends \advanced_testcase {
/**
* Setup testcase.
*/
public function setUp(): void {
parent::setUp();
// Survey module is disabled by default, enable it for testing.
$manager = \core_plugin_manager::resolve_plugininfo_class('mod');
$manager::enable_plugin('survey', 1);
}
public function test_create_instance(): void {
global $DB;
$this->resetAfterTest();
$this->setAdminUser();
$course = $this->getDataGenerator()->create_course();
$this->assertFalse($DB->record_exists('survey', array('course' => $course->id)));
$survey = $this->getDataGenerator()->create_module('survey', array('course' => $course));
$records = $DB->get_records('survey', array('course' => $course->id), 'id');
$this->assertEquals(1, count($records));
$this->assertTrue(array_key_exists($survey->id, $records));
$params = array('course' => $course->id, 'name' => 'Another survey');
$survey = $this->getDataGenerator()->create_module('survey', $params);
$records = $DB->get_records('survey', array('course' => $course->id), 'id');
$this->assertEquals(2, count($records));
$this->assertEquals('Another survey', $records[$survey->id]->name);
}
public function test_create_instance_with_template(): void {
global $DB;
$this->resetAfterTest();
$this->setAdminUser();
$course = $this->getDataGenerator()->create_course();
$templates = $DB->get_records_menu('survey', array('template' => 0), 'name', 'id, name');
$firsttemplateid = key($templates);
// By default survey is created with the first available template.
$survey = $this->getDataGenerator()->create_module('survey', array('course' => $course));
$record = $DB->get_record('survey', array('id' => $survey->id));
$this->assertEquals($firsttemplateid, $record->template);
// Survey can be created specifying the template id.
$tmplid = array_search('ciqname', $templates);
$survey = $this->getDataGenerator()->create_module('survey', array('course' => $course,
'template' => $tmplid));
$record = $DB->get_record('survey', array('id' => $survey->id));
$this->assertEquals($tmplid, $record->template);
// Survey can be created specifying the template name instead of id.
$survey = $this->getDataGenerator()->create_module('survey', array('course' => $course,
'template' => 'collesaname'));
$record = $DB->get_record('survey', array('id' => $survey->id));
$this->assertEquals(array_search('collesaname', $templates), $record->template);
// Survey can not be created specifying non-existing template id or name.
try {
$this->getDataGenerator()->create_module('survey', array('course' => $course,
'template' => 87654));
$this->fail('Exception about non-existing numeric template is expected');
} catch (\Exception $e) {}
try {
$this->getDataGenerator()->create_module('survey', array('course' => $course,
'template' => 'nonexistingcode'));
$this->fail('Exception about non-existing string template is expected');
} catch (\Exception $e) {}
}
}

404
mod/survey/tests/lib_test.php
View File

@ -1,404 +0,0 @@
<?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/>.
/**
* Unit tests for mod_survey lib
*
* @package mod_survey
* @category external
* @copyright 2015 Juan Leyva <juan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 3.0
*/
namespace mod_survey;
defined('MOODLE_INTERNAL') || die();
/**
* Unit tests for mod_survey lib
*
* @package mod_survey
* @category external
* @copyright 2015 Juan Leyva <juan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 3.0
*/
class lib_test extends \advanced_testcase {
/**
* Prepares things before this test case is initialised
* @return void
*/
public static function setUpBeforeClass(): void {
global $CFG;
require_once($CFG->dirroot . '/mod/survey/lib.php');
parent::setUpBeforeClass();
}
/**
* Setup testcase.
*/
public function setUp(): void {
parent::setUp();
// Survey module is disabled by default, enable it for testing.
$manager = \core_plugin_manager::resolve_plugininfo_class('mod');
$manager::enable_plugin('survey', 1);
}
/**
* Test survey_view
* @return void
*/
public function test_survey_view(): void {
global $CFG;
$CFG->enablecompletion = 1;
$this->resetAfterTest();
$this->setAdminUser();
// Setup test data.
$course = $this->getDataGenerator()->create_course(array('enablecompletion' => 1));
$survey = $this->getDataGenerator()->create_module('survey', array('course' => $course->id),
array('completion' => 2, 'completionview' => 1));
$context = \context_module::instance($survey->cmid);
$cm = get_coursemodule_from_instance('survey', $survey->id);
// Trigger and capture the event.
$sink = $this->redirectEvents();
survey_view($survey, $course, $cm, $context, 'form');
$events = $sink->get_events();
// 2 additional events thanks to completion.
$this->assertCount(3, $events);
$event = array_shift($events);
// Checking that the event contains the expected values.
$this->assertInstanceOf('\mod_survey\event\course_module_viewed', $event);
$this->assertEquals($context, $event->get_context());
$moodleurl = new \moodle_url('/mod/survey/view.php', array('id' => $cm->id));
$this->assertEquals($moodleurl, $event->get_url());
$this->assertEquals('form', $event->other['viewed']);
$this->assertEventContextNotUsed($event);
$this->assertNotEmpty($event->get_name());
// Check completion status.
$completion = new \completion_info($course);
$completiondata = $completion->get_data($cm);
$this->assertEquals(1, $completiondata->completionstate);
}
/**
* Test survey_order_questions
*/
public function test_survey_order_questions(): void {
global $DB;
$this->resetAfterTest();
$course = $this->getDataGenerator()->create_course();
$survey = $this->getDataGenerator()->create_module('survey', array('course' => $course->id));
$orderedquestionids = explode(',', $survey->questions);
$surveyquestions = $DB->get_records_list("survey_questions", "id", $orderedquestionids);
$questionsordered = survey_order_questions($surveyquestions, $orderedquestionids);
// Check one by one the correct order.
for ($i = 0; $i < count($orderedquestionids); $i++) {
$this->assertEquals($orderedquestionids[$i], $questionsordered[$i]->id);
}
}
/**
* Test survey_save_answers
*/
public function test_survey_save_answers(): void {
global $DB;
$this->resetAfterTest();
$this->setAdminUser();
// Setup test data.
$course = $this->getDataGenerator()->create_course();
$survey = $this->getDataGenerator()->create_module('survey', array('course' => $course->id));
$context = \context_module::instance($survey->cmid);
// Build our questions and responses array.
$realquestions = array();
$questions = survey_get_questions($survey);
$i = 5;
foreach ($questions as $q) {
if ($q->type > 0) {
if ($q->multi) {
$subquestions = survey_get_subquestions($q);
foreach ($subquestions as $sq) {
$key = 'q' . $sq->id;
$realquestions[$key] = $i % 5 + 1;
$i++;
}
} else {
$key = 'q' . $q->id;
$realquestions[$key] = $i % 5 + 1;
$i++;
}
}
}
$sink = $this->redirectEvents();
survey_save_answers($survey, $realquestions, $course, $context);
// Check the stored answers, they must match.
$dbanswers = $DB->get_records_menu('survey_answers', array('survey' => $survey->id), '', 'question, answer1');
foreach ($realquestions as $key => $value) {
$id = str_replace('q', '', $key);
$this->assertEquals($value, $dbanswers[$id]);
}
// Check events.
$events = $sink->get_events();
$this->assertCount(1, $events);
$event = array_shift($events);
// Checking that the event contains the expected values.
$this->assertInstanceOf('\mod_survey\event\response_submitted', $event);
$this->assertEquals($context, $event->get_context());
$this->assertEquals($survey->id, $event->other['surveyid']);
}
public function test_survey_core_calendar_provide_event_action(): void {
$this->resetAfterTest();
$this->setAdminUser();
// Create the activity.
$course = $this->getDataGenerator()->create_course();
$survey = $this->getDataGenerator()->create_module('survey', array('course' => $course->id));
// Create a calendar event.
$event = $this->create_action_event($course->id, $survey->id,
\core_completion\api::COMPLETION_EVENT_TYPE_DATE_COMPLETION_EXPECTED);
// Create an action factory.
$factory = new \core_calendar\action_factory();
// Decorate action event.
$actionevent = mod_survey_core_calendar_provide_event_action($event, $factory);
// Confirm the event was decorated.
$this->assertInstanceOf('\core_calendar\local\event\value_objects\action', $actionevent);
$this->assertEquals(get_string('view'), $actionevent->get_name());
$this->assertInstanceOf('moodle_url', $actionevent->get_url());
$this->assertEquals(1, $actionevent->get_item_count());
$this->assertTrue($actionevent->is_actionable());
}
public function test_survey_core_calendar_provide_event_action_for_user(): void {
global $CFG;
$this->resetAfterTest();
$this->setAdminUser();
// Create the activity.
$course = $this->getDataGenerator()->create_course();
$survey = $this->getDataGenerator()->create_module('survey', array('course' => $course->id));
// Create a student and enrol into the course.
$student = $this->getDataGenerator()->create_and_enrol($course, 'student');
// Create a calendar event.
$event = $this->create_action_event($course->id, $survey->id,
\core_completion\api::COMPLETION_EVENT_TYPE_DATE_COMPLETION_EXPECTED);
// Now log out.
$CFG->forcelogin = true; // We don't want to be logged in as guest, as guest users might still have some capabilities.
$this->setUser();
// Create an action factory.
$factory = new \core_calendar\action_factory();
// Decorate action event for the student.
$actionevent = mod_survey_core_calendar_provide_event_action($event, $factory, $student->id);
// Confirm the event was decorated.
$this->assertInstanceOf('\core_calendar\local\event\value_objects\action', $actionevent);
$this->assertEquals(get_string('view'), $actionevent->get_name());
$this->assertInstanceOf('moodle_url', $actionevent->get_url());
$this->assertEquals(1, $actionevent->get_item_count());
$this->assertTrue($actionevent->is_actionable());
}
public function test_survey_core_calendar_provide_event_action_as_non_user(): void {
global $CFG;
$this->resetAfterTest();
$this->setAdminUser();
// Create the activity.
$course = $this->getDataGenerator()->create_course();
$survey = $this->getDataGenerator()->create_module('survey', array('course' => $course->id));
// Create a calendar event.
$event = $this->create_action_event($course->id, $survey->id,
\core_completion\api::COMPLETION_EVENT_TYPE_DATE_COMPLETION_EXPECTED);
// Log out the user and set force login to true.
\core\session\manager::init_empty_session();
$CFG->forcelogin = true;
// Create an action factory.
$factory = new \core_calendar\action_factory();
// Decorate action event.
$actionevent = mod_survey_core_calendar_provide_event_action($event, $factory);
// Ensure result was null.
$this->assertNull($actionevent);
}
public function test_survey_core_calendar_provide_event_action_already_completed(): void {
global $CFG;
$this->resetAfterTest();
$this->setAdminUser();
$CFG->enablecompletion = 1;
// Create the activity.
$course = $this->getDataGenerator()->create_course(array('enablecompletion' => 1));
$survey = $this->getDataGenerator()->create_module('survey', array('course' => $course->id),
array('completion' => 2, 'completionview' => 1, 'completionexpected' => time() + DAYSECS));
// Get some additional data.
$cm = get_coursemodule_from_instance('survey', $survey->id);
// Create a calendar event.
$event = $this->create_action_event($course->id, $survey->id,
\core_completion\api::COMPLETION_EVENT_TYPE_DATE_COMPLETION_EXPECTED);
// Mark the activity as completed.
$completion = new \completion_info($course);
$completion->set_module_viewed($cm);
// Create an action factory.
$factory = new \core_calendar\action_factory();
// Decorate action event.
$actionevent = mod_survey_core_calendar_provide_event_action($event, $factory);
// Ensure result was null.
$this->assertNull($actionevent);
}
public function test_survey_core_calendar_provide_event_action_already_completed_for_user(): void {
global $CFG;
$this->resetAfterTest();
$this->setAdminUser();
$CFG->enablecompletion = 1;
// Create the activity.
$course = $this->getDataGenerator()->create_course(array('enablecompletion' => 1));
$survey = $this->getDataGenerator()->create_module('survey', array('course' => $course->id),
array('completion' => 2, 'completionview' => 1, 'completionexpected' => time() + DAYSECS));
// Create 2 students and enrol them into the course.
$student1 = $this->getDataGenerator()->create_and_enrol($course, 'student');
$student2 = $this->getDataGenerator()->create_and_enrol($course, 'student');
// Get some additional data.
$cm = get_coursemodule_from_instance('survey', $survey->id);
// Create a calendar event.
$event = $this->create_action_event($course->id, $survey->id,
\core_completion\api::COMPLETION_EVENT_TYPE_DATE_COMPLETION_EXPECTED);
// Mark the activity as completed for the $student1.
$completion = new \completion_info($course);
$completion->set_module_viewed($cm, $student1->id);
// Now log in as $student2.
$this->setUser($student2);
// Create an action factory.
$factory = new \core_calendar\action_factory();
// Decorate action event for $student1.
$actionevent = mod_survey_core_calendar_provide_event_action($event, $factory, $student1->id);
// Ensure result was null.
$this->assertNull($actionevent);
}
/**
* Creates an action event.
*
* @param int $courseid The course id.
* @param int $instanceid The instance id.
* @param string $eventtype The event type.
* @return bool|calendar_event
*/
private function create_action_event($courseid, $instanceid, $eventtype) {
$event = new \stdClass();
$event->name = 'Calendar event';
$event->modulename = 'survey';
$event->courseid = $courseid;
$event->instance = $instanceid;
$event->type = CALENDAR_EVENT_TYPE_ACTION;
$event->eventtype = $eventtype;
$event->timestart = time();
return \calendar_event::create($event);
}
/**
* Test the callback responsible for returning the completion rule descriptions.
* This function should work given either an instance of the module (cm_info), such as when checking the active rules,
* or if passed a stdClass of similar structure, such as when checking the the default completion settings for a mod type.
*/
public function test_mod_survey_completion_get_active_rule_descriptions(): void {
$this->resetAfterTest();
$this->setAdminUser();
// Two activities, both with automatic completion. One has the 'completionsubmit' rule, one doesn't.
$course = $this->getDataGenerator()->create_course(['enablecompletion' => 2]);
$survey1 = $this->getDataGenerator()->create_module('survey', [
'course' => $course->id,
'completion' => 2,
'completionsubmit' => 1,
]);
$survey2 = $this->getDataGenerator()->create_module('survey', [
'course' => $course->id,
'completion' => 2,
'completionsubmit' => 0,
]);
$cm1 = \cm_info::create(get_coursemodule_from_instance('survey', $survey1->id));
$cm2 = \cm_info::create(get_coursemodule_from_instance('survey', $survey2->id));
// Data for the stdClass input type.
// This type of input would occur when checking the default completion rules for an activity type, where we don't have
// any access to cm_info, rather the input is a stdClass containing completion and customdata attributes, just like cm_info.
$moddefaults = new \stdClass();
$moddefaults->customdata = ['customcompletionrules' => ['completionsubmit' => 1]];
$moddefaults->completion = 2;
$activeruledescriptions = [get_string('completionsubmit', 'survey')];
$this->assertEquals(mod_survey_get_completion_active_rule_descriptions($cm1), $activeruledescriptions);
$this->assertEquals(mod_survey_get_completion_active_rule_descriptions($cm2), []);
$this->assertEquals(mod_survey_get_completion_active_rule_descriptions($moddefaults), $activeruledescriptions);
$this->assertEquals(mod_survey_get_completion_active_rule_descriptions(new \stdClass()), []);
}
}

534
mod/survey/tests/privacy/provider_test.php
View File

@ -1,534 +0,0 @@
<?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/>.
/**
* Data provider tests.
*
* @package mod_survey
* @category test
* @copyright 2018 Frédéric Massart
* @author Frédéric Massart <fred@branchup.tech>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace mod_survey\privacy;
defined('MOODLE_INTERNAL') || die();
global $CFG;
use core_privacy\tests\provider_testcase;
use core_privacy\local\request\approved_contextlist;
use core_privacy\local\request\approved_userlist;
use core_privacy\local\request\transform;
use core_privacy\local\request\writer;
use mod_survey\privacy\provider;
require_once($CFG->dirroot . '/mod/survey/lib.php');
/**
* Data provider testcase class.
*
* @package mod_survey
* @category test
* @copyright 2018 Frédéric Massart
* @author Frédéric Massart <fred@branchup.tech>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class provider_test extends provider_testcase {
public function setUp(): void {
global $PAGE;
parent::setUp();
$this->resetAfterTest();
$PAGE->get_renderer('core');
// Survey module is disabled by default, enable it for testing.
$manager = \core_plugin_manager::resolve_plugininfo_class('mod');
$manager::enable_plugin('survey', 1);
}
public function test_get_contexts_for_userid(): void {
$dg = $this->getDataGenerator();
$c1 = $dg->create_course();
$c2 = $dg->create_course();
$cm1a = $dg->create_module('survey', ['template' => 1, 'course' => $c1]);
$cm1b = $dg->create_module('survey', ['template' => 2, 'course' => $c1]);
$cm1c = $dg->create_module('survey', ['template' => 2, 'course' => $c1]);
$cm2a = $dg->create_module('survey', ['template' => 1, 'course' => $c2]);
$cm2b = $dg->create_module('survey', ['template' => 1, 'course' => $c2]);
$u1 = $dg->create_user();
$u2 = $dg->create_user();
$this->create_answer($cm1a->id, 1, $u1->id);
$this->create_answer($cm1a->id, 1, $u2->id);
$this->create_answer($cm1b->id, 1, $u2->id);
$this->create_answer($cm2a->id, 1, $u1->id);
$this->create_analysis($cm2b->id, $u1->id);
$this->create_analysis($cm1c->id, $u2->id);
$contextids = provider::get_contexts_for_userid($u1->id)->get_contextids();
$this->assertCount(3, $contextids);
$this->assertTrue(in_array(\context_module::instance($cm1a->cmid)->id, $contextids));
$this->assertTrue(in_array(\context_module::instance($cm2a->cmid)->id, $contextids));
$this->assertTrue(in_array(\context_module::instance($cm2b->cmid)->id, $contextids));
$contextids = provider::get_contexts_for_userid($u2->id)->get_contextids();
$this->assertCount(3, $contextids);
$this->assertTrue(in_array(\context_module::instance($cm1a->cmid)->id, $contextids));
$this->assertTrue(in_array(\context_module::instance($cm1b->cmid)->id, $contextids));
$this->assertTrue(in_array(\context_module::instance($cm1c->cmid)->id, $contextids));
}
/**
* Test for provider::test_get_users_in_context().
*/
public function test_get_users_in_context(): void {
$dg = $this->getDataGenerator();
$component = 'mod_survey';
$c1 = $dg->create_course();
$c2 = $dg->create_course();
$cm1a = $dg->create_module('survey', ['template' => 1, 'course' => $c1]);
$cm1b = $dg->create_module('survey', ['template' => 2, 'course' => $c1]);
$cm2 = $dg->create_module('survey', ['template' => 1, 'course' => $c2]);
$cm1acontext = \context_module::instance($cm1a->cmid);
$cm1bcontext = \context_module::instance($cm1b->cmid);
$cm2context = \context_module::instance($cm2->cmid);
$u1 = $dg->create_user();
$u2 = $dg->create_user();
$bothusers = [$u1->id, $u2->id];
sort($bothusers);
$this->create_answer($cm1a->id, 1, $u1->id);
$this->create_answer($cm1b->id, 1, $u1->id);
$this->create_answer($cm1b->id, 1, $u2->id);
$this->create_answer($cm2->id, 1, $u2->id);
$this->create_analysis($cm2->id, $u1->id);
// Cm1a should only contain u1.
$userlist = new \core_privacy\local\request\userlist($cm1acontext, $component);
provider::get_users_in_context($userlist);
$this->assertCount(1, $userlist);
$this->assertEquals([$u1->id], $userlist->get_userids());
// Cm1b should contain u1 and u2 (both have answers).
$userlist = new \core_privacy\local\request\userlist($cm1bcontext, $component);
provider::get_users_in_context($userlist);
$this->assertCount(2, $userlist);
$actual = $userlist->get_userids();
sort($actual);
$this->assertEquals($bothusers, $actual);
// Cm2 should contain u1 (analysis) and u2 (answer).
$userlist = new \core_privacy\local\request\userlist($cm2context, $component);
provider::get_users_in_context($userlist);
$this->assertCount(2, $userlist);
$actual = $userlist->get_userids();
sort($actual);
$this->assertEquals($bothusers, $actual);
}
public function test_delete_data_for_all_users_in_context(): void {
global $DB;
$dg = $this->getDataGenerator();
$c1 = $dg->create_course();
$cm1a = $dg->create_module('survey', ['template' => 1, 'course' => $c1]);
$cm1b = $dg->create_module('survey', ['template' => 2, 'course' => $c1]);
$cm1c = $dg->create_module('survey', ['template' => 2, 'course' => $c1]);
$u1 = $dg->create_user();
$u2 = $dg->create_user();
$this->create_answer($cm1a->id, 1, $u1->id);
$this->create_answer($cm1a->id, 1, $u2->id);
$this->create_answer($cm1b->id, 1, $u2->id);
$this->create_answer($cm1c->id, 1, $u1->id);
$this->create_analysis($cm1a->id, $u1->id);
$this->create_analysis($cm1b->id, $u1->id);
$this->create_analysis($cm1a->id, $u2->id);
$this->create_analysis($cm1c->id, $u2->id);
$this->assertTrue($DB->record_exists('survey_answers', ['userid' => $u1->id, 'survey' => $cm1a->id]));
$this->assertTrue($DB->record_exists('survey_answers', ['userid' => $u1->id, 'survey' => $cm1c->id]));
$this->assertTrue($DB->record_exists('survey_answers', ['userid' => $u2->id, 'survey' => $cm1a->id]));
$this->assertTrue($DB->record_exists('survey_answers', ['userid' => $u2->id, 'survey' => $cm1b->id]));
$this->assertTrue($DB->record_exists('survey_analysis', ['userid' => $u1->id, 'survey' => $cm1a->id]));
$this->assertTrue($DB->record_exists('survey_analysis', ['userid' => $u1->id, 'survey' => $cm1b->id]));
$this->assertTrue($DB->record_exists('survey_analysis', ['userid' => $u2->id, 'survey' => $cm1a->id]));
$this->assertTrue($DB->record_exists('survey_analysis', ['userid' => $u2->id, 'survey' => $cm1c->id]));
// Deleting the course does nothing.
provider::delete_data_for_all_users_in_context(\context_course::instance($c1->id));
$this->assertTrue($DB->record_exists('survey_answers', ['userid' => $u1->id, 'survey' => $cm1a->id]));
$this->assertTrue($DB->record_exists('survey_answers', ['userid' => $u1->id, 'survey' => $cm1c->id]));
$this->assertTrue($DB->record_exists('survey_answers', ['userid' => $u2->id, 'survey' => $cm1a->id]));
$this->assertTrue($DB->record_exists('survey_answers', ['userid' => $u2->id, 'survey' => $cm1b->id]));
$this->assertTrue($DB->record_exists('survey_analysis', ['userid' => $u1->id, 'survey' => $cm1a->id]));
$this->assertTrue($DB->record_exists('survey_analysis', ['userid' => $u1->id, 'survey' => $cm1b->id]));
$this->assertTrue($DB->record_exists('survey_analysis', ['userid' => $u2->id, 'survey' => $cm1a->id]));
$this->assertTrue($DB->record_exists('survey_analysis', ['userid' => $u2->id, 'survey' => $cm1c->id]));
provider::delete_data_for_all_users_in_context(\context_module::instance($cm1c->cmid));
$this->assertTrue($DB->record_exists('survey_answers', ['userid' => $u1->id, 'survey' => $cm1a->id]));
$this->assertFalse($DB->record_exists('survey_answers', ['userid' => $u1->id, 'survey' => $cm1c->id]));
$this->assertTrue($DB->record_exists('survey_answers', ['userid' => $u2->id, 'survey' => $cm1a->id]));
$this->assertTrue($DB->record_exists('survey_answers', ['userid' => $u2->id, 'survey' => $cm1b->id]));
$this->assertTrue($DB->record_exists('survey_analysis', ['userid' => $u1->id, 'survey' => $cm1a->id]));
$this->assertTrue($DB->record_exists('survey_analysis', ['userid' => $u1->id, 'survey' => $cm1b->id]));
$this->assertTrue($DB->record_exists('survey_analysis', ['userid' => $u2->id, 'survey' => $cm1a->id]));
$this->assertFalse($DB->record_exists('survey_analysis', ['userid' => $u2->id, 'survey' => $cm1c->id]));
provider::delete_data_for_all_users_in_context(\context_module::instance($cm1a->cmid));
$this->assertFalse($DB->record_exists('survey_answers', ['userid' => $u1->id, 'survey' => $cm1a->id]));
$this->assertFalse($DB->record_exists('survey_answers', ['userid' => $u1->id, 'survey' => $cm1c->id]));
$this->assertFalse($DB->record_exists('survey_answers', ['userid' => $u2->id, 'survey' => $cm1a->id]));
$this->assertTrue($DB->record_exists('survey_answers', ['userid' => $u2->id, 'survey' => $cm1b->id]));
$this->assertFalse($DB->record_exists('survey_analysis', ['userid' => $u1->id, 'survey' => $cm1a->id]));
$this->assertTrue($DB->record_exists('survey_analysis', ['userid' => $u1->id, 'survey' => $cm1b->id]));
$this->assertFalse($DB->record_exists('survey_analysis', ['userid' => $u2->id, 'survey' => $cm1a->id]));
$this->assertFalse($DB->record_exists('survey_analysis', ['userid' => $u2->id, 'survey' => $cm1c->id]));
}
public function test_delete_data_for_user(): void {
global $DB;
$dg = $this->getDataGenerator();
$c1 = $dg->create_course();
$cm1a = $dg->create_module('survey', ['template' => 1, 'course' => $c1]);
$cm1b = $dg->create_module('survey', ['template' => 2, 'course' => $c1]);
$cm1c = $dg->create_module('survey', ['template' => 2, 'course' => $c1]);
$u1 = $dg->create_user();
$u2 = $dg->create_user();
$this->create_answer($cm1a->id, 1, $u1->id);
$this->create_answer($cm1a->id, 1, $u2->id);
$this->create_answer($cm1b->id, 1, $u2->id);
$this->create_answer($cm1c->id, 1, $u1->id);
$this->create_analysis($cm1a->id, $u1->id);
$this->create_analysis($cm1b->id, $u1->id);
$this->create_analysis($cm1a->id, $u2->id);
$this->create_analysis($cm1c->id, $u2->id);
$this->assertTrue($DB->record_exists('survey_answers', ['userid' => $u1->id, 'survey' => $cm1a->id]));
$this->assertTrue($DB->record_exists('survey_answers', ['userid' => $u1->id, 'survey' => $cm1c->id]));
$this->assertTrue($DB->record_exists('survey_answers', ['userid' => $u2->id, 'survey' => $cm1a->id]));
$this->assertTrue($DB->record_exists('survey_answers', ['userid' => $u2->id, 'survey' => $cm1b->id]));
$this->assertTrue($DB->record_exists('survey_analysis', ['userid' => $u1->id, 'survey' => $cm1a->id]));
$this->assertTrue($DB->record_exists('survey_analysis', ['userid' => $u1->id, 'survey' => $cm1b->id]));
$this->assertTrue($DB->record_exists('survey_analysis', ['userid' => $u2->id, 'survey' => $cm1a->id]));
$this->assertTrue($DB->record_exists('survey_analysis', ['userid' => $u2->id, 'survey' => $cm1c->id]));
provider::delete_data_for_user(new approved_contextlist($u1, 'mod_survey', [
\context_course::instance($c1->id)->id,
\context_module::instance($cm1a->cmid)->id,
\context_module::instance($cm1b->cmid)->id,
]));
$this->assertFalse($DB->record_exists('survey_answers', ['userid' => $u1->id, 'survey' => $cm1a->id]));
$this->assertTrue($DB->record_exists('survey_answers', ['userid' => $u1->id, 'survey' => $cm1c->id]));
$this->assertTrue($DB->record_exists('survey_answers', ['userid' => $u2->id, 'survey' => $cm1a->id]));
$this->assertTrue($DB->record_exists('survey_answers', ['userid' => $u2->id, 'survey' => $cm1b->id]));
$this->assertFalse($DB->record_exists('survey_analysis', ['userid' => $u1->id, 'survey' => $cm1a->id]));
$this->assertFalse($DB->record_exists('survey_analysis', ['userid' => $u1->id, 'survey' => $cm1b->id]));
$this->assertTrue($DB->record_exists('survey_analysis', ['userid' => $u2->id, 'survey' => $cm1a->id]));
$this->assertTrue($DB->record_exists('survey_analysis', ['userid' => $u2->id, 'survey' => $cm1c->id]));
}
/**
* Test for provider::delete_data_for_users().
*/
public function test_delete_data_for_users(): void {
global $DB;
$dg = $this->getDataGenerator();
$component = 'mod_survey';
$c1 = $dg->create_course();
$cm1a = $dg->create_module('survey', ['template' => 1, 'course' => $c1]);
$cm1b = $dg->create_module('survey', ['template' => 2, 'course' => $c1]);
$cm1c = $dg->create_module('survey', ['template' => 2, 'course' => $c1]);
$cm1acontext = \context_module::instance($cm1a->cmid);
$cm1bcontext = \context_module::instance($cm1b->cmid);
$u1 = $dg->create_user();
$u2 = $dg->create_user();
$this->create_answer($cm1a->id, 1, $u1->id);
$this->create_answer($cm1a->id, 1, $u2->id);
$this->create_analysis($cm1a->id, $u1->id);
$this->create_analysis($cm1a->id, $u2->id);
$this->create_answer($cm1b->id, 1, $u2->id);
$this->create_analysis($cm1b->id, $u1->id);
$this->create_answer($cm1c->id, 1, $u1->id);
$this->create_analysis($cm1c->id, $u2->id);
// Confirm data exists before deletion.
$this->assertTrue($DB->record_exists('survey_answers', ['userid' => $u1->id, 'survey' => $cm1a->id]));
$this->assertTrue($DB->record_exists('survey_answers', ['userid' => $u1->id, 'survey' => $cm1c->id]));
$this->assertTrue($DB->record_exists('survey_answers', ['userid' => $u2->id, 'survey' => $cm1a->id]));
$this->assertTrue($DB->record_exists('survey_answers', ['userid' => $u2->id, 'survey' => $cm1b->id]));
$this->assertTrue($DB->record_exists('survey_analysis', ['userid' => $u1->id, 'survey' => $cm1a->id]));
$this->assertTrue($DB->record_exists('survey_analysis', ['userid' => $u1->id, 'survey' => $cm1b->id]));
$this->assertTrue($DB->record_exists('survey_analysis', ['userid' => $u2->id, 'survey' => $cm1a->id]));
$this->assertTrue($DB->record_exists('survey_analysis', ['userid' => $u2->id, 'survey' => $cm1c->id]));
// Ensure only approved user data is deleted.
$approveduserids = [$u1->id];
$approvedlist = new approved_userlist($cm1acontext, $component, $approveduserids);
provider::delete_data_for_users($approvedlist);
$this->assertFalse($DB->record_exists('survey_answers', ['userid' => $u1->id, 'survey' => $cm1a->id]));
$this->assertFalse($DB->record_exists('survey_analysis', ['userid' => $u1->id, 'survey' => $cm1a->id]));
$this->assertTrue($DB->record_exists('survey_answers', ['userid' => $u2->id, 'survey' => $cm1a->id]));
$this->assertTrue($DB->record_exists('survey_analysis', ['userid' => $u2->id, 'survey' => $cm1a->id]));
$approveduserids = [$u1->id, $u2->id];
$approvedlist = new approved_userlist($cm1bcontext, $component, $approveduserids);
provider::delete_data_for_users($approvedlist);
$this->assertFalse($DB->record_exists('survey_answers', ['survey' => $cm1b->id]));
$this->assertFalse($DB->record_exists('survey_analysis', ['survey' => $cm1b->id]));
$this->assertTrue($DB->record_exists('survey_answers', ['userid' => $u1->id, 'survey' => $cm1c->id]));
$this->assertTrue($DB->record_exists('survey_analysis', ['userid' => $u2->id, 'survey' => $cm1c->id]));
}
public function test_export_data_for_user(): void {
global $DB;
$dg = $this->getDataGenerator();
$templates = $DB->get_records_menu('survey', array('template' => 0), 'name', 'name, id');
$c1 = $dg->create_course();
$s1a = $dg->create_module('survey', ['template' => $templates['attlsname'], 'course' => $c1]);
$s1b = $dg->create_module('survey', ['template' => $templates['ciqname'], 'course' => $c1]);
$s1c = $dg->create_module('survey', ['template' => $templates['collesapname'], 'course' => $c1]);
$u1 = $dg->create_user();
$u2 = $dg->create_user();
$s1actx = \context_module::instance($s1a->cmid);
$s1bctx = \context_module::instance($s1b->cmid);
$s1cctx = \context_module::instance($s1c->cmid);
$this->answer_survey($s1a, $u1, $c1, $s1actx);
$this->answer_survey($s1b, $u1, $c1, $s1bctx);
$this->create_analysis($s1a->id, $u1->id, 'Hello,');
$this->answer_survey($s1a, $u2, $c1, $s1actx);
$this->answer_survey($s1c, $u2, $c1, $s1cctx);
$this->create_analysis($s1b->id, $u2->id, 'World!');
provider::export_user_data(new approved_contextlist($u1, 'mod_survey', [$s1actx->id, $s1bctx->id, $s1cctx->id]));
$data = writer::with_context($s1actx)->get_data([]);
$this->assertNotEmpty($data);
$this->assert_exported_answers($data->answers, $u1, $s1a);
$data = writer::with_context($s1actx)->get_related_data([], 'survey_analysis');
$this->assertEquals('Hello,', $data->notes);
$data = writer::with_context($s1bctx)->get_data([]);
$this->assertNotEmpty($data);
$this->assert_exported_answers($data->answers, $u1, $s1b);
$data = writer::with_context($s1bctx)->get_related_data([], 'survey_analysis');
$this->assertEmpty($data);
$data = writer::with_context($s1cctx)->get_data([]);
$this->assertEmpty($data);
$data = writer::with_context($s1cctx)->get_related_data([], 'survey_analysis');
$this->assertEmpty($data);
writer::reset();
provider::export_user_data(new approved_contextlist($u2, 'mod_survey', [$s1actx->id, $s1bctx->id, $s1cctx->id]));
$data = writer::with_context($s1actx)->get_data([]);
$this->assertNotEmpty($data);
$this->assert_exported_answers($data->answers, $u2, $s1a);
$data = writer::with_context($s1actx)->get_related_data([], 'survey_analysis');
$this->assertEmpty($data);
$data = writer::with_context($s1bctx)->get_data([]);
$this->assertEmpty($data);
$data = writer::with_context($s1bctx)->get_related_data([], 'survey_analysis');
$this->assertEquals('World!', $data->notes);
$data = writer::with_context($s1cctx)->get_data([]);
$this->assertNotEmpty($data);
$this->assert_exported_answers($data->answers, $u2, $s1c);
$data = writer::with_context($s1cctx)->get_related_data([], 'survey_analysis');
$this->assertEmpty($data);
}
/**
* Answer a survey in a predictable manner.
*
* @param stdClass $survey The survey.
* @param stdClass $user The user.
* @param stdClass $course The course.
* @param context_module $context The module context.
* @return void
*/
protected function answer_survey($survey, $user, $course, \context_module $context) {
global $USER;
$userid = $user->id;
$questions = survey_get_questions($survey);
$answer = function(&$answers, $q) use ($userid) {
$key = 'q' . ($q->type == 2 ? 'P' : '') . $q->id;
if ($q->type < 1) {
$a = "A:{$q->id}:{$userid}";
$answers[$key] = $a;
} else if ($q->type < 3) {
$options = explode(',', get_string($q->options, 'mod_survey'));
$answers[$key] = ($q->id + $userid) % count($options) + 1;
} else {
$options = explode(',', get_string($q->options, 'mod_survey'));
$answers["q{$q->id}"] = ($q->id + $userid) % count($options) + 1;
$answers["qP{$q->id}"] = ($q->id + $userid + 1) % count($options) + 1;
}
};
foreach ($questions as $q) {
if ($q->type < 0) {
continue;
} else if ($q->type > 0 && $q->multi) {
$subquestions = survey_get_subquestions($q);
foreach ($subquestions as $sq) {
$answer($answers, $sq);
}
} else {
$answer($answers, $q);
}
}
$origuser = $USER;
$this->setUser($user);
survey_save_answers($survey, $answers, $course, $context);
$this->setUser($origuser);
}
/**
* Assert the answers provided to a survey.
*
* @param array $answers The answers.
* @param object $user The user.
* @param object $survey The survey.
* @return void
*/
protected function assert_exported_answers($answers, $user, $survey) {
global $DB;
$userid = $user->id;
$questionids = explode(',', $survey->questions);
$topquestions = $DB->get_records_list('survey_questions', 'id', $questionids, 'id');
$questions = [];
foreach ($topquestions as $q) {
if ($q->type < 0) {
continue;
} else if ($q->type > 0 && $q->multi) {
$questionids = explode(',', $q->multi);
$subqs = $DB->get_records_list('survey_questions', 'id', $questionids, 'id');
} else {
$subqs = [$q];
}
foreach ($subqs as $sq) {
$questions[] = $sq;
}
}
$this->assertCount(count($questions), $answers);
$answer = reset($answers);
foreach ($questions as $question) {
$qtype = $question->type;
$question = survey_translate_question($question);
$options = $qtype > 0 ? explode(',', $question->options) : '-';
$this->assertEquals($question->text, $answer['question']['text']);
$this->assertEquals($question->shorttext, $answer['question']['shorttext']);
$this->assertEquals($question->intro, $answer['question']['intro']);
$this->assertEquals($options, $answer['question']['options']);
if ($qtype < 1) {
$this->assertEquals("A:{$question->id}:{$userid}", $answer['answer']['actual']);
} else if ($qtype == 1 || $qtype == 2) {
$chosen = ($question->id + $userid) % count($options);
$key = $qtype == 1 ? 'actual' : 'preferred';
$this->assertEquals($options[$chosen], $answer['answer'][$key]);
} else {
$chosen = ($question->id + $userid) % count($options);
$this->assertEquals($options[$chosen], $answer['answer']['actual']);
$chosen = ($question->id + $userid + 1) % count($options);
$this->assertEquals($options[$chosen], $answer['answer']['preferred']);
}
// Grab next answer, if any.
$answer = next($answers);
}
}
/**
* Create analysis.
*
* @param int $surveyid The survey ID.
* @param int $userid The user ID.
* @param string $notes The nodes.
* @return stdClass
*/
protected function create_analysis($surveyid, $userid, $notes = '') {
global $DB;
$record = (object) [
'survey' => $surveyid,
'userid' => $userid,
'notes' => $notes
];
$record->id = $DB->insert_record('survey_analysis', $record);
return $record;
}
/**
* Create answer.
*
* @param int $surveyid The survey ID.
* @param int $questionid The question ID.
* @param int $userid The user ID.
* @param string $answer1 The first answer field.
* @param string $answer2 The second answer field.
* @return stdClass
*/
protected function create_answer($surveyid, $questionid, $userid, $answer1 = '', $answer2 = '') {
global $DB;
$record = (object) [
'survey' => $surveyid,
'question' => $questionid,
'userid' => $userid,
'answer1' => $answer1,
'answer2' => $answer2,
'time' => time()
];
$record->id = $DB->insert_record('survey_answers', $record);
return $record;
}
}

85
mod/survey/tests/search/search_test.php
View File

@ -1,85 +0,0 @@
<?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/>.
/**
* Unit test for mod_survey searching.
*
* This is needed because the activity.php class overrides default behaviour.
*
* @package mod_survey
* @category test
* @copyright 2017 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace mod_survey\search;
/**
* Unit test for mod_survey searching.
*
* This is needed because the activity.php class overrides default behaviour.
*
* @package mod_survey
* @category test
* @copyright 2017 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class search_test extends \advanced_testcase {
/**
* Setup testcase.
*/
public function setUp(): void {
parent::setUp();
// Survey module is disabled by default, enable it for testing.
$manager = \core_plugin_manager::resolve_plugininfo_class('mod');
$manager::enable_plugin('survey', 1);
}
/**
* Test survey_view
* @return void
*/
public function test_survey_indexing(): void {
global $CFG;
$this->resetAfterTest();
require_once($CFG->dirroot . '/search/tests/fixtures/testable_core_search.php');
\testable_core_search::instance();
$area = \core_search\manager::get_search_area('mod_survey-activity');
// Setup test data.
$generator = $this->getDataGenerator();
$course = $generator->create_course();
$survey1 = $generator->create_module('survey', ['course' => $course->id]);
$survey2 = $generator->create_module('survey', ['course' => $course->id]);
// Get all surveys for indexing - note that there are special entries in the table with
// course zero which should not be returned.
$rs = $area->get_document_recordset();
$this->assertEquals(2, iterator_count($rs));
$rs->close();
// Test specific context and course context.
$rs = $area->get_document_recordset(0, \context_module::instance($survey1->cmid));
$this->assertEquals(1, iterator_count($rs));
$rs->close();
$rs = $area->get_document_recordset(0, \context_course::instance($course->id));
$this->assertEquals(2, iterator_count($rs));
$rs->close();
}
}

30
mod/survey/version.php
View File

@ -1,30 +0,0 @@
<?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/>.
/**
* Version information
*
* @package mod_survey
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
$plugin->version = 2024100700; // The current module version (Date: YYYYMMDDXX).
$plugin->requires = 2024100100; // Requires this Moodle version.
$plugin->component = 'mod_survey'; // Full name of the plugin (used for diagnostics)
$plugin->cron = 0;

184
mod/survey/view.php
View File

@ -1,184 +0,0 @@
<?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/>.
/**
* This file is responsible for displaying the survey
*
* @package mod_survey
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
require_once("../../config.php");
require_once("lib.php");
$id = required_param('id', PARAM_INT); // Course Module ID.
if (! $cm = get_coursemodule_from_id('survey', $id)) {
throw new \moodle_exception('invalidcoursemodule');
}
$cm = cm_info::create($cm);
if (! $course = $DB->get_record("course", array("id" => $cm->course))) {
throw new \moodle_exception('coursemisconf');
}
$PAGE->set_url('/mod/survey/view.php', array('id' => $id));
require_login($course, false, $cm);
$context = context_module::instance($cm->id);
require_capability('mod/survey:participate', $context);
if (! $survey = $DB->get_record("survey", array("id" => $cm->instance))) {
throw new \moodle_exception('invalidsurveyid', 'survey');
}
if (! $template = $DB->get_record("survey", array("id" => $survey->template))) {
throw new \moodle_exception('invalidtmptid', 'survey');
}
$showscales = ($template->name != 'ciqname');
// Check the survey hasn't already been filled out.
$surveyalreadydone = survey_already_done($survey->id, $USER->id);
if ($surveyalreadydone) {
// Trigger course_module_viewed event and completion.
survey_view($survey, $course, $cm, $context, 'graph');
} else {
survey_view($survey, $course, $cm, $context, 'form');
}
$strsurvey = get_string("modulename", "survey");
$PAGE->set_title($survey->name);
$PAGE->set_heading($course->fullname);
// No need to show the description if the survey is done and a graph page is to be shown.
if ($surveyalreadydone && $showscales) {
$PAGE->activityheader->set_description('');
} else {
// If the survey has empty description, display the default one.
$trimmedintro = trim($survey->intro);
if (empty($trimmedintro)) {
$tempo = $DB->get_field("survey", "intro", array("id" => $survey->template));
$PAGE->activityheader->set_description(get_string($tempo, "survey"));
}
}
$PAGE->add_body_class('limitedwidth');
echo $OUTPUT->header();
// Check to see if groups are being used in this survey.
if ($groupmode = groups_get_activity_groupmode($cm)) { // Groups are being used.
$currentgroup = groups_get_activity_group($cm);
} else {
$currentgroup = 0;
}
$groupingid = $cm->groupingid;
if (has_capability('mod/survey:readresponses', $context) or ($groupmode == VISIBLEGROUPS)) {
$currentgroup = 0;
}
if (!$cm->visible) {
notice(get_string("activityiscurrentlyhidden"));
}
if (!is_enrolled($context)) {
echo $OUTPUT->notification(get_string("guestsnotallowed", "survey"));
}
if ($surveyalreadydone) {
$numusers = survey_count_responses($survey->id, $currentgroup, $groupingid);
if ($showscales) {
// Ensure that graph.php will allow the user to see the graph.
if (has_capability('mod/survey:readresponses', $context) || !$groupmode || groups_is_member($currentgroup)) {
echo $OUTPUT->box(get_string("surveycompleted", "survey"));
echo $OUTPUT->box(get_string("peoplecompleted", "survey", $numusers));
echo '<div class="resultgraph">';
survey_print_graph("id=$cm->id&amp;sid=$USER->id&amp;group=$currentgroup&amp;type=student.png");
echo '</div>';
} else {
echo $OUTPUT->box(get_string("surveycompletednograph", "survey"));
echo $OUTPUT->box(get_string("peoplecompleted", "survey", $numusers));
}
} else {
echo $OUTPUT->spacer(array('height' => 30, 'width' => 1), true); // Should be done with CSS instead.
$questions = survey_get_questions($survey);
foreach ($questions as $question) {
if ($question->type == 0 or $question->type == 1) {
if ($answer = survey_get_user_answer($survey->id, $question->id, $USER->id)) {
$table = new html_table();
$table->head = array(get_string($question->text, "survey"));
$table->align = array ("left");
$table->data[] = array(s($answer->answer1));// No html here, just plain text.
echo html_writer::table($table);
echo $OUTPUT->spacer(array('height' => 30, 'width' => 1), true);
}
}
}
}
echo $OUTPUT->footer();
exit;
}
echo "<form method=\"post\" action=\"save.php\" id=\"surveyform\">";
echo '<div>';
echo "<input type=\"hidden\" name=\"id\" value=\"$id\" />";
echo "<input type=\"hidden\" name=\"sesskey\" value=\"".sesskey()."\" />";
echo '<div>'. get_string('allquestionrequireanswer', 'survey'). '</div>';
// Get all the major questions in order.
$questions = survey_get_questions($survey);
global $qnum; // TODO: ugly globals hack for survey_print_*().
$qnum = 0;
foreach ($questions as $question) {
if ($question->type >= 0) {
$question = survey_translate_question($question);
if ($question->multi) {
survey_print_multi($question);
} else {
survey_print_single($question);
}
}
}
if (!is_enrolled($context)) {
echo '</div>';
echo "</form>";
echo $OUTPUT->footer();
exit;
}
$PAGE->requires->js_call_amd('mod_survey/validation', 'ensureRadiosChosen', array('surveyform'));
echo '<br />';
echo '<input type="submit" class="btn btn-primary" value="'. get_string("submit"). '" />';
echo '</div>';
echo "</form>";
echo $OUTPUT->footer();

2
version.php
View File

@ -29,7 +29,7 @@
defined('MOODLE_INTERNAL') || die();
$version = 2024120500.00; // YYYYMMDD = weekly release date of this DEV branch.
$version = 2024120500.01; // YYYYMMDD = weekly release date of this DEV branch.
// RR = release increments - 00 in DEV branches.
// .XX = incremental changes.
$release = '5.0dev (Build: 20241205)'; // Human-friendly version name