$pageresult" : $pageresult; + } else { + $pagenum = $pageresult; } - if (count($choices) == 1) { - $data['questions'][$pagenum][$i]['value'] = $data['questions'][$pagenum][$i]['choices'][0]['value']; + } else if ($action == 'previouspage') { + $prevpage = $result['nextpagenum']; + if ($prevpage === false) { + $pagenum = 1; + } else { + $pagenum = $prevpage; } - $i++; - } - } - if (isset($data['questions'][$pagenum]) && !empty($data['questions'][$pagenum])) { - $i = 0; - foreach ($data['questions'][$pagenum] as $arr) { - $data['pagequestions'][$i] = $arr; - $i++; + } else if ($action == 'submit') { + self::add_index_data($questionnaire, $data, $userid); + $data['action'] = 'index'; + $template = "mod_questionnaire/local/mobile/$versionname/main_index_page"; + break; } - } - if (isset($questionnaire['questions'][$pagenum + 1]) && !empty($questionnaire['questions'][$pagenum + 1])) { - $data['nextpage'] = $pagenum + 1; - } - if ($prevpage) { - $data['prevpage'] = $prevpage; - } - } - - if ($questionnaire['completed'] == true) { - // Branching specific logic. - // If we are branching and the questionnaire is complete, display all the responses on one page. - $pagecounter = 1; - foreach ($questionnaire['questions'] as $question) { - $i = 0; - foreach ($questionnaire['questions'][$pagecounter] as $questionid => $choices) { - if (isset($questionnaire['questionsinfo'][$pagecounter][$questionid]) && - !empty($questionnaire['questionsinfo'][$pagecounter][$questionid])) { - $data['questions'][$pagecounter][$i]['info'] - = $questionnaire['questionsinfo'][$pagecounter][$questionid]; - if ($data['questions'][$pagecounter][$i]['info']['required'] == 'n') { - unset($data['questions'][$pagecounter][$i]['info']['required']); - } - $ii = 0; - foreach ($choices as $k => $v) { - $data['questions'][$pagecounter][$i]['choices'][$ii] = (array) $v; - $ii++; - } - if (count($choices) == 1) { - $data['questions'][$pagecounter][$i]['value'] - = $data['questions'][$pagecounter][$i]['choices'][0]['value']; - } - $i++; + $pagequestiondata = self::add_pagequestion_data($questionnaire, $pagenum, $response); + $data['pagequestions'] = $pagequestiondata['pagequestions']; + $responses = $pagequestiondata['responses']; + $numpages = count($questionnaire->questionsbysec); + // Set some variables we are going to be using. + if (!empty($questionnaire->questionsbysec) && ($numpages > 1)) { + if ($pagenum > 1) { + $data['prevpage'] = true; } - if ($pagecounter > count($questionnaire['questions'])) { - break; + if ($pagenum < $numpages) { + $data['nextpage'] = true; } } - $pagecounter++; - $x = 0; - $questioncounter = 1; - foreach ($data['questions'] as $dataq) { - foreach ($dataq as $arr) { - $data['pagequestions'][$x] = $arr; - $x++; - if ($questioncounter >= count($questionnaire['questions'])) { - break; - } - } - $questioncounter++; - } + $data['pagenum'] = $pagenum; + $data['completed'] = 0; + $data['emptypage'] = 0; + $template = "mod_questionnaire/local/mobile/$versionname/view_activity_page"; } + break; - $data['prevpage'] = 0; - $data['nextpage'] = 0; - $pagebreaks = false; - } - } else { - $data['emptypage'] = true; - $data['emptypage_content'] = get_string('questionnaire:submit', 'questionnaire'); - } - // Let each pagequestions know it's current required step, and fill up the final required step. - // Logic states that we get all the required steps and give them an counter. - // We get the final required count and check it againts the input once it's sent to a js file. - // If its the final required count we display the button. - $currentrequiredresponse = 0; - $counter = 0; - $multichoiceflag = false; - $completedchoices = 0; - $finalpagerequired = false; - $completeddisabledflag = false; - foreach ($data['pagequestions'] as &$pagequestion) { - if ($pagequestion['info']['required'] == 'y') { - if (!empty($pagequestion['choices']) && $pagequestion['info']['response_table'] == 'response_rank') { - foreach ($pagequestion['choices'] as &$choice) { - if (empty($choice['value'])) { - if ($currentrequiredresponse > 0 && empty($counter)) { - $counter = $currentrequiredresponse; + case 'review': + // If reviewing a submission. + if ($questionnaire->capabilities->readownresponses && isset($args->submissionid) && !empty($args->submissionid)) { + $questionnaire->add_response($args->submissionid); + $response = $questionnaire->responses[$args->submissionid]; + $qnum = 1; + $pagequestions = []; + foreach ($questionnaire->questions as $question) { + if ($question->supports_mobile()) { + $pagequestions[] = $question->mobile_question_display($qnum, $questionnaire->autonum); + $responses = array_merge($responses, $question->get_mobile_response_data($response)); + if ($question->is_numbered()) { + $qnum++; } - $counter++; - $choice['current_required_resp'] = $counter; - } else { - $completedchoices++; - $completeddisabledflag = true; } } - $currentrequiredresponse = $counter; - } else { - $currentrequiredresponse++; - $pagequestion['info']['current_required_resp'] = $currentrequiredresponse; + $data['prevpage'] = 0; + $data['nextpage'] = 0; + $data['pagequestions'] = $pagequestions; + $data['completed'] = 1; + $data['emptypage'] = 0; + $template = "mod_questionnaire/local/mobile/$versionname/view_activity_page"; } - if ($pagequestion['info']['qnum'] === count($data['pagequestions'])) { - $finalpagerequired = true; - } - } - } - - $disablesavebutton = true; - if ($completedchoices == $currentrequiredresponse && !$finalpagerequired) { - $disablesavebutton = false; - } else if ($completeddisabledflag) { - $disablesavebutton = false; - } else { - $disablesavebutton = true; + break; } - // Let each pagequestions know what the final required field is. - foreach ($data['pagequestions'] as &$pagequestion) { - $pagequestion['info']['final_required_resp'] = $currentrequiredresponse - $completedchoices; - } - - $mobileviewactivity = 'mod_questionnaire/mobile_view_activity_page'; - if ($branching) { - $mobileviewactivity = 'mod_questionnaire/mobile_view_activity_branching_page'; - } + $data['hasmorepages'] = $data['prevpage'] || $data['nextpage']; - $data['pagebreak'] = true; - - return [ + $return = [ 'templates' => [ [ 'id' => 'main', - 'html' => $OUTPUT->render_from_template($mobileviewactivity, $data) + 'html' => $OUTPUT->render_from_template($template, $data) ], ], - 'javascript' => file_get_contents($CFG->dirroot . '/mod/questionnaire/javascript/mobile_questionnaire.js'), - 'otherdata' => [ - 'fields' => json_encode($questionnaire['fields']), - 'questionsinfo' => json_encode($questionnaire['questionsinfo']), - 'questions' => json_encode($questionnaire['questions']), - 'pagequestions' => json_encode($data['pagequestions']), - 'responses' => json_encode($questionnaire['responses']), - 'pagenum' => $pagenum, - 'nextpage' => $data['nextpage'], - 'prevpage' => $data['prevpage'], - 'completed' => $data['completed'], - 'intro' => $questionnaire['questionnaire']['intro'], - 'string_required' => get_string('required'), - 'string_dropdown' => get_string('selectdropdowntext', 'mod_questionnaire'), - 'disable_save' => $disablesavebutton, - ], + 'javascript' => file_get_contents($CFG->dirroot . '/mod/questionnaire/appjs/uncheckother.js'), + 'otherdata' => $responses, 'files' => null ]; + return $return; } /** @@ -302,169 +205,74 @@ protected static function require_capability(\stdClass $cm, \context $context, s require_capability($cap, $context); } - public static function mobile_view_activity_branching($args) { - global $OUTPUT, $USER, $CFG, $DB, $SESSION; - - require_once($CFG->dirroot.'/mod/questionnaire/questionnaire.class.php'); - require_once($CFG->dirroot . '/mod/questionnaire/lib.php'); - $args = (object) $args; - $cmid = $args->cmid; - $pagenum = (isset($args->pagenum) && !empty($args->pagenum)) ? intval($args->pagenum) : 1; - $prevpage = 0; - if (!empty($SESSION->prevpage)) { - $prevpage = $SESSION->prevpage; - if (!$prevpage) { - $SESSION->prevpage = $pagenum; - if ($pagenum == 1) { - $prevpage = 0; - } else { - $prevpage = $pagenum; - } + /** + * Add the submissions. + * @param \questionnaire $questionnaire + * @param array $data + * @param int $userid + */ + protected static function add_index_data($questionnaire, &$data, $userid) { + // List any existing submissions, if user is allowed to review them. + if ($questionnaire->capabilities->readownresponses) { + $questionnaire->add_user_responses(); + $submissions = []; + foreach ($questionnaire->responses as $response) { + $submissions[] = ['submissiondate' => userdate($response->submitted), 'submissionid' => $response->id]; } + if (!empty($submissions)) { + $data['submissions'] = $submissions; + } else { + $data['emptypage'] = 1; + } + if ($questionnaire->user_has_saved_response($userid)) { + $data['resume'] = 1; + } + $data['emptypage'] = 0; } - $quesitonnaireresponses = (!empty($args->responses)) ? $args->responses : []; - $branching = (isset($args->branching) && !empty($args->branching)) ? intval($args->branching) : 0; - // Capabilities check. - $cm = get_coursemodule_from_id('questionnaire', $cmid); - $context = \context_module::instance($cmid); - self::require_capability($cm, $context, 'mod/questionnaire:view'); - // Set some variables we are going to be using. - $questionnaire = get_questionnaire_data($cmid, $USER->id); - if (isset($questionnaire['questions'][$pagenum - 1]) && !empty($questionnaire['questions'][$pagenum - 1])) { - $prevpage = $pagenum - 1; - } + } - $branching = check_mobile_branching_logic($questionnaire); - $pagenum = get_mobile_questionnaire($questionnaire, $pagenum, $branching); - $newpagenum = $pagenum['pagenum']; - $newprevpagenum = $prevpage; - $newnextpagenum = $pagenum['nextpage']; - $pagenum = $newpagenum; + /** + * Ass the questions for the page. + * @param \questionnaire $questionnaire + * @param int $pagenum + * @param response $response + * @return array + */ + protected static function add_pagequestion_data($questionnaire, $pagenum, $response=null) { + $qnum = 1; + $pagequestions = []; + $responses = []; - $data = [ - 'questionnaire' => $questionnaire, - 'cmid' => $cmid, - 'courseid' => intval($cm->course), - 'pagenum' => $pagenum, - 'userid' => $USER->id, - 'nextpage' => 0, - 'prevpage' => 0, - 'emptypage' => false - ]; - $data['completed'] = (isset($questionnaire['response']['complete']) - && $questionnaire['response']['complete'] == 'y') ? 1 : 0; - $data['complete_userdate'] = (isset($questionnaire['response']['complete']) - && $questionnaire['response']['complete'] == 'y') ? - userdate($questionnaire['response']['submitted']) : ''; - if (isset($questionnaire['questions'][$pagenum])) { - $i = 0; - foreach ($questionnaire['questions'][$pagenum] as $questionid => $choices) { - if (isset($questionnaire['questionsinfo'][$pagenum][$questionid]) - && !empty($questionnaire['questionsinfo'][$pagenum][$questionid])) { - $data['questions'][$pagenum][$i]['info'] = $questionnaire['questionsinfo'][$pagenum][$questionid]; - if ($data['questions'][$pagenum][$i]['info']['required'] == 'n') { - unset($data['questions'][$pagenum][$i]['info']['required']); - } - $ii = 0; - foreach ($choices as $k => $v) { - $data['questions'][$pagenum][$i]['choices'][$ii] = (array) $v; - $ii++; - } - if (count($choices) == 1) { - $data['questions'][$pagenum][$i]['value'] = $data['questions'][$pagenum][$i]['choices'][0]['value']; + // Find out what question number we are on $i New fix for question numbering. + $i = 0; + if ($pagenum > 1) { + for ($j = 2; $j <= $pagenum; $j++) { + foreach ($questionnaire->questionsbysec[$j - 1] as $questionid) { + if ($questionnaire->questions[$questionid]->type_id < QUESPAGEBREAK) { + $i++; } - $i++; } } - if (isset($data['questions'][$pagenum]) && !empty($data['questions'][$pagenum])) { - $i = 0; - foreach ($data['questions'][$pagenum] as $arr) { - $data['pagequestions'][$i] = $arr; - $i++; - } - } - if (isset($questionnaire['questions'][$pagenum + 1]) && !empty($questionnaire['questions'][$pagenum + 1])) { - $data['nextpage'] = $pagenum + 1; - } - if ($prevpage) { - $data['prevpage'] = $prevpage; - } } - // Let each pagequestions know it's current required step, and fill up the final required step. - // Logic states that we get all the required steps and give them an counter. - // We get the final required count and check it againts the input once it's sent to a js file. - // If its the final required count we display the button. - $currentrequiredresponse = 0; - $counter = 0; - $multichoiceflag = false; - $completedchoices = 0; - $finalpagerequired = false; - $completeddisabledflag = false; - foreach ($data['pagequestions'] as &$pagequestion) { - if ($pagequestion['info']['required'] == 'y') { - if (!empty($pagequestion['choices']) && $pagequestion['info']['response_table'] == 'response_rank') { - foreach ($pagequestion['choices'] as &$choice) { - if (empty($choice['value'])) { - if ($currentrequiredresponse > 0 && empty($counter)) { - $counter = $currentrequiredresponse; - } - $counter++; - $choice['current_required_resp'] = $counter; - } else { - $completedchoices++; - $completeddisabledflag = true; - } - } - $currentrequiredresponse = $counter; - } else { - $currentrequiredresponse++; - $pagequestion['info']['current_required_resp'] = $currentrequiredresponse; + $qnum = $i + 1; + + foreach ($questionnaire->questionsbysec[$pagenum] as $questionid) { + $question = $questionnaire->questions[$questionid]; + if ($question->supports_mobile()) { + $pagequestions[] = $question->mobile_question_display($qnum, $questionnaire->autonum); + $mobileotherdata = $question->mobile_otherdata(); + if (!empty($mobileotherdata)) { + $responses = array_merge($responses, $mobileotherdata); } - if ($pagequestion['info']['qnum'] === count($data['pagequestions'])) { - $finalpagerequired = true; + if (($response !== null) && isset($response->answers[$questionid])) { + $responses = array_merge($responses, $question->get_mobile_response_data($response)); + } + if ($question->is_numbered()) { + $qnum++; } } } - $disablesavebutton = true; - if ($completedchoices == $currentrequiredresponse && !$finalpagerequired) { - $disablesavebutton = false; - } else if ($completeddisabledflag) { - $disablesavebutton = false; - } else { - $disablesavebutton = true; - } - - // Let each pagequestions know what the final required field is. - foreach ($data['pagequestions'] as &$pagequestion) { - $pagequestion['info']['final_required_resp'] = $currentrequiredresponse; - } - $data['pagebreak'] = true; // Branching logic is always true. - - return [ - 'templates' => [ - [ - 'id' => 'main', - 'html' => $OUTPUT->render_from_template('mod_questionnaire/mobile_view_activity_branching_page', $data) - ], - ], - 'javascript' => file_get_contents($CFG->dirroot . '/mod/questionnaire/javascript/mobile_questionnaire.js'), - 'otherdata' => [ - 'fields' => json_encode($questionnaire['fields']), - 'questionsinfo' => json_encode($questionnaire['questionsinfo']), - 'questions' => json_encode($questionnaire['questions']), - 'pagequestions' => json_encode($data['pagequestions']), - 'responses' => json_encode($questionnaire['responses']), - 'pagenum' => $pagenum, - 'nextpage' => $newnextpagenum, - 'prevpage' => $newprevpagenum, - 'completed' => $data['completed'], - 'intro' => $questionnaire['questionnaire']['intro'], - 'string_required' => get_string('required'), - 'string_dropdown' => get_string('selectdropdowntext', 'mod_questionnaire'), - 'disable_save' => $disablesavebutton, - ], - 'files' => null - ]; + return ['pagequestions' => $pagequestions, 'responses' => $responses]; } -} \ No newline at end of file +} diff --git a/classes/output/nonrespondentspage.php b/classes/output/nonrespondentspage.php index 2f8b6312..4771ebf0 100644 --- a/classes/output/nonrespondentspage.php +++ b/classes/output/nonrespondentspage.php @@ -14,6 +14,8 @@ // You should have received a copy of the GNU General Public License // along with Moodle. If not, see
';
- $output .= !empty($data->{'q'.$this->id}) ? format_text($data->{'q'.$this->id}, FORMAT_HTML) : ' ';
+ $output .= $answer;
$output .= '
';
return $output;
}
// Note - intentianally returning 'precise' for length and 'length' for precise.
+ /**
+ * Return the length form element.
+ * @param \MoodleQuickForm $mform
+ * @param string $helptext
+ */
protected function form_length(\MoodleQuickForm $mform, $helptext = '') {
- $responseformats = array(
+ $responseformats = [
"0" => get_string('formateditor', 'questionnaire'),
- "1" => get_string('formatplain', 'questionnaire'));
+ "1" => get_string('formatplain', 'questionnaire')];
$mform->addElement('select', 'precise', get_string('responseformat', 'questionnaire'), $responseformats);
$mform->setType('precise', PARAM_INT);
return $mform;
}
+ /**
+ * True if question provides mobile support.
+ * @return bool
+ */
+ public function supports_mobile() {
+ return true;
+ }
+
+ /**
+ * Return the precision form element.
+ * @param \MoodleQuickForm $mform
+ * @param string $helptext
+ */
protected function form_precise(\MoodleQuickForm $mform, $helptext = '') {
- $choices = array();
+ $choices = [];
for ($lines = 5; $lines <= 40; $lines += 5) {
$choices[$lines] = get_string('nlines', 'questionnaire', $lines);
}
@@ -101,4 +161,4 @@ protected function form_precise(\MoodleQuickForm $mform, $helptext = '') {
$mform->setType('length', PARAM_INT);
return $mform;
}
-}
\ No newline at end of file
+}
diff --git a/classes/question/numerical.php b/classes/question/numerical.php
index ca74ff21..d86bbedb 100644
--- a/classes/question/numerical.php
+++ b/classes/question/numerical.php
@@ -14,39 +14,51 @@
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see ');
- $options = ['wrap' => 'virtual', 'class' => 'qopts'];
- $mform->addElement('textarea', 'allchoices', get_string('possibleanswers', 'questionnaire'), $options);
- $mform->setType('allchoices', PARAM_RAW);
- $mform->addRule('allchoices', null, 'required', null, 'client');
- $mform->addHelpButton('allchoices', $helpname, 'questionnaire');
- $mform->addElement('html', '
');
- $mform->addElement('hidden', 'num_choices', $numchoices);
- $mform->setType('num_choices', PARAM_INT);
+ $mform->addElement('html', '');
+ $options = ['wrap' => 'virtual', 'class' => 'qopts'];
+ $mform->addElement('textarea', 'allchoices', get_string('possibleanswers', 'questionnaire'), $options);
+ $mform->setType('allchoices', PARAM_RAW);
+ $mform->addRule('allchoices', null, 'required', null, 'client');
+ $mform->addHelpButton('allchoices', $helpname, 'questionnaire');
+ $mform->addElement('html', '
');
+ $mform->addElement('hidden', 'num_choices', $numchoices);
+ $mform->setType('num_choices', PARAM_INT);
+ }
return $allchoices;
}
+ /**
+ * Override if the question uses the extradata field.
+ * @param \MoodleQuickForm $mform
+ * @param string $helpname
+ * @return \MoodleQuickForm
+ */
+ protected function form_extradata(\MoodleQuickForm $mform, $helpname = '') {
+ $mform->addElement('hidden', 'extradata');
+ $mform->setType('extradata', PARAM_INT);
+ return $mform;
+ }
+
// Helper functions for commonly used editing functions.
- static public function form_length_hidden(\MoodleQuickForm $mform, $value = 0) {
+ /**
+ * Add the length element as hidden.
+ * @param \MoodleQuickForm $mform
+ * @param int $value
+ * @return \MoodleQuickForm
+ */
+ public static function form_length_hidden(\MoodleQuickForm $mform, $value = 0) {
$mform->addElement('hidden', 'length', $value);
$mform->setType('length', PARAM_INT);
return $mform;
}
- static public function form_length_text(\MoodleQuickForm $mform, $helpname = '', $value = 0) {
+ /**
+ * Add the length element as text.
+ * @param \MoodleQuickForm $mform
+ * @param string $helpname
+ * @param int $value
+ * @return \MoodleQuickForm
+ */
+ public static function form_length_text(\MoodleQuickForm $mform, $helpname = '', $value = 0) {
$mform->addElement('text', 'length', get_string($helpname, 'questionnaire'), ['size' => '1'], $value);
$mform->setType('length', PARAM_INT);
if (!empty($helpname)) {
@@ -1107,13 +1274,27 @@ static public function form_length_text(\MoodleQuickForm $mform, $helpname = '',
return $mform;
}
- static public function form_precise_hidden(\MoodleQuickForm $mform, $value = 0) {
+ /**
+ * Add the precise element as hidden.
+ * @param \MoodleQuickForm $mform
+ * @param int $value
+ * @return \MoodleQuickForm
+ */
+ public static function form_precise_hidden(\MoodleQuickForm $mform, $value = 0) {
$mform->addElement('hidden', 'precise', $value);
$mform->setType('precise', PARAM_INT);
return $mform;
}
- static public function form_precise_text(\MoodleQuickForm $mform, $helpname = '', $value = 0) {
+ /**
+ * Add the precise element as text.
+ * @param \MoodleQuickForm $mform
+ * @param string $helpname
+ * @param int $value
+ * @return \MoodleQuickForm
+ * @throws \coding_exception
+ */
+ public static function form_precise_text(\MoodleQuickForm $mform, $helpname = '', $value = 0) {
$mform->addElement('text', 'precise', get_string($helpname, 'questionnaire'), ['size' => '1']);
$mform->setType('precise', PARAM_INT);
if (!empty($helpname)) {
@@ -1124,6 +1305,8 @@ static public function form_precise_text(\MoodleQuickForm $mform, $helpname = ''
/**
* Create and update question data from the forms.
+ * @param \stdClass $formdata
+ * @param questionnaire $questionnaire
*/
public function form_update($formdata, $questionnaire) {
global $DB;
@@ -1133,13 +1316,13 @@ public function form_update($formdata, $questionnaire) {
// Update existing question.
// Handle any attachments in the content.
- $formdata->itemid = $formdata->content['itemid'];
- $formdata->format = $formdata->content['format'];
+ $formdata->itemid = $formdata->content['itemid'];
+ $formdata->format = $formdata->content['format'];
$formdata->content = $formdata->content['text'];
$formdata->content = file_save_draft_area_files($formdata->itemid, $questionnaire->context->id, 'mod_questionnaire',
'question', $formdata->qid, ['subdirs' => true], $formdata->content);
- $fields = ['name', 'type_id', 'length', 'precise', 'required', 'content'];
+ $fields = ['name', 'type_id', 'length', 'precise', 'required', 'content', 'extradata'];
$questionrecord = new \stdClass();
$questionrecord->id = $formdata->qid;
foreach ($fields as $f) {
@@ -1157,7 +1340,7 @@ public function form_update($formdata, $questionnaire) {
// Create new question:
// Need to update any image content after the question is created, so create then update the content.
$formdata->surveyid = $formdata->sid;
- $fields = ['surveyid', 'name', 'type_id', 'length', 'precise', 'required', 'position'];
+ $fields = ['surveyid', 'name', 'type_id', 'length', 'precise', 'required', 'position', 'extradata'];
$questionrecord = new \stdClass();
foreach ($fields as $f) {
if (isset($formdata->$f)) {
@@ -1169,10 +1352,10 @@ public function form_update($formdata, $questionnaire) {
$this->add($questionrecord);
// Handle any attachments in the content.
- $formdata->itemid = $formdata->content['itemid'];
- $formdata->format = $formdata->content['format'];
+ $formdata->itemid = $formdata->content['itemid'];
+ $formdata->format = $formdata->content['format'];
$formdata->content = $formdata->content['text'];
- $content = file_save_draft_area_files($formdata->itemid, $questionnaire->context->id, 'mod_questionnaire',
+ $content = file_save_draft_area_files($formdata->itemid, $questionnaire->context->id, 'mod_questionnaire',
'question', $this->qid, ['subdirs' => true], $formdata->content);
$DB->set_field('questionnaire_question', 'content', $content, ['id' => $this->qid]);
}
@@ -1215,7 +1398,7 @@ public function form_update($formdata, $questionnaire) {
}
while ($nidx < $newcount) {
- // New choices...
+ // New choices.
$choicerecord = new \stdClass();
$choicerecord->question_id = $this->qid;
$choicerecord->content = trim($newchoices[$nidx]);
@@ -1305,6 +1488,8 @@ public function form_update($formdata, $questionnaire) {
/**
* Any preprocessing of general data.
+ * @param \stdClass $formdata
+ * @return bool
*/
protected function form_preprocess_data($formdata) {
if ($this->has_choices()) {
@@ -1349,6 +1534,8 @@ protected function form_preprocess_data($formdata) {
/**
* Override this function for question specific choice preprocessing.
+ * @param \stdClass $formdata
+ * @return false
*/
protected function form_preprocess_choicedata($formdata) {
if (empty($formdata->allchoices)) {
@@ -1356,4 +1543,115 @@ protected function form_preprocess_choicedata($formdata) {
}
return false;
}
-}
\ No newline at end of file
+
+ /**
+ * True if question provides mobile support.
+ * @return bool
+ */
+ public function supports_mobile() {
+ return false;
+ }
+
+ /**
+ * Override and return false if not supporting mobile app.
+ * @param int $qnum
+ * @param bool $autonum
+ * @return \stdClass
+ */
+ public function mobile_question_display($qnum, $autonum = false) {
+ $options = ['noclean' => true, 'para' => false, 'filter' => true,
+ 'context' => $this->context, 'overflowdiv' => true];
+ $mobiledata = (object)[
+ 'id' => $this->id,
+ 'name' => $this->name,
+ 'type_id' => $this->type_id,
+ 'length' => $this->length,
+ 'content' => format_text(file_rewrite_pluginfile_urls($this->content, 'pluginfile.php', $this->context->id,
+ 'mod_questionnaire', 'question', $this->id), FORMAT_HTML, $options),
+ 'content_stripped' => strip_tags($this->content),
+ 'required' => ($this->required == 'y') ? 1 : 0,
+ 'deleted' => $this->deleted,
+ 'response_table' => $this->responsetable,
+ 'fieldkey' => $this->mobile_fieldkey(),
+ 'precise' => $this->precise,
+ 'qnum' => $qnum,
+ 'errormessage' => get_string('required') . ': ' . $this->name
+ ];
+ $mobiledata->choices = $this->mobile_question_choices_display();
+
+ if ($this->mobile_question_extradata_display()) {
+ $mobiledata->extradata = json_decode($this->extradata);
+ }
+ if ($autonum) {
+ $mobiledata->content = $qnum . '. ' . $mobiledata->content;
+ $mobiledata->content_stripped = $qnum . '. ' . $mobiledata->content_stripped;
+ }
+ $mobiledata->responses = '';
+ return $mobiledata;
+ }
+
+ /**
+ * Override and return false if not supporting mobile app.
+ * @return array
+ */
+ public function mobile_question_choices_display() {
+ $choices = [];
+ $cnum = 0;
+ if ($this->has_choices()) {
+ foreach ($this->choices as $choice) {
+ $choices[$cnum] = clone($choice);
+ $contents = questionnaire_choice_values($choice->content);
+ $choices[$cnum]->content = format_text($contents->text, FORMAT_HTML, ['noclean' => true]).$contents->image;
+ $cnum++;
+ }
+ }
+ return $choices;
+ }
+
+ /**
+ * Return a field key to be used by the mobile app.
+ * @param int $choiceid
+ * @return string
+ */
+ public function mobile_fieldkey($choiceid = 0) {
+ $choicefield = '';
+ if ($choiceid !== 0) {
+ $choicefield = '_' . $choiceid;
+ }
+ return 'response_' . $this->type_id . '_' . $this->id . $choicefield;
+ }
+
+ /**
+ * Return the mobile response data.
+ * @param response $response
+ * @return array
+ */
+ public function get_mobile_response_data($response) {
+ $resultdata = [];
+ if (isset($response->answers[$this->id][0])) {
+ $resultdata[$this->mobile_fieldkey()] = $response->answers[$this->id][0]->value;
+ } else {
+ $resultdata[$this->mobile_fieldkey()] = false;
+ }
+
+ return $resultdata;
+ }
+
+ /**
+ * True if question need extradata for mobile app.
+ *
+ * @return bool
+ */
+ public function mobile_question_extradata_display() {
+ return false;
+ }
+
+ /**
+ * Return the otherdata to be used by the mobile app.
+ *
+ * @return array
+ */
+ public function mobile_otherdata() {
+ return [];
+ }
+}
diff --git a/classes/question/radio.php b/classes/question/radio.php
index 99888fed..4d818d7a 100644
--- a/classes/question/radio.php
+++ b/classes/question/radio.php
@@ -14,23 +14,30 @@
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see ('.$val.')'; } else { @@ -238,8 +316,7 @@ protected function question_survey_display($data, $descendantsdata, $blankquesti $num = 0; foreach ($this->choices as $cid => $choice) { - $str = 'q'."{$this->id}_$cid"; - $num += (isset($data->$str) && ($data->$str != -999)); + $num += (isset($response->answers[$this->id][$cid]) && ($response->answers[$this->id][$cid]->value != -999)); } $notcomplete = false; @@ -248,36 +325,32 @@ protected function question_survey_display($data, $descendantsdata, $blankquesti $notcomplete = true; } - $row = 0; + $rowstart = self::ROW_START; $choicetags->qelements['rows'] = []; foreach ($this->choices as $cid => $choice) { $cols = []; if (isset($choice->content)) { - $row++; $str = 'q'."{$this->id}_$cid"; $content = $choice->content; - if ($osgood) { + $rendercontent = format_text($choice->content, FORMAT_PLAIN); + if ($this->osgood_rate_scale()) { list($content, $contentright) = array_merge(preg_split('/[|]/', $content), array(' ')); } - - $arialtitle = 'Choice'; - if ($notcomplete && isset($data->$str) && ($data->$str == -999)) { - $arialtitle = get_string('pleasecomplete', 'questionnaire'); - } - $cols[] = ['colstyle' => 'text-align: '.$textalign.';', 'coltext' => format_text($content, FORMAT_HTML, ['noclean' => true]).' ']; $bg = 'c0 raterow'; - if ($nbchoices > 1 && $this->precise != 2 && !$blankquestionnaire) { + $hasnotansweredchoice = false; + if (($nbchoices > 1) && !$this->no_duplicate_choices() && !$blankquestionnaire) { + $hasnotansweredchoice = true; $checked = ' checked="checked"'; $completeclass = 'notanswered'; $title = ''; - if ($notcomplete && isset($data->$str) && ($data->$str == -999)) { + if ($notcomplete && isset($response->answers[$this->id][$cid]) && + ($response->answers[$this->id][$cid]->value == -999)) { $completeclass = 'notcompleted'; $title = get_string('pleasecomplete', 'questionnaire'); } - // Set value of notanswered button to -999 in order to eliminate it from form submit later on. $colinput = ['name' => $str, 'value' => -999]; if (!empty($checked)) { @@ -286,25 +359,35 @@ protected function question_survey_display($data, $descendantsdata, $blankquesti if (!empty($order)) { $colinput['onclick'] = $order; } + $colinput['label'] = $this->set_label($rowstart, $rendercontent, self::COL_START, + get_string('unanswered', 'questionnaire')); $cols[] = ['colstyle' => 'width:1%;', 'colclass' => $completeclass, 'coltitle' => $title, 'colinput' => $colinput]; - $choicetags->qelements['title'] = $title; - } - for ($j = 0; $j < $this->length + $isna; $j++) { + if ($nameddegrees > 0) { + reset($this->nameddegrees); + } + $colstart = $hasnotansweredchoice ? self::COL_START + 1 : self::COL_START; + for ($j = 1; $j <= $this->length + $this->has_na_column(); $j++) { + if (!isset($collabel[$j])) { + // If not using this value, continue. + continue; + } $col = []; - $checked = ((isset($data->$str) && ($j == $data->$str || - $j == $this->length && $data->$str == -1)) ? ' checked="checked"' : ''); $checked = ''; - if (isset($data->$str) && ($j == $data->$str || $j == $this->length && $data->$str == -1)) { + // If isna column then set na choice to -1 value. This needs work! + if (!empty($this->nameddegrees) && (key($this->nameddegrees) !== null)) { + $value = key($this->nameddegrees); + next($this->nameddegrees); + } else { + $value = ($j <= $this->length ? $j : -1); + } + if (isset($response->answers[$this->id][$cid]) && ($value == $response->answers[$this->id][$cid]->value)) { $checked = ' checked="checked"'; } $col['colstyle'] = 'text-align:center'; $col['colclass'] = $bg; - $i = $j + 1; - $col['colhiddentext'] = get_string('option', 'questionnaire', $i); - // If isna column then set na choice to -1 value. - $value = ($j < $this->length ? $j : - 1); + $col['colhiddentext'] = get_string('option', 'questionnaire', $j); $col['colinput']['name'] = $str; $col['colinput']['value'] = $value; $col['colinput']['id'] = $str.'_'.$value; @@ -317,18 +400,20 @@ protected function question_survey_display($data, $descendantsdata, $blankquesti if (!empty($order)) { $col['colinput']['onclick'] = $order; } - $col['colinput']['label'] = 'Choice '.$collabel[$j].' for row '.format_text($content, FORMAT_PLAIN); + $col['colinput']['label'] = $this->set_label($rowstart, $rendercontent, $colstart, $collabel[$j]); if ($bg == 'c0 raterow') { $bg = 'c1 raterow'; } else { $bg = 'c0 raterow'; } + $colstart++; $cols[] = $col; } - if ($osgood) { + if ($this->osgood_rate_scale()) { $cols[] = ['coltext' => ' '.format_text($contentright, FORMAT_HTML, ['noclean' => true])]; } - $choicetags->qelements['rows'][] = ['cols' => $cols, 'title' => $arialtitle]; + $choicetags->qelements['rows'][] = ['cols' => $cols]; + $rowstart++; } } @@ -337,24 +422,23 @@ protected function question_survey_display($data, $descendantsdata, $blankquesti /** * Return the context tags for the rate response template. - * @param object $data - * @return object The rate question response context tags. - * + * @param \mod_questionnaire\responsetype\response\response $response + * @return \stdClass The rate question response context tags. + * @throws \coding_exception */ - protected function response_survey_display($data) { + protected function response_survey_display($response) { static $uniquetag = 0; // To make sure all radios have unique names. $resptags = new \stdClass(); $resptags->headers = []; $resptags->rows = []; - if (!isset($data->{'q'.$this->id}) || !is_array($data->{'q'.$this->id})) { - $data->{'q'.$this->id} = array(); + if (!isset($response->answers[$this->id])) { + $response->answers[$this->id][] = new \mod_questionnaire\responsetype\answer\answer(); } // Check if rate question has one line only to display full width columns of choices. $nocontent = false; foreach ($this->choices as $cid => $choice) { - $content = $choice->content; if ($choice->content == '') { $nocontent = true; break; @@ -362,35 +446,24 @@ protected function response_survey_display($data) { } $resptags->twidth = $nocontent ? "50%" : "99.9%"; - $osgood = $this->precise == 3; $bg = 'c0'; $nameddegrees = 0; $cidnamed = array(); - $n = array(); // Max length of potential named degree in column head. $maxndlen = 0; - foreach ($this->choices as $cid => $choice) { - $content = $choice->content; - if (preg_match("/^[0-9]{1,3}=/", $content, $ndd)) { - $ndd = format_text(substr($content, strlen($ndd[0])), FORMAT_HTML, ['noclean' => true]); - $n[$nameddegrees] = $ndd; - if (strlen($ndd) > $maxndlen) { - $maxndlen = strlen($ndd); - } - $cidnamed[$cid] = true; - $nameddegrees++; - } - } - if ($osgood) { + if ($this->osgood_rate_scale()) { $resptags->osgood = 1; if ($maxndlen < 4) { $sidecolwidth = '45%'; + $sidecolwidthn = 45; } else if ($maxndlen < 13) { $sidecolwidth = '40%'; + $sidecolwidthn = 40; } else { $sidecolwidth = '30%'; + $sidecolwidthn = 30; } - $nn = 100 - ($sidecolwidth * 2); + $nn = 100 - ($sidecolwidthn * 2); $resptags->sidecolwidth = $sidecolwidth; $resptags->colwidth = ($nn / $this->length).'%'; $resptags->textalign = 'right'; @@ -399,13 +472,18 @@ protected function response_survey_display($data) { $resptags->colwidth = (50 / $this->length).'%'; $resptags->textalign = 'left'; } - for ($j = 0; $j < $this->length; $j++) { + if (!empty($this->nameddegrees)) { + $this->length = count($this->nameddegrees); + reset($this->nameddegrees); + } + for ($j = 1; $j <= $this->length; $j++) { $cellobj = new \stdClass(); $cellobj->bg = $bg; - if (isset($n[$j])) { - $cellobj->str = $n[$j]; + if (!empty($this->nameddegrees)) { + $cellobj->str = current($this->nameddegrees); + next($this->nameddegrees); } else { - $cellobj->str = $j + 1; + $cellobj->str = $j; } if ($bg == 'c0') { $bg = 'c1'; @@ -414,7 +492,7 @@ protected function response_survey_display($data) { } $resptags->headers[] = $cellobj; } - if ($this->precise == 1) { + if ($this->has_na_column()) { $cellobj = new \stdClass(); $cellobj->bg = $bg; $cellobj->str = get_string('notapplicable', 'questionnaire'); @@ -431,21 +509,32 @@ protected function response_survey_display($data) { if ($contents->modname) { $content = $contents->text; } - if ($osgood) { + if ($this->osgood_rate_scale()) { list($content, $contentright) = array_merge(preg_split('/[|]/', $content), array(' ')); } $rowobj->content = format_text($content, FORMAT_HTML, ['noclean' => true]).' '; $bg = 'c0'; $cols = []; - for ($j = 0; $j < $this->length; $j++) { + if (!empty($this->nameddegrees)) { + $this->length = count($this->nameddegrees); + reset($this->nameddegrees); + } + for ($j = 1; $j <= $this->length; $j++) { $cellobj = new \stdClass(); - if (isset($data->$str) && ($j == $data->$str)) { - $cellobj->checked = 1; + if (isset($response->answers[$this->id][$cid])) { + if (!empty($this->nameddegrees)) { + if ($response->answers[$this->id][$cid]->value == key($this->nameddegrees)) { + $cellobj->checked = 1; + } + next($this->nameddegrees); + } else if ($j == $response->answers[$this->id][$cid]->value) { + $cellobj->checked = 1; + } } $cellobj->str = $str.$j.$uniquetag++; $cellobj->bg = $bg; // N/A column checked. - $checkedna = (isset($data->$str) && ($data->$str == -1)); + $checkedna = (isset($response->answers[$this->id][$cid]) && ($response->answers[$this->id][$cid]->value == -1)); if ($bg == 'c0') { $bg = 'c1'; } else { @@ -453,7 +542,7 @@ protected function response_survey_display($data) { } $cols[] = $cellobj; } - if ($this->precise == 1) { // N/A column. + if ($this->has_na_column()) { // N/A column. $cellobj = new \stdClass(); if ($checkedna) { $cellobj->checked = 1; @@ -463,7 +552,7 @@ protected function response_survey_display($data) { $cols[] = $cellobj; } $rowobj->cols = $cols; - if ($osgood) { + if ($this->osgood_rate_scale()) { $rowobj->osgoodstr = ' '.format_text($contentright, FORMAT_HTML, ['noclean' => true]); } $resptags->rows[] = $rowobj; @@ -475,15 +564,29 @@ protected function response_survey_display($data) { /** * Check question's form data for complete response. * - * @param object $responsedata The data entered into the response. + * @param \stdClass $responsedata The data entered into the response. * @return boolean * */ public function response_complete($responsedata) { + if (!is_a($responsedata, 'mod_questionnaire\responsetype\response\response')) { + $response = \mod_questionnaire\responsetype\response\response::response_from_webform($responsedata, [$this]); + } else { + $response = $responsedata; + } + + // To make it easier, create an array of answers by choiceid. + $answers = []; + if (isset($response->answers[$this->id])) { + foreach ($response->answers[$this->id] as $answer) { + $answers[$answer->choiceid] = $answer; + } + } + + $answered = true; $num = 0; $nbchoices = count($this->choices); $na = get_string('notapplicable', 'questionnaire'); - $complete = true; foreach ($this->choices as $cid => $choice) { // In case we have named degrees on the Likert scale, count them to substract from nbchoices. $nameddegrees = 0; @@ -491,36 +594,50 @@ public function response_complete($responsedata) { if (preg_match("/^[0-9]{1,3}=/", $content)) { $nameddegrees++; } else { - $str = 'q'."{$this->id}_$cid"; - if (isset($responsedata->$str) && $responsedata->$str == $na) { - $responsedata->$str = -1; + if (isset($answers[$cid]) && !empty($answers[$cid]) && ($answers[$cid]->value == $na)) { + $answers[$cid]->value = -1; } // If choice value == -999 this is a not yet answered choice. - $num += (isset($responsedata->$str) && ($responsedata->$str != -999)); + $num += (isset($answers[$cid]) && ($answers[$cid]->value != -999)); } $nbchoices -= $nameddegrees; } if ($num == 0) { - if (!$this->has_dependencies()) { - if ($this->required()) { - $complete = false; - } + if ($this->required()) { + $answered = false; } } - return $complete; + return $answered; } /** * Check question's form data for valid response. Override this is type has specific format requirements. * - * @param object $responsedata The data entered into the response. + * @param \stdClass $responsedata The data entered into the response. * @return boolean */ public function response_valid($responsedata) { + // Work with a response object. + if (!is_a($responsedata, 'mod_questionnaire\responsetype\response\response')) { + $response = \mod_questionnaire\responsetype\response\response::response_from_webform($responsedata, [$this]); + } else { + $response = $responsedata; + } $num = 0; $nbchoices = count($this->choices); $na = get_string('notapplicable', 'questionnaire'); + + // Create an answers array indexed by choiceid for ease. + $answers = []; + $nodups = []; + if (isset($response->answers[$this->id])) { + foreach ($response->answers[$this->id] as $answer) { + $answers[$answer->choiceid] = $answer; + $nodups[] = $answer->value; + } + } + foreach ($this->choices as $cid => $choice) { // In case we have named degrees on the Likert scale, count them to substract from nbchoices. $nameddegrees = 0; @@ -528,20 +645,29 @@ public function response_valid($responsedata) { if (preg_match("/^[0-9]{1,3}=/", $content)) { $nameddegrees++; } else { - $str = 'q'."{$this->id}_$cid"; - if (isset($responsedata->$str) && ($responsedata->$str == $na)) { - $responsedata->$str = -1; + if (isset($answers[$cid]) && ($answers[$cid]->value == $na)) { + $answers[$cid]->value = -1; } // If choice value == -999 this is a not yet answered choice. - $num += (isset($responsedata->$str) && ($responsedata->$str != -999)); + $num += (isset($answers[$cid]) && ($answers[$cid]->value != -999)); } $nbchoices -= $nameddegrees; } // If nodupes and nb choice restricted, nbchoices may be > actual choices, so limit it to $question->length. - $isrestricted = ($this->length < count($this->choices)) && ($this->precise == 2); + $isrestricted = ($this->length < count($this->choices)) && $this->no_duplicate_choices(); if ($isrestricted) { $nbchoices = min ($nbchoices, $this->length); } + + // Test for duplicate answers in a no duplicate question type. + if ($this->no_duplicate_choices()) { + foreach ($answers as $answer) { + if (count(array_keys($nodups, $answer->value)) > 1) { + return false; + } + } + } + if (($num != $nbchoices) && ($num != 0)) { return false; } else { @@ -549,10 +675,20 @@ public function response_valid($responsedata) { } } + /** + * Return the length form element. + * @param \MoodleQuickForm $mform + * @param string $helptext + */ protected function form_length(\MoodleQuickForm $mform, $helptext = '') { return parent::form_length($mform, 'numberscaleitems'); } + /** + * Return the precision form element. + * @param \MoodleQuickForm $mform + * @param string $helptext + */ protected function form_precise(\MoodleQuickForm $mform, $helptext = '') { $precoptions = array("0" => get_string('normal', 'questionnaire'), "1" => get_string('notapplicablecolumn', 'questionnaire'), @@ -566,7 +702,54 @@ protected function form_precise(\MoodleQuickForm $mform, $helptext = '') { } /** - * Preprocess choice data. + * Override if the question uses the extradata field. + * @param \MoodleQuickForm $mform + * @param string $helpname + * @return \MoodleQuickForm + */ + protected function form_extradata(\MoodleQuickForm $mform, $helpname = '') { + $defaultvalue = ''; + foreach ($this->nameddegrees as $value => $label) { + $defaultvalue .= $value . '=' . $label . "\n"; + } + + $options = ['wrap' => 'virtual']; + $mform->addElement('textarea', 'allnameddegrees', get_string('allnameddegrees', 'questionnaire'), $options); + $mform->setDefault('allnameddegrees', $defaultvalue); + $mform->setType('allnameddegrees', PARAM_RAW); + $mform->addHelpButton('allnameddegrees', 'allnameddegrees', 'questionnaire'); + + return $mform; + } + + /** + * Any preprocessing of general data. + * @param \stdClass $formdata + * @return bool + */ + protected function form_preprocess_data($formdata) { + $nameddegrees = []; + // Named degrees are put one per line in the form "[value]=[label]". + if (!empty($formdata->allnameddegrees)) { + $nameddegreelines = explode("\n", $formdata->allnameddegrees); + foreach ($nameddegreelines as $nameddegreeline) { + $nameddegreeline = trim($nameddegreeline); + if (($nameddegree = \mod_questionnaire\question\choice::content_is_named_degree_choice($nameddegreeline)) !== + false) { + $nameddegrees += $nameddegree; + } + } + } + + // Now store the new named degrees in extradata. + $formdata->extradata = json_encode($nameddegrees); + return parent::form_preprocess_data($formdata); + } + + /** + * Override this function for question specific choice preprocessing. + * @param \stdClass $formdata + * @return false */ protected function form_preprocess_choicedata($formdata) { if (empty($formdata->allchoices)) { @@ -601,10 +784,341 @@ protected function form_preprocess_choicedata($formdata) { $formdata->length = $nbnameddegrees; } // Sanity check for "no duplicate choices"". - if ($formdata->precise == 2 && ($formdata->length > $nbvalues || !$formdata->length)) { + if (self::type_is_no_duplicate_choices($formdata->precise) && ($formdata->length > $nbvalues || !$formdata->length)) { $formdata->length = $nbvalues; } } return true; } -} \ No newline at end of file + + /** + * Update the choice with the choicerecord. + * @param \stdClass $choicerecord + * @return bool + */ + public function update_choice($choicerecord) { + if ($nameddegree = \mod_questionnaire\question\choice::content_is_named_degree_choice($choicerecord->content)) { + // Preserve any existing value from the new array. + $this->nameddegrees = $nameddegree + $this->nameddegrees; + $this->insert_nameddegrees($this->nameddegrees); + } + return parent::update_choice($choicerecord); + } + + /** + * Add a new choice to the database. + * @param \stdClass $choicerecord + * @return bool + */ + public function add_choice($choicerecord) { + if ($nameddegree = \mod_questionnaire\question\choice::content_is_named_degree_choice($choicerecord->content)) { + // Preserve any existing value from the new array. + $this->nameddegrees = $nameddegree + $this->nameddegrees; + $this->insert_nameddegrees($this->nameddegrees); + } + return parent::add_choice($choicerecord); + } + + /** + * True if question provides mobile support. + * + * @return bool + */ + public function supports_mobile() { + return true; + } + + /** + * Override and return false if not supporting mobile app. + * @param int $qnum + * @param bool $autonum + * @return \stdClass + */ + public function mobile_question_display($qnum, $autonum = false) { + $mobiledata = parent::mobile_question_display($qnum, $autonum); + $mobiledata->rates = $this->mobile_question_rates_display(); + if ($this->has_na_column()) { + $mobiledata->hasnacolumn = (object)['value' => -1, 'label' => get_string('notapplicable', 'questionnaire')]; + } + + $mobiledata->israte = true; + return $mobiledata; + } + + /** + * Override and return false if not supporting mobile app. + * @return array + */ + public function mobile_question_choices_display() { + $choices = []; + $excludes = []; + $vals = $extracontents = []; + $cnum = 0; + foreach ($this->choices as $choiceid => $choice) { + $choice->na = false; + $choice->choice_id = $choiceid; + $choice->id = $choiceid; + $choice->question_id = $this->id; + + // Add a fieldkey for each choice. + $choice->fieldkey = $this->mobile_fieldkey($choiceid); + + if ($this->osgood_rate_scale()) { + list($choice->leftlabel, $choice->rightlabel) = array_merge(preg_split('/[|]/', $choice->content), []); + } + + if ($this->normal_rate_scale() || $this->no_duplicate_choices()) { + $choices[$cnum] = $choice; + if ($this->required()) { + $choices[$cnum]->min = 0; + $choices[$cnum]->minstr = 1; + } else { + $choices[$cnum]->min = 0; + $choices[$cnum]->minstr = 1; + } + $choices[$cnum]->max = intval($this->length) - 1; + $choices[$cnum]->maxstr = intval($this->length); + + } else if ($this->has_na_column()) { + $choices[$cnum] = $choice; + if ($this->required()) { + $choices[$cnum]->min = 0; + $choices[$cnum]->minstr = 1; + } else { + $choices[$cnum]->min = 0; + $choices[$cnum]->minstr = 1; + } + $choices[$cnum]->max = intval($this->length); + $choices[$cnum]->na = true; + + } else { + $excludes[$choiceid] = $choiceid; + if ($choice->value == null) { + if ($arr = explode('|', $choice->content)) { + if (count($arr) == 2) { + $choices[$cnum] = $choice; + $choices[$cnum]->content = ''; + $choices[$cnum]->minstr = $arr[0]; + $choices[$cnum]->maxstr = $arr[1]; + } + } + } else { + $val = intval($choice->value); + $vals[$val] = $val; + $extracontents[] = $choice->content; + } + } + if ($vals) { + if ($q = $choices) { + foreach (array_keys($q) as $itemid) { + $choices[$itemid]->min = min($vals); + $choices[$itemid]->max = max($vals); + } + } + } + if ($extracontents) { + $extracontents = array_unique($extracontents); + $extrahtml = '
- ';
+ foreach ($extracontents as $extracontent) {
+ $extrahtml .= '
- '.$extracontent.' '; + } + $extrahtml .= '
'); // Begin div qn-container.
+ if ($dependencies) {
+ // Begin div qn-container with indent if questionnaire has child.
+ $mform->addElement('html', '
');
+ } else {
+ $mform->addElement('html', '
';
- $table->data[] = array('', $out, '');
-
- switch ($sort) {
- case 'ascending':
- uasort($counts, 'self::sortavgasc');
- break;
- case 'descending':
- uasort($counts, 'self::sortavgdesc');
- break;
- }
- reset ($counts);
-
- if (!empty($counts) && is_array($counts)) {
- foreach ($counts as $content => $contentobj) {
- // Eliminate potential named degrees on Likert scale.
- if (!preg_match("/^[0-9]{1,3}=/", $content)) {
-
- if (isset($contentobj->avg)) {
- $avg = $contentobj->avg;
- if (isset($contentobj->avgvalue)) {
- $avgvalue = $contentobj->avgvalue;
- } else {
- $avgvalue = '';
- }
- } else {
- $avg = '';
- }
- $nbna = $contentobj->nbna;
-
- if ($avg) {
- $out = '';
- if (($j = $avg * $width) > 0) {
- $marginposition = ($avg - 0.5 ) / ($length + $isrestricted) * 100;
- }
- if (!right_to_left()) {
- $out .= '
';
- } else {
- $out .= '';
- }
- } else {
- $out = '';
- }
-
- if ($osgood) {
- // Ensure there are two bits of content.
- list($content, $contentright) = array_merge(preg_split('/[|]/', $content), array(' '));
- } else {
- $contents = questionnaire_choice_values($content);
- if ($contents->modname) {
- $content = $contents->text;
- }
- }
- if ($osgood) {
- $table->data[] = array('
(#)'; - } - if ($precision == 1) { - $na = get_string('notapplicable', 'questionnaire'); - } else { - $na = ''; - } - $nameddegrees = 0; - $n = array(); - foreach ($question->choices as $choice) { - $content = $choice->content; - // Check for number from 1 to 3 digits, followed by the equal sign = (to accomodate named degrees). - if (preg_match("/^([0-9]{1,3})=(.*)$/", $content, $ndd)) { - $n[$nameddegrees] = format_text($ndd[2], FORMAT_HTML, ['noclean' => true]); - $nameddegrees++; - } else { - $contents = questionnaire_choice_values($content); - if ($contents->modname) { - $choice->content = $contents->text; - } - } - } - - $headings = array(''.get_string('responses', 'questionnaire').''); - if ($osgood) { - $align = array('right'); - } else { - $align = array('left'); - } - - // Display the column titles. - for ($j = 0; $j < $length; $j++) { - if (isset($n[$j])) { - $str = $n[$j]; - } else { - $str = $j + 1; - } - array_push($headings, ''.$str.''); - array_push($align, 'center'); - } - if ($osgood) { - array_push($headings, ''); - array_push($align, 'left'); - } - array_push($headings, $strtotal); - if ($isrestricted) { - array_push($headings, get_string('notapplicable', 'questionnaire')); - array_push($align, 'center'); - } - array_push($align, 'center'); - if ($na) { - array_push($headings, $na); - array_push($align, 'center'); - } - - $table = new html_table(); - $table->head = $headings; - $table->align = $align; - $table->attributes['class'] = 'generaltable'; - // Now display the responses. - foreach ($ranks as $content => $rank) { - $data = array(); - // Eliminate potential named degrees on Likert scale. - if (!preg_match("/^[0-9]{1,3}=/", $content)) { - // First display the list of degrees (named or un-named) - // number of NOT AVAILABLE responses for this possible answer. - $nbna = $counts[$content]->nbna; - // TOTAL number of responses for this possible answer. - $total = $counts[$content]->num; - $nbresp = ''.$total.''; - if ($osgood) { - // Ensure there are two bits of content. - list($content, $contentright) = array_merge(preg_split('/[|]/', $content), array(' ')); - $data[] = format_text($content, FORMAT_HTML, ['noclean' => true]); - } else { - // Eliminate potentially short-named choices. - $contents = questionnaire_choice_values($content); - if ($contents->modname) { - $content = $contents->text; - } - $data[] = format_text($content, FORMAT_HTML, ['noclean' => true]); - } - // Display ranks/rates numbers. - $maxrank = max($rank); - for ($i = 0; $i <= $length - 1; $i++) { - $percent = ''; - if (isset($rank[$i])) { - $str = $rank[$i]; - if ($total !== 0 && $str !== 0) { - $percent = ' ('.number_format(($str * 100) / $total).'%)'; - } - // Emphasize responses with max rank value. - if ($str == $maxrank) { - $str = ''.$str.''; - } - } else { - $str = 0; - } - $data[] = $str.$percent; - } - if ($osgood) { - $data[] = format_text($contentright, FORMAT_HTML, ['noclean' => true]); - } - $data[] = $nbresp; - if ($isrestricted) { - $data[] = $nbresponses - $total; - } - if (!$osgood) { - if ($na) { - $data[] = $nbna; - } - } - } // End named degrees. - $table->data[] = $data; - } - return html_writer::table($table); - } - - /** - * Sorting functions for ascending and descending. - * - */ - static private function sortavgasc($a, $b) { - if (isset($a->avg) && isset($b->avg)) { - if ( $a->avg < $b->avg ) { - return -1; - } else if ($a->avg > $b->avg ) { - return 1; - } else { - return 0; - } - } - } - - static private function sortavgdesc($a, $b) { - if (isset($a->avg) && isset($b->avg)) { - if ( $a->avg > $b->avg ) { - return -1; - } else if ($a->avg < $b->avg) { - return 1; - } else { - return 0; - } - } - } -} diff --git a/classes/response/multiple.php b/classes/response/multiple.php deleted file mode 100644 index 0d338acd..00000000 --- a/classes/response/multiple.php +++ /dev/null @@ -1,332 +0,0 @@ -. - -/** - * This file contains the parent class for questionnaire question types. - * - * @author Mike Churchward - * @license http://www.gnu.org/copyleft/gpl.html GNU Public License - * @package questiontypes - */ - -namespace mod_questionnaire\response; -defined('MOODLE_INTERNAL') || die(); - -use mod_questionnaire\db\bulk_sql_config; - -/** - * Class for multiple response types. - * - * @author Mike Churchward - * @package responsetypes - */ - -class multiple extends single { - /** - * The only differences between multuple and single responses are the - * response table and the insert logic. - */ - static public function response_table() { - return 'questionnaire_resp_multiple'; - } - - public function insert_response($rid, $val) { - global $DB; - $resid = ''; - foreach ($this->question->choices as $cid => $choice) { - if (strpos($choice->content, '!other') === 0) { - $other = optional_param('q'.$this->question->id.'_'.$cid, '', PARAM_CLEAN); - if (empty($other)) { - continue; - } - if (!isset($val) || !is_array($val)) { - $val = array($cid); - } else { - array_push($val, $cid); - } - if (preg_match("/[^ \t\n]/", $other)) { - $record = new \stdClass(); - $record->response_id = $rid; - $record->question_id = $this->question->id; - $record->choice_id = $cid; - $record->response = $other; - $resid = $DB->insert_record('questionnaire_response_other', $record); - } - } - } - - if (!isset($val) || !is_array($val)) { - return false; - } - - foreach ($val as $cid) { - $cid = clean_param($cid, PARAM_CLEAN); - if ($cid != 0) { // Do not save response if choice is empty. - if (preg_match("/other_q[0-9]+/", $cid)) { - continue; - } - $record = new \stdClass(); - $record->response_id = $rid; - $record->question_id = $this->question->id; - $record->choice_id = $cid; - $resid = $DB->insert_record(self::response_table(), $record); - } - } - return $resid; - } - - /** - * Return an array of answers by question/choice for the given response. Must be implemented by the subclass. - * - * @param int $rid The response id. - * @param null $col Other data columns to return. - * @param bool $csvexport Using for CSV export. - * @param int $choicecodes CSV choicecodes are required. - * @param int $choicetext CSV choicetext is required. - * @return array - */ - static public function response_select($rid, $col = null, $csvexport = false, $choicecodes = 0, $choicetext = 1) { - global $DB; - - $stringother = get_string('other', 'questionnaire'); - $values = []; - $sql = 'SELECT a.id as aid, q.id as qid '.$col.',c.content as ccontent,c.id as cid '. - 'FROM {'.self::response_table().'} a, {questionnaire_question} q, {questionnaire_quest_choice} c '. - 'WHERE a.response_id = ? AND a.question_id=q.id AND a.choice_id=c.id '. - 'ORDER BY a.id,a.question_id,c.id'; - $records = $DB->get_records_sql($sql, [$rid]); - if ($csvexport) { - $tmp = null; - if (!empty($records)) { - $qids2 = array(); - $oldqid = ''; - foreach ($records as $qid => $row) { - if ($row->qid != $oldqid) { - $qids2[] = $row->qid; - $oldqid = $row->qid; - } - } - list($qsql, $params) = $DB->get_in_or_equal($qids2); - $sql = 'SELECT * FROM {questionnaire_quest_choice} WHERE question_id ' . $qsql . ' ORDER BY id'; - $records2 = $DB->get_records_sql($sql, $params); - foreach ($records2 as $qid => $row2) { - $selected = '0'; - $qid2 = $row2->question_id; - $cid2 = $row2->id; - $c2 = $row2->content; - $otherend = false; - if ($c2 == '!other') { - $c2 = '!other='.get_string('other', 'questionnaire'); - } - if (preg_match('/^!other/', $c2)) { - $otherend = true; - } else { - $contents = questionnaire_choice_values($c2); - if ($contents->modname) { - $c2 = $contents->modname; - } else if ($contents->title) { - $c2 = $contents->title; - } - } - $sql = 'SELECT a.name as name, a.type_id as q_type, a.position as pos ' . - 'FROM {questionnaire_question} a WHERE id = ?'; - $currentquestion = $DB->get_records_sql($sql, [$qid2]); - foreach ($currentquestion as $question) { - $name1 = $question->name; - $type1 = $question->q_type; - } - $newrow = []; - foreach ($records as $qid => $row1) { - $qid1 = $row1->qid; - $cid1 = $row1->cid; - // If available choice has been selected by student. - if ($qid1 == $qid2 && $cid1 == $cid2) { - $selected = '1'; - } - } - if ($otherend) { - $newrow2 = array(); - $newrow2[] = $question->pos; - $newrow2[] = $type1; - $newrow2[] = $name1; - $newrow2[] = '['.get_string('other', 'questionnaire').']'; - $newrow2[] = $selected; - $tmp2 = $qid2.'_other'; - $values["$tmp2"] = $newrow2; - } - $newrow[] = $question->pos; - $newrow[] = $type1; - $newrow[] = $name1; - $newrow[] = $c2; - $newrow[] = $selected; - $tmp = $qid2.'_'.$cid2; - $values["$tmp"] = $newrow; - } - } - unset($tmp); - unset($row); - - } else { - $arr = []; - $tmp = null; - foreach ($records as $row) { - $qid = $row->qid; - $cid = $row->cid; - unset($row->aid); - unset($row->qid); - unset($row->cid); - $arow = get_object_vars($row); - $newrow = []; - foreach ($arow as $key => $val) { - if (!is_numeric($key)) { - $newrow[] = $val; - } - } - if (preg_match('/^!other/', $row->ccontent)) { - $newrow[] = 'other_' . $cid; - } else { - $newrow[] = (int)$cid; - } - if ($tmp == $qid) { - $arr[] = $newrow; - continue; - } - if ($tmp != null) { - $values["$tmp"] = $arr; - } - $tmp = $qid; - $arr = array($newrow); - } - if ($tmp != null) { - $values["$tmp"] = $arr; - } - unset($arr); - unset($tmp); - unset($row); - } - - // Response_other. - // This will work even for multiple !other fields within one question - // AND for identical !other responses in different questions JR. - $sql = 'SELECT c.id as cid, c.content as content, a.response as aresponse, q.id as qid, q.position as position, - q.type_id as type_id, q.name as name '. - 'FROM {questionnaire_response_other} a, {questionnaire_question} q, {questionnaire_quest_choice} c '. - 'WHERE a.response_id= ? AND a.question_id=q.id AND a.choice_id=c.id '. - 'ORDER BY a.question_id,c.id '; - $records = $DB->get_records_sql($sql, [$rid]); - foreach ($records as $record) { - $newrow = []; - $position = $record->position; - $typeid = $record->type_id; - $name = $record->name; - $cid = $record->cid; - $qid = $record->qid; - $content = $record->content; - - // The !other modality with no label. - if ($content == '!other') { - $content = '!other='.$stringother; - } - $content = substr($content, 7); - $aresponse = $record->aresponse; - // The first two empty values are needed for compatibility with "normal" (non !other) responses. - // They are only needed for the CSV export, in fact. - $newrow[] = $position; - $newrow[] = $typeid; - $newrow[] = $name; - $content = $stringother; - $newrow[] = $content; - $newrow[] = $aresponse; - $values["${qid}_${cid}"] = $newrow; - } - - return $values; - } - - /** - * Return sql and params for getting responses in bulk. - * @author Guy Thomas - * @param int|array $questionnaireids One id, or an array of ids. - * @param bool|int $responseid - * @param bool|int $userid - * @return array - */ - public function get_bulk_sql($questionnaireids, $responseid = false, $userid = false, $groupid = false, $showincompletes = 0) { - global $DB; - - $sql = $this->bulk_sql(); - - if (($groupid !== false) && ($groupid > 0)) { - $groupsql = ' INNER JOIN {groups_members} gm ON gm.groupid = ? AND gm.userid = qr.userid '; - $gparams = [$groupid]; - } else { - $groupsql = ''; - $gparams = []; - } - - if (is_array($questionnaireids)) { - list($qsql, $params) = $DB->get_in_or_equal($questionnaireids); - } else { - $qsql = ' = ? '; - $params = [$questionnaireids]; - } - if ($showincompletes == 1) { - $showcompleteonly = ''; - } else { - $showcompleteonly = 'AND qr.complete = ? '; - $params[] = 'y'; - } - - $sql .= " - AND qr.questionnaireid $qsql $showcompleteonly - LEFT JOIN {questionnaire_response_other} qro ON qro.response_id = qr.id AND qro.choice_id = qrm.choice_id - LEFT JOIN {user} u ON u.id = qr.userid - $groupsql - "; - $params = array_merge($params, $gparams); - - if ($responseid) { - $sql .= " WHERE qr.id = ?"; - $params[] = $responseid; - } else if ($userid) { - $sql .= " WHERE qr.userid = ?"; - $params[] = $userid; - } - return [$sql, $params]; - } - - /** - * Return sql for getting responses in bulk. - * @author Guy Thomas - * @return string - */ - protected function bulk_sql() { - global $DB; - - $userfields = $this->user_fields_sql(); - $alias = 'qrm'; - $extraselect = ''; - $extraselect .= 'qrm.choice_id, ' . $DB->sql_order_by_text('qro.response', 1000) . ' AS response, 0 AS rankvalue'; - - return " - SELECT " . $DB->sql_concat_join("'_'", ['qr.id', "'".$this->question->helpname()."'", $alias.'.id']) . " AS id, - qr.submitted, qr.complete, qr.grade, qr.userid, $userfields, qr.id AS rid, $alias.question_id, - $extraselect - FROM {questionnaire_response} qr - JOIN {".self::response_table()."} $alias ON $alias.response_id = qr.id - "; - } -} diff --git a/classes/response/rank.php b/classes/response/rank.php deleted file mode 100644 index afa3fe3d..00000000 --- a/classes/response/rank.php +++ /dev/null @@ -1,364 +0,0 @@ -. - -/** - * This file contains the parent class for questionnaire question types. - * - * @author Mike Churchward - * @license http://www.gnu.org/copyleft/gpl.html GNU Public License - * @package questiontypes - */ - -namespace mod_questionnaire\response; -defined('MOODLE_INTERNAL') || die(); - -use mod_questionnaire\db\bulk_sql_config; - -/** - * Class for rank responses. - * - * @author Mike Churchward - * @package responsetypes - */ - -class rank extends base { - static public function response_table() { - return 'questionnaire_response_rank'; - } - - /** - * @param int $rid - * @param mixed $val - * @return bool|int - */ - public function insert_response($rid, $val) { - global $DB; - if ($this->question->type_id == QUESRATE) { - $resid = false; - foreach ($this->question->choices as $cid => $choice) { - $other = optional_param('q'.$this->question->id.'_'.$cid, null, PARAM_CLEAN); - // Choice not set or not answered. - if (!isset($other) || $other == '') { - continue; - } - if ($other == get_string('notapplicable', 'questionnaire')) { - $rank = -1; - } else { - $rank = intval($other); - } - $record = new \stdClass(); - $record->response_id = $rid; - $record->question_id = $this->question->id; - $record->choice_id = $cid; - $record->rankvalue = $rank; - $resid = $DB->insert_record(self::response_table(), $record); - } - return $resid; - } else { // THIS SHOULD NEVER HAPPEN. - if ($val == get_string('notapplicable', 'questionnaire')) { - $rank = -1; - } else { - $rank = intval($val); - } - $record = new \stdClass(); - $record->response_id = $rid; - $record->question_id = $this->question->id; - $record->rankvalue = $rank; - return $DB->insert_record(self::response_table(), $record); - } - } - - /** - * @param bool $rids - * @param bool $anonymous - * @return array - */ - public function get_results($rids=false, $anonymous=false) { - global $DB; - - $rsql = ''; - if (!empty($rids)) { - list($rsql, $params) = $DB->get_in_or_equal($rids); - $rsql = ' AND response_id ' . $rsql; - } - - if ($this->question->type_id == QUESRATE) { - // JR there can't be an !other field in rating questions ??? - $rankvalue = array(); - $select = 'question_id=' . $this->question->id . ' AND content NOT LIKE \'!other%\' ORDER BY id ASC'; - if ($rows = $DB->get_records_select('questionnaire_quest_choice', $select)) { - foreach ($rows as $row) { - $this->counts[$row->content] = new \stdClass(); - $nbna = $DB->count_records(self::response_table(), array('question_id' => $this->question->id, - 'choice_id' => $row->id, 'rankvalue' => '-1')); - $this->counts[$row->content]->nbna = $nbna; - // The $row->value may be null (i.e. empty) or have a 'NULL' value. - if ($row->value !== null && $row->value !== 'NULL') { - $rankvalue[] = $row->value; - } - } - } - - $isrestricted = ($this->question->length < count($this->question->choices)) && $this->question->precise == 2; - // Usual case. - if (!$isrestricted) { - if (!empty ($rankvalue)) { - $sql = "SELECT r.id, c.content, r.rankvalue, c.id AS choiceid - FROM {questionnaire_quest_choice} c, {".self::response_table()."} r - WHERE r.choice_id = c.id - AND c.question_id = " . $this->question->id . " - AND r.rankvalue >= 0{$rsql} - ORDER BY choiceid"; - $results = $DB->get_records_sql($sql, $params); - $value = array(); - foreach ($results as $result) { - if (isset ($value[$result->choiceid])) { - $value[$result->choiceid] += $rankvalue[$result->rankvalue]; - } else { - $value[$result->choiceid] = $rankvalue[$result->rankvalue]; - } - } - } - - $sql = "SELECT c.id, c.content, a.average, a.num - FROM {questionnaire_quest_choice} c - INNER JOIN - (SELECT c2.id, AVG(a2.rankvalue+1) AS average, COUNT(a2.response_id) AS num - FROM {questionnaire_quest_choice} c2, {".self::response_table()."} a2 - WHERE c2.question_id = ? AND a2.question_id = ? AND a2.choice_id = c2.id AND a2.rankvalue >= 0{$rsql} - GROUP BY c2.id) a ON a.id = c.id - order by c.id"; - $results = $DB->get_records_sql($sql, array_merge(array($this->question->id, $this->question->id), $params)); - if (!empty ($rankvalue)) { - foreach ($results as $key => $result) { - $result->averagevalue = $value[$key] / $result->num; - } - } - // Reindex by 'content'. Can't do this from the query as it won't work with MS-SQL. - foreach ($results as $key => $result) { - $results[$result->content] = $result; - unset($results[$key]); - } - return $results; - // Case where scaleitems is less than possible choices. - } else { - $sql = "SELECT c.id, c.content, a.sum, a.num - FROM {questionnaire_quest_choice} c - INNER JOIN - (SELECT c2.id, SUM(a2.rankvalue+1) AS sum, COUNT(a2.response_id) AS num - FROM {questionnaire_quest_choice} c2, {".self::response_table()."} a2 - WHERE c2.question_id = ? AND a2.question_id = ? AND a2.choice_id = c2.id AND a2.rankvalue >= 0{$rsql} - GROUP BY c2.id) a ON a.id = c.id"; - $results = $DB->get_records_sql($sql, array_merge(array($this->question->id, $this->question->id), $params)); - // Formula to calculate the best ranking order. - $nbresponses = count($rids); - foreach ($results as $key => $result) { - $result->average = ($result->sum + ($nbresponses - $result->num) * ($this->length + 1)) / $nbresponses; - $results[$result->content] = $result; - unset($results[$key]); - } - return $results; - } - } else { - $sql = 'SELECT A.rankvalue, COUNT(A.response_id) AS num ' . - 'FROM {'.self::response_table().'} A ' . - 'WHERE A.question_id= ? ' . $rsql . ' ' . - 'GROUP BY A.rankvalue'; - return $DB->get_records_sql($sql, array_merge(array($this->question->id), $params)); - } - } - - /** - * Provide the feedback scores for all requested response id's. This should be provided only by questions that provide feedback. - * @param array $rids - * @return array | boolean - */ - public function get_feedback_scores(array $rids) { - global $DB; - - $rsql = ''; - $params = [$this->question->id]; - if (!empty($rids)) { - list($rsql, $rparams) = $DB->get_in_or_equal($rids); - $params = array_merge($params, $rparams); - $rsql = ' AND response_id ' . $rsql; - } - $params[] = 'y'; - - $sql = 'SELECT r.id, r.response_id as rid, r.question_id AS qid, r.choice_id AS cid, r.rankvalue ' . - 'FROM {'.$this->response_table().'} r ' . - 'INNER JOIN {questionnaire_quest_choice} c ON r.choice_id = c.id ' . - 'WHERE r.question_id= ? ' . $rsql . ' ' . - 'ORDER BY rid,cid ASC'; - $responses = $DB->get_recordset_sql($sql, $params); - - $sql = 'SELECT id, value ' . - 'FROM {questionnaire_quest_choice} ' . - 'WHERE question_id = ? AND value IS NOT NULL ' . - 'ORDER BY id ASC '; - $scorerecs = $DB->get_records_sql($sql, $params); - - // Reindex $scores as a zero starting array. - $scores = []; - foreach ($scorerecs as $scorerec) { - $scores[] = $scorerec->value; - } - - $rid = 0; - $feedbackscores = []; - foreach ($responses as $response) { - if ($rid != $response->rid) { - $rid = $response->rid; - $feedbackscores[$rid] = new \stdClass(); - $feedbackscores[$rid]->rid = $rid; - $feedbackscores[$rid]->score = 0; - } - $feedbackscores[$rid]->score += isset($scores[$response->rankvalue]) ? $scores[$response->rankvalue] : 0; - } - - return (!empty($feedbackscores) ? $feedbackscores : false); - } - - /** - * @param bool $rids - * @param string $sort - * @param bool $anonymous - * @return string - */ - public function display_results($rids=false, $sort='', $anonymous=false) { - $output = ''; - - if (is_array($rids)) { - $prtotal = 1; - } else if (is_int($rids)) { - $prtotal = 0; - } - - if ($rows = $this->get_results($rids, $sort, $anonymous)) { - $stravgvalue = ''; // For printing table heading. - foreach ($this->counts as $key => $value) { - $ccontent = $key; - $avgvalue = ''; - if (array_key_exists($ccontent, $rows)) { - $avg = $rows[$ccontent]->average; - $this->counts[$ccontent]->num = $rows[$ccontent]->num; - if (isset($rows[$ccontent]->averagevalue)) { - $avgvalue = $rows[$ccontent]->averagevalue; - $osgood = false; - if ($this->question->precise == 3) { // Osgood's semantic differential. - $osgood = true; - } - if ($stravgvalue == '' && !$osgood) { - $stravgvalue = ' ('.get_string('andaveragevalues', 'questionnaire').')'; - } - } else { - $avgvalue = null; - } - } else { - $avg = 0; - } - $this->counts[$ccontent]->avg = $avg; - $this->counts[$ccontent]->avgvalue = $avgvalue; - } - $output .= \mod_questionnaire\response\display_support::mkresavg($this->counts, count($rids), $this->question->choices, - $this->question->precise, $prtotal, $this->question->length, $sort, $stravgvalue); - - $output .= \mod_questionnaire\response\display_support::mkrescount($this->counts, $rids, $rows, $this->question, - $this->question->precise, $this->question->length, $sort); - } else { - $output .= '
@@ -66,16 +71,20 @@
@@ -260,10 +267,9 @@
\ No newline at end of file
diff --git a/db/log.php b/db/log.php
index af423063..968e5dc0 100644
--- a/db/log.php
+++ b/db/log.php
@@ -17,9 +17,8 @@
/**
* Capability definitions for the quiz module.
*
- * @package mod
- * @subpackage questionnaire
- * @copyright 2010 Remote-Learner.net (http://www.remote-learner.net)
+ * @package mod_questionnaire
+ * @copyright 2016 Mike Churchward (mike.churchward@poetopensource.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
@@ -29,4 +28,4 @@
array('module' => 'questionnaire', 'action' => 'view all', 'mtable' => 'questionnaire', 'field' => 'name'),
array('module' => 'questionnaire', 'action' => 'submit', 'mtable' => 'questionnaire_response', 'field' => 'id'),
array('module' => 'questionnaire', 'action' => 'view', 'mtable' => 'questionnaire', 'field' => 'name'),
-);
\ No newline at end of file
+);
diff --git a/db/mobile.php b/db/mobile.php
index 4f6d5f0d..01bec8fb 100644
--- a/db/mobile.php
+++ b/db/mobile.php
@@ -29,17 +29,23 @@
'handlers' => [
'questionsview' => [
'displaydata' => [
- 'icon' => $CFG->wwwroot . '/mod/questionnaire/pix/icon.gif',
- 'class' => '',
+ 'icon' => $CFG->wwwroot . '/mod/questionnaire/pix/icon.svg',
+ 'class' => 'core-course-module-questionnaire-handler',
],
'delegate' => 'CoreCourseModuleDelegate',
- 'method' => 'mobile_view_activity'
+ 'method' => 'mobile_view_activity',
+ 'styles' => [
+ 'url' => $CFG->wwwroot . '/mod/questionnaire/styles_app.css',
+ 'version' => '1.5'
+ ]
]
],
'lang' => [
['yourresponse', 'questionnaire'],
['submitted', 'questionnaire'],
+ ['answerquestions', 'questionnaire'],
['areyousure', 'moodle'],
+ ['resumesurvey', 'questionnaire'],
['success', 'moodle'],
['savechanges', 'moodle'],
['nextpage', 'questionnaire'],
@@ -48,4 +54,4 @@
['required', 'moodle']
],
]
-];
\ No newline at end of file
+];
diff --git a/db/services.php b/db/services.php
index e7c529be..ba55f345 100644
--- a/db/services.php
+++ b/db/services.php
@@ -26,14 +26,22 @@
defined('MOODLE_INTERNAL') || die;
+$services = [
+ 'mod_questionnaire_ws' => [
+ 'functions' => ['mod_questionnaire_submit_questionnaire_response'],
+ 'requiredcapability' => '',
+ 'enabled' => 1
+ ]
+];
+
$functions = [
- 'mod_questionnaire_submit_questionnaire_branching' => [
- 'classname' => 'mod_questionnaire_external',
- 'methodname' => 'submit_questionnaire_branching',
+ 'mod_questionnaire_submit_questionnaire_response' => [
+ 'classname' => 'mod_questionnaire\external',
+ 'methodname' => 'submit_questionnaire_response',
'classpath' => 'mod/questionnaire/externallib.php',
- 'description' => 'Questionnaire Branching submit',
+ 'description' => 'Questionnaire submit',
'type' => 'write',
'capabilities' => 'mod/questionnaire:submit',
'services' => [MOODLE_OFFICIAL_MOBILE_SERVICE]
]
-];
\ No newline at end of file
+];
diff --git a/db/tasks.php b/db/tasks.php
index c36110b1..40d241ab 100644
--- a/db/tasks.php
+++ b/db/tasks.php
@@ -16,6 +16,7 @@
/**
* Definition of Questionnaire scheduled tasks.
+ *
* Default is to run once every 12 hours.
*
* @package mod_questionnaire
@@ -23,9 +24,9 @@
* @copyright 2015 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
-
defined('MOODLE_INTERNAL') || die();
+/** @var array $tasks */
$tasks = array(
array(
'classname' => 'mod_questionnaire\task\cleanup',
diff --git a/db/upgrade.php b/db/upgrade.php
index 270b1758..dd5fd989 100644
--- a/db/upgrade.php
+++ b/db/upgrade.php
@@ -15,14 +15,18 @@
// along with Moodle. If not, see
Confirmation page'; +$string['configemailreporting'] = 'Allow reports by email'; +$string['configemailreportinglong'] = 'Enables options for some reports to be emailed directly to specified email addresses.'; $string['configusergraph'] = 'Display charts for "Personality Test" feedback'; $string['configusergraphlong'] = 'Use the Rgraph library to display "Personality Test" feedback charts.'; $string['configmaxsections'] = 'Maximum feedback sections'; @@ -113,10 +118,14 @@ $string['createcontent_help'] = 'Select one of the radio button options. \'Create new\' is the default.'; $string['createcontent_link'] = 'mod/questionnaire/mod#Content_Options'; $string['createnew'] = 'Create new'; +$string['centerlabel'] = 'Centre label'; $string['date'] = 'Date'; $string['date_help'] = 'Use this question type if you expect the response to be a correctly formatted date.'; $string['date_link'] = 'mod/questionnaire/questions#Date'; -$string['dateformatting'] = 'Use the day/month/year format, e.g. for March 14th, 1945: 14/3/1945'; +$string['dateformatting'] = 'Use the year-month-day format, e.g. for March 4th, 1945: 1945-03-04'; +// Prior to release 3.6.0, you could specify an input date format in the above string. Now, the format must be as below. This +// string is used now in case sites modified the above string. +$string['strictdateformatting'] = 'Enter the date using the date picker below.'; $string['deleteallresponses'] = 'Delete ALL Responses'; $string['deletecurrentquestion'] = 'Delete question {$a}'; $string['deletedallgroupresp'] = 'Deleted ALL Responses in group {$a}'; @@ -135,10 +144,12 @@ $string['directwarnings'] = 'Direct dependencies to this question will be removed. This will affect:'; $string['displaymethod'] = 'Display method not defined for question.'; $string['download'] = 'Download'; -$string['downloadtextformat'] = 'Download as CSV'; -$string['downloadtextformat_help'] = 'This feature enables you to save all the responses of a questionnaire to a text file (CSV). - This file can then be imported into a spreadsheet (e.g. MS Excel or Open Office Calc) or a statistical package for further processing the data.'; +$string['downloadpdf'] = 'Download PDF'; +$string['downloadtextformat'] = 'Download'; +$string['downloadtextformat_help'] = 'This feature enables you to download questionnaire responses in a file format of your choice. + The file can then be opened in a spreadsheet program (e.g. MS Excel or Open Office Calc) or a statistical package for further processing.'; $string['downloadtextformat_link'] = 'mod/questionnaire/report#Download_in_text_format'; +$string['downloadtypes'] = 'Report type'; $string['dropdown'] = 'Dropdown Box'; $string['dropdown_help'] = 'There is no real advantage to using the Dropdown Box over using the Radio Buttons except perhaps for longish lists of options, to save screen space.'; @@ -148,6 +159,15 @@ $string['editingquestionnaire'] = 'Editing Questionnaire Settings'; $string['editquestion'] = 'Editing {$a} question'; $string['email'] = 'Email'; +$string['emailextra'] = 'Send download to emails'; +$string['emailextra_help'] = 'Will send the download file to the listed email addresses, separated by commas. Note that NO security or privacy checking is done. + \'allowemailreporting\' must be enabled in module settings to access this.'; +$string['emailsnotspecified'] = 'No email(s) were specified.'; +$string['emailroles'] = 'Send download to roles'; +$string['emailroles_help'] = 'Will send the download file to all roles with "mod/questionnaire:submissionnotification" capability via email. + \'allowemailreporting\' must be enabled in module settings to access this.'; +$string['emailsend'] = 'Send reports'; +$string['emailssent'] = 'Downloads sent to specified email(s).'; $string['errnewname'] = 'Sorry, name already in use. Pick a new name.'; $string['erroropening'] = 'Error opening questionnaire.'; $string['errortable'] = 'Error system table corrupt.'; @@ -196,7 +216,8 @@ $string['feedbacknotes_help'] = 'Text entered here will be displayed to the respondents at the end of their Feedback Report'; $string['feedbackoptions'] = 'Feedback options'; $string['feedbackoptions_help'] = 'Feedback options are available if your questionnaire contains the following question types and question settings: -Radio buttons; Dropdown box; Yes/No; or Rate (normal or Osgood scale). Those questions must be set as Required, their Question Name field must NOT be empty and the Possible answers choices must contain a value.'; +Radio buttons; Dropdown box; Yes/No; Rate (normal or Osgood scale) or Slider. Those questions must be set as Required, their Question Name field must NOT be empty and the Possible answers choices must contain a value. +Slider questions must NOT use a negative value for the Minimum slider range.'; $string['feedbackoptions_link'] = 'mod/questionnaire/personality_test'; $string['feedbackremovequestionfromsection'] = 'This question is part of feedback section [{$a}]'; $string['feedbackremovesection'] = 'Removing this question will completely remove feedback section [{$a}]'; @@ -234,6 +255,7 @@ $string['headingtext'] = 'Heading text'; $string['horizontal'] = 'Horizontal'; $string['id'] = 'ID'; +$string['includerankaverages'] = 'Include rank question averages'; $string['includechoicecodes'] = 'Include choice codes'; $string['includechoicetext'] = 'Include choice text'; $string['includeincomplete'] = "Include incomplete responses"; @@ -244,12 +266,19 @@ $string['invalidresponserecord'] = 'Invalid response record specified.'; $string['invalidsurveyid'] = 'Invalid questionnaire ID.'; $string['invalidsectionid'] = 'Invalid feedback section specified.'; +$string['invalidrange'] = 'The maximum slider value must be greater than the minimum slider value.'; +$string['invalidstartingvalue'] = 'The starting value must be equal to or between the minimum and maximum values. For example, if using a scale of 1-10, the starting value could be 5.'; +$string['invalidminmaxrange'] = 'This question type supports an absolute maximum range of -100 to +100. We expect the vast majority of questionnaire designs to use a range of 1-10 or -10 to +10.'; +$string['invalidincrement'] = 'Note that the value increments must be lower than the maximum value. For example, if a scale of 1-10, the increment value would probably be 1.'; $string['indirectwarnings'] = 'This list shows the indirect dependent questions and the remaining dependencies for direct dependent questions:'; $string['kindofratescale'] = 'Type of rate scale'; $string['kindofratescale_help'] = 'Right-click on the More Help link below.'; $string['kindofratescale_link'] = 'mod/questionnaire/questions#Type_of_rate_scale'; $string['lastrespondent'] = 'Last Respondent'; $string['length'] = 'Length'; +$string['leftlabel'] = 'Left label'; +$string['leftpart'] = '{$a->min} is {$a->leftlabel}'; +$string['leftpartdefault'] = '{$a->min} is minimum slider range'; $string['managequestions'] = 'Manage questions'; $string['managequestions_help'] = 'In the Manage questions section of the Edit Questions page, you can conduct a number of operations on a Questionnaire\'s questions.'; $string['managequestions_link'] = 'mod/questionnaire/questions#Manage_questions'; @@ -269,6 +298,10 @@ Default values are 20 characters for the Input Box width and 25 characters for the maximum length of text entered.'; $string['messageprovider:message'] = 'Questionnaire reminder'; $string['messageprovider:notification'] = 'Questionnaire submission'; +$string['middlepart'] = ', {$a->centreval} is {$a->middlelabel}'; +$string['middlepartdefault'] = ', {$a->centreval} is average'; +$string['middlepartwithtwovalues'] = ', {$a->centreval1} and {$a->centreval2} are {$a->middlelabel}'; +$string['middlepartwithtwovaluesdefault'] = ', {$a->centreval1} and {$a->centreval2} are average'; $string['minforcedresponses'] = 'Min. forced responses'; $string['minforcedresponses_help'] = 'Use these parameters to force respondent to tick a minimum of **Min.** boxes and a maximum of **Max.** check boxes. To force an exact number of check boxes to be ticked, set **Min.** and **Max.** to the same value. If only a min or a max value is desired, just leave the other @@ -276,15 +309,20 @@ respondent does not comply with your requirements. Obviously you should make any requirements clear to the respondent either in the general instructions of your Questionnaire or in the text of relevant questions.'; $string['misconfigured'] = 'Course is misconfigured'; -$string['missingquestion'] = 'Please answer Required question '; -$string['missingquestions'] = 'Please answer Required questions: '; +$string['missingquestion'] = 'Please answer required question '; +$string['missingquestions'] = 'Please answer required questions: '; $string['modulename'] = 'Questionnaire'; $string['modulename_help'] = 'The questionnaire module allows you to construct surveys using a variety of question types, for the purpose of gathering data from users.'; +$string['modulename_link'] = 'mod/questionnaire/view'; $string['modulenameplural'] = 'Questionnaires'; $string['movedisabled'] = 'This item cannot be moved'; $string['myresponses'] = 'All your responses'; $string['myresponsetitle'] = 'Your {$a} response(s)'; $string['myresults'] = 'Your Results'; +$string['minrange'] = 'Minimum slider range (left)'; +$string['minrange_help'] = 'Set the minimum value of the range on the left-hand side. It defaults to 1, but can set as low as -100. If you use a negative number (-100 to -1), the right-hand maximum will be expressed with a positive (+) sign.'; +$string['maxrange'] = 'Maximum slider range (right)'; +$string['maxrange_help'] = 'Set the maximum value of the range on the right-hand side. It defaults to 100, but it could be any number between 1-100. If the minimum value for the left-hand is a negative value, the maximum range will be expressed with a positive (+) sign.'; $string['name'] = 'Name'; $string['navigate'] = 'Allow branching questions'; $string['navigate_help'] = 'Enable Yes/No and Radio Buttons questions to have Child questions dependent on their choices in your questionnaire.'; @@ -332,9 +370,8 @@ $string['numeric'] = 'Numeric'; $string['numeric_help'] = 'Use this question type if you expect the response to be a correctly formatted number.'; $string['of'] = 'of'; -$string['opendate'] = 'Use Open Date'; -$string['opendate_help'] = 'You can specify a date to open the questionnaire here. Check the check box, and select the date and time you want. - Users will not be able to fill out the questionnaire before that date. If this is not selected, it will be open immediately.'; +$string['openafterclose'] = 'You have specified an open date after the close date'; +$string['opendate'] = 'Allow responses from'; $string['option'] = 'option {$a}'; $string['optional'] = 'Optional - At least one of this dependencies has to be fulfilled.'; $string['optionalname'] = 'Question Name'; @@ -431,6 +468,10 @@ $string['privacy:metadata:questionnaire_resp_single:choice_id'] = 'The ID of the choice record for this response.'; $string['private'] = 'Private'; +$string['progressbar'] = 'Show progress bar'; +$string['progresshelp'] = 'Progress Bar'; +$string['progresshelp_help'] = 'Move on to the next page to fill up the progress bar'; +$string['progressbar_info'] = 'Questionnaire {$a} complete.'; $string['public'] = 'Public'; $string['publiccopy'] = 'Copy:'; $string['publicoriginal'] = 'Original:'; @@ -525,7 +566,11 @@ $string['resume_link'] = 'mod/questionnaire/mod#Save/Resume_answers'; $string['resumesurvey'] = 'Resume questionnaire'; $string['return'] = 'Return'; +$string['rightlabel'] = 'Right label'; +$string['rightpart'] = ' and {$a->max} is {$a->rightlabel}'; +$string['rightpartdefault'] = ' and {$a->max} is maximum slider range'; $string['save'] = 'Save'; +$string['save_and_exit'] = 'Save and exit'; $string['saveasnew'] = 'Save as New Question'; $string['savedbutnotsubmitted'] = 'This questionnaire has been saved but not yet submitted.'; $string['savedprogress'] = 'Your progress has been saved. You may return at any time to complete this questionnaire.'; @@ -546,7 +591,7 @@ $string['send_message_to'] = 'Send message to:'; $string['sendemail_help'] = 'Sends a copy of each submission to the specified address or addresses. You can provide more than one address by separating them with commas. -Leave blank for no email backup.'; +Leave blank for no email backup. \'allowemailreporting\' must be enabled in module settings to access this.'; $string['set'] = 'set'; $string['settings'] = 'Settings'; $string['settingssaved'] = 'Settings saved'; @@ -568,9 +613,16 @@ $string['subtitle_help'] = 'Subtitle of this questionnaire. Appears below the title on the first page only.'; $string['subject'] = 'Subject'; $string['summary'] = 'Summary'; +$string['summaryreportattached'] = 'Questionnaire summary report attached'; $string['surveynotexists'] = 'questionnaire does not exist.'; $string['surveyowner'] = 'You must be a questionnaire owner to perform this operation.'; $string['surveyresponse'] = 'Response from questionnaire'; +$string['slider'] = 'Slider'; +$string['slider_help'] = 'The slider question allows respondents to select a value from a continuous range by dragging a slider between two extremes. A centre value can also be set.'; +$string['startingvalue'] = 'Slider starting value'; +$string['startingvalue_help'] = 'The slider starting value specifies where the slider should first appear for respondents. It defaults to 1 because the range is unknown. You may wish to start it in the centre of the range by giving a central value (a range of 1-100 has a centre value of 50).'; +$string['stepvalue'] = 'Slider increment value'; +$string['stepvalue_help'] = 'The slider increment value specifies how finely you wish respondents to indicate their response in the range. The question defaults to a range of 1-100 with an increment of one, allowing respondents to give values of 70, 71, 72, 73, 74 etc. But you could instead set increments of five, allowing respondents to give values of 60, 65, 70, 75, 80 etc., or even just a range of 1-10 with increments of 1.'; $string['template'] = 'Template'; $string['templatenotviewable'] = 'Template questionnaires are not viewable.'; $string['text'] = 'Question Text'; @@ -607,7 +659,7 @@ $string['usetemplate'] = 'Use template'; $string['vertical'] = 'Vertical'; $string['view'] = 'View'; -$string['viewallresponses'] = 'View All Responses'; +$string['viewallresponses'] = 'View all responses'; $string['viewallresponses_help'] = 'If the questionnaire is set to **Group Mode**: *Visible groups*, or is set to *Separate groups* and the current user has the *moodle/site:accessallgroups* capability (in the current context), and groups have been defined in the current course, then the user has access to a dropdown list of groups. This dropdown list enables the user to "filter" the questionnaire responses by groups. @@ -618,8 +670,9 @@ $string['viewindividualresponse'] = 'Individual responses'; $string['viewindividualresponse_help'] = 'Click on the respondents\' names in the list below to view their individual responses.'; $string['viewresponses'] = 'All responses ({$a})'; -$string['viewyourresponses'] = 'Your responses- view {$a}'; +$string['viewyourresponses'] = 'View your response(s)'; $string['warning'] = 'Warning, error encountered.'; +$string['where'] = 'where '; $string['wronganswers'] = 'There is something wrong with your answers (see below)'; $string['wrongdateformat'] = 'The date entered: {$a} does not correspond to the format shown in the example.'; $string['wrongdaterange'] = 'ERROR! The year must be set in the 1902 to 2037 range.'; @@ -627,7 +680,8 @@ $string['wrongformats'] = 'There is something wrong with your answer to questions: '; $string['yesno'] = 'Yes/No'; $string['yesno_help'] = 'Simple Yes/No question.'; -$string['yourresponse'] = 'Your response'; -$string['yourresponses'] = 'Your responses'; +$string['yourresponse'] = 'View your response(s)'; +$string['yourresponses'] = 'View your response(s)'; $string['crontask'] = 'Questionnaire cleanup job'; -$string['selectdropdowntext'] = 'Select One'; \ No newline at end of file +$string['nopermissions'] = 'Sorry, but you do not currently have permissions to view this page or perform this action.'; +$string['unanswered'] = 'Unanswered'; diff --git a/lib.php b/lib.php index efdb8af6..dd7f2ea0 100644 --- a/lib.php +++ b/lib.php @@ -14,20 +14,25 @@ // You should have received a copy of the GNU General Public License // along with Moodle. If not, see
'; // Need to reload questions. - $questions = $DB->get_records('questionnaire_question', ['surveyid' => $sid, 'deleted' => 'n'], 'id'); - $DB->set_field('questionnaire_question', 'deleted', 'y', ['id' => $qid, 'surveyid' => $sid]); - $select = 'surveyid = '.$sid.' AND deleted = \'n\' AND position > '. - $questions[$qid]->position; - if ($records = $DB->get_records_select('questionnaire_question', $select, null, 'position ASC')) { - foreach ($records as $record) { - $DB->set_field('questionnaire_question', 'position', $record->position - 1, ['id' => $record->id]); + if ($questions = $DB->get_records('questionnaire_question', ['surveyid' => $sid, 'deleted' => 'n'], 'id')) { + $DB->set_field('questionnaire_question', 'deleted', 'y', ['id' => $qid, 'surveyid' => $sid]); + $select = 'surveyid = ' . $sid . ' AND deleted = \'n\' AND position > ' . + $questions[$qid]->position; + if ($records = $DB->get_records_select('questionnaire_question', $select, null, 'position ASC')) { + foreach ($records as $record) { + $DB->set_field('questionnaire_question', 'position', $record->position - 1, ['id' => $record->id]); + } } } } } // Add pagebreak between question child and not dependent question that follows. if ($qu['type_id'] != QUESPAGEBREAK) { - $j = $i - 1; - if ($j != 0) { - $prevtypeid = $positions[$j]['type_id']; - $prevdependencies = $positions[$j]['dependencies']; - - $outerdependencies = count($qu['dependencies']) >= count($prevdependencies) ? $qu['dependencies'] : $prevdependencies; - $innerdependencies = count($qu['dependencies']) < count($prevdependencies) ? $qu['dependencies'] : $prevdependencies; - + if ($prevqu) { + $prevdependencies = $prevqu['dependencies']; + $outerdependencies = count($qu['dependencies']) >= count($prevdependencies) ? + $qu['dependencies'] : $prevdependencies; + $innerdependencies = count($qu['dependencies']) < count($prevdependencies) ? + $qu['dependencies'] : $prevdependencies; + + $okeys = []; + $ikeys = []; foreach ($outerdependencies as $okey => $outerdependency) { foreach ($innerdependencies as $ikey => $innerdependency) { if ($outerdependency->dependquestionid === $innerdependency->dependquestionid && - $outerdependency->dependchoiceid === $innerdependency->dependchoiceid && - $outerdependency->dependlogic === $innerdependency->dependlogic) { - unset($outerdependencies[$okey]); - unset($innerdependencies[$ikey]); + $outerdependency->dependchoiceid === $innerdependency->dependchoiceid && + $outerdependency->dependlogic === $innerdependency->dependlogic) { + $okeys[] = $okey; + $ikeys[] = $ikey; } } } + foreach ($okeys as $key) { + if (key_exists($key, $outerdependencies)) { + unset($outerdependencies[$key]); + } + } + foreach ($ikeys as $key) { + if (key_exists($key, $innerdependencies)) { + unset($innerdependencies[$key]); + } + } + $diffdependencies = count($outerdependencies) + count($innerdependencies); if (($prevtypeid != QUESPAGEBREAK && $diffdependencies != 0) @@ -886,9 +850,8 @@ function questionnaire_check_page_breaks($questionnaire) { return (false); } $newpbids[] = $newqid; - $movetopos = $i; - $questionnaire = new questionnaire($questionnaire->id, null, $course, $cm); - $questionnaire->move_question($newqid, $movetopos); + $questionnaire = new questionnaire($course, $cm, $questionnaire->id, null); + $questionnaire->move_question($newqid, $qu['qpos']); } } } @@ -898,7 +861,7 @@ function questionnaire_check_page_breaks($questionnaire) { } else if ($newpbids) { $msg .= get_string('checkbreaksadded', 'questionnaire').' '; $newpbids = array_reverse ($newpbids); - $questionnaire = new questionnaire($questionnaire->id, null, $course, $cm); + $questionnaire = new questionnaire($course, $cm, $questionnaire->id, null); foreach ($newpbids as $newpbid) { $msg .= $questionnaire->questions[$newpbid]->position.' '; } @@ -908,6 +871,10 @@ function questionnaire_check_page_breaks($questionnaire) { /** * Code snippet used to set up the questionform. + * @param stdClass $questionnaire + * @param int $qid + * @param int $qtype + * @return mixed|\mod_questionnaire\question\question */ function questionnaire_prep_for_questionform($questionnaire, $qid, $qtype) { $context = context_module::instance($questionnaire->cm->id); @@ -933,7 +900,7 @@ function questionnaire_prep_for_questionform($questionnaire, $qid, $qtype) { } } } else { - $question = \mod_questionnaire\question\base::question_builder($qtype); + $question = \mod_questionnaire\question\question::question_builder($qtype); $question->sid = $questionnaire->survey->id; $question->id = $questionnaire->cm->id; $question->type_id = $qtype; @@ -957,28 +924,28 @@ function questionnaire_get_standard_page_items($id = null, $a = null) { if ($id) { if (! $cm = get_coursemodule_from_id('questionnaire', $id)) { - print_error('invalidcoursemodule'); + throw new \moodle_exception('invalidcoursemodule', 'mod_questionnaire'); } if (! $course = $DB->get_record("course", array("id" => $cm->course))) { - print_error('coursemisconf'); + throw new \moodle_exception('coursemisconf', 'mod_questionnaire'); } if (! $questionnaire = $DB->get_record("questionnaire", array("id" => $cm->instance))) { - print_error('invalidcoursemodule'); + throw new \moodle_exception('invalidcoursemodule', 'mod_questionnaire'); } } else { if (! $questionnaire = $DB->get_record("questionnaire", array("id" => $a))) { - print_error('invalidcoursemodule'); + throw new \moodle_exception('invalidcoursemodule', 'mod_questionnaire'); } if (! $course = $DB->get_record("course", array("id" => $questionnaire->course))) { - print_error('coursemisconf'); + throw new \moodle_exception('coursemisconf', 'mod_questionnaire'); } if (! $cm = get_coursemodule_from_instance("questionnaire", $questionnaire->id, $course->id)) { - print_error('invalidcoursemodule'); + throw new \moodle_exception('invalidcoursemodule', 'mod_questionnaire'); } } return (array($cm, $course, $questionnaire)); -} \ No newline at end of file +} diff --git a/mobiledump.txt b/mobiledump.txt new file mode 100644 index 00000000..e8fe347c --- /dev/null +++ b/mobiledump.txt @@ -0,0 +1,54 @@ +
+ <%#choices%>
+
+
+
+
+ checked="true"<%/value%>
+ value="<%id%>"
+ <%#completed%> disabled="true"<%/completed%>>
+
+
+
+
+ <%/choices%>
+
+
+
+
+
+
+=========== error_log ===============
+
+[Thu Aug 01 10:17:34.671596 2019] [php7:notice] [pid 67268] [client ::1:61305] stdClass Object
+(
+ [action] => nextpage
+ [appcustomurlscheme] => moodlemobile
+ [appid] => com.moodle.moodlemobile
+ [appisdesktop] => 1
+ [appismobile] => 0
+ [appiswide] => 1
+ [applang] => en-us
+ [appplatform] => mac
+ [appversioncode] => 3700
+ [appversionname] => 3.7.0
+ [cmid] => 153
+ [completeq] => 1
+ [pagenum] => 2
+ [rid] => 0
+ [userid] => 3
+)
+
diff --git a/mod_form.php b/mod_form.php
index 23fa7e58..26fcd227 100644
--- a/mod_form.php
+++ b/mod_form.php
@@ -14,27 +14,30 @@
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see
\n"; @@ -1878,23 +2216,25 @@ private function get_full_submission_for_notifications($answers) { /** * Construct the response data for a given response and return a structured export. - * @param $rid + * @param int $rid * @return string * @throws coding_exception */ public function get_structured_response($rid) { - $answers = new stdClass(); - $this->response_import_all($rid, $answers); - return $this->get_full_submission_for_export($answers); + $this->add_response($rid); + return $this->get_full_submission_for_export($rid); } /** * Return a JSON structure containing all the questions and answers for a specific submission. - * @param $answers The array of answers from import_all_responses. - * @return string - * @throws coding_exception + * @param int $rid + * @return array */ - private function get_full_submission_for_export($answers) { + private function get_full_submission_for_export($rid) { + if (!isset($this->responses[$rid])) { + $this->add_response($rid); + } + $exportstructure = []; foreach ($this->questions as $question) { $rqid = 'q' . $question->id; @@ -1906,54 +2246,46 @@ private function get_full_submission_for_export($answers) { $choices = []; $cids = []; foreach ($question->choices as $cid => $choice) { - if (!empty($choice->value)) { + if (!empty($choice->value) && (strpos($choice->content, '=') !== false)) { $choices[$choice->value] = substr($choice->content, (strpos($choice->content, '=') + 1)); } else { $cids[$rqid . '_' . $cid] = $choice->content; } } - foreach ($cids as $rqid => $choice) { - if (isset($answers->$rqid)) { + if (isset($this->responses[$rid]->answers[$question->id])) { + foreach ($cids as $rqid => $choice) { $cid = substr($rqid, (strpos($rqid, '_') + 1)); - if (isset($question->choices[$cid]) && isset($choices[$answers->$rqid + 1])) { - $rating = $choices[$answers->$rqid + 1]; - } else { - $rating = $answers->$rqid + 1; + if (isset($this->responses[$rid]->answers[$question->id][$cid])) { + if (isset($question->choices[$cid]) && + isset($choices[$this->responses[$rid]->answers[$question->id][$cid]->value])) { + $rating = $choices[$this->responses[$rid]->answers[$question->id][$cid]->value]; + } else { + $rating = $this->responses[$rid]->answers[$question->id][$cid]->value; + } + $response->answers[] = $question->choices[$cid]->content . ' = ' . $rating; } - $response->answers[] = $question->choices[$cid]->content . ' = ' . $rating; } } } else if ($question->has_choices()) { - // Check for "other". - foreach ($question->choices as $cid => $choice) { - if (strpos($choice->content, '!other=') !== false) { - $other = $cid; - break; - } - } $answertext = ''; - if (isset($answers->$rqid) && is_array($answers->$rqid)) { + if (isset($this->responses[$rid]->answers[$question->id])) { $i = 0; - foreach ($answers->$rqid as $answer) { + foreach ($this->responses[$rid]->answers[$question->id] as $answer) { if ($i > 0) { $answertext .= '; '; } - if (isset($other) && ($answer == ('other_' . $other))) { - $answertext .= $answers->{$rqid . '_' . $other}; + if ($question->choices[$answer->choiceid]->is_other_choice()) { + $answertext .= $answer->value; } else { - $answertext .= $question->choices[$answer]->content; + $answertext .= $question->choices[$answer->choiceid]->content; } $i++; } - } else if (isset($answers->$rqid) && isset($other) && ($answers->$rqid == ('other_' . $other))) { - $answertext .= $answers->{$rqid . '_' . $other}; - } else if (isset($answers->$rqid) && isset($question->choices[$answers->$rqid])) { - $answertext .= $question->choices[$answers->$rqid]->content; } $response->answers[] = $answertext; - } else if (isset($answers->$rqid)) { - $response->answers[] = $answers->$rqid; + } else if (isset($this->responses[$rid]->answers[$question->id])) { + $response->answers[] = $this->responses[$rid]->answers[$question->id][0]->value; } $exportstructure[] = $response; } @@ -2005,13 +2337,11 @@ private function get_formatted_answers_for_emails($answers) { * @param int $rid The id of the response record. * @param string $email The comma separated list of emails to send to. * @return bool - * @throws coding_exception - * @throws dml_exception */ private function response_send_email($rid, $email) { global $CFG; - $submission = $this->generate_csv($rid, '', null, 1, 0); + $submission = $this->generate_csv(0, $rid, '', null, 1); if (!empty($submission)) { $answers = $this->get_formatted_answers_for_emails($submission); } else { @@ -2032,10 +2362,10 @@ private function response_send_email($rid, $email) { '&rid='.$rid.'&instance='.$this->id; // Html and plaintext body. - $bodyhtml = ''.$url.''.$endhtml; - $bodyplaintext = $url.$endplaintext; - $bodyhtml .= get_string('surveyresponse', 'questionnaire') .' "'.$name.'"'.$endhtml; - $bodyplaintext .= get_string('surveyresponse', 'questionnaire') .' "'.$name.'"'.$endplaintext; + $bodyhtml = ''.$url.''.$endhtml; + $bodyplaintext = $url.$endplaintext; + $bodyhtml .= get_string('surveyresponse', 'questionnaire') .' "'.$name.'"'.$endhtml; + $bodyplaintext .= get_string('surveyresponse', 'questionnaire') .' "'.$name.'"'.$endplaintext; $bodyhtml .= $answers['html']; $bodyplaintext .= $answers['plaintext']; @@ -2061,19 +2391,27 @@ private function response_send_email($rid, $email) { return $return; } - public function response_insert($section, $rid, $userid, $resume=false) { + /** + * Insert the provided response. + * @param object $responsedata An object containing all data for the response. + * @param int $userid + * @param bool $resume + * @return bool|int + */ + public function response_insert($responsedata, $userid, $resume=false) { global $DB; $record = new stdClass(); $record->submitted = time(); - if (empty($rid)) { + if (empty($responsedata->rid)) { // Create a uniqe id for this response. $record->questionnaireid = $this->id; $record->userid = $userid; - $rid = $DB->insert_record('questionnaire_response', $record); + $responsedata->rid = $DB->insert_record('questionnaire_response', $record); + $responsedata->id = $responsedata->rid; } else { - $record->id = $rid; + $record->id = $responsedata->rid; $DB->update_record('questionnaire_response', $record); } if ($resume) { @@ -2092,56 +2430,47 @@ public function response_insert($section, $rid, $userid, $resume=false) { $event->trigger(); } - if (!empty($this->questionsbysec[$section])) { - foreach ($this->questionsbysec[$section] as $question) { - // NOTE *** $val really should be a value obtained from the caller or somewhere else. - // Note that "optional_param" accepting arrays is deprecated for optional_param_array. - if ($question->responsetable == 'resp_multiple') { - $val = optional_param_array('q'.$question->id, '', PARAM_RAW); - } else { - $val = optional_param('q'.$question->id, '', PARAM_RAW); - } - $question->insert_response($rid, $val); + if (!isset($responsedata->sec)) { + $responsedata->sec = 1; + } + if (!empty($this->questionsbysec[$responsedata->sec])) { + foreach ($this->questionsbysec[$responsedata->sec] as $questionid) { + $this->questions[$questionid]->insert_response($responsedata); } } - return($rid); + return($responsedata->rid); } - private function response_select($rid, $col = null, $csvexport = false, $choicecodes=0, $choicetext=1) { - if ($col == null) { - $col = ''; - } - if (!is_array($col) && !empty($col)) { - $col = explode(',', preg_replace("/\s/", '', $col)); - } - if (is_array($col) && count($col) > 0) { - $callback = function($a) { - return 'q.'.$a; - }; - $col = ',' . implode(',', array_map($callback, $col)); - } - + /** + * Get the answers for the all response types. + * @param int $rid + * @return array + */ + private function response_select($rid) { // Response_bool (yes/no). - $values = \mod_questionnaire\response\boolean::response_select($rid, $col, $csvexport, $choicecodes, $choicetext); + $values = \mod_questionnaire\responsetype\boolean::response_select($rid); // Response_single (radio button or dropdown). - $values += \mod_questionnaire\response\single::response_select($rid, $col, $csvexport, $choicecodes, $choicetext); + $values += \mod_questionnaire\responsetype\single::response_select($rid); // Response_multiple. - $values += \mod_questionnaire\response\multiple::response_select($rid, $col, $csvexport, $choicecodes, $choicetext); + $values += \mod_questionnaire\responsetype\multiple::response_select($rid); // Response_rank. - $values += \mod_questionnaire\response\rank::response_select($rid, $col, $csvexport, $choicecodes, $choicetext); + $values += \mod_questionnaire\responsetype\rank::response_select($rid); // Response_text. - $values += \mod_questionnaire\response\text::response_select($rid, $col, $csvexport, $choicecodes, $choicetext); + $values += \mod_questionnaire\responsetype\text::response_select($rid); // Response_date. - $values += \mod_questionnaire\response\date::response_select($rid, $col, $csvexport, $choicecodes, $choicetext); + $values += \mod_questionnaire\responsetype\date::response_select($rid); return($values); } + /** + * Redirect to the appropriate finish page. + */ private function response_goto_thankyou() { global $CFG, $USER, $DB; @@ -2178,6 +2507,11 @@ private function response_goto_thankyou() { if (empty($thankhead)) { $thankhead = get_string('thank_head', 'questionnaire'); } + if ($this->progressbar && isset($this->questionsbysec) && count($this->questionsbysec) > 1) { + // Show 100% full progress bar on completion. + $this->page->add_to_page('progressbar', + $this->renderer->render_progress_bar(count($this->questionsbysec) + 1, $this->questionsbysec)); + } $this->page->add_to_page('title', $thankhead); $this->page->add_to_page('addinfo', format_text(file_rewrite_pluginfile_urls($thankbody, 'pluginfile.php', @@ -2190,20 +2524,22 @@ private function response_goto_thankyou() { $currentgroupid = 0; } if ($this->capabilities->readownresponses) { - $this->page->add_to_page('message', - (''. - get_string("continue").'')); + $url = new moodle_url('myreport.php', ['id' => $this->cm->id, 'instance' => $this->cm->instance, 'user' => $USER->id, + 'byresponse' => 0, 'action' => 'vresp']); + $this->page->add_to_page('continue', $this->renderer->single_button($url, get_string('continue'))); } else { - $this->page->add_to_page('message', - (''. - get_string("continue").'')); + $url = new moodle_url('/course/view.php', ['id' => $this->course->id]); + $this->page->add_to_page('continue', $this->renderer->single_button($url, get_string('continue'))); } return; } + /** + * Redirect to the provided url. + * @param string $url + */ private function response_goto_saved($url) { - global $CFG; + global $CFG, $USER; $resumesurvey = get_string('resumesurvey', 'questionnaire'); $savedprogress = get_string('savedprogress', 'questionnaire', ''.$resumesurvey.''); @@ -2212,11 +2548,33 @@ private function response_goto_saved($url) { $this->page->add_to_page('respondentinfo', $this->renderer->homelink($CFG->wwwroot.'/course/view.php?id='.$this->course->id, get_string("backto", "moodle", $this->course->fullname))); + + if ($this->resume) { + $message = $this->user_access_messages($USER->id, true); + if ($message === false) { + if ($this->user_can_take($USER->id)) { + if ($this->questions) { // Sanity check. + if ($this->user_has_saved_response($USER->id)) { + $this->page->add_to_page('respondentinfo', + $this->renderer->homelink($CFG->wwwroot . '/mod/questionnaire/complete.php?' . + 'id=' . $this->cm->id . '&resume=1', $resumesurvey)); + } + } + } + } + } return; } // Survey Results Methods. + /** + * Add the navigation to the responses page. + * @param int $currrid + * @param int $currentgroupid + * @param stdClass $cm + * @param bool $byresponse + */ public function survey_results_navbar_alpha($currrid, $currentgroupid, $cm, $byresponse) { global $CFG, $DB; @@ -2316,7 +2674,7 @@ public function survey_results_navbar_alpha($currrid, $currentgroupid, $cm, $byr $name = 'popup'; $link = new moodle_url($url); $action = new popup_action('click', $link, $name, $options); - $actionlink = $this->renderer->action_link($link, $linkname, $action, ['role' => 'link', 'title' => $title], + $actionlink = $this->renderer->action_link($link, $linkname, $action, ['title' => $title], new pix_icon('t/print', $title)); $navbar->printaction = $actionlink; $this->page->add_to_page('navigationbar', $this->renderer->navigationbar($navbar)); @@ -2358,6 +2716,7 @@ public function survey_results_navbar_alpha($currrid, $currentgroupid, $cm, $byr $respcols = new stdClass(); for ($i = 0; $i < $colnumber; $i++) { $colname = 'respondentscolumn'.$i; + $respcols->$colname = (object)['respondentlink' => []]; for ($j = 0; $j < $lines; $j++) { $respcols->{$colname}->respondentlink[] = $resparr[$a]; $a++; @@ -2374,7 +2733,15 @@ public function survey_results_navbar_alpha($currrid, $currentgroupid, $cm, $byr } } - // Display responses for current user (your responses). + /** + * Display responses for current user (your responses). + * @param int $currrid + * @param int $userid + * @param int $instance + * @param array $resps + * @param string $reporttype + * @param string $sid + */ public function survey_results_navbar_student($currrid, $userid, $instance, $resps, $reporttype='myreport', $sid='') { global $DB; $stranonymous = get_string('anonymous', 'questionnaire'); @@ -2438,33 +2805,21 @@ public function survey_results_navbar_student($currrid, $userid, $instance, $res $this->page->add_to_page('bottomnavigationbar', $this->renderer->usernavigationbar($navbar)); } - /* {{{ proto string survey_results(int surveyid, int precision, bool show_totals, int question_id, - * array choice_ids, int response_id) - Builds HTML for the results for the survey. If a - question id and choice id(s) are given, then the results - are only calculated for respodants who chose from the - choice ids for the given question id. - Returns empty string on sucess, else returns an error - string. */ - - public function survey_results($precision = 1, $showtotals = 1, $qid = '', $cids = '', $rid = '', - $uid=false, $currentgroupid='', $sort='') { + /** + * Builds HTML for the results for the survey. If a question id and choice id(s) are given, then the results are only calculated + * for respodants who chose from the choice ids for the given question id. Returns empty string on success, else returns an + * error string. + * @param string $rid + * @param bool $uid + * @param bool $pdf + * @param string $currentgroupid + * @param string $sort + * @return string|void + */ + public function survey_results($rid = '', $uid=false, $pdf = false, $currentgroupid='', $sort='') { global $SESSION, $DB; $SESSION->questionnaire->noresponses = false; - if (empty($precision)) { - $precision = 1; - } - if ($showtotals === '') { - $showtotals = 1; - } - - if (is_int($cids)) { - $cids = array($cids); - } - if (is_string($cids)) { - $cids = preg_split("/ /", $cids); // Turn space seperated list into array. - } // Build associative array holding whether each question // type has answer choices or not and the table the answers are in @@ -2537,9 +2892,9 @@ public function survey_results($precision = 1, $showtotals = 1, $qid = '', $cids $this->survey_results_navbar($rid); } - $this->page->add_to_page('title', clean_text($this->survey->title)); + $this->page->add_to_page('title', format_string($this->survey->title)); if ($this->survey->subtitle) { - $this->page->add_to_page('subtitle', clean_text($this->survey->subtitle)); + $this->page->add_to_page('subtitle', format_string($this->survey->subtitle)); } if ($this->survey->info) { $infotext = file_rewrite_pluginfile_urls($this->survey->info, 'pluginfile.php', @@ -2555,27 +2910,41 @@ public function survey_results($precision = 1, $showtotals = 1, $qid = '', $cids if ($question->type_id == QUESPAGEBREAK) { continue; } - $this->page->add_to_page('responses', $this->renderer->container_start('qn-container')); - if ($question->type_id != QUESSECTIONTEXT) { + if ($question->is_numbered()) { $qnum++; + } + if (!$pdf) { + $this->page->add_to_page('responses', $this->renderer->container_start('qn-container')); $this->page->add_to_page('responses', $this->renderer->container_start('qn-info')); - if ($question->type_id != QUESSECTIONTEXT) { + if ($question->is_numbered()) { $this->page->add_to_page('responses', $this->renderer->heading($qnum, 2, 'qn-number')); } $this->page->add_to_page('responses', $this->renderer->container_end()); // End qn-info. + $this->page->add_to_page('responses', $this->renderer->container_start('qn-content')); } - $this->page->add_to_page('responses', $this->renderer->container_start('qn-content')); // If question text is "empty", i.e. 2 non-breaking spaces were inserted, do not display any question text. if ($question->content == '
\n"; - $output .= $questionnaire->renderer->help_icon('downloadtextformat', 'questionnaire'); - $output .= ' ' . (get_string('downloadtextformat', 'questionnaire')) . ': ' . - get_string('responses', 'questionnaire').' '.$groupname; - $output .= $questionnaire->renderer->heading(get_string('textdownloadoptions', 'questionnaire')); + $output .= html_writer::tag('h2', (get_string('downloadtextformat', 'questionnaire')) + . ': ' . get_string('responses', 'questionnaire') . ' ' . + $groupname . $questionnaire->renderer->help_icon('downloadtextformat', 'questionnaire')); + $output .= $questionnaire->renderer->heading(get_string('textdownloadoptions', 'questionnaire'), 3); $output .= $questionnaire->renderer->box_start(); - $output .= "\n"; + $downloadparams = [ + 'instance' => $instance, + 'user' => $user, + 'sid' => $sid, + 'action' => 'dfs', + 'group' => $currentgroupid + ]; + $extrafields = $questionnaire->renderer->render_from_template('mod_questionnaire/extrafields', []); + $output .= $questionnaire->renderer->download_dataformat_selector(get_string('downloadtypes', 'questionnaire'), + 'report.php', 'downloadformat', $downloadparams, $extrafields); $output .= $questionnaire->renderer->box_end(); $questionnaire->page->add_to_page('respondentinfo', $output); @@ -471,35 +483,58 @@ exit(); break; - case 'dcsv': // Download responses data as text (cvs) format. + case 'dfs': require_capability('mod/questionnaire:downloadresponses', $context); - require_once($CFG->libdir.'/dataformatlib.php'); - // Use the questionnaire name as the file name. Clean it and change any non-filename characters to '_'. $name = clean_param($questionnaire->name, PARAM_FILE); $name = preg_replace("/[^A-Z0-9]+/i", "_", trim($name)); $choicecodes = optional_param('choicecodes', '0', PARAM_INT); - $choicetext = optional_param('choicetext', '0', PARAM_INT); - $showincompletes = optional_param('complete', '0', PARAM_INT); - $output = $questionnaire->generate_csv('', $user, $choicecodes, $choicetext, $currentgroupid, $showincompletes); - - // Use Moodle's core download function for outputting csv. - $rowheaders = array_shift($output); - download_as_dataformat($name, 'csv', $rowheaders, $output); + $choicetext = optional_param('choicetext', '0', PARAM_INT); + $showincompletes = optional_param('complete', '0', PARAM_INT); + $rankaverages = optional_param('rankaverages', '0', PARAM_INT); + $dataformat = optional_param('downloadformat', '', PARAM_ALPHA); + $emailroles = optional_param('emailroles', 0, PARAM_INT); + $emailextra = optional_param('emailextra', '', PARAM_RAW); + + $output = $questionnaire->generate_csv($currentgroupid, '', $user, $choicecodes, $choicetext, $showincompletes, + $rankaverages); + + $columns = $output[0]; + unset($output[0]); + + // Check if email report was selected. + $emailreport = optional_param('emailreport', '', PARAM_ALPHA); + if (empty($emailreport)) { + \core\dataformat::download_data($name, $dataformat, $columns, $output); + } else { + // Emailreport button selected. + if (get_config('questionnaire', 'allowemailreporting') && (!empty($emailroles) || !empty($emailextra))) { + require_once('savefileformat.php'); + $users = !empty($emailroles) ? $questionnaire->get_notifiable_users($USER->id) : []; + $otheremails = explode(',', $emailextra); + if (!empty($users) || !empty($otheremails)) { + $thisurl = new moodle_url('report.php', + ['instance' => $instance, 'action' => 'dwnpg', 'group' => $currentgroupid]); + save_as_dataformat($name, $dataformat, $columns, $output, $users, $otheremails, $thisurl); + } + } else { + redirect(new moodle_url('report.php', ['instance' => $instance, 'action' => 'dwnpg', 'group' => $currentgroupid]), + get_string('emailsnotspecified', 'questionnaire')); + } + } exit(); break; case 'vall': // View all responses. case 'vallasort': // View all responses sorted in ascending order. case 'vallarsort': // View all responses sorted in descending order. - $PAGE->set_title(get_string('questionnairereport', 'questionnaire')); $PAGE->set_heading(format_string($course->fullname)); - echo $questionnaire->renderer->header(); if (!$questionnaire->capabilities->readallresponses && !$questionnaire->capabilities->readallresponseanytime) { + echo $questionnaire->renderer->header(); // Should never happen, unless called directly by a snoop. - print_error('nopermissions', '', '', get_string('viewallresponses', 'questionnaire')); + throw new \moodle_exception('nopermissions', 'mod_questionnaire'); // Finish the page. echo $questionnaire->renderer->footer($course); break; @@ -516,7 +551,9 @@ default: $SESSION->questionnaire->current_tab = 'valldefault'; } - include('tabs.php'); + if ($outputtarget != 'print') { + include('tabs.php'); + } $respinfo = ''; $resps = array(); @@ -584,30 +621,72 @@ 'courseid' => $course->id, 'other' => array('action' => $action, 'instance' => $instance, 'groupid' => $currentgroupid) ); - $event = \mod_questionnaire\event\all_responses_viewed::create($params); - $event->trigger(); - $respinfo .= get_string('viewallresponses', 'questionnaire').'. '.$groupname.'. '; - $strsort = get_string('order_'.$sort, 'questionnaire'); - $respinfo .= $strsort; - $respinfo .= $questionnaire->renderer->help_icon('orderresponses', 'questionnaire'); - $questionnaire->page->add_to_page('respondentinfo', $respinfo); + if ($outputtarget == 'pdf') { + $pdf = questionnaire_report_start_pdf(); + if ($currentgroupid > 0) { + $groupname = get_string('group') . ': ' . groups_get_group_name($currentgroupid) . ''; + } else { + $groupname = '' . get_string('allparticipants') . ''; + } + $respinfo = get_string('viewallresponses', 'questionnaire') . '. ' . $groupname . '. '; + $strsort = get_string('order_' . $sort, 'questionnaire'); + $respinfo .= $strsort; + $questionnaire->page->add_to_page('respondentinfo', $respinfo); + $questionnaire->survey_results('', false, true, $currentgroupid, $sort); + $html = $questionnaire->renderer->render($questionnaire->page); + + // Supress any warnings. There is at least one error in the TCPF library at line 16749 where 'text-align' is + // not an array. + $errorreporting = error_reporting(0); + $pdf->writeHTML($html); + @$pdf->Output(clean_param($questionnaire->name, PARAM_FILE) . '.pdf', 'D'); + error_reporting($errorreporting); + + } else { // Default to HTML. + $event = \mod_questionnaire\event\all_responses_viewed::create($params); + $event->trigger(); - $ret = $questionnaire->survey_results(1, 1, '', '', '', false, $currentgroupid, $sort); + if ($outputtarget != 'print') { + $linkname = get_string('downloadpdf', 'mod_questionnaire'); + $link = new moodle_url('/mod/questionnaire/report.php', + ['action' => 'vall', 'instance' => $instance, 'group' => $currentgroupid, 'target' => 'pdf']); + $downpdficon = new pix_icon('f/pdf', $linkname); + $respinfo .= $questionnaire->renderer->action_link($link, null, null, null, $downpdficon); + + $linkname = get_string('print', 'mod_questionnaire'); + $link = new \moodle_url('/mod/questionnaire/report.php', + ['action' => 'vall', 'instance' => $instance, 'group' => $currentgroupid, 'target' => 'print']); + $htmlicon = new pix_icon('t/print', $linkname); + $options = ['menubar' => true, 'location' => false, 'scrollbars' => true, 'resizable' => true, + 'height' => 600, 'width' => 800, 'title' => $linkname]; + $name = 'popup'; + $action = new popup_action('click', $link, $name, $options); + $class = ''; + $respinfo .= $questionnaire->renderer->action_link($link, null, $action, + ['class' => $class, 'title' => $linkname], $htmlicon) . ' '; + + $respinfo .= get_string('viewallresponses', 'questionnaire') . '. ' . $groupname . '. '; + $strsort = get_string('order_' . $sort, 'questionnaire'); + $respinfo .= $strsort; + $respinfo .= $questionnaire->renderer->help_icon('orderresponses', 'questionnaire'); + $questionnaire->page->add_to_page('respondentinfo', $respinfo); + } - echo $questionnaire->renderer->render($questionnaire->page); + $ret = $questionnaire->survey_results('', false, false, $currentgroupid, $sort); - // Finish the page. - echo $questionnaire->renderer->footer($course); + echo $questionnaire->renderer->header(); + echo $questionnaire->renderer->render($questionnaire->page); + echo $questionnaire->renderer->footer($course); + } break; case 'vresp': // View by response. - default: if (empty($questionnaire->survey)) { - print_error('surveynotexists', 'questionnaire'); + throw new \moodle_exception('surveynotexists', 'mod_questionnaire'); } else if ($questionnaire->survey->courseid != $course->id) { - print_error('surveyowner', 'questionnaire'); + throw new \moodle_exception('surveyowner', 'mod_questionnaire'); } $ruser = false; $noresponses = false; @@ -674,28 +753,48 @@ $rid = $rids[0]; } - // Print the page header. - $PAGE->set_title(get_string('questionnairereport', 'questionnaire')); - $PAGE->set_heading(format_string($course->fullname)); - echo $questionnaire->renderer->header(); - - // Print the tabs. - if ($byresponse) { - $SESSION->questionnaire->current_tab = 'vrespsummary'; - } - if ($individualresponse) { - $SESSION->questionnaire->current_tab = 'individualresp'; - } - include('tabs.php'); - - // Print the main part of the page. - // TODO provide option to select how many columns and/or responses per page. - if ($noresponses) { $questionnaire->page->add_to_page('respondentinfo', - get_string('group').' '.groups_get_group_name($currentgroupid).': '. + get_string('group') . ' ' . groups_get_group_name($currentgroupid) . ': ' . get_string('noresponses', 'questionnaire')); - } else { + + } else if ($outputtarget == 'pdf') { + $pdf = questionnaire_report_start_pdf(); + if ($currentgroupid > 0) { + $groupname = get_string('group') . ': ' . groups_get_group_name($currentgroupid) . ''; + } else { + $groupname = '' . get_string('allparticipants') . ''; + } + if (!$byresponse) { // Show respondents individual responses. + $questionnaire->view_response($rid, '', $resps, true, true, false, $currentgroupid, $outputtarget); + } + $html = $questionnaire->renderer->render($questionnaire->page); + // Supress any warnings. There is at least one error in the TCPF library at line 16749 where 'text-align' is + // not an array. + $errorreporting = error_reporting(0); + $pdf->writeHTML($html); + @$pdf->Output(clean_param($questionnaire->name, PARAM_FILE), 'D'); + error_reporting($errorreporting); + + } else { // Default to HTML. + // Print the page header. + $PAGE->set_title(get_string('questionnairereport', 'questionnaire')); + $PAGE->set_heading(format_string($course->fullname)); + + // Print the tabs. + if ($byresponse) { + $SESSION->questionnaire->current_tab = 'vrespsummary'; + } + if ($individualresponse) { + $SESSION->questionnaire->current_tab = 'individualresp'; + } + if ($outputtarget == 'html') { + include('tabs.php'); + } + + // Print the main part of the page. + // TODO provide option to select how many columns and/or responses per page. + $groupname = get_string('group').': '.groups_get_group_name($currentgroupid).''; if ($currentgroupid == 0 ) { $groupname = get_string('allparticipants'); @@ -708,15 +807,47 @@ $respinfo .= $questionnaire->renderer->box_end(); $questionnaire->page->add_to_page('respondentinfo', $respinfo); } - $questionnaire->survey_results_navbar_alpha($rid, $currentgroupid, $cm, $byresponse); + if ($outputtarget == 'html') { + $questionnaire->survey_results_navbar_alpha($rid, $currentgroupid, $cm, $byresponse); + } if (!$byresponse) { // Show respondents individual responses. - $questionnaire->view_response($rid, '', false, $resps, true, true, false, $currentgroupid); + $questionnaire->view_response($rid, '', $resps, true, true, false, $currentgroupid, $outputtarget); } + echo $questionnaire->renderer->header(); + echo $questionnaire->renderer->render($questionnaire->page); + echo $questionnaire->renderer->footer($course); } - - echo $questionnaire->renderer->render($questionnaire->page); - - // Finish the page. - echo $questionnaire->renderer->footer($course); break; } + +/** + * Return a pdf object. + * @return pdf + */ +function questionnaire_report_start_pdf() { + global $CFG; + + require_once($CFG->libdir . '/pdflib.php'); + $pdf = new pdf(); + $pdf->SetCreator(PDF_CREATOR); + $pdf->SetAuthor('Moodle Questionnaire'); + $pdf->SetTitle('All responses'); + $pdf->setPrintHeader(false); + // Set default monospaced font. + $pdf->SetDefaultMonospacedFont(PDF_FONT_MONOSPACED); + + // Set margins. + $pdf->SetMargins(PDF_MARGIN_LEFT, PDF_MARGIN_TOP, PDF_MARGIN_RIGHT); + $pdf->SetHeaderMargin(PDF_MARGIN_HEADER); + $pdf->SetFooterMargin(PDF_MARGIN_FOOTER); + + // Set auto page breaks. + $pdf->SetAutoPageBreak(true, PDF_MARGIN_BOTTOM); + + // Set image scale factor. + $pdf->setImageScale(PDF_IMAGE_SCALE_RATIO); + // Set background color for headings. + $pdf->SetFillColor(238, 238, 238); + $pdf->AddPage('L'); + return $pdf; +} diff --git a/savefileformat.php b/savefileformat.php new file mode 100644 index 00000000..cb01d211 --- /dev/null +++ b/savefileformat.php @@ -0,0 +1,105 @@ +. + +/** + * savefileformat.php - Replaces dataformatlib.php to capture output into files. + * + * @package mod_questionnaire + * @copyright 2019 onward Mike Churchward (mike.churchward@poetopensource.org) + * @author Mike Churchward + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +/** + * Sends a formated data file to the browser and optionally a file. This is needed until the main data format API provides a way + * to ouput a file as well as stream to the browser. This file relies on capturing output buffers (ugly hack). + * + * @param string $filename The base filename without an extension + * @param string $dataformat A dataformat name + * @param array $columns An ordered map of column keys and labels + * @param Iterator $iterator An iterator over the records, usually a RecordSet + * @param array $users + * @param array $emails + * @param string $redirect + */ +function save_as_dataformat($filename, $dataformat, $columns, $iterator, $users = [], $emails = [], $redirect = '') { + global $CFG, $OUTPUT; + + $classname = 'dataformat_' . $dataformat . '\writer'; + if (!class_exists($classname)) { + throw new coding_exception("Unable to locate dataformat/$dataformat/classes/writer.php"); + } + $format = new $classname; + + // The data format export could take a while to generate... + set_time_limit(0); + + // Close the session so that the users other tabs in the same session are not blocked. + \core\session\manager::write_close(); + + $format->set_filename($filename); + // File creation for any data format is initiated by "send_http_headers()". This is required. But, this also will cause the + // browser to respond with a "save / open" dialogue. To get rid of the dialogue, immediately retract the headers with + // "header_remove()". + $format->send_http_headers(); + header_remove(); + + // Start capturing output to write to a file. + ob_start(); + // This exists to support all dataformats - see MDL-56046. + if (method_exists($format, 'write_header')) { + debugging('The function write_header() does not support multiple sheets. In order to support multiple sheets you ' . + 'must implement start_output() and start_sheet() and remove write_header() in your dataformat.', DEBUG_DEVELOPER); + $format->write_header($columns); + } else { + $format->start_output(); + $format->start_sheet($columns); + } + $c = 0; + foreach ($iterator as $row) { + if ($row === null) { + continue; + } + $format->write_record($row, $c++); + } + // This exists to support all dataformats - see MDL-56046. + if (method_exists($format, 'write_footer')) { + debugging('The function write_footer() does not support multiple sheets. In order to support multiple sheets you ' . + 'must implement close_sheet() and close_output() and remove write_footer() in your dataformat.', DEBUG_DEVELOPER); + $format->write_footer($columns); + } else { + $format->close_sheet($columns); + $format->close_output(); + $output = ob_get_contents(); + $ext = $format->get_extension(); + $filepath = make_temp_directory('mod_questionnaire') . '/' . $filename . $ext; + $fp = fopen($filepath, 'wb'); + fwrite($fp, $output); + fclose($fp); + $subjecttext = get_string('summaryreportattached', 'questionnaire'); + foreach ($users as $user) { + email_to_user($user, $CFG->noreplyaddress, $subjecttext, $subjecttext, '', $filepath, $filename.$ext); + } + foreach ($emails as $email) { + $email = trim($email); + $user = (object)['id' => -10, 'email' => $email, 'firstname' => $email, 'lastname' => $email, 'mailformat' => 1]; + email_to_user($user, $CFG->noreplyaddress, $subjecttext, $subjecttext, '', $filepath, $filename.$ext); + } + unlink($filepath); + } + ob_end_clean(); + echo $OUTPUT->redirect_message($redirect, get_string('emailssent', 'questionnaire'), 3, false); +} diff --git a/settings.php b/settings.php index fede9974..6a21c51d 100644 --- a/settings.php +++ b/settings.php @@ -17,9 +17,10 @@ /** * Setting page for questionaire module * - * @package mod - * @subpackage questionnaire + * @package mod_questionnaire * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @copyright 2016 onward Mike Churchward (mike.churchward@poetgroup.org) + * @author Mike Churchward */ defined('MOODLE_INTERNAL') || die; @@ -42,9 +43,13 @@ 'group' => get_string('group'), 'id' => get_string('id', 'questionnaire'), 'fullname' => get_string('fullname'), - 'username' => get_string('username') + 'username' => get_string('username'), + 'useridentityfields' => get_string('showuseridentity', 'admin') ); $settings->add(new admin_setting_configmultiselect('questionnaire/downloadoptions', get_string('textdownloadoptions', 'questionnaire'), '', array_keys($choices), $choices)); + + $settings->add(new admin_setting_configcheckbox('questionnaire/allowemailreporting', + get_string('configemailreporting', 'questionnaire'), get_string('configemailreportinglong', 'questionnaire'), 0)); } diff --git a/show_nonrespondents.php b/show_nonrespondents.php index ce51da6c..924fd98d 100644 --- a/show_nonrespondents.php +++ b/show_nonrespondents.php @@ -15,11 +15,11 @@ // along with Moodle. If not, see
'); // Begin div qn-container.
+ }
+
$mextra = array('value' => $question->id,
'alt' => $strmove,
'title' => $strmove);
@@ -241,7 +257,7 @@ public function definition() {
$manageqgroup[] =& $mform->createElement('image', 'editbutton['.$question->id.']', $esrc, $eextra);
$manageqgroup[] =& $mform->createElement('image', 'removebutton['.$question->id.']', $rsrc, $rextra);
- if ($tid != QUESPAGEBREAK && $tid != QUESSECTIONTEXT) {
+ if ($tid != QUESPAGEBREAK && $tid != QUESSECTIONTEXT && $tid != QUESSLIDER) {
if ($required == 'y') {
$reqsrc = $questionnaire->renderer->image_url('t/stop');
$strrequired = get_string('required', 'questionnaire');
@@ -315,12 +331,10 @@ public function definition() {
$mform->addElement('static', 'qdepend_' . $question->id, '', $dependencies);
}
- if ($tid != QUESPAGEBREAK) {
- if ($tid != QUESSECTIONTEXT) {
+ if ($question->is_numbered()) {
$qnumber = '';
- } else {
+ } else {
$qnumber = '';
- }
}
if ($this->moveq && $pos < $moveqposition) {
@@ -361,9 +375,14 @@ public function definition() {
$mform->addElement('html', '
');
}
+ /**
+ * Form validation.
+ * @param array $data
+ * @param array $files
+ * @return array
+ */
public function validation($data, $files) {
$errors = parent::validation($data, $files);
return $errors;
}
-
-}
\ No newline at end of file
+}
diff --git a/classes/response/date.php b/classes/response/date.php
deleted file mode 100644
index 45a8712a..00000000
--- a/classes/response/date.php
+++ /dev/null
@@ -1,204 +0,0 @@
-.
-
-/**
- * This file contains the parent class for questionnaire question types.
- *
- * @author Mike Churchward
- * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package questiontypes
- */
-
-namespace mod_questionnaire\response;
-defined('MOODLE_INTERNAL') || die();
-
-use mod_questionnaire\db\bulk_sql_config;
-
-/**
- * Class for date response types.
- *
- * @author Mike Churchward
- * @package responsetypes
- */
-
-class date extends base {
- static public function response_table() {
- return 'questionnaire_response_date';
- }
-
- public function insert_response($rid, $val) {
- global $DB;
- $checkdateresult = questionnaire_check_date($val);
- $thisdate = $val;
- if (substr($checkdateresult, 0, 5) == 'wrong') {
- return false;
- }
- // Now use ISO date formatting.
- $checkdateresult = questionnaire_check_date($thisdate, true);
- $record = new \stdClass();
- $record->response_id = $rid;
- $record->question_id = $this->question->id;
- $record->response = $checkdateresult;
- return $DB->insert_record(self::response_table(), $record);
- }
-
- public function get_results($rids=false, $anonymous=false) {
- global $DB;
-
- $rsql = '';
- $params = array($this->question->id);
- if (!empty($rids)) {
- list($rsql, $rparams) = $DB->get_in_or_equal($rids);
- $params = array_merge($params, $rparams);
- $rsql = ' AND response_id ' . $rsql;
- }
-
- $sql = 'SELECT id, response ' .
- 'FROM {'.self::response_table().'} ' .
- 'WHERE question_id= ? ' . $rsql;
-
- return $DB->get_records_sql($sql, $params);
- }
-
- /**
- * Provide a template for results screen if defined.
- * @return mixed The template string or false/
- */
- public function results_template() {
- return 'mod_questionnaire/results_date';
- }
-
- /**
- * @param bool $rids
- * @param string $sort
- * @param bool $anonymous
- * @return string
- * @throws \coding_exception
- */
- public function display_results($rids=false, $sort='', $anonymous=false) {
- $numresps = count($rids);
- if ($rows = $this->get_results($rids, $anonymous)) {
- $numrespondents = count($rows);
- foreach ($rows as $row) {
- // Count identical answers (case insensitive).
- $this->text = $row->response;
- if (!empty($this->text)) {
- $dateparts = preg_split('/-/', $this->text);
- $this->text = make_timestamp($dateparts[0], $dateparts[1], $dateparts[2]); // Unix timestamp.
- $textidx = clean_text($this->text);
- $this->counts[$textidx] = !empty($this->counts[$textidx]) ? ($this->counts[$textidx] + 1) : 1;
- }
- }
- $pagetags = $this->get_results_tags($this->counts, $numresps, $numrespondents);
- } else {
- $pagetags = new \stdClass();
- }
- return $pagetags;
- }
-
- /**
- * Override the results tags function for templates for questions with dates.
- *
- * @param $weights
- * @param $participants Number of questionnaire participants.
- * @param $respondents Number of question respondents.
- * @param $showtotals
- * @param string $sort
- * @return \stdClass
- * @throws \coding_exception
- */
- public function get_results_tags($weights, $participants, $respondents, $showtotals = 1, $sort = '') {
- $dateformat = get_string('strfdate', 'questionnaire');
-
- $pagetags = new \stdClass();
- if ($respondents == 0) {
- return $pagetags;
- }
-
- if (!empty($weights) && is_array($weights)) {
- $pagetags->responses = [];
- $numresps = 0;
- ksort ($weights); // Sort dates into chronological order.
- foreach ($weights as $content => $num) {
- $response = new \stdClass();
- $response->text = userdate($content, $dateformat, '', false); // Change timestamp into readable dates.
- $numresps += $num;
- $response->total = $num;
- $pagetags->responses[] = (object)['response' => $response];
- }
-
- if ($showtotals == 1) {
- $pagetags->total = new \stdClass();
- $pagetags->total->total = "$numresps/$participants";
- }
- }
-
- return $pagetags;
- }
-
- /**
- * Return an array of answers by question/choice for the given response. Must be implemented by the subclass.
- *
- * @param int $rid The response id.
- * @param null $col Other data columns to return.
- * @param bool $csvexport Using for CSV export.
- * @param int $choicecodes CSV choicecodes are required.
- * @param int $choicetext CSV choicetext is required.
- * @return array
- */
- static public function response_select($rid, $col = null, $csvexport = false, $choicecodes = 0, $choicetext = 1) {
- global $DB;
-
- $values = [];
- $sql = 'SELECT q.id '.$col.', a.response as aresponse '.
- 'FROM {'.self::response_table().'} a, {questionnaire_question} q '.
- 'WHERE a.response_id=? AND a.question_id=q.id ';
- $records = $DB->get_records_sql($sql, [$rid]);
- $dateformat = get_string('strfdate', 'questionnaire');
- foreach ($records as $qid => $row) {
- unset ($row->id);
- $row = (array)$row;
- $newrow = array();
- foreach ($row as $key => $val) {
- if (!is_numeric($key)) {
- $newrow[] = $val;
- // Convert date from yyyy-mm-dd database format to actual questionnaire dateformat.
- // does not work with dates prior to 1900 under Windows.
- if (preg_match('/\d\d\d\d-\d\d-\d\d/', $val)) {
- $dateparts = preg_split('/-/', $val);
- $val = make_timestamp($dateparts[0], $dateparts[1], $dateparts[2]); // Unix timestamp.
- $val = userdate ( $val, $dateformat);
- $newrow[] = $val;
- }
- }
- }
- $values["$qid"] = $newrow;
- $val = array_pop($values["$qid"]);
- array_push($values["$qid"], '', '', $val);
- }
-
- return $values;
- }
-
- /**
- * Configure bulk sql
- * @return bulk_sql_config
- */
- protected function bulk_sql_config() {
- return new bulk_sql_config(self::response_table(), 'qrd', false, true, false);
- }
-}
-
diff --git a/classes/response/display_support.php b/classes/response/display_support.php
deleted file mode 100644
index 83dd0b9c..00000000
--- a/classes/response/display_support.php
+++ /dev/null
@@ -1,426 +0,0 @@
-.
-
-/**
- * This file contains the parent class for questionnaire question types.
- *
- * @author Mike Churchward
- * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package questiontypes
- */
-
-namespace mod_questionnaire\response;
-defined('MOODLE_INTERNAL') || die();
-use \html_writer;
-use \html_table;
-
-/**
- * Class for response display support.
- *
- * @author Mike Churchward
- * @package display_support
- */
-
-class display_support {
-
- /* {{{ proto void mkresavg(array weights, int total, int precision, bool show_totals)
- Builds HTML showing AVG results. */
-
- public static function mkresavg($counts, $total, $choices, $precision, $showtotals, $length, $sort, $stravgvalue='') {
- global $CFG;
- $stravgrank = get_string('averagerank', 'questionnaire');
- $osgood = false;
- if ($precision == 3) { // Osgood's semantic differential.
- $osgood = true;
- $stravgrank = get_string('averageposition', 'questionnaire');
- }
- $stravg = ''.$qnum.'
'.$stravgrank.$stravgvalue.'
';
-
- $isna = $precision == 1;
- $isnahead = '';
- $nbchoices = count ($counts);
- $isrestricted = ($length < $nbchoices) && $precision == 2;
-
- if ($isna) {
- $isnahead = get_string('notapplicable', 'questionnaire');
- }
- $table = new html_table();
-
- $table->align = array('', '', 'center', 'right');
- $table->width = ' 99%';
- if ($isna) {
- $table->head = array('', $stravg, '⇓', $isnahead);
- } else {
- if ($osgood) {
- $stravg = ''.$stravgrank.'
';
- $table->head = array('', $stravg, '');
- } else {
- $table->head = array('', $stravg, '⇓');
- }
- }
- // TODO JR please calculate the correct width of the question text column (col #1).
- $rightcolwidth = '5%';
- $table->size = array('60%', '*', $rightcolwidth);
- if ($isna) {
- $table->size = array('55%', '*', $rightcolwidth, $rightcolwidth);
- }
- if ($osgood) {
- $table->size = array('25%', '50%', '25%');
- }
-
- $imageurl = $CFG->wwwroot.'/mod/questionnaire/images/';
- $llength = $length;
- if (!$llength) {
- $llength = 5;
- }
- // Add an extra column to accomodate lower ranks in this case.
- $llength += $isrestricted;
- $width = 100 / $llength;
- $n = array();
- $nameddegrees = 0;
- foreach ($choices as $choice) {
- // To take into account languages filter.
- $content = (format_text($choice->content, FORMAT_HTML, ['noclean' => true]));
- if (preg_match("/^[0-9]{1,3}=/", $content, $ndd)) {
- $n[$nameddegrees] = substr($content, strlen($ndd[0]));
- $nameddegrees++;
- }
- }
- $nbchoices = $length;
- for ($j = 0; $j < $length; $j++) {
- if (isset($n[$j])) {
- $str = $n[$j];
- } else {
- $str = $j + 1;
- }
- }
- $out = '| '.$str.' | '; - } - $out .= '
';
- } else {
- $out .= '';
- }
- } else {
- $out = '';
- }
-
- if ($osgood) {
- // Ensure there are two bits of content.
- list($content, $contentright) = array_merge(preg_split('/[|]/', $content), array(' '));
- } else {
- $contents = questionnaire_choice_values($content);
- if ($contents->modname) {
- $content = $contents->text;
- }
- }
- if ($osgood) {
- $table->data[] = array(''.
- format_text($content, FORMAT_HTML, ['noclean' => true]).'
', $out,
- ''.format_text($contentright, FORMAT_HTML, ['noclean' => true]).'
');
- // JR JUNE 2012 do not display meaningless average rank values for Osgood.
- } else {
- if ($avg) {
- $stravgval = '';
- if ($stravgvalue) {
- $stravgval = '('.sprintf('%.1f', $avgvalue).')';
- }
- if ($isna) {
- $table->data[] = [format_text($content, FORMAT_HTML, ['noclean' => true]), $out,
- sprintf('%.1f', $avg).' '.$stravgval, $nbna];
- } else {
- $table->data[] = [format_text($content, FORMAT_HTML, ['noclean' => true]), $out,
- sprintf('%.1f', $avg).' '.$stravgval];
- }
- } else if ($nbna != 0) {
- $table->data[] = array(format_text($content, FORMAT_HTML, ['noclean' => true]), $out, '', $nbna);
- }
- }
- } // End if named degrees.
- } // End foreach.
- } else {
- $table->data[] = array('', get_string('noresponsedata', 'questionnaire'));
- }
- return html_writer::table($table);
- }
-
- public static function mkrescount($counts, $rids, $rows, $question, $precision, $length, $sort) {
- // Display number of responses to Rate questions - see http://moodle.org/mod/forum/discuss.php?d=185106.
- global $DB;
- $nbresponses = count($rids);
- // Prepare data to be displayed.
- $isrestricted = ($length < count($question->choices)) && $precision == 2;
-
- $rsql = '';
- if (!empty($rids)) {
- list($rsql, $params) = $DB->get_in_or_equal($rids);
- $rsql = ' AND response_id ' . $rsql;
- }
-
- array_unshift($params, $question->id); // This is question_id.
- $sql = 'SELECT r.id, c.content, r.rankvalue, c.id AS choiceid ' .
- 'FROM {questionnaire_quest_choice} c , ' .
- '{questionnaire_response_rank} r ' .
- 'WHERE c.question_id = ?' .
- ' AND r.question_id = c.question_id' .
- ' AND r.choice_id = c.id ' .
- $rsql .
- ' ORDER BY choiceid, rankvalue ASC';
- $choices = $DB->get_records_sql($sql, $params);
-
- // Sort rows (results) by average value.
- if ($sort != 'default') {
- $sortarray = array();
- foreach ($rows as $row) {
- foreach ($row as $key => $value) {
- if (!isset($sortarray[$key])) {
- $sortarray[$key] = array();
- }
- $sortarray[$key][] = $value;
- }
- }
- $orderby = "average";
- switch ($sort) {
- case 'ascending':
- array_multisort($sortarray[$orderby], SORT_ASC, $rows);
- break;
- case 'descending':
- array_multisort($sortarray[$orderby], SORT_DESC, $rows);
- break;
- }
- }
- $nbranks = $length;
- $ranks = array();
- foreach ($rows as $row) {
- $choiceid = $row->id;
- foreach ($choices as $choice) {
- if ($choice->choiceid == $choiceid) {
- $n = 0;
- for ($i = 0; $i < $nbranks; $i++) {
- if ($choice->rankvalue == $i) {
- $n++;
- if (!isset($ranks[$choice->content][$i])) {
- $ranks[$choice->content][$i] = 0;
- }
- $ranks[$choice->content][$i] += $n;
- }
- }
- }
- }
- }
-
- // Psettings for display.
- $strtotal = ''.get_string('total', 'questionnaire').'';
- $isna = $precision == 1;
- $isnahead = '';
- $osgood = false;
- if ($precision == 3) { // Osgood's semantic differential.
- $osgood = true;
- }
- if ($isna) {
- $isnahead = get_string('notapplicable', 'questionnaire').'(#)'; - } - if ($precision == 1) { - $na = get_string('notapplicable', 'questionnaire'); - } else { - $na = ''; - } - $nameddegrees = 0; - $n = array(); - foreach ($question->choices as $choice) { - $content = $choice->content; - // Check for number from 1 to 3 digits, followed by the equal sign = (to accomodate named degrees). - if (preg_match("/^([0-9]{1,3})=(.*)$/", $content, $ndd)) { - $n[$nameddegrees] = format_text($ndd[2], FORMAT_HTML, ['noclean' => true]); - $nameddegrees++; - } else { - $contents = questionnaire_choice_values($content); - if ($contents->modname) { - $choice->content = $contents->text; - } - } - } - - $headings = array(''.get_string('responses', 'questionnaire').''); - if ($osgood) { - $align = array('right'); - } else { - $align = array('left'); - } - - // Display the column titles. - for ($j = 0; $j < $length; $j++) { - if (isset($n[$j])) { - $str = $n[$j]; - } else { - $str = $j + 1; - } - array_push($headings, ''.$str.''); - array_push($align, 'center'); - } - if ($osgood) { - array_push($headings, ''); - array_push($align, 'left'); - } - array_push($headings, $strtotal); - if ($isrestricted) { - array_push($headings, get_string('notapplicable', 'questionnaire')); - array_push($align, 'center'); - } - array_push($align, 'center'); - if ($na) { - array_push($headings, $na); - array_push($align, 'center'); - } - - $table = new html_table(); - $table->head = $headings; - $table->align = $align; - $table->attributes['class'] = 'generaltable'; - // Now display the responses. - foreach ($ranks as $content => $rank) { - $data = array(); - // Eliminate potential named degrees on Likert scale. - if (!preg_match("/^[0-9]{1,3}=/", $content)) { - // First display the list of degrees (named or un-named) - // number of NOT AVAILABLE responses for this possible answer. - $nbna = $counts[$content]->nbna; - // TOTAL number of responses for this possible answer. - $total = $counts[$content]->num; - $nbresp = ''.$total.''; - if ($osgood) { - // Ensure there are two bits of content. - list($content, $contentright) = array_merge(preg_split('/[|]/', $content), array(' ')); - $data[] = format_text($content, FORMAT_HTML, ['noclean' => true]); - } else { - // Eliminate potentially short-named choices. - $contents = questionnaire_choice_values($content); - if ($contents->modname) { - $content = $contents->text; - } - $data[] = format_text($content, FORMAT_HTML, ['noclean' => true]); - } - // Display ranks/rates numbers. - $maxrank = max($rank); - for ($i = 0; $i <= $length - 1; $i++) { - $percent = ''; - if (isset($rank[$i])) { - $str = $rank[$i]; - if ($total !== 0 && $str !== 0) { - $percent = ' ('.number_format(($str * 100) / $total).'%)'; - } - // Emphasize responses with max rank value. - if ($str == $maxrank) { - $str = ''.$str.''; - } - } else { - $str = 0; - } - $data[] = $str.$percent; - } - if ($osgood) { - $data[] = format_text($contentright, FORMAT_HTML, ['noclean' => true]); - } - $data[] = $nbresp; - if ($isrestricted) { - $data[] = $nbresponses - $total; - } - if (!$osgood) { - if ($na) { - $data[] = $nbna; - } - } - } // End named degrees. - $table->data[] = $data; - } - return html_writer::table($table); - } - - /** - * Sorting functions for ascending and descending. - * - */ - static private function sortavgasc($a, $b) { - if (isset($a->avg) && isset($b->avg)) { - if ( $a->avg < $b->avg ) { - return -1; - } else if ($a->avg > $b->avg ) { - return 1; - } else { - return 0; - } - } - } - - static private function sortavgdesc($a, $b) { - if (isset($a->avg) && isset($b->avg)) { - if ( $a->avg > $b->avg ) { - return -1; - } else if ($a->avg < $b->avg) { - return 1; - } else { - return 0; - } - } - } -} diff --git a/classes/response/multiple.php b/classes/response/multiple.php deleted file mode 100644 index 0d338acd..00000000 --- a/classes/response/multiple.php +++ /dev/null @@ -1,332 +0,0 @@ -. - -/** - * This file contains the parent class for questionnaire question types. - * - * @author Mike Churchward - * @license http://www.gnu.org/copyleft/gpl.html GNU Public License - * @package questiontypes - */ - -namespace mod_questionnaire\response; -defined('MOODLE_INTERNAL') || die(); - -use mod_questionnaire\db\bulk_sql_config; - -/** - * Class for multiple response types. - * - * @author Mike Churchward - * @package responsetypes - */ - -class multiple extends single { - /** - * The only differences between multuple and single responses are the - * response table and the insert logic. - */ - static public function response_table() { - return 'questionnaire_resp_multiple'; - } - - public function insert_response($rid, $val) { - global $DB; - $resid = ''; - foreach ($this->question->choices as $cid => $choice) { - if (strpos($choice->content, '!other') === 0) { - $other = optional_param('q'.$this->question->id.'_'.$cid, '', PARAM_CLEAN); - if (empty($other)) { - continue; - } - if (!isset($val) || !is_array($val)) { - $val = array($cid); - } else { - array_push($val, $cid); - } - if (preg_match("/[^ \t\n]/", $other)) { - $record = new \stdClass(); - $record->response_id = $rid; - $record->question_id = $this->question->id; - $record->choice_id = $cid; - $record->response = $other; - $resid = $DB->insert_record('questionnaire_response_other', $record); - } - } - } - - if (!isset($val) || !is_array($val)) { - return false; - } - - foreach ($val as $cid) { - $cid = clean_param($cid, PARAM_CLEAN); - if ($cid != 0) { // Do not save response if choice is empty. - if (preg_match("/other_q[0-9]+/", $cid)) { - continue; - } - $record = new \stdClass(); - $record->response_id = $rid; - $record->question_id = $this->question->id; - $record->choice_id = $cid; - $resid = $DB->insert_record(self::response_table(), $record); - } - } - return $resid; - } - - /** - * Return an array of answers by question/choice for the given response. Must be implemented by the subclass. - * - * @param int $rid The response id. - * @param null $col Other data columns to return. - * @param bool $csvexport Using for CSV export. - * @param int $choicecodes CSV choicecodes are required. - * @param int $choicetext CSV choicetext is required. - * @return array - */ - static public function response_select($rid, $col = null, $csvexport = false, $choicecodes = 0, $choicetext = 1) { - global $DB; - - $stringother = get_string('other', 'questionnaire'); - $values = []; - $sql = 'SELECT a.id as aid, q.id as qid '.$col.',c.content as ccontent,c.id as cid '. - 'FROM {'.self::response_table().'} a, {questionnaire_question} q, {questionnaire_quest_choice} c '. - 'WHERE a.response_id = ? AND a.question_id=q.id AND a.choice_id=c.id '. - 'ORDER BY a.id,a.question_id,c.id'; - $records = $DB->get_records_sql($sql, [$rid]); - if ($csvexport) { - $tmp = null; - if (!empty($records)) { - $qids2 = array(); - $oldqid = ''; - foreach ($records as $qid => $row) { - if ($row->qid != $oldqid) { - $qids2[] = $row->qid; - $oldqid = $row->qid; - } - } - list($qsql, $params) = $DB->get_in_or_equal($qids2); - $sql = 'SELECT * FROM {questionnaire_quest_choice} WHERE question_id ' . $qsql . ' ORDER BY id'; - $records2 = $DB->get_records_sql($sql, $params); - foreach ($records2 as $qid => $row2) { - $selected = '0'; - $qid2 = $row2->question_id; - $cid2 = $row2->id; - $c2 = $row2->content; - $otherend = false; - if ($c2 == '!other') { - $c2 = '!other='.get_string('other', 'questionnaire'); - } - if (preg_match('/^!other/', $c2)) { - $otherend = true; - } else { - $contents = questionnaire_choice_values($c2); - if ($contents->modname) { - $c2 = $contents->modname; - } else if ($contents->title) { - $c2 = $contents->title; - } - } - $sql = 'SELECT a.name as name, a.type_id as q_type, a.position as pos ' . - 'FROM {questionnaire_question} a WHERE id = ?'; - $currentquestion = $DB->get_records_sql($sql, [$qid2]); - foreach ($currentquestion as $question) { - $name1 = $question->name; - $type1 = $question->q_type; - } - $newrow = []; - foreach ($records as $qid => $row1) { - $qid1 = $row1->qid; - $cid1 = $row1->cid; - // If available choice has been selected by student. - if ($qid1 == $qid2 && $cid1 == $cid2) { - $selected = '1'; - } - } - if ($otherend) { - $newrow2 = array(); - $newrow2[] = $question->pos; - $newrow2[] = $type1; - $newrow2[] = $name1; - $newrow2[] = '['.get_string('other', 'questionnaire').']'; - $newrow2[] = $selected; - $tmp2 = $qid2.'_other'; - $values["$tmp2"] = $newrow2; - } - $newrow[] = $question->pos; - $newrow[] = $type1; - $newrow[] = $name1; - $newrow[] = $c2; - $newrow[] = $selected; - $tmp = $qid2.'_'.$cid2; - $values["$tmp"] = $newrow; - } - } - unset($tmp); - unset($row); - - } else { - $arr = []; - $tmp = null; - foreach ($records as $row) { - $qid = $row->qid; - $cid = $row->cid; - unset($row->aid); - unset($row->qid); - unset($row->cid); - $arow = get_object_vars($row); - $newrow = []; - foreach ($arow as $key => $val) { - if (!is_numeric($key)) { - $newrow[] = $val; - } - } - if (preg_match('/^!other/', $row->ccontent)) { - $newrow[] = 'other_' . $cid; - } else { - $newrow[] = (int)$cid; - } - if ($tmp == $qid) { - $arr[] = $newrow; - continue; - } - if ($tmp != null) { - $values["$tmp"] = $arr; - } - $tmp = $qid; - $arr = array($newrow); - } - if ($tmp != null) { - $values["$tmp"] = $arr; - } - unset($arr); - unset($tmp); - unset($row); - } - - // Response_other. - // This will work even for multiple !other fields within one question - // AND for identical !other responses in different questions JR. - $sql = 'SELECT c.id as cid, c.content as content, a.response as aresponse, q.id as qid, q.position as position, - q.type_id as type_id, q.name as name '. - 'FROM {questionnaire_response_other} a, {questionnaire_question} q, {questionnaire_quest_choice} c '. - 'WHERE a.response_id= ? AND a.question_id=q.id AND a.choice_id=c.id '. - 'ORDER BY a.question_id,c.id '; - $records = $DB->get_records_sql($sql, [$rid]); - foreach ($records as $record) { - $newrow = []; - $position = $record->position; - $typeid = $record->type_id; - $name = $record->name; - $cid = $record->cid; - $qid = $record->qid; - $content = $record->content; - - // The !other modality with no label. - if ($content == '!other') { - $content = '!other='.$stringother; - } - $content = substr($content, 7); - $aresponse = $record->aresponse; - // The first two empty values are needed for compatibility with "normal" (non !other) responses. - // They are only needed for the CSV export, in fact. - $newrow[] = $position; - $newrow[] = $typeid; - $newrow[] = $name; - $content = $stringother; - $newrow[] = $content; - $newrow[] = $aresponse; - $values["${qid}_${cid}"] = $newrow; - } - - return $values; - } - - /** - * Return sql and params for getting responses in bulk. - * @author Guy Thomas - * @param int|array $questionnaireids One id, or an array of ids. - * @param bool|int $responseid - * @param bool|int $userid - * @return array - */ - public function get_bulk_sql($questionnaireids, $responseid = false, $userid = false, $groupid = false, $showincompletes = 0) { - global $DB; - - $sql = $this->bulk_sql(); - - if (($groupid !== false) && ($groupid > 0)) { - $groupsql = ' INNER JOIN {groups_members} gm ON gm.groupid = ? AND gm.userid = qr.userid '; - $gparams = [$groupid]; - } else { - $groupsql = ''; - $gparams = []; - } - - if (is_array($questionnaireids)) { - list($qsql, $params) = $DB->get_in_or_equal($questionnaireids); - } else { - $qsql = ' = ? '; - $params = [$questionnaireids]; - } - if ($showincompletes == 1) { - $showcompleteonly = ''; - } else { - $showcompleteonly = 'AND qr.complete = ? '; - $params[] = 'y'; - } - - $sql .= " - AND qr.questionnaireid $qsql $showcompleteonly - LEFT JOIN {questionnaire_response_other} qro ON qro.response_id = qr.id AND qro.choice_id = qrm.choice_id - LEFT JOIN {user} u ON u.id = qr.userid - $groupsql - "; - $params = array_merge($params, $gparams); - - if ($responseid) { - $sql .= " WHERE qr.id = ?"; - $params[] = $responseid; - } else if ($userid) { - $sql .= " WHERE qr.userid = ?"; - $params[] = $userid; - } - return [$sql, $params]; - } - - /** - * Return sql for getting responses in bulk. - * @author Guy Thomas - * @return string - */ - protected function bulk_sql() { - global $DB; - - $userfields = $this->user_fields_sql(); - $alias = 'qrm'; - $extraselect = ''; - $extraselect .= 'qrm.choice_id, ' . $DB->sql_order_by_text('qro.response', 1000) . ' AS response, 0 AS rankvalue'; - - return " - SELECT " . $DB->sql_concat_join("'_'", ['qr.id', "'".$this->question->helpname()."'", $alias.'.id']) . " AS id, - qr.submitted, qr.complete, qr.grade, qr.userid, $userfields, qr.id AS rid, $alias.question_id, - $extraselect - FROM {questionnaire_response} qr - JOIN {".self::response_table()."} $alias ON $alias.response_id = qr.id - "; - } -} diff --git a/classes/response/rank.php b/classes/response/rank.php deleted file mode 100644 index afa3fe3d..00000000 --- a/classes/response/rank.php +++ /dev/null @@ -1,364 +0,0 @@ -. - -/** - * This file contains the parent class for questionnaire question types. - * - * @author Mike Churchward - * @license http://www.gnu.org/copyleft/gpl.html GNU Public License - * @package questiontypes - */ - -namespace mod_questionnaire\response; -defined('MOODLE_INTERNAL') || die(); - -use mod_questionnaire\db\bulk_sql_config; - -/** - * Class for rank responses. - * - * @author Mike Churchward - * @package responsetypes - */ - -class rank extends base { - static public function response_table() { - return 'questionnaire_response_rank'; - } - - /** - * @param int $rid - * @param mixed $val - * @return bool|int - */ - public function insert_response($rid, $val) { - global $DB; - if ($this->question->type_id == QUESRATE) { - $resid = false; - foreach ($this->question->choices as $cid => $choice) { - $other = optional_param('q'.$this->question->id.'_'.$cid, null, PARAM_CLEAN); - // Choice not set or not answered. - if (!isset($other) || $other == '') { - continue; - } - if ($other == get_string('notapplicable', 'questionnaire')) { - $rank = -1; - } else { - $rank = intval($other); - } - $record = new \stdClass(); - $record->response_id = $rid; - $record->question_id = $this->question->id; - $record->choice_id = $cid; - $record->rankvalue = $rank; - $resid = $DB->insert_record(self::response_table(), $record); - } - return $resid; - } else { // THIS SHOULD NEVER HAPPEN. - if ($val == get_string('notapplicable', 'questionnaire')) { - $rank = -1; - } else { - $rank = intval($val); - } - $record = new \stdClass(); - $record->response_id = $rid; - $record->question_id = $this->question->id; - $record->rankvalue = $rank; - return $DB->insert_record(self::response_table(), $record); - } - } - - /** - * @param bool $rids - * @param bool $anonymous - * @return array - */ - public function get_results($rids=false, $anonymous=false) { - global $DB; - - $rsql = ''; - if (!empty($rids)) { - list($rsql, $params) = $DB->get_in_or_equal($rids); - $rsql = ' AND response_id ' . $rsql; - } - - if ($this->question->type_id == QUESRATE) { - // JR there can't be an !other field in rating questions ??? - $rankvalue = array(); - $select = 'question_id=' . $this->question->id . ' AND content NOT LIKE \'!other%\' ORDER BY id ASC'; - if ($rows = $DB->get_records_select('questionnaire_quest_choice', $select)) { - foreach ($rows as $row) { - $this->counts[$row->content] = new \stdClass(); - $nbna = $DB->count_records(self::response_table(), array('question_id' => $this->question->id, - 'choice_id' => $row->id, 'rankvalue' => '-1')); - $this->counts[$row->content]->nbna = $nbna; - // The $row->value may be null (i.e. empty) or have a 'NULL' value. - if ($row->value !== null && $row->value !== 'NULL') { - $rankvalue[] = $row->value; - } - } - } - - $isrestricted = ($this->question->length < count($this->question->choices)) && $this->question->precise == 2; - // Usual case. - if (!$isrestricted) { - if (!empty ($rankvalue)) { - $sql = "SELECT r.id, c.content, r.rankvalue, c.id AS choiceid - FROM {questionnaire_quest_choice} c, {".self::response_table()."} r - WHERE r.choice_id = c.id - AND c.question_id = " . $this->question->id . " - AND r.rankvalue >= 0{$rsql} - ORDER BY choiceid"; - $results = $DB->get_records_sql($sql, $params); - $value = array(); - foreach ($results as $result) { - if (isset ($value[$result->choiceid])) { - $value[$result->choiceid] += $rankvalue[$result->rankvalue]; - } else { - $value[$result->choiceid] = $rankvalue[$result->rankvalue]; - } - } - } - - $sql = "SELECT c.id, c.content, a.average, a.num - FROM {questionnaire_quest_choice} c - INNER JOIN - (SELECT c2.id, AVG(a2.rankvalue+1) AS average, COUNT(a2.response_id) AS num - FROM {questionnaire_quest_choice} c2, {".self::response_table()."} a2 - WHERE c2.question_id = ? AND a2.question_id = ? AND a2.choice_id = c2.id AND a2.rankvalue >= 0{$rsql} - GROUP BY c2.id) a ON a.id = c.id - order by c.id"; - $results = $DB->get_records_sql($sql, array_merge(array($this->question->id, $this->question->id), $params)); - if (!empty ($rankvalue)) { - foreach ($results as $key => $result) { - $result->averagevalue = $value[$key] / $result->num; - } - } - // Reindex by 'content'. Can't do this from the query as it won't work with MS-SQL. - foreach ($results as $key => $result) { - $results[$result->content] = $result; - unset($results[$key]); - } - return $results; - // Case where scaleitems is less than possible choices. - } else { - $sql = "SELECT c.id, c.content, a.sum, a.num - FROM {questionnaire_quest_choice} c - INNER JOIN - (SELECT c2.id, SUM(a2.rankvalue+1) AS sum, COUNT(a2.response_id) AS num - FROM {questionnaire_quest_choice} c2, {".self::response_table()."} a2 - WHERE c2.question_id = ? AND a2.question_id = ? AND a2.choice_id = c2.id AND a2.rankvalue >= 0{$rsql} - GROUP BY c2.id) a ON a.id = c.id"; - $results = $DB->get_records_sql($sql, array_merge(array($this->question->id, $this->question->id), $params)); - // Formula to calculate the best ranking order. - $nbresponses = count($rids); - foreach ($results as $key => $result) { - $result->average = ($result->sum + ($nbresponses - $result->num) * ($this->length + 1)) / $nbresponses; - $results[$result->content] = $result; - unset($results[$key]); - } - return $results; - } - } else { - $sql = 'SELECT A.rankvalue, COUNT(A.response_id) AS num ' . - 'FROM {'.self::response_table().'} A ' . - 'WHERE A.question_id= ? ' . $rsql . ' ' . - 'GROUP BY A.rankvalue'; - return $DB->get_records_sql($sql, array_merge(array($this->question->id), $params)); - } - } - - /** - * Provide the feedback scores for all requested response id's. This should be provided only by questions that provide feedback. - * @param array $rids - * @return array | boolean - */ - public function get_feedback_scores(array $rids) { - global $DB; - - $rsql = ''; - $params = [$this->question->id]; - if (!empty($rids)) { - list($rsql, $rparams) = $DB->get_in_or_equal($rids); - $params = array_merge($params, $rparams); - $rsql = ' AND response_id ' . $rsql; - } - $params[] = 'y'; - - $sql = 'SELECT r.id, r.response_id as rid, r.question_id AS qid, r.choice_id AS cid, r.rankvalue ' . - 'FROM {'.$this->response_table().'} r ' . - 'INNER JOIN {questionnaire_quest_choice} c ON r.choice_id = c.id ' . - 'WHERE r.question_id= ? ' . $rsql . ' ' . - 'ORDER BY rid,cid ASC'; - $responses = $DB->get_recordset_sql($sql, $params); - - $sql = 'SELECT id, value ' . - 'FROM {questionnaire_quest_choice} ' . - 'WHERE question_id = ? AND value IS NOT NULL ' . - 'ORDER BY id ASC '; - $scorerecs = $DB->get_records_sql($sql, $params); - - // Reindex $scores as a zero starting array. - $scores = []; - foreach ($scorerecs as $scorerec) { - $scores[] = $scorerec->value; - } - - $rid = 0; - $feedbackscores = []; - foreach ($responses as $response) { - if ($rid != $response->rid) { - $rid = $response->rid; - $feedbackscores[$rid] = new \stdClass(); - $feedbackscores[$rid]->rid = $rid; - $feedbackscores[$rid]->score = 0; - } - $feedbackscores[$rid]->score += isset($scores[$response->rankvalue]) ? $scores[$response->rankvalue] : 0; - } - - return (!empty($feedbackscores) ? $feedbackscores : false); - } - - /** - * @param bool $rids - * @param string $sort - * @param bool $anonymous - * @return string - */ - public function display_results($rids=false, $sort='', $anonymous=false) { - $output = ''; - - if (is_array($rids)) { - $prtotal = 1; - } else if (is_int($rids)) { - $prtotal = 0; - } - - if ($rows = $this->get_results($rids, $sort, $anonymous)) { - $stravgvalue = ''; // For printing table heading. - foreach ($this->counts as $key => $value) { - $ccontent = $key; - $avgvalue = ''; - if (array_key_exists($ccontent, $rows)) { - $avg = $rows[$ccontent]->average; - $this->counts[$ccontent]->num = $rows[$ccontent]->num; - if (isset($rows[$ccontent]->averagevalue)) { - $avgvalue = $rows[$ccontent]->averagevalue; - $osgood = false; - if ($this->question->precise == 3) { // Osgood's semantic differential. - $osgood = true; - } - if ($stravgvalue == '' && !$osgood) { - $stravgvalue = ' ('.get_string('andaveragevalues', 'questionnaire').')'; - } - } else { - $avgvalue = null; - } - } else { - $avg = 0; - } - $this->counts[$ccontent]->avg = $avg; - $this->counts[$ccontent]->avgvalue = $avgvalue; - } - $output .= \mod_questionnaire\response\display_support::mkresavg($this->counts, count($rids), $this->question->choices, - $this->question->precise, $prtotal, $this->question->length, $sort, $stravgvalue); - - $output .= \mod_questionnaire\response\display_support::mkrescount($this->counts, $rids, $rows, $this->question, - $this->question->precise, $this->question->length, $sort); - } else { - $output .= '
'.get_string('noresponsedata', 'questionnaire').'
'; - } - return $output; - } - - /** - * Return an array of answers by question/choice for the given response. Must be implemented by the subclass. - * - * @param int $rid The response id. - * @param null $col Other data columns to return. - * @param bool $csvexport Using for CSV export. - * @param int $choicecodes CSV choicecodes are required. - * @param int $choicetext CSV choicetext is required. - * @return array - */ - static public function response_select($rid, $col = null, $csvexport = false, $choicecodes = 0, $choicetext = 1) { - global $DB; - - $values = []; - $sql = 'SELECT a.id as aid, q.id AS qid, q.precise AS precise, c.id AS cid '.$col.', c.content as ccontent, - a.rankvalue as arank '. - 'FROM {'.self::response_table().'} a, {questionnaire_question} q, {questionnaire_quest_choice} c '. - 'WHERE a.response_id= ? AND a.question_id=q.id AND a.choice_id=c.id '. - 'ORDER BY aid, a.question_id, c.id'; - $records = $DB->get_records_sql($sql, [$rid]); - foreach ($records as $row) { - // Next two are 'qid' and 'cid', each with numeric and hash keys. - $osgood = false; - if ($row->precise == 3) { - $osgood = true; - } - $qid = $row->qid.'_'.$row->cid; - unset($row->aid); // Get rid of the answer id. - unset($row->qid); - unset($row->cid); - unset($row->precise); - $row = (array)$row; - $newrow = []; - foreach ($row as $key => $val) { - if ($key != 'content') { // No need to keep question text - ony keep choice text and rank. - if ($key == 'ccontent') { - if ($osgood) { - list($contentleft, $contentright) = array_merge(preg_split('/[|]/', $val), [' ']); - $contents = questionnaire_choice_values($contentleft); - if ($contents->title) { - $contentleft = $contents->title; - } - $contents = questionnaire_choice_values($contentright); - if ($contents->title) { - $contentright = $contents->title; - } - $val = strip_tags($contentleft.'|'.$contentright); - $val = preg_replace("/[\r\n\t]/", ' ', $val); - } else { - $contents = questionnaire_choice_values($val); - if ($contents->modname) { - $val = $contents->modname; - } else if ($contents->title) { - $val = $contents->title; - } else if ($contents->text) { - $val = strip_tags($contents->text); - $val = preg_replace("/[\r\n\t]/", ' ', $val); - } - } - } - $newrow[] = $val; - } - } - $values[$qid] = $newrow; - } - - return $values; - } - - /** - * Configure bulk sql - * @return bulk_sql_config - */ - protected function bulk_sql_config() { - return new bulk_sql_config(self::response_table(), 'qrr', true, false, true); - } - -} \ No newline at end of file diff --git a/classes/response/single.php b/classes/response/single.php deleted file mode 100644 index cdc4b647..00000000 --- a/classes/response/single.php +++ /dev/null @@ -1,353 +0,0 @@ -. - -/** - * This file contains the parent class for questionnaire question types. - * - * @author Mike Churchward - * @license http://www.gnu.org/copyleft/gpl.html GNU Public License - * @package questiontypes - */ - -namespace mod_questionnaire\response; -defined('MOODLE_INTERNAL') || die(); - -/** - * Class for single response types. - * - * @author Mike Churchward - * @package responsetypes - */ - -class single extends base { - static public function response_table() { - return 'questionnaire_resp_single'; - } - - public function insert_response($rid, $val) { - global $DB; - if (!empty($val)) { - foreach ($this->question->choices as $cid => $choice) { - if (strpos($choice->content, '!other') === 0) { - $other = optional_param('q'.$this->question->id.'_'.$cid, null, PARAM_TEXT); - if (!isset($other)) { - continue; - } - if (preg_match("/[^ \t\n]/", $other)) { - $record = new \stdClass(); - $record->response_id = $rid; - $record->question_id = $this->question->id; - $record->choice_id = $cid; - $record->response = $other; - $resid = $DB->insert_record('questionnaire_response_other', $record); - $val = $cid; - break; - } - } - } - } - if (preg_match("/other_q([0-9]+)/", (isset($val) ? $val : ''), $regs)) { - $cid = $regs[1]; - if (!isset($other)) { - $other = optional_param('q'.$this->question->id.'_'.$cid, null, PARAM_TEXT); - } - if (preg_match("/[^ \t\n]/", $other)) { - $record = new \stdClass(); - $record->response_id = $rid; - $record->question_id = $this->question->id; - $record->choice_id = $cid; - $record->response = $other; - $resid = $DB->insert_record('questionnaire_response_other', $record); - $val = $cid; - } - } - $record = new \stdClass(); - $record->response_id = $rid; - $record->question_id = $this->question->id; - $record->choice_id = isset($val) ? $val : 0; - if ($record->choice_id) {// If "no answer" then choice_id is empty (CONTRIB-846). - try { - return $DB->insert_record(static::response_table(), $record); - } catch (\dml_write_exception $ex) { - return false; - } - } else { - return false; - } - } - - public function get_results($rids=false, $anonymous=false) { - global $DB; - - $rsql = ''; - $params = array($this->question->id); - if (!empty($rids)) { - list($rsql, $rparams) = $DB->get_in_or_equal($rids); - $params = array_merge($params, $rparams); - $rsql = ' AND response_id ' . $rsql; - } - - // Added qc.id to preserve original choices ordering. - $sql = 'SELECT rt.id, qc.id as cid, qc.content ' . - 'FROM {questionnaire_quest_choice} qc, ' . - '{'.static::response_table().'} rt ' . - 'WHERE qc.question_id= ? AND qc.content NOT LIKE \'!other%\' AND ' . - 'rt.question_id=qc.question_id AND rt.choice_id=qc.id' . $rsql . ' ' . - 'ORDER BY qc.id'; - - $rows = $DB->get_records_sql($sql, $params); - - // Handle 'other...'. - $sql = 'SELECT rt.id, rt.response, qc.content ' . - 'FROM {questionnaire_response_other} rt, ' . - '{questionnaire_quest_choice} qc ' . - 'WHERE rt.question_id= ? AND rt.choice_id=qc.id' . $rsql . ' ' . - 'ORDER BY qc.id'; - - if ($recs = $DB->get_records_sql($sql, $params)) { - $i = 1; - foreach ($recs as $rec) { - $rows['other'.$i] = new \stdClass(); - $rows['other'.$i]->content = $rec->content; - $rows['other'.$i]->response = $rec->response; - $i++; - } - } - - return $rows; - } - - /** - * Provide the feedback scores for all requested response id's. This should be provided only by questions that provide feedback. - * @param array $rids - * @return array | boolean - */ - public function get_feedback_scores(array $rids) { - global $DB; - - $rsql = ''; - $params = [$this->question->id]; - if (!empty($rids)) { - list($rsql, $rparams) = $DB->get_in_or_equal($rids); - $params = array_merge($params, $rparams); - $rsql = ' AND response_id ' . $rsql; - } - $params[] = 'y'; - - $sql = 'SELECT response_id as rid, c.value AS score ' . - 'FROM {'.$this->response_table().'} r ' . - 'INNER JOIN {questionnaire_quest_choice} c ON r.choice_id = c.id ' . - 'WHERE r.question_id= ? ' . $rsql . ' ' . - 'ORDER BY response_id ASC'; - return $DB->get_records_sql($sql, $params); - } - - /** - * Provide a template for results screen if defined. - * @return mixed The template string or false/ - */ - public function results_template() { - return 'mod_questionnaire/results_choice'; - } - - /** - * Return the JSON structure required for the template. - * - * @param bool $rids - * @param string $sort - * @param bool $anonymous - * @return string - */ - public function display_results($rids=false, $sort='', $anonymous=false) { - global $DB; - - $rows = $this->get_results($rids, $anonymous); - if (is_array($rids)) { - $prtotal = 1; - } else if (is_int($rids)) { - $prtotal = 0; - } - $numresps = count($rids); - - $responsecountsql = 'SELECT COUNT(DISTINCT r.response_id) ' . - 'FROM {' . $this->response_table() . '} r ' . - 'WHERE r.question_id = ? '; - $numrespondents = $DB->count_records_sql($responsecountsql, [$this->question->id]); - - if ($rows) { - foreach ($rows as $idx => $row) { - if (strpos($idx, 'other') === 0) { - $answer = $row->response; - $ccontent = $row->content; - $content = preg_replace(array('/^!other=/', '/^!other/'), - array('', get_string('other', 'questionnaire')), $ccontent); - $content .= ' ' . clean_text($answer); - $textidx = $content; - $this->counts[$textidx] = !empty($this->counts[$textidx]) ? ($this->counts[$textidx] + 1) : 1; - } else { - $contents = questionnaire_choice_values($row->content); - $this->choice = $contents->text.$contents->image; - $textidx = $this->choice; - $this->counts[$textidx] = !empty($this->counts[$textidx]) ? ($this->counts[$textidx] + 1) : 1; - } - } - $pagetags = $this->get_results_tags($this->counts, $numresps, $numrespondents, $prtotal, $sort); - } else { - $pagetags = new \stdClass(); - } - return $pagetags; - } - - /** - * Return an array of answers by question/choice for the given response. Must be implemented by the subclass. - * - * @param int $rid The response id. - * @param null $col Other data columns to return. - * @param bool $csvexport Using for CSV export. - * @param int $choicecodes CSV choicecodes are required. - * @param int $choicetext CSV choicetext is required. - * @return array - */ - static public function response_select($rid, $col = null, $csvexport = false, $choicecodes = 0, $choicetext = 1) { - global $DB; - - $values = []; - $sql = 'SELECT q.id '.$col.', q.type_id as q_type, c.content as ccontent,c.id as cid '. - 'FROM {'.static::response_table().'} a, {questionnaire_question} q, {questionnaire_quest_choice} c '. - 'WHERE a.response_id = ? AND a.question_id=q.id AND a.choice_id=c.id '; - $records = $DB->get_records_sql($sql, [$rid]); - foreach ($records as $qid => $row) { - $cid = $row->cid; - if ($csvexport) { - static $i = 1; - $qrecords = $DB->get_records('questionnaire_quest_choice', ['question_id' => $qid]); - foreach ($qrecords as $value) { - if ($value->id == $cid) { - $contents = questionnaire_choice_values($value->content); - if ($contents->modname) { - $row->ccontent = $contents->modname; - } else { - $content = $contents->text; - if (preg_match('/^!other/', $content)) { - $row->ccontent = get_string('other', 'questionnaire'); - } else if (($choicecodes == 1) && ($choicetext == 1)) { - $row->ccontent = "$i : $content"; - } else if ($choicecodes == 1) { - $row->ccontent = "$i"; - } else { - $row->ccontent = $content; - } - } - $i = 1; - break; - } - $i++; - } - } - unset($row->id); - unset($row->cid); - unset($row->q_type); - $arow = get_object_vars($row); - $newrow = []; - foreach ($arow as $key => $val) { - if (!is_numeric($key)) { - $newrow[] = $val; - } - } - if (preg_match('/^!other/', $row->ccontent)) { - $newrow[] = 'other_' . $cid; - } else { - $newrow[] = (int)$cid; - } - $values[$qid] = $newrow; - } - - return $values; - } - - /** - * Return sql and params for getting responses in bulk. - * @author Guy Thomas - * @param int|array $questionnaireids One id, or an array of ids. - * @param bool|int $responseid - * @param bool|int $userid - * @return array - */ - public function get_bulk_sql($questionnaireids, $responseid = false, $userid = false, $groupid = false, $showincompletes = 0) { - global $DB; - - $sql = $this->bulk_sql(); - if (($groupid !== false) && ($groupid > 0)) { - $groupsql = ' INNER JOIN {groups_members} gm ON gm.groupid = ? AND gm.userid = qr.userid '; - $gparams = [$groupid]; - } else { - $groupsql = ''; - $gparams = []; - } - - if (is_array($questionnaireids)) { - list($qsql, $params) = $DB->get_in_or_equal($questionnaireids); - } else { - $qsql = ' = ? '; - $params = [$questionnaireids]; - } - if ($showincompletes == 1) { - $showcompleteonly = ''; - } else { - $showcompleteonly = 'AND qr.complete = ? '; - $params[] = 'y'; - } - - $sql .= " - AND qr.questionnaireid $qsql $showcompleteonly - LEFT JOIN {questionnaire_response_other} qro ON qro.response_id = qr.id AND qro.choice_id = qrs.choice_id - LEFT JOIN {user} u ON u.id = qr.userid - $groupsql - "; - $params = array_merge($params, $gparams); - - if ($responseid) { - $sql .= " WHERE qr.id = ?"; - $params[] = $responseid; - } else if ($userid) { - $sql .= " WHERE qr.userid = ?"; - $params[] = $userid; - } - - return [$sql, $params]; - } - - /** - * Return sql for getting responses in bulk. - * @author Guy Thomas - * @return string - */ - protected function bulk_sql() { - global $DB; - - $userfields = $this->user_fields_sql(); - $alias = 'qrs'; - $extraselect = 'qrs.choice_id, ' . $DB->sql_order_by_text('qro.response', 1000) . ' AS response, 0 AS rankvalue'; - - return " - SELECT " . $DB->sql_concat_join("'_'", ['qr.id', "'".$this->question->helpname()."'", $alias.'.id']) . " AS id, - qr.submitted, qr.complete, qr.grade, qr.userid, $userfields, qr.id AS rid, $alias.question_id, - $extraselect - FROM {questionnaire_response} qr - JOIN {".static::response_table()."} $alias ON $alias.response_id = qr.id - "; - } -} diff --git a/classes/responsetype/answer/answer.php b/classes/responsetype/answer/answer.php new file mode 100644 index 00000000..7f9bab53 --- /dev/null +++ b/classes/responsetype/answer/answer.php @@ -0,0 +1,83 @@ +. + +namespace mod_questionnaire\responsetype\answer; + +/** + * This defines a structured class to hold question answers. + * + * @author Mike Churchward + * @license http://www.gnu.org/copyleft/gpl.html GNU Public License + * @package mod_questionnaire + * @copyright 2019, onwards Poet + */ +class answer { + + // Class properties. + + /** @var int $id The id of the question response data record this applies to. */ + public $id; + + /** @var int $responseid This id of the response record this applies to. */ + public $responseid; + + /** @var int $questionid The id of the question this response applies to. */ + public $questionid; + + /** @var string $content The choiceid of this response (if applicable). */ + public $choiceid; + + /** @var string $value The value of this response (if applicable). */ + public $value; + + /** + * Answer constructor. + * @param null $id + * @param null $responseid + * @param null $questionid + * @param null $choiceid + * @param null $value + */ + public function __construct($id = null, $responseid = null, $questionid = null, $choiceid = null, $value = null) { + $this->id = $id; + $this->responseid = $responseid; + $this->questionid = $questionid; + $this->choiceid = $choiceid; + $this->value = $value; + } + + /** + * Create and return an answer object from data. + * + * @param \stdClass|array $answerdata The data to load. + * @return answer + */ + public static function create_from_data($answerdata) { + if (!is_array($answerdata)) { + $answerdata = (array)$answerdata; + } + + $properties = array_keys(get_class_vars(__CLASS__)); + foreach ($properties as $property) { + if (!isset($answerdata[$property])) { + $answerdata[$property] = null; + } + } + + return new answer($answerdata['id'], $answerdata['responseid'], $answerdata['questionid'], $answerdata['choiceid'], + $answerdata['value']); + } +} diff --git a/classes/response/boolean.php b/classes/responsetype/boolean.php similarity index 52% rename from classes/response/boolean.php rename to classes/responsetype/boolean.php index dddcfcba..6dbe39de 100644 --- a/classes/response/boolean.php +++ b/classes/responsetype/boolean.php @@ -14,45 +14,100 @@ // You should have received a copy of the GNU General Public License // along with Moodle. If not, see'.$stravgrank.$stravgvalue.'
';
+
+ $isna = $this->question->precise == 1;
+ $isnahead = '';
+ $nbchoices = count($this->counts);
+ $isrestricted = ($this->question->length < $nbchoices) && $this->question->precise == 2;
+
+ if ($isna) {
+ $isnahead = get_string('notapplicable', 'questionnaire');
+ }
+ $pagetags = new \stdClass();
+ $pagetags->averages = new \stdClass();
+
+ if ($isna) {
+ $header1 = new \stdClass();
+ $header1->text = '';
+ $header1->align = '';
+ $header2 = new \stdClass();
+ $header2->text = $stravg;
+ $header2->align = '';
+ $header3 = new \stdClass();
+ $header3->text = '⇓';
+ $header3->align = 'center';
+ $header4 = new \stdClass();
+ $header4->text = $isnahead;
+ $header4->align = 'right';
+ } else {
+ if ($osgood) {
+ $stravg = ''.$stravgrank.'
';
+ $header1 = new \stdClass();
+ $header1->text = '';
+ $header1->align = '';
+ $header2 = new \stdClass();
+ $header2->text = $stravg;
+ $header2->align = '';
+ $header3 = new \stdClass();
+ $header3->text = '';
+ $header3->align = 'center';
+ } else {
+ $header1 = new \stdClass();
+ $header1->text = '';
+ $header1->align = '';
+ $header2 = new \stdClass();
+ $header2->text = $stravg;
+ $header2->align = '';
+ $header3 = new \stdClass();
+ $header3->text = '⇓';
+ $header3->align = 'center';
+ }
+ }
+ // PDF columns are based on a 11.69in x 8.27in page. Margins are 15mm each side, or 1.1811 in total.
+ $pdfwidth = 11.69 - 1.1811;
+ if ($isna) {
+ $header1->width = '55%';
+ $header2->width = '35%';
+ $header3->width = '5%';
+ $header4->width = '5%';
+ $header1->pdfwidth = $pdfwidth * .55;
+ $header2->pdfwidth = $pdfwidth * .35;
+ $header3->pdfwidth = $pdfwidth * .05;
+ $header4->pdfwidth = $pdfwidth * .05;
+ } else if ($osgood) {
+ $header1->width = '25%';
+ $header2->width = '50%';
+ $header3->width = '25%';
+ $header1->pdfwidth = $pdfwidth * .25;
+ $header2->pdfwidth = $pdfwidth * .5;
+ $header3->pdfwidth = $pdfwidth * .25;
+ } else {
+ $header1->width = '60%';
+ $header2->width = '35%';
+ $header3->width = '5%';
+ $header1->pdfwidth = $pdfwidth * .6;
+ $header2->pdfwidth = $pdfwidth * .35;
+ $header3->pdfwidth = $pdfwidth * .05;
+ }
+ $pagetags->averages->headers = [$header1, $header2, $header3];
+ if (isset($header4)) {
+ $pagetags->averages->headers[] = $header4;
+ }
+
+ $imageurl = $CFG->wwwroot.'/mod/questionnaire/images/hbar.gif';
+ $spacerimage = $CFG->wwwroot . '/mod/questionnaire/images/hbartransp.gif';
+ $llength = $this->question->length;
+ if (!$llength) {
+ $llength = 5;
+ }
+ // Add an extra column to accomodate lower ranks in this case.
+ $llength += $isrestricted;
+ $width = 100 / $llength;
+ $n = array();
+ $nameddegrees = 0;
+ foreach ($this->question->nameddegrees as $degree) {
+ // To take into account languages filter.
+ $content = (format_text($degree, FORMAT_HTML, ['noclean' => true]));
+ $n[$nameddegrees] = $degree;
+ $nameddegrees++;
+ }
+ for ($j = 0; $j < $this->question->length; $j++) {
+ if (isset($n[$j])) {
+ $str = $n[$j];
+ } else {
+ $str = $j + 1;
+ }
+ }
+ $rankcols = [];
+ $pdfwidth = $header2->pdfwidth / (100 / $width);
+ for ($i = 0; $i <= $llength - 1; $i++) {
+ if ($isrestricted && $i == $llength - 1) {
+ $str = "...";
+ $rankcols[] = (object)['width' => $width . '%', 'text' => '...', 'pdfwidth' => $pdfwidth];
+ } else if (isset($n[$i])) {
+ $str = $n[$i];
+ $rankcols[] = (object)['width' => $width . '%', 'text' => $n[$i], 'pdfwidth' => $pdfwidth];
+ } else {
+ $str = $i + 1;
+ $rankcols[] = (object)['width' => $width . '%', 'text' => $i + 1, 'pdfwidth' => $pdfwidth];
+ }
+ }
+ $pagetags->averages->choicelabelrow = new \stdClass();
+ $pagetags->averages->choicelabelrow->innertablewidth = $header2->pdfwidth;
+ $pagetags->averages->choicelabelrow->column1 = (object)['width' => $header1->width, 'align' => $header1->align,
+ 'text' => '', 'pdfwidth' => $header1->pdfwidth];
+ $pagetags->averages->choicelabelrow->column2 = (object)['width' => $header2->width, 'align' => $header2->align,
+ 'ranks' => $rankcols, 'pdfwidth' => $header2->pdfwidth];
+ $pagetags->averages->choicelabelrow->column3 = (object)['width' => $header3->width, 'align' => $header3->align,
+ 'text' => '', 'pdfwidth' => $header3->pdfwidth];
+ if ($isna) {
+ $pagetags->averages->choicelabelrow->column4 = (object)['width' => $header4->width, 'align' => $header4->align,
+ 'text' => '', 'pdfwidth' => $header4->pdfwidth];
+ }
+
+ switch ($sort) {
+ case 'ascending':
+ uasort($this->counts, self::class . '::sortavgasc');
+ break;
+ case 'descending':
+ uasort($this->counts, self::class . '::sortavgdesc');
+ break;
+ }
+ reset ($this->counts);
+
+ if (!empty($this->counts) && is_array($this->counts)) {
+ $pagetags->averages->choiceaverages = [];
+ foreach ($this->counts as $content => $contentobj) {
+ // Eliminate potential named degrees on Likert scale.
+ if (!preg_match("/^[0-9]{1,3}=/", $content)) {
+ if (isset($contentobj->avg)) {
+ $avg = $contentobj->avg;
+ // If named degrees were used, swap averages for display.
+ if (isset($contentobj->avgvalue)) {
+ $avg = $contentobj->avgvalue;
+ $avgvalue = $contentobj->avg;
+ } else {
+ $avgvalue = '';
+ }
+ } else {
+ $avg = '';
+ }
+ $nbna = $contentobj->nbna;
+
+ if ($avg) {
+ if (($j = $avg * $width) > 0) {
+ $marginposition = ($avg - 0.5 ) / ($this->question->length + $isrestricted);
+ }
+ if (!right_to_left()) {
+ $margin = 'margin-left:' . $marginposition * 100 . '%';
+ $marginpdf = $marginposition * $pagetags->averages->choicelabelrow->innertablewidth;
+ } else {
+ $margin = 'margin-right:' . $marginposition * 100 . '%';
+ $marginpdf = $pagetags->averages->choicelabelrow->innertablewidth -
+ ($marginposition * $pagetags->averages->choicelabelrow->innertablewidth);
+ }
+ } else {
+ $margin = '';
+ }
+
+ if ($osgood) {
+ // Ensure there are two bits of content.
+ list($content, $contentright) = array_merge(preg_split('/[|]/', $content), array(' '));
+ } else {
+ $contents = questionnaire_choice_values($content);
+ if ($contents->modname) {
+ $content = $contents->text;
+ }
+ }
+ if ($osgood) {
+ $choicecol1 = new \stdClass();
+ $choicecol1->width = $header1->width;
+ $choicecol1->pdfwidth = $header1->pdfwidth;
+ $choicecol1->align = $header1->align;
+ $choicecol1->text = '' .
+ format_text($content, FORMAT_HTML, ['noclean' => true]) . '
';
+ $choicecol2 = new \stdClass();
+ $choicecol2->width = $header2->width;
+ $choicecol2->pdfwidth = $header2->pdfwidth;
+ $choicecol2->align = $header2->align;
+ $choicecol2->imageurl = $imageurl;
+ $choicecol2->spacerimage = $spacerimage;
+ $choicecol2->margin = $margin;
+ $choicecol2->marginpdf = $marginpdf;
+ $choicecol3 = new \stdClass();
+ $choicecol3->width = $header3->width;
+ $choicecol3->pdfwidth = $header3->pdfwidth;
+ $choicecol3->align = $header3->align;
+ $choicecol3->text = '' .
+ format_text($contentright, FORMAT_HTML, ['noclean' => true]) . '
';
+ $pagetags->averages->choiceaverages[] = (object)['column1' => $choicecol1, 'column2' => $choicecol2,
+ 'column3' => $choicecol3];
+ // JR JUNE 2012 do not display meaningless average rank values for Osgood.
+ } else if ($avg || ($nbna != 0)) {
+ $stravgval = '';
+ if ($avg) {
+ if ($stravgvalue) {
+ $stravgval = '('.sprintf('%.1f', $avgvalue).')';
+ }
+ $stravgval = sprintf('%.1f', $avg).' '.$stravgval;
+ if ($isna) {
+ $choicecol4 = new \stdClass();
+ $choicecol4->width = $header4->width;
+ $choicecol4->pdfwidth = $header4->pdfwidth;
+ $choicecol4->align = $header4->align;
+ $choicecol4->text = $nbna;
+ }
+ }
+ $choicecol1 = new \stdClass();
+ $choicecol1->width = $header1->width;
+ $choicecol1->pdfwidth = $header1->pdfwidth;
+ $choicecol1->align = $header1->align;
+ $choicecol1->text = format_text($content, FORMAT_HTML, ['noclean' => true]);
+ $choicecol2 = new \stdClass();
+ $choicecol2->width = $header2->width;
+ $choicecol2->pdfwidth = $header2->pdfwidth;
+ $choicecol2->align = $header2->align;
+ $choicecol2->imageurl = $imageurl;
+ $choicecol2->spacerimage = $spacerimage;
+ $choicecol2->margin = $margin;
+ $choicecol2->marginpdf = $marginpdf;
+ $choicecol3 = new \stdClass();
+ $choicecol3->width = $header3->width;
+ $choicecol3->pdfwidth = $header3->pdfwidth;
+ $choicecol3->align = $header3->align;
+ $choicecol3->text = $stravgval;
+ if ($avg) {
+ if (isset($choicecol4)) {
+ $pagetags->averages->choiceaverages[] = (object)['column1' => $choicecol1,
+ 'column2' => $choicecol2, 'column3' => $choicecol3, 'column4' => $choicecol4];
+ } else {
+ $pagetags->averages->choiceaverages[] = (object)['column1' => $choicecol1,
+ 'column2' => $choicecol2, 'column3' => $choicecol3];
+ }
+ } else {
+ $choicecol4 = new \stdClass();
+ $choicecol4->width = $header4->width;
+ $choicecol4->pdfwidth = $header4->pdfwidth;
+ $choicecol4->align = $header4->align;
+ $choicecol4->text = $nbna;
+ $pagetags->averages->choiceaverages[] = (object)['column1' => $choicecol1, 'column2' => $choicecol2,
+ 'column3' => $choicecol3];
+ }
+ }
+ } // End if named degrees.
+ } // End foreach.
+ } else {
+ $nodata1 = new \stdClass();
+ $nodata1->width = $header1->width;
+ $nodata1->align = $header1->align;
+ $nodata1->text = '';
+ $nodata2 = new \stdClass();
+ $nodata2->width = $header2->width;
+ $nodata2->align = $header2->align;
+ $nodata2->text = get_string('noresponsedata', 'mod_questionnaire');
+ $nodata3 = new \stdClass();
+ $nodata3->width = $header3->width;
+ $nodata3->align = $header3->align;
+ $nodata3->text = '';
+ if (isset($header4)) {
+ $nodata4 = new \stdClass();
+ $nodata4->width = $header4->width;
+ $nodata4->align = $header4->align;
+ $nodata4->text = '';
+ $pagetags->averages->nodata = [$nodata1, $nodata2, $nodata3, $nodata4];
+ } else {
+ $pagetags->averages->nodata = [$nodata1, $nodata2, $nodata3];
+ }
+ }
+ return $pagetags;
+ }
+
+ /**
+ * Return a structure for counts.
+ * @param array $rids
+ * @param array $rows
+ * @param string $sort
+ * @return \stdClass
+ */
+ private function mkrescount($rids, $rows, $sort) {
+ // Display number of responses to Rate questions - see http://moodle.org/mod/forum/discuss.php?d=185106.
+ global $DB;
+
+ $nbresponses = count($rids);
+ // Prepare data to be displayed.
+ $isrestricted = ($this->question->length < count($this->question->choices)) && $this->question->precise == 2;
+
+ $rsql = '';
+ if (!empty($rids)) {
+ list($rsql, $params) = $DB->get_in_or_equal($rids);
+ $rsql = ' AND response_id ' . $rsql;
+ }
+
+ array_unshift($params, $this->question->id); // This is question_id.
+ $sql = 'SELECT r.id, c.content, r.rankvalue, c.id AS choiceid ' .
+ 'FROM {questionnaire_quest_choice} c , ' .
+ '{questionnaire_response_rank} r ' .
+ 'WHERE c.question_id = ?' .
+ ' AND r.question_id = c.question_id' .
+ ' AND r.choice_id = c.id ' .
+ $rsql .
+ ' ORDER BY choiceid, rankvalue ASC';
+ $choices = $DB->get_records_sql($sql, $params);
+
+ // Sort rows (results) by average value.
+ if ($sort != 'default') {
+ $sortarray = array();
+ foreach ($rows as $row) {
+ foreach ($row as $key => $value) {
+ if (!isset($sortarray[$key])) {
+ $sortarray[$key] = array();
+ }
+ $sortarray[$key][] = $value;
+ }
+ }
+ $orderby = "average";
+ switch ($sort) {
+ case 'ascending':
+ array_multisort($sortarray[$orderby], SORT_ASC, $rows);
+ break;
+ case 'descending':
+ array_multisort($sortarray[$orderby], SORT_DESC, $rows);
+ break;
+ }
+ }
+ $nbranks = $this->question->length;
+ $ranks = [];
+ $rankvalue = [];
+ if (!empty($this->question->nameddegrees)) {
+ $rankvalue = array_flip(array_keys($this->question->nameddegrees));
+ }
+ foreach ($rows as $row) {
+ $choiceid = $row->id;
+ foreach ($choices as $choice) {
+ if ($choice->choiceid == $choiceid) {
+ $n = 0;
+ for ($i = 1; $i <= $nbranks; $i++) {
+ if ((isset($rankvalue[$choice->rankvalue]) && ($rankvalue[$choice->rankvalue] == ($i - 1))) ||
+ (empty($rankvalue) && ($choice->rankvalue == $i))) {
+ $n++;
+ if (!isset($ranks[$choice->content][$i])) {
+ $ranks[$choice->content][$i] = 0;
+ }
+ $ranks[$choice->content][$i] += $n;
+ } else if (!isset($ranks[$choice->content][$i])) {
+ $ranks[$choice->content][$i] = 0;
+ }
+ }
+ }
+ }
+ }
+
+ // Psettings for display.
+ $strtotal = ''.get_string('total', 'questionnaire').'';
+ $isna = $this->question->precise == 1;
+ $osgood = false;
+ if ($this->question->precise == 3) { // Osgood's semantic differential.
+ $osgood = true;
+ }
+ if ($this->question->precise == 1) {
+ $na = get_string('notapplicable', 'questionnaire');
+ } else {
+ $na = '';
+ }
+ $nameddegrees = 0;
+ $n = array();
+ foreach ($this->question->nameddegrees as $degree) {
+ $content = $degree;
+ $n[$nameddegrees] = format_text($content, FORMAT_HTML, ['noclean' => true]);
+ $nameddegrees++;
+ }
+ foreach ($this->question->choices as $choice) {
+ $contents = questionnaire_choice_values($choice->content);
+ if ($contents->modname) {
+ $choice->content = $contents->text;
+ }
+ }
+
+ $pagetags = new \stdClass();
+ $pagetags->totals = new \stdClass();
+ $pagetags->totals->headers = [];
+ if ($osgood) {
+ $align = 'right';
+ } else {
+ $align = 'left';
+ }
+ $pagetags->totals->headers[] = (object)['align' => $align,
+ 'text' => ''.get_string('responses', 'questionnaire').''];
+
+ // Display the column titles.
+ for ($j = 0; $j < $this->question->length; $j++) {
+ if (isset($n[$j])) {
+ $str = $n[$j];
+ } else {
+ $str = $j + 1;
+ }
+ $pagetags->totals->headers[] = (object)['align' => 'center', 'text' => ''.$str.''];
+ }
+ if ($osgood) {
+ $pagetags->totals->headers[] = (object)['align' => 'left', 'text' => ''];
+ }
+ $pagetags->totals->headers[] = (object)['align' => 'center', 'text' => $strtotal];
+ if ($isrestricted) {
+ $pagetags->totals->headers[] = (object)['align' => 'center', 'text' => get_string('notapplicable', 'questionnaire')];
+ }
+ if ($na) {
+ $pagetags->totals->headers[] = (object)['align' => 'center', 'text' => $na];
+ }
+
+ // Now display the responses.
+ $pagetags->totals->choices = [];
+ foreach ($ranks as $content => $rank) {
+ $totalcols = [];
+ // Eliminate potential named degrees on Likert scale.
+ if (!preg_match("/^[0-9]{1,3}=/", $content)) {
+ // First display the list of degrees (named or un-named)
+ // number of NOT AVAILABLE responses for this possible answer.
+ $nbna = $this->counts[$content]->nbna;
+ // TOTAL number of responses for this possible answer.
+ $total = $this->counts[$content]->num;
+ $nbresp = ''.$total.'';
+ if ($osgood) {
+ // Ensure there are two bits of content.
+ list($content, $contentright) = array_merge(preg_split('/[|]/', $content), array(' '));
+ $header = reset($pagetags->totals->headers);
+ $totalcols[] = (object)['align' => $header->align,
+ 'text' => format_text($content, FORMAT_HTML, ['noclean' => true])];
+ } else {
+ // Eliminate potentially short-named choices.
+ $contents = questionnaire_choice_values($content);
+ if ($contents->modname) {
+ $content = $contents->text;
+ }
+ $header = reset($pagetags->totals->headers);
+ $totalcols[] = (object)['align' => $header->align,
+ 'text' => format_text($content, FORMAT_HTML, ['noclean' => true])];
+ }
+ // Display ranks/rates numbers.
+ $maxrank = max($rank);
+ for ($i = 1; $i <= $this->question->length; $i++) {
+ $percent = '';
+ if (isset($rank[$i])) {
+ $str = $rank[$i];
+ if ($total !== 0 && $str !== 0) {
+ $percent = ' ('.number_format(($str * 100) / $total).'%)';
+ }
+ // Emphasize responses with max rank value.
+ if ($str == $maxrank) {
+ $str = ''.$str.'';
+ }
+ } else {
+ $str = 0;
+ }
+ $header = next($pagetags->totals->headers);
+ $totalcols[] = (object)['align' => $header->align, 'text' => $str.$percent];
+ }
+ if ($osgood) {
+ $header = next($pagetags->totals->headers);
+ $totalcols[] = (object)['align' => $header->align,
+ 'text' => format_text($contentright, FORMAT_HTML, ['noclean' => true])];
+ }
+ $header = next($pagetags->totals->headers);
+ $totalcols[] = (object)['align' => $header->align, 'text' => $nbresp];
+ if ($isrestricted) {
+ $header = next($pagetags->totals->headers);
+ $totalcols[] = (object)['align' => $header->align, 'text' => $nbresponses - $total];
+ }
+ if (!$osgood) {
+ if ($na) {
+ $header = next($pagetags->totals->headers);
+ $totalcols[] = (object)['align' => $header->align, 'text' => $nbna];
+ }
+ }
+ } // End named degrees.
+ $pagetags->totals->choices[] = (object)['totalcols' => $totalcols];
+ }
+ return $pagetags;
+ }
+
+ /**
+ * Sorting function for ascending.
+ * @param \stdClass $a
+ * @param \stdClass $b
+ * @return int
+ */
+ private static function sortavgasc($a, $b) {
+ if (isset($a->avg) && isset($b->avg)) {
+ if ( $a->avg < $b->avg ) {
+ return -1;
+ } else if ($a->avg > $b->avg ) {
+ return 1;
+ } else {
+ return 0;
+ }
+ }
+ }
+
+ /**
+ * Sorting function for descending.
+ * @param \stdClass $a
+ * @param \stdClass $b
+ * @return int
+ */
+ private static function sortavgdesc($a, $b) {
+ if (isset($a->avg) && isset($b->avg)) {
+ if ( $a->avg > $b->avg ) {
+ return -1;
+ } else if ($a->avg < $b->avg) {
+ return 1;
+ } else {
+ return 0;
+ }
+ }
+ }
+}
diff --git a/classes/responsetype/response/response.php b/classes/responsetype/response/response.php
new file mode 100644
index 00000000..070160d2
--- /dev/null
+++ b/classes/responsetype/response/response.php
@@ -0,0 +1,173 @@
+.
+
+namespace mod_questionnaire\responsetype\response;
+
+/**
+ * This defines a structured class to hold responses.
+ *
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package mod_questionnaire
+ * @copyright 2019, onwards Poet
+ */
+class response {
+
+ // Class properties.
+
+ /** @var int $id The id of the response this applies to. */
+ public $id;
+
+ /** @var int $questionnaireid The id of the questionnaire this response applies to. */
+ public $questionnaireid;
+
+ /** @var int $userid The id of the user for this response. */
+ public $userid;
+
+ /** @var int $submitted The most recent submission date of this response. */
+ public $submitted;
+
+ /** @var boolean $complete Flag for final submission of this response. */
+ public $complete;
+
+ /** @var int $grade Numeric grade for this response (if applicable). */
+ public $grade;
+
+ /** @var array $answers Array by question of array of answer objects. */
+ public $answers;
+
+ /**
+ * Choice constructor.
+ * @param null $id
+ * @param null $questionnaireid
+ * @param null $userid
+ * @param null $submitted
+ * @param null $complete
+ * @param null $grade
+ * @param bool $addanswers
+ */
+ public function __construct($id = null, $questionnaireid = null, $userid = null, $submitted = null, $complete = null,
+ $grade = null, $addanswers = true) {
+ $this->id = $id;
+ $this->questionnaireid = $questionnaireid;
+ $this->userid = $userid;
+ $this->submitted = $submitted;
+ $this->complete = $complete;
+ $this->grade = $grade;
+
+ // Add answers by questions that exist.
+ if ($addanswers) {
+ $this->add_questions_answers();
+ }
+ }
+
+ /**
+ * Create and return a response object from data.
+ *
+ * @param \stdClass|array $responsedata The data to load.
+ * @return response
+ */
+ public static function create_from_data($responsedata) {
+ if (!is_array($responsedata)) {
+ $responsedata = (array)$responsedata;
+ }
+
+ $properties = array_keys(get_class_vars(__CLASS__));
+ foreach ($properties as $property) {
+ if (!isset($responsedata[$property])) {
+ $responsedata[$property] = null;
+ }
+ }
+
+ return new response($responsedata['id'], $responsedata['questionnaireid'], $responsedata['userid'],
+ $responsedata['submitted'], $responsedata['complete'], $responsedata['grade']);
+ }
+
+ /**
+ * Provide a response object from web form data to the question.
+ *
+ * @param \stdClass $responsedata All of the responsedata as an object.
+ * @param array $questions
+ * @return bool|response A response object.
+ */
+ public static function response_from_webform($responsedata, $questions) {
+ global $USER;
+
+ $questionnaireid = isset($responsedata->questionnaire_id) ? $responsedata->questionnaire_id :
+ (isset($responsedata->a) ? $responsedata->a : 0);
+ $response = new response($responsedata->rid, $questionnaireid, $USER->id, null, null, null, false);
+ foreach ($questions as $question) {
+ if ($question->supports_responses()) {
+ $response->answers[$question->id] = $question->responsetype::answers_from_webform($responsedata, $question);
+ }
+ }
+ return $response;
+ }
+
+ /**
+ * Provide a response object from mobile app data to the question.
+ *
+ * @param id $questionnaireid
+ * @param id $responseid
+ * @param \stdClass $responsedata All of the responsedata as an object.
+ * @param array $questions Array of question objects.
+ * @return bool|response A response object.
+ */
+ public static function response_from_appdata($questionnaireid, $responseid, $responsedata, $questions) {
+ global $USER;
+
+ $response = new response($responseid, $questionnaireid, $USER->id, null, null, null, false);
+
+ // Process app data by question and choice and create a webform structure.
+ $processedresponses = new \stdClass();
+ $processedresponses->rid = $responseid;
+ foreach ($responsedata as $answerid => $value) {
+ $parts = explode('_', $answerid);
+ if ($parts[0] == 'response') {
+ $qid = 'q' . $parts[2];
+ if (!isset($processedresponses->{$qid})) {
+ $processedresponses->{$qid} = [];
+ }
+ if (isset($parts[3])) {
+ $cid = $parts[3];
+ } else {
+ $cid = 0;
+ }
+ $processedresponses->{$qid}[$cid] = $value;
+ }
+ }
+
+ foreach ($questions as $question) {
+ if ($question->supports_responses() && isset($processedresponses->{'q'.$question->id})) {
+ $response->answers[$question->id] = $question->responsetype::answers_from_appdata($processedresponses, $question);
+ }
+ }
+ return $response;
+ }
+
+ /**
+ * Add the answers to each question in a question array of answers structure.
+ */
+ public function add_questions_answers() {
+ $this->answers = [];
+ $this->answers += \mod_questionnaire\responsetype\multiple::response_answers_by_question($this->id);
+ $this->answers += \mod_questionnaire\responsetype\single::response_answers_by_question($this->id);
+ $this->answers += \mod_questionnaire\responsetype\rank::response_answers_by_question($this->id);
+ $this->answers += \mod_questionnaire\responsetype\boolean::response_answers_by_question($this->id);
+ $this->answers += \mod_questionnaire\responsetype\date::response_answers_by_question($this->id);
+ $this->answers += \mod_questionnaire\responsetype\text::response_answers_by_question($this->id);
+ }
+}
diff --git a/classes/response/base.php b/classes/responsetype/responsetype.php
similarity index 70%
rename from classes/response/base.php
rename to classes/responsetype/responsetype.php
index ce857ad2..59e3715d 100644
--- a/classes/response/base.php
+++ b/classes/responsetype/responsetype.php
@@ -14,51 +14,81 @@
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see Confirmation page'; +$string['configemailreporting'] = 'Allow reports by email'; +$string['configemailreportinglong'] = 'Enables options for some reports to be emailed directly to specified email addresses.'; $string['configusergraph'] = 'Display charts for "Personality Test" feedback'; $string['configusergraphlong'] = 'Use the Rgraph library to display "Personality Test" feedback charts.'; $string['configmaxsections'] = 'Maximum feedback sections'; @@ -113,10 +118,14 @@ $string['createcontent_help'] = 'Select one of the radio button options. \'Create new\' is the default.'; $string['createcontent_link'] = 'mod/questionnaire/mod#Content_Options'; $string['createnew'] = 'Create new'; +$string['centerlabel'] = 'Centre label'; $string['date'] = 'Date'; $string['date_help'] = 'Use this question type if you expect the response to be a correctly formatted date.'; $string['date_link'] = 'mod/questionnaire/questions#Date'; -$string['dateformatting'] = 'Use the day/month/year format, e.g. for March 14th, 1945: 14/3/1945'; +$string['dateformatting'] = 'Use the year-month-day format, e.g. for March 4th, 1945: 1945-03-04'; +// Prior to release 3.6.0, you could specify an input date format in the above string. Now, the format must be as below. This +// string is used now in case sites modified the above string. +$string['strictdateformatting'] = 'Enter the date using the date picker below.'; $string['deleteallresponses'] = 'Delete ALL Responses'; $string['deletecurrentquestion'] = 'Delete question {$a}'; $string['deletedallgroupresp'] = 'Deleted ALL Responses in group {$a}'; @@ -135,10 +144,12 @@ $string['directwarnings'] = 'Direct dependencies to this question will be removed. This will affect:'; $string['displaymethod'] = 'Display method not defined for question.'; $string['download'] = 'Download'; -$string['downloadtextformat'] = 'Download as CSV'; -$string['downloadtextformat_help'] = 'This feature enables you to save all the responses of a questionnaire to a text file (CSV). - This file can then be imported into a spreadsheet (e.g. MS Excel or Open Office Calc) or a statistical package for further processing the data.'; +$string['downloadpdf'] = 'Download PDF'; +$string['downloadtextformat'] = 'Download'; +$string['downloadtextformat_help'] = 'This feature enables you to download questionnaire responses in a file format of your choice. + The file can then be opened in a spreadsheet program (e.g. MS Excel or Open Office Calc) or a statistical package for further processing.'; $string['downloadtextformat_link'] = 'mod/questionnaire/report#Download_in_text_format'; +$string['downloadtypes'] = 'Report type'; $string['dropdown'] = 'Dropdown Box'; $string['dropdown_help'] = 'There is no real advantage to using the Dropdown Box over using the Radio Buttons except perhaps for longish lists of options, to save screen space.'; @@ -148,6 +159,15 @@ $string['editingquestionnaire'] = 'Editing Questionnaire Settings'; $string['editquestion'] = 'Editing {$a} question'; $string['email'] = 'Email'; +$string['emailextra'] = 'Send download to emails'; +$string['emailextra_help'] = 'Will send the download file to the listed email addresses, separated by commas. Note that NO security or privacy checking is done. + \'allowemailreporting\' must be enabled in module settings to access this.'; +$string['emailsnotspecified'] = 'No email(s) were specified.'; +$string['emailroles'] = 'Send download to roles'; +$string['emailroles_help'] = 'Will send the download file to all roles with "mod/questionnaire:submissionnotification" capability via email. + \'allowemailreporting\' must be enabled in module settings to access this.'; +$string['emailsend'] = 'Send reports'; +$string['emailssent'] = 'Downloads sent to specified email(s).'; $string['errnewname'] = 'Sorry, name already in use. Pick a new name.'; $string['erroropening'] = 'Error opening questionnaire.'; $string['errortable'] = 'Error system table corrupt.'; @@ -196,7 +216,8 @@ $string['feedbacknotes_help'] = 'Text entered here will be displayed to the respondents at the end of their Feedback Report'; $string['feedbackoptions'] = 'Feedback options'; $string['feedbackoptions_help'] = 'Feedback options are available if your questionnaire contains the following question types and question settings: -Radio buttons; Dropdown box; Yes/No; or Rate (normal or Osgood scale). Those questions must be set as Required, their Question Name field must NOT be empty and the Possible answers choices must contain a value.'; +Radio buttons; Dropdown box; Yes/No; Rate (normal or Osgood scale) or Slider. Those questions must be set as Required, their Question Name field must NOT be empty and the Possible answers choices must contain a value. +Slider questions must NOT use a negative value for the Minimum slider range.'; $string['feedbackoptions_link'] = 'mod/questionnaire/personality_test'; $string['feedbackremovequestionfromsection'] = 'This question is part of feedback section [{$a}]'; $string['feedbackremovesection'] = 'Removing this question will completely remove feedback section [{$a}]'; @@ -234,6 +255,7 @@ $string['headingtext'] = 'Heading text'; $string['horizontal'] = 'Horizontal'; $string['id'] = 'ID'; +$string['includerankaverages'] = 'Include rank question averages'; $string['includechoicecodes'] = 'Include choice codes'; $string['includechoicetext'] = 'Include choice text'; $string['includeincomplete'] = "Include incomplete responses"; @@ -244,12 +266,19 @@ $string['invalidresponserecord'] = 'Invalid response record specified.'; $string['invalidsurveyid'] = 'Invalid questionnaire ID.'; $string['invalidsectionid'] = 'Invalid feedback section specified.'; +$string['invalidrange'] = 'The maximum slider value must be greater than the minimum slider value.'; +$string['invalidstartingvalue'] = 'The starting value must be equal to or between the minimum and maximum values. For example, if using a scale of 1-10, the starting value could be 5.'; +$string['invalidminmaxrange'] = 'This question type supports an absolute maximum range of -100 to +100. We expect the vast majority of questionnaire designs to use a range of 1-10 or -10 to +10.'; +$string['invalidincrement'] = 'Note that the value increments must be lower than the maximum value. For example, if a scale of 1-10, the increment value would probably be 1.'; $string['indirectwarnings'] = 'This list shows the indirect dependent questions and the remaining dependencies for direct dependent questions:'; $string['kindofratescale'] = 'Type of rate scale'; $string['kindofratescale_help'] = 'Right-click on the More Help link below.'; $string['kindofratescale_link'] = 'mod/questionnaire/questions#Type_of_rate_scale'; $string['lastrespondent'] = 'Last Respondent'; $string['length'] = 'Length'; +$string['leftlabel'] = 'Left label'; +$string['leftpart'] = '{$a->min} is {$a->leftlabel}'; +$string['leftpartdefault'] = '{$a->min} is minimum slider range'; $string['managequestions'] = 'Manage questions'; $string['managequestions_help'] = 'In the Manage questions section of the Edit Questions page, you can conduct a number of operations on a Questionnaire\'s questions.'; $string['managequestions_link'] = 'mod/questionnaire/questions#Manage_questions'; @@ -269,6 +298,10 @@ Default values are 20 characters for the Input Box width and 25 characters for the maximum length of text entered.'; $string['messageprovider:message'] = 'Questionnaire reminder'; $string['messageprovider:notification'] = 'Questionnaire submission'; +$string['middlepart'] = ', {$a->centreval} is {$a->middlelabel}'; +$string['middlepartdefault'] = ', {$a->centreval} is average'; +$string['middlepartwithtwovalues'] = ', {$a->centreval1} and {$a->centreval2} are {$a->middlelabel}'; +$string['middlepartwithtwovaluesdefault'] = ', {$a->centreval1} and {$a->centreval2} are average'; $string['minforcedresponses'] = 'Min. forced responses'; $string['minforcedresponses_help'] = 'Use these parameters to force respondent to tick a minimum of **Min.** boxes and a maximum of **Max.** check boxes. To force an exact number of check boxes to be ticked, set **Min.** and **Max.** to the same value. If only a min or a max value is desired, just leave the other @@ -276,15 +309,20 @@ respondent does not comply with your requirements. Obviously you should make any requirements clear to the respondent either in the general instructions of your Questionnaire or in the text of relevant questions.'; $string['misconfigured'] = 'Course is misconfigured'; -$string['missingquestion'] = 'Please answer Required question '; -$string['missingquestions'] = 'Please answer Required questions: '; +$string['missingquestion'] = 'Please answer required question '; +$string['missingquestions'] = 'Please answer required questions: '; $string['modulename'] = 'Questionnaire'; $string['modulename_help'] = 'The questionnaire module allows you to construct surveys using a variety of question types, for the purpose of gathering data from users.'; +$string['modulename_link'] = 'mod/questionnaire/view'; $string['modulenameplural'] = 'Questionnaires'; $string['movedisabled'] = 'This item cannot be moved'; $string['myresponses'] = 'All your responses'; $string['myresponsetitle'] = 'Your {$a} response(s)'; $string['myresults'] = 'Your Results'; +$string['minrange'] = 'Minimum slider range (left)'; +$string['minrange_help'] = 'Set the minimum value of the range on the left-hand side. It defaults to 1, but can set as low as -100. If you use a negative number (-100 to -1), the right-hand maximum will be expressed with a positive (+) sign.'; +$string['maxrange'] = 'Maximum slider range (right)'; +$string['maxrange_help'] = 'Set the maximum value of the range on the right-hand side. It defaults to 100, but it could be any number between 1-100. If the minimum value for the left-hand is a negative value, the maximum range will be expressed with a positive (+) sign.'; $string['name'] = 'Name'; $string['navigate'] = 'Allow branching questions'; $string['navigate_help'] = 'Enable Yes/No and Radio Buttons questions to have Child questions dependent on their choices in your questionnaire.'; @@ -332,9 +370,8 @@ $string['numeric'] = 'Numeric'; $string['numeric_help'] = 'Use this question type if you expect the response to be a correctly formatted number.'; $string['of'] = 'of'; -$string['opendate'] = 'Use Open Date'; -$string['opendate_help'] = 'You can specify a date to open the questionnaire here. Check the check box, and select the date and time you want. - Users will not be able to fill out the questionnaire before that date. If this is not selected, it will be open immediately.'; +$string['openafterclose'] = 'You have specified an open date after the close date'; +$string['opendate'] = 'Allow responses from'; $string['option'] = 'option {$a}'; $string['optional'] = 'Optional - At least one of this dependencies has to be fulfilled.'; $string['optionalname'] = 'Question Name'; @@ -431,6 +468,10 @@ $string['privacy:metadata:questionnaire_resp_single:choice_id'] = 'The ID of the choice record for this response.'; $string['private'] = 'Private'; +$string['progressbar'] = 'Show progress bar'; +$string['progresshelp'] = 'Progress Bar'; +$string['progresshelp_help'] = 'Move on to the next page to fill up the progress bar'; +$string['progressbar_info'] = 'Questionnaire {$a} complete.'; $string['public'] = 'Public'; $string['publiccopy'] = 'Copy:'; $string['publicoriginal'] = 'Original:'; @@ -525,7 +566,11 @@ $string['resume_link'] = 'mod/questionnaire/mod#Save/Resume_answers'; $string['resumesurvey'] = 'Resume questionnaire'; $string['return'] = 'Return'; +$string['rightlabel'] = 'Right label'; +$string['rightpart'] = ' and {$a->max} is {$a->rightlabel}'; +$string['rightpartdefault'] = ' and {$a->max} is maximum slider range'; $string['save'] = 'Save'; +$string['save_and_exit'] = 'Save and exit'; $string['saveasnew'] = 'Save as New Question'; $string['savedbutnotsubmitted'] = 'This questionnaire has been saved but not yet submitted.'; $string['savedprogress'] = 'Your progress has been saved. You may return at any time to complete this questionnaire.'; @@ -546,7 +591,7 @@ $string['send_message_to'] = 'Send message to:'; $string['sendemail_help'] = 'Sends a copy of each submission to the specified address or addresses. You can provide more than one address by separating them with commas. -Leave blank for no email backup.'; +Leave blank for no email backup. \'allowemailreporting\' must be enabled in module settings to access this.'; $string['set'] = 'set'; $string['settings'] = 'Settings'; $string['settingssaved'] = 'Settings saved'; @@ -568,9 +613,16 @@ $string['subtitle_help'] = 'Subtitle of this questionnaire. Appears below the title on the first page only.'; $string['subject'] = 'Subject'; $string['summary'] = 'Summary'; +$string['summaryreportattached'] = 'Questionnaire summary report attached'; $string['surveynotexists'] = 'questionnaire does not exist.'; $string['surveyowner'] = 'You must be a questionnaire owner to perform this operation.'; $string['surveyresponse'] = 'Response from questionnaire'; +$string['slider'] = 'Slider'; +$string['slider_help'] = 'The slider question allows respondents to select a value from a continuous range by dragging a slider between two extremes. A centre value can also be set.'; +$string['startingvalue'] = 'Slider starting value'; +$string['startingvalue_help'] = 'The slider starting value specifies where the slider should first appear for respondents. It defaults to 1 because the range is unknown. You may wish to start it in the centre of the range by giving a central value (a range of 1-100 has a centre value of 50).'; +$string['stepvalue'] = 'Slider increment value'; +$string['stepvalue_help'] = 'The slider increment value specifies how finely you wish respondents to indicate their response in the range. The question defaults to a range of 1-100 with an increment of one, allowing respondents to give values of 70, 71, 72, 73, 74 etc. But you could instead set increments of five, allowing respondents to give values of 60, 65, 70, 75, 80 etc., or even just a range of 1-10 with increments of 1.'; $string['template'] = 'Template'; $string['templatenotviewable'] = 'Template questionnaires are not viewable.'; $string['text'] = 'Question Text'; @@ -607,7 +659,7 @@ $string['usetemplate'] = 'Use template'; $string['vertical'] = 'Vertical'; $string['view'] = 'View'; -$string['viewallresponses'] = 'View All Responses'; +$string['viewallresponses'] = 'View all responses'; $string['viewallresponses_help'] = 'If the questionnaire is set to **Group Mode**: *Visible groups*, or is set to *Separate groups* and the current user has the *moodle/site:accessallgroups* capability (in the current context), and groups have been defined in the current course, then the user has access to a dropdown list of groups. This dropdown list enables the user to "filter" the questionnaire responses by groups. @@ -618,8 +670,9 @@ $string['viewindividualresponse'] = 'Individual responses'; $string['viewindividualresponse_help'] = 'Click on the respondents\' names in the list below to view their individual responses.'; $string['viewresponses'] = 'All responses ({$a})'; -$string['viewyourresponses'] = 'Your responses- view {$a}'; +$string['viewyourresponses'] = 'View your response(s)'; $string['warning'] = 'Warning, error encountered.'; +$string['where'] = 'where '; $string['wronganswers'] = 'There is something wrong with your answers (see below)'; $string['wrongdateformat'] = 'The date entered: {$a} does not correspond to the format shown in the example.'; $string['wrongdaterange'] = 'ERROR! The year must be set in the 1902 to 2037 range.'; @@ -627,7 +680,8 @@ $string['wrongformats'] = 'There is something wrong with your answer to questions: '; $string['yesno'] = 'Yes/No'; $string['yesno_help'] = 'Simple Yes/No question.'; -$string['yourresponse'] = 'Your response'; -$string['yourresponses'] = 'Your responses'; +$string['yourresponse'] = 'View your response(s)'; +$string['yourresponses'] = 'View your response(s)'; $string['crontask'] = 'Questionnaire cleanup job'; -$string['selectdropdowntext'] = 'Select One'; \ No newline at end of file +$string['nopermissions'] = 'Sorry, but you do not currently have permissions to view this page or perform this action.'; +$string['unanswered'] = 'Unanswered'; diff --git a/lib.php b/lib.php index efdb8af6..dd7f2ea0 100644 --- a/lib.php +++ b/lib.php @@ -14,20 +14,25 @@ // You should have received a copy of the GNU General Public License // along with Moodle. If not, see
- ';
- foreach ($extracontents as $extracontent) {
- $extrahtml .= '
- '.$extracontent.' '; - } - $extrahtml .= '
'; // Need to reload questions. - $questions = $DB->get_records('questionnaire_question', ['surveyid' => $sid, 'deleted' => 'n'], 'id'); - $DB->set_field('questionnaire_question', 'deleted', 'y', ['id' => $qid, 'surveyid' => $sid]); - $select = 'surveyid = '.$sid.' AND deleted = \'n\' AND position > '. - $questions[$qid]->position; - if ($records = $DB->get_records_select('questionnaire_question', $select, null, 'position ASC')) { - foreach ($records as $record) { - $DB->set_field('questionnaire_question', 'position', $record->position - 1, ['id' => $record->id]); + if ($questions = $DB->get_records('questionnaire_question', ['surveyid' => $sid, 'deleted' => 'n'], 'id')) { + $DB->set_field('questionnaire_question', 'deleted', 'y', ['id' => $qid, 'surveyid' => $sid]); + $select = 'surveyid = ' . $sid . ' AND deleted = \'n\' AND position > ' . + $questions[$qid]->position; + if ($records = $DB->get_records_select('questionnaire_question', $select, null, 'position ASC')) { + foreach ($records as $record) { + $DB->set_field('questionnaire_question', 'position', $record->position - 1, ['id' => $record->id]); + } } } } } // Add pagebreak between question child and not dependent question that follows. if ($qu['type_id'] != QUESPAGEBREAK) { - $j = $i - 1; - if ($j != 0) { - $prevtypeid = $positions[$j]['type_id']; - $prevdependencies = $positions[$j]['dependencies']; - - $outerdependencies = count($qu['dependencies']) >= count($prevdependencies) ? $qu['dependencies'] : $prevdependencies; - $innerdependencies = count($qu['dependencies']) < count($prevdependencies) ? $qu['dependencies'] : $prevdependencies; - + if ($prevqu) { + $prevdependencies = $prevqu['dependencies']; + $outerdependencies = count($qu['dependencies']) >= count($prevdependencies) ? + $qu['dependencies'] : $prevdependencies; + $innerdependencies = count($qu['dependencies']) < count($prevdependencies) ? + $qu['dependencies'] : $prevdependencies; + + $okeys = []; + $ikeys = []; foreach ($outerdependencies as $okey => $outerdependency) { foreach ($innerdependencies as $ikey => $innerdependency) { if ($outerdependency->dependquestionid === $innerdependency->dependquestionid && - $outerdependency->dependchoiceid === $innerdependency->dependchoiceid && - $outerdependency->dependlogic === $innerdependency->dependlogic) { - unset($outerdependencies[$okey]); - unset($innerdependencies[$ikey]); + $outerdependency->dependchoiceid === $innerdependency->dependchoiceid && + $outerdependency->dependlogic === $innerdependency->dependlogic) { + $okeys[] = $okey; + $ikeys[] = $ikey; } } } + foreach ($okeys as $key) { + if (key_exists($key, $outerdependencies)) { + unset($outerdependencies[$key]); + } + } + foreach ($ikeys as $key) { + if (key_exists($key, $innerdependencies)) { + unset($innerdependencies[$key]); + } + } + $diffdependencies = count($outerdependencies) + count($innerdependencies); if (($prevtypeid != QUESPAGEBREAK && $diffdependencies != 0) @@ -886,9 +850,8 @@ function questionnaire_check_page_breaks($questionnaire) { return (false); } $newpbids[] = $newqid; - $movetopos = $i; - $questionnaire = new questionnaire($questionnaire->id, null, $course, $cm); - $questionnaire->move_question($newqid, $movetopos); + $questionnaire = new questionnaire($course, $cm, $questionnaire->id, null); + $questionnaire->move_question($newqid, $qu['qpos']); } } } @@ -898,7 +861,7 @@ function questionnaire_check_page_breaks($questionnaire) { } else if ($newpbids) { $msg .= get_string('checkbreaksadded', 'questionnaire').' '; $newpbids = array_reverse ($newpbids); - $questionnaire = new questionnaire($questionnaire->id, null, $course, $cm); + $questionnaire = new questionnaire($course, $cm, $questionnaire->id, null); foreach ($newpbids as $newpbid) { $msg .= $questionnaire->questions[$newpbid]->position.' '; } @@ -908,6 +871,10 @@ function questionnaire_check_page_breaks($questionnaire) { /** * Code snippet used to set up the questionform. + * @param stdClass $questionnaire + * @param int $qid + * @param int $qtype + * @return mixed|\mod_questionnaire\question\question */ function questionnaire_prep_for_questionform($questionnaire, $qid, $qtype) { $context = context_module::instance($questionnaire->cm->id); @@ -933,7 +900,7 @@ function questionnaire_prep_for_questionform($questionnaire, $qid, $qtype) { } } } else { - $question = \mod_questionnaire\question\base::question_builder($qtype); + $question = \mod_questionnaire\question\question::question_builder($qtype); $question->sid = $questionnaire->survey->id; $question->id = $questionnaire->cm->id; $question->type_id = $qtype; @@ -957,28 +924,28 @@ function questionnaire_get_standard_page_items($id = null, $a = null) { if ($id) { if (! $cm = get_coursemodule_from_id('questionnaire', $id)) { - print_error('invalidcoursemodule'); + throw new \moodle_exception('invalidcoursemodule', 'mod_questionnaire'); } if (! $course = $DB->get_record("course", array("id" => $cm->course))) { - print_error('coursemisconf'); + throw new \moodle_exception('coursemisconf', 'mod_questionnaire'); } if (! $questionnaire = $DB->get_record("questionnaire", array("id" => $cm->instance))) { - print_error('invalidcoursemodule'); + throw new \moodle_exception('invalidcoursemodule', 'mod_questionnaire'); } } else { if (! $questionnaire = $DB->get_record("questionnaire", array("id" => $a))) { - print_error('invalidcoursemodule'); + throw new \moodle_exception('invalidcoursemodule', 'mod_questionnaire'); } if (! $course = $DB->get_record("course", array("id" => $questionnaire->course))) { - print_error('coursemisconf'); + throw new \moodle_exception('coursemisconf', 'mod_questionnaire'); } if (! $cm = get_coursemodule_from_instance("questionnaire", $questionnaire->id, $course->id)) { - print_error('invalidcoursemodule'); + throw new \moodle_exception('invalidcoursemodule', 'mod_questionnaire'); } } return (array($cm, $course, $questionnaire)); -} \ No newline at end of file +} diff --git a/mobiledump.txt b/mobiledump.txt new file mode 100644 index 00000000..e8fe347c --- /dev/null +++ b/mobiledump.txt @@ -0,0 +1,54 @@ +
\n"; @@ -1878,23 +2216,25 @@ private function get_full_submission_for_notifications($answers) { /** * Construct the response data for a given response and return a structured export. - * @param $rid + * @param int $rid * @return string * @throws coding_exception */ public function get_structured_response($rid) { - $answers = new stdClass(); - $this->response_import_all($rid, $answers); - return $this->get_full_submission_for_export($answers); + $this->add_response($rid); + return $this->get_full_submission_for_export($rid); } /** * Return a JSON structure containing all the questions and answers for a specific submission. - * @param $answers The array of answers from import_all_responses. - * @return string - * @throws coding_exception + * @param int $rid + * @return array */ - private function get_full_submission_for_export($answers) { + private function get_full_submission_for_export($rid) { + if (!isset($this->responses[$rid])) { + $this->add_response($rid); + } + $exportstructure = []; foreach ($this->questions as $question) { $rqid = 'q' . $question->id; @@ -1906,54 +2246,46 @@ private function get_full_submission_for_export($answers) { $choices = []; $cids = []; foreach ($question->choices as $cid => $choice) { - if (!empty($choice->value)) { + if (!empty($choice->value) && (strpos($choice->content, '=') !== false)) { $choices[$choice->value] = substr($choice->content, (strpos($choice->content, '=') + 1)); } else { $cids[$rqid . '_' . $cid] = $choice->content; } } - foreach ($cids as $rqid => $choice) { - if (isset($answers->$rqid)) { + if (isset($this->responses[$rid]->answers[$question->id])) { + foreach ($cids as $rqid => $choice) { $cid = substr($rqid, (strpos($rqid, '_') + 1)); - if (isset($question->choices[$cid]) && isset($choices[$answers->$rqid + 1])) { - $rating = $choices[$answers->$rqid + 1]; - } else { - $rating = $answers->$rqid + 1; + if (isset($this->responses[$rid]->answers[$question->id][$cid])) { + if (isset($question->choices[$cid]) && + isset($choices[$this->responses[$rid]->answers[$question->id][$cid]->value])) { + $rating = $choices[$this->responses[$rid]->answers[$question->id][$cid]->value]; + } else { + $rating = $this->responses[$rid]->answers[$question->id][$cid]->value; + } + $response->answers[] = $question->choices[$cid]->content . ' = ' . $rating; } - $response->answers[] = $question->choices[$cid]->content . ' = ' . $rating; } } } else if ($question->has_choices()) { - // Check for "other". - foreach ($question->choices as $cid => $choice) { - if (strpos($choice->content, '!other=') !== false) { - $other = $cid; - break; - } - } $answertext = ''; - if (isset($answers->$rqid) && is_array($answers->$rqid)) { + if (isset($this->responses[$rid]->answers[$question->id])) { $i = 0; - foreach ($answers->$rqid as $answer) { + foreach ($this->responses[$rid]->answers[$question->id] as $answer) { if ($i > 0) { $answertext .= '; '; } - if (isset($other) && ($answer == ('other_' . $other))) { - $answertext .= $answers->{$rqid . '_' . $other}; + if ($question->choices[$answer->choiceid]->is_other_choice()) { + $answertext .= $answer->value; } else { - $answertext .= $question->choices[$answer]->content; + $answertext .= $question->choices[$answer->choiceid]->content; } $i++; } - } else if (isset($answers->$rqid) && isset($other) && ($answers->$rqid == ('other_' . $other))) { - $answertext .= $answers->{$rqid . '_' . $other}; - } else if (isset($answers->$rqid) && isset($question->choices[$answers->$rqid])) { - $answertext .= $question->choices[$answers->$rqid]->content; } $response->answers[] = $answertext; - } else if (isset($answers->$rqid)) { - $response->answers[] = $answers->$rqid; + } else if (isset($this->responses[$rid]->answers[$question->id])) { + $response->answers[] = $this->responses[$rid]->answers[$question->id][0]->value; } $exportstructure[] = $response; } @@ -2005,13 +2337,11 @@ private function get_formatted_answers_for_emails($answers) { * @param int $rid The id of the response record. * @param string $email The comma separated list of emails to send to. * @return bool - * @throws coding_exception - * @throws dml_exception */ private function response_send_email($rid, $email) { global $CFG; - $submission = $this->generate_csv($rid, '', null, 1, 0); + $submission = $this->generate_csv(0, $rid, '', null, 1); if (!empty($submission)) { $answers = $this->get_formatted_answers_for_emails($submission); } else { @@ -2032,10 +2362,10 @@ private function response_send_email($rid, $email) { '&rid='.$rid.'&instance='.$this->id; // Html and plaintext body. - $bodyhtml = ''.$url.''.$endhtml; - $bodyplaintext = $url.$endplaintext; - $bodyhtml .= get_string('surveyresponse', 'questionnaire') .' "'.$name.'"'.$endhtml; - $bodyplaintext .= get_string('surveyresponse', 'questionnaire') .' "'.$name.'"'.$endplaintext; + $bodyhtml = ''.$url.''.$endhtml; + $bodyplaintext = $url.$endplaintext; + $bodyhtml .= get_string('surveyresponse', 'questionnaire') .' "'.$name.'"'.$endhtml; + $bodyplaintext .= get_string('surveyresponse', 'questionnaire') .' "'.$name.'"'.$endplaintext; $bodyhtml .= $answers['html']; $bodyplaintext .= $answers['plaintext']; @@ -2061,19 +2391,27 @@ private function response_send_email($rid, $email) { return $return; } - public function response_insert($section, $rid, $userid, $resume=false) { + /** + * Insert the provided response. + * @param object $responsedata An object containing all data for the response. + * @param int $userid + * @param bool $resume + * @return bool|int + */ + public function response_insert($responsedata, $userid, $resume=false) { global $DB; $record = new stdClass(); $record->submitted = time(); - if (empty($rid)) { + if (empty($responsedata->rid)) { // Create a uniqe id for this response. $record->questionnaireid = $this->id; $record->userid = $userid; - $rid = $DB->insert_record('questionnaire_response', $record); + $responsedata->rid = $DB->insert_record('questionnaire_response', $record); + $responsedata->id = $responsedata->rid; } else { - $record->id = $rid; + $record->id = $responsedata->rid; $DB->update_record('questionnaire_response', $record); } if ($resume) { @@ -2092,56 +2430,47 @@ public function response_insert($section, $rid, $userid, $resume=false) { $event->trigger(); } - if (!empty($this->questionsbysec[$section])) { - foreach ($this->questionsbysec[$section] as $question) { - // NOTE *** $val really should be a value obtained from the caller or somewhere else. - // Note that "optional_param" accepting arrays is deprecated for optional_param_array. - if ($question->responsetable == 'resp_multiple') { - $val = optional_param_array('q'.$question->id, '', PARAM_RAW); - } else { - $val = optional_param('q'.$question->id, '', PARAM_RAW); - } - $question->insert_response($rid, $val); + if (!isset($responsedata->sec)) { + $responsedata->sec = 1; + } + if (!empty($this->questionsbysec[$responsedata->sec])) { + foreach ($this->questionsbysec[$responsedata->sec] as $questionid) { + $this->questions[$questionid]->insert_response($responsedata); } } - return($rid); + return($responsedata->rid); } - private function response_select($rid, $col = null, $csvexport = false, $choicecodes=0, $choicetext=1) { - if ($col == null) { - $col = ''; - } - if (!is_array($col) && !empty($col)) { - $col = explode(',', preg_replace("/\s/", '', $col)); - } - if (is_array($col) && count($col) > 0) { - $callback = function($a) { - return 'q.'.$a; - }; - $col = ',' . implode(',', array_map($callback, $col)); - } - + /** + * Get the answers for the all response types. + * @param int $rid + * @return array + */ + private function response_select($rid) { // Response_bool (yes/no). - $values = \mod_questionnaire\response\boolean::response_select($rid, $col, $csvexport, $choicecodes, $choicetext); + $values = \mod_questionnaire\responsetype\boolean::response_select($rid); // Response_single (radio button or dropdown). - $values += \mod_questionnaire\response\single::response_select($rid, $col, $csvexport, $choicecodes, $choicetext); + $values += \mod_questionnaire\responsetype\single::response_select($rid); // Response_multiple. - $values += \mod_questionnaire\response\multiple::response_select($rid, $col, $csvexport, $choicecodes, $choicetext); + $values += \mod_questionnaire\responsetype\multiple::response_select($rid); // Response_rank. - $values += \mod_questionnaire\response\rank::response_select($rid, $col, $csvexport, $choicecodes, $choicetext); + $values += \mod_questionnaire\responsetype\rank::response_select($rid); // Response_text. - $values += \mod_questionnaire\response\text::response_select($rid, $col, $csvexport, $choicecodes, $choicetext); + $values += \mod_questionnaire\responsetype\text::response_select($rid); // Response_date. - $values += \mod_questionnaire\response\date::response_select($rid, $col, $csvexport, $choicecodes, $choicetext); + $values += \mod_questionnaire\responsetype\date::response_select($rid); return($values); } + /** + * Redirect to the appropriate finish page. + */ private function response_goto_thankyou() { global $CFG, $USER, $DB; @@ -2178,6 +2507,11 @@ private function response_goto_thankyou() { if (empty($thankhead)) { $thankhead = get_string('thank_head', 'questionnaire'); } + if ($this->progressbar && isset($this->questionsbysec) && count($this->questionsbysec) > 1) { + // Show 100% full progress bar on completion. + $this->page->add_to_page('progressbar', + $this->renderer->render_progress_bar(count($this->questionsbysec) + 1, $this->questionsbysec)); + } $this->page->add_to_page('title', $thankhead); $this->page->add_to_page('addinfo', format_text(file_rewrite_pluginfile_urls($thankbody, 'pluginfile.php', @@ -2190,20 +2524,22 @@ private function response_goto_thankyou() { $currentgroupid = 0; } if ($this->capabilities->readownresponses) { - $this->page->add_to_page('message', - (''. - get_string("continue").'')); + $url = new moodle_url('myreport.php', ['id' => $this->cm->id, 'instance' => $this->cm->instance, 'user' => $USER->id, + 'byresponse' => 0, 'action' => 'vresp']); + $this->page->add_to_page('continue', $this->renderer->single_button($url, get_string('continue'))); } else { - $this->page->add_to_page('message', - (''. - get_string("continue").'')); + $url = new moodle_url('/course/view.php', ['id' => $this->course->id]); + $this->page->add_to_page('continue', $this->renderer->single_button($url, get_string('continue'))); } return; } + /** + * Redirect to the provided url. + * @param string $url + */ private function response_goto_saved($url) { - global $CFG; + global $CFG, $USER; $resumesurvey = get_string('resumesurvey', 'questionnaire'); $savedprogress = get_string('savedprogress', 'questionnaire', ''.$resumesurvey.''); @@ -2212,11 +2548,33 @@ private function response_goto_saved($url) { $this->page->add_to_page('respondentinfo', $this->renderer->homelink($CFG->wwwroot.'/course/view.php?id='.$this->course->id, get_string("backto", "moodle", $this->course->fullname))); + + if ($this->resume) { + $message = $this->user_access_messages($USER->id, true); + if ($message === false) { + if ($this->user_can_take($USER->id)) { + if ($this->questions) { // Sanity check. + if ($this->user_has_saved_response($USER->id)) { + $this->page->add_to_page('respondentinfo', + $this->renderer->homelink($CFG->wwwroot . '/mod/questionnaire/complete.php?' . + 'id=' . $this->cm->id . '&resume=1', $resumesurvey)); + } + } + } + } + } return; } // Survey Results Methods. + /** + * Add the navigation to the responses page. + * @param int $currrid + * @param int $currentgroupid + * @param stdClass $cm + * @param bool $byresponse + */ public function survey_results_navbar_alpha($currrid, $currentgroupid, $cm, $byresponse) { global $CFG, $DB; @@ -2316,7 +2674,7 @@ public function survey_results_navbar_alpha($currrid, $currentgroupid, $cm, $byr $name = 'popup'; $link = new moodle_url($url); $action = new popup_action('click', $link, $name, $options); - $actionlink = $this->renderer->action_link($link, $linkname, $action, ['role' => 'link', 'title' => $title], + $actionlink = $this->renderer->action_link($link, $linkname, $action, ['title' => $title], new pix_icon('t/print', $title)); $navbar->printaction = $actionlink; $this->page->add_to_page('navigationbar', $this->renderer->navigationbar($navbar)); @@ -2358,6 +2716,7 @@ public function survey_results_navbar_alpha($currrid, $currentgroupid, $cm, $byr $respcols = new stdClass(); for ($i = 0; $i < $colnumber; $i++) { $colname = 'respondentscolumn'.$i; + $respcols->$colname = (object)['respondentlink' => []]; for ($j = 0; $j < $lines; $j++) { $respcols->{$colname}->respondentlink[] = $resparr[$a]; $a++; @@ -2374,7 +2733,15 @@ public function survey_results_navbar_alpha($currrid, $currentgroupid, $cm, $byr } } - // Display responses for current user (your responses). + /** + * Display responses for current user (your responses). + * @param int $currrid + * @param int $userid + * @param int $instance + * @param array $resps + * @param string $reporttype + * @param string $sid + */ public function survey_results_navbar_student($currrid, $userid, $instance, $resps, $reporttype='myreport', $sid='') { global $DB; $stranonymous = get_string('anonymous', 'questionnaire'); @@ -2438,33 +2805,21 @@ public function survey_results_navbar_student($currrid, $userid, $instance, $res $this->page->add_to_page('bottomnavigationbar', $this->renderer->usernavigationbar($navbar)); } - /* {{{ proto string survey_results(int surveyid, int precision, bool show_totals, int question_id, - * array choice_ids, int response_id) - Builds HTML for the results for the survey. If a - question id and choice id(s) are given, then the results - are only calculated for respodants who chose from the - choice ids for the given question id. - Returns empty string on sucess, else returns an error - string. */ - - public function survey_results($precision = 1, $showtotals = 1, $qid = '', $cids = '', $rid = '', - $uid=false, $currentgroupid='', $sort='') { + /** + * Builds HTML for the results for the survey. If a question id and choice id(s) are given, then the results are only calculated + * for respodants who chose from the choice ids for the given question id. Returns empty string on success, else returns an + * error string. + * @param string $rid + * @param bool $uid + * @param bool $pdf + * @param string $currentgroupid + * @param string $sort + * @return string|void + */ + public function survey_results($rid = '', $uid=false, $pdf = false, $currentgroupid='', $sort='') { global $SESSION, $DB; $SESSION->questionnaire->noresponses = false; - if (empty($precision)) { - $precision = 1; - } - if ($showtotals === '') { - $showtotals = 1; - } - - if (is_int($cids)) { - $cids = array($cids); - } - if (is_string($cids)) { - $cids = preg_split("/ /", $cids); // Turn space seperated list into array. - } // Build associative array holding whether each question // type has answer choices or not and the table the answers are in @@ -2537,9 +2892,9 @@ public function survey_results($precision = 1, $showtotals = 1, $qid = '', $cids $this->survey_results_navbar($rid); } - $this->page->add_to_page('title', clean_text($this->survey->title)); + $this->page->add_to_page('title', format_string($this->survey->title)); if ($this->survey->subtitle) { - $this->page->add_to_page('subtitle', clean_text($this->survey->subtitle)); + $this->page->add_to_page('subtitle', format_string($this->survey->subtitle)); } if ($this->survey->info) { $infotext = file_rewrite_pluginfile_urls($this->survey->info, 'pluginfile.php', @@ -2555,27 +2910,41 @@ public function survey_results($precision = 1, $showtotals = 1, $qid = '', $cids if ($question->type_id == QUESPAGEBREAK) { continue; } - $this->page->add_to_page('responses', $this->renderer->container_start('qn-container')); - if ($question->type_id != QUESSECTIONTEXT) { + if ($question->is_numbered()) { $qnum++; + } + if (!$pdf) { + $this->page->add_to_page('responses', $this->renderer->container_start('qn-container')); $this->page->add_to_page('responses', $this->renderer->container_start('qn-info')); - if ($question->type_id != QUESSECTIONTEXT) { + if ($question->is_numbered()) { $this->page->add_to_page('responses', $this->renderer->heading($qnum, 2, 'qn-number')); } $this->page->add_to_page('responses', $this->renderer->container_end()); // End qn-info. + $this->page->add_to_page('responses', $this->renderer->container_start('qn-content')); } - $this->page->add_to_page('responses', $this->renderer->container_start('qn-content')); // If question text is "empty", i.e. 2 non-breaking spaces were inserted, do not display any question text. if ($question->content == '
') { $question->content = ''; } - $this->page->add_to_page('responses', - $this->renderer->container(format_text(file_rewrite_pluginfile_urls($question->content, 'pluginfile.php', + if ($pdf) { + $response = new stdClass(); + if ($question->is_numbered()) { + $response->qnum = $qnum; + } + $response->qcontent = format_text(file_rewrite_pluginfile_urls($question->content, 'pluginfile.php', $question->context->id, 'mod_questionnaire', 'question', $question->id), - FORMAT_HTML, ['noclean' => true]), 'qn-question')); - $this->page->add_to_page('responses', $this->renderer->results_output($question, $rids, $sort, $anonymous)); - $this->page->add_to_page('responses', $this->renderer->container_end()); // End qn-content. - $this->page->add_to_page('responses', $this->renderer->container_end()); // End qn-container. + FORMAT_HTML, ['noclean' => true]); + $response->results = $this->renderer->results_output($question, $rids, $sort, $anonymous, $pdf); + $this->page->add_to_page('responses', $response); + } else { + $this->page->add_to_page('responses', + $this->renderer->container(format_text(file_rewrite_pluginfile_urls($question->content, 'pluginfile.php', + $question->context->id, 'mod_questionnaire', 'question', $question->id), + FORMAT_HTML, ['noclean' => true]), 'qn-question')); + $this->page->add_to_page('responses', $this->renderer->results_output($question, $rids, $sort, $anonymous)); + $this->page->add_to_page('responses', $this->renderer->container_end()); // End qn-content. + $this->page->add_to_page('responses', $this->renderer->container_end()); // End qn-container. + } } return; @@ -2583,12 +2952,9 @@ public function survey_results($precision = 1, $showtotals = 1, $qid = '', $cids /** * Get unique list of question types used in the current survey. - * - * @author: Guy Thomas - * @param int $surveyid + * author: Guy Thomas * @param bool $uniquebytable * @return array - * @throws moodle_exception */ protected function get_survey_questiontypes($uniquebytable = false) { @@ -2623,22 +2989,26 @@ protected function choice_types() { /** * Return all the fields to be used for users in questionnaire sql. - * - * @author: Guy Thomas + * author: Guy Thomas * @return array|string */ protected function user_fields() { - $userfieldsarr = get_all_user_name_fields(); + if (class_exists('\core_user\fields')) { + $userfieldsarr = \core_user\fields::get_name_fields(); + } else { + $userfieldsarr = get_all_user_name_fields(); + } $userfieldsarr = array_merge($userfieldsarr, ['username', 'department', 'institution']); return $userfieldsarr; } /** * Get all survey responses in one go. - * - * @author: Guy Thomas + * author: Guy Thomas * @param string $rid * @param string $userid + * @param bool $groupid + * @param int $showincompletes * @return array */ protected function get_survey_all_responses($rid = '', $userid = '', $groupid = false, $showincompletes = 0) { @@ -2649,25 +3019,25 @@ protected function get_survey_all_responses($rid = '', $userid = '', $groupid = // If a questionnaire is "public", and this is the master course, need to get responses from all instances. if ($this->survey_is_public_master()) { - $qids = array_keys($DB->get_records('questionnaire', ['sid' => $this->sid], 'id')); + $qids = array_keys($DB->get_records('questionnaire', ['sid' => $this->sid], 'id') ?? []); } else { $qids = $this->id; } foreach ($uniquetypes as $type) { - $question = \mod_questionnaire\question\base::question_builder($type); - if (!isset($question->response)) { + $question = \mod_questionnaire\question\question::question_builder($type); + if (!isset($question->responsetype)) { continue; } $allresponsessql .= $allresponsessql == '' ? '' : ' UNION ALL '; - list ($sql, $params) = $question->response->get_bulk_sql($qids, $rid, $userid, $groupid, $showincompletes); + list ($sql, $params) = $question->responsetype->get_bulk_sql($qids, $rid, $userid, $groupid, $showincompletes); $allresponsesparams = array_merge($allresponsesparams, $params); $allresponsessql .= $sql; } $allresponsessql .= " ORDER BY usrid, id"; $allresponses = $DB->get_recordset_sql($allresponsessql, $allresponsesparams); - return $allresponses; + return $allresponses ?? []; } /** @@ -2690,39 +3060,29 @@ public function survey_is_public_master() { /** * Process individual row for csv output - * @param array $outputrow output row + * @param array $row * @param stdClass $resprow resultset row * @param int $currentgroupid * @param array $questionsbyposition * @param int $nbinfocols * @param int $numrespcols + * @param array $options + * @param array $identityfields * @return array - * @throws Exception - * @throws coding_exception - * @throws dml_exception - * @throws dml_missing_record_exception - * @throws dml_multiple_records_exception */ protected function process_csv_row(array &$row, stdClass $resprow, $currentgroupid, array &$questionsbyposition, $nbinfocols, - $numrespcols, $showincompletes = 0) { + $numrespcols, + $options, + $identityfields) { global $DB; - static $config = null; // If using an anonymous response, map users to unique user numbers so that number of unique anonymous users can be seen. static $anonumap = []; - if ($config === null) { - $config = get_config('questionnaire', 'downloadoptions'); - } - $options = empty($config) ? array() : explode(',', $config); - if ($showincompletes == 1) { - $options[] = 'complete'; - } - $positioned = []; $user = new stdClass(); foreach ($this->user_fields() as $userfield) { @@ -2818,6 +3178,9 @@ protected function process_csv_row(array &$row, if (in_array('complete', $options)) { array_push($positioned, $resprow->complete); } + foreach ($identityfields as $field) { + array_push($positioned, $resprow->$field); + } for ($c = $nbinfocols; $c < $numrespcols; $c++) { if (isset($row[$c])) { @@ -2837,10 +3200,19 @@ protected function process_csv_row(array &$row, return $positioned; } - /* {{{ proto array survey_generate_csv(int surveyid) - Exports the results of a survey to an array. - */ - public function generate_csv($rid='', $userid='', $choicecodes=1, $choicetext=0, $currentgroupid, $showincompletes = 0) { + /** + * Exports the results of a survey to an array. + * @param int $currentgroupid + * @param string $rid + * @param string $userid + * @param int $choicecodes + * @param int $choicetext + * @param int $showincompletes + * @param int $rankaverages + * @return array + */ + public function generate_csv($currentgroupid, $rid='', $userid='', $choicecodes=1, $choicetext=0, $showincompletes=0, + $rankaverages=0) { global $DB; raise_memory_limit('1G'); @@ -2859,11 +3231,18 @@ public function generate_csv($rid='', $userid='', $choicecodes=1, $choicetext=0, if (in_array($option, array('response', 'submitted', 'id'))) { $columns[] = get_string($option, 'questionnaire'); $types[] = 0; + } else if ($option == 'useridentityfields') { + // Ignore option. + continue; } else { $columns[] = get_string($option); $types[] = 1; } } + $identityfields = $this->get_identity_fields($options); + foreach ($identityfields as $field) { + $columns[] = \core_user\fields::get_display_name($field); + } $nbinfocols = count($columns); $idtocsvmap = array( @@ -2877,11 +3256,12 @@ public function generate_csv($rid='', $userid='', $choicecodes=1, $choicetext=0, '0', // 7: rating -> number '0', // 8: rate -> number '1', // 9: date -> string - '0' // 10: numeric -> number. + '0', // 10: numeric -> number. + '0', // 11: slider -> number. ); if (!$survey = $DB->get_record('questionnaire_survey', array('id' => $this->survey->id))) { - print_error ('surveynotexists', 'questionnaire'); + throw new \moodle_exception('surveynotexists', 'mod_questionnaire'); } // Get all responses for this survey in one go. @@ -2921,7 +3301,7 @@ public function generate_csv($rid='', $userid='', $choicecodes=1, $choicetext=0, foreach ($this->questions as $question) { // Skip questions that aren't response capable. - if (!isset($question->response)) { + if (!isset($question->responsetype)) { continue; } // Establish the table's field names. @@ -2947,7 +3327,7 @@ public function generate_csv($rid='', $userid='', $choicecodes=1, $choicetext=0, foreach ($choices as $choice) { $content = $choice->content; // If "Other" add a column for the actual "other" text entered. - if (preg_match('/^!other/', $content)) { + if (\mod_questionnaire\question\choice::content_is_other_choice($content)) { $col = $choice->name.'_'.$stringother; $columns[][$qpos] = $col; $questionidcols[][$qpos] = null; @@ -2975,7 +3355,7 @@ public function generate_csv($rid='', $userid='', $choicecodes=1, $choicetext=0, array_push($types, '0'); // If "Other" add a column for the "other" checkbox. // Then add a column for the actual "other" text entered. - if (preg_match('/^!other/', $content)) { + if (\mod_questionnaire\question\choice::content_is_other_choice($content)) { $content = $stringother; $col = $choice->name.'->['.$content.']'; $columns[][$qpos] = $col; @@ -2991,7 +3371,7 @@ public function generate_csv($rid='', $userid='', $choicecodes=1, $choicetext=0, $modality = ''; $content = $choice->content; $osgood = false; - if ($choice->precise == 3) { + if (\mod_questionnaire\question\rate::type_is_osgood_rate_scale($choice->precise)) { $osgood = true; } if (preg_match("/^[0-9]{1,3}=/", $content, $ndd)) { @@ -3076,19 +3456,65 @@ public function generate_csv($rid='', $userid='', $choicecodes=1, $choicetext=0, $formatoptions = new stdClass(); $formatoptions->filter = false; // To prevent any filtering in CSV output. + if ($rankaverages) { + $averages = []; + $rids = []; + $allresponsesrs2 = $this->get_survey_all_responses($rid, $userid, $currentgroupid); + foreach ($allresponsesrs2 as $responserow) { + if (!isset($rids[$responserow->rid])) { + $rids[$responserow->rid] = $responserow->rid; + } + } + } + // Get textual versions of responses, add them to output at the correct col position. $prevresprow = false; // Previous response row. $row = []; + if ($rankaverages) { + $averagerow = []; + } + $useridentityfields = []; foreach ($allresponsesrs as $responserow) { $rid = $responserow->rid; $qid = $responserow->question_id; + + // It's possible for a response to exist for a deleted question. Ignore these. + if (!isset($this->questions[$qid])) { + continue; + } + + if (!empty($identityfields)) { + // Get identity fields for user. + if (isset($useridentityfields[$responserow->userid])) { + $customfields = $useridentityfields[$responserow->userid]; + } else { + $customfields = self::get_user_identity_fields($this->context, $responserow->userid); + $useridentityfields[$responserow->userid] = $customfields; + } + + // Set profile fields for user in response row. + foreach ($identityfields as $field) { + $responserow->{$field} = $customfields->{$field}; + } + } + $question = $this->questions[$qid]; $qtype = intval($question->type_id); + if ($rankaverages) { + if ($qtype === QUESRATE) { + if (empty($averages[$qid])) { + $results = $this->questions[$qid]->responsetype->get_results($rids); + foreach ($results as $qresult) { + $averages[$qid][$qresult->id] = $qresult->average; + } + } + } + } $questionobj = $this->questions[$qid]; if ($prevresprow !== false && $prevresprow->rid !== $rid) { $output[] = $this->process_csv_row($row, $prevresprow, $currentgroupid, $questionsbyposition, - $nbinfocols, $numrespcols, $showincompletes); + $nbinfocols, $numrespcols, $options, $identityfields); $row = []; } @@ -3096,10 +3522,13 @@ public function generate_csv($rid='', $userid='', $choicecodes=1, $choicetext=0, $key = $qid.'_'.$responserow->choice_id; $position = $questionpositions[$key]; if ($qtype === QUESRATE) { - $choicetxt = $responserow->rankvalue + 1; + $choicetxt = $responserow->rankvalue; + if ($rankaverages) { + $averagerow[$position] = $averages[$qid][$responserow->choice_id]; + } } else { $content = $choicesbyqid[$qid][$responserow->choice_id]->content; - if (preg_match('/^!other/', $content)) { + if (\mod_questionnaire\question\choice::content_is_other_choice($content)) { // If this is an "other" column, put the text entered in the next position. $row[$position + 1] = $responserow->response; $choicetxt = empty($responserow->choice_id) ? '0' : '1'; @@ -3128,9 +3557,9 @@ public function generate_csv($rid='', $userid='', $choicecodes=1, $choicetext=0, } $content = $choicesbyqid[$qid][$responserow->choice_id]->content; - if (preg_match('/^!other/', $content)) { + if (\mod_questionnaire\question\choice::content_is_other_choice($content)) { // If this has an "other" text, use it. - $responsetxt = get_string('other', 'questionnaire'); + $responsetxt = \mod_questionnaire\question\choice::content_other_choice_display($content); $responsetxt1 = $responserow->response; } else if (($choicecodes == 1) && ($choicetext == 1)) { $responsetxt = $c.' : '.$content; @@ -3155,6 +3584,7 @@ public function generate_csv($rid='', $userid='', $choicecodes=1, $choicetext=0, $row[$position] = $responsetxt; // Check for "other" text and set it to the next position if present. if (!empty($responsetxt1)) { + $responsetxt1 = preg_replace("/[\r\n\t]/", ' ', $responsetxt1); $row[$position + 1] = $responsetxt1; unset($responsetxt1); } @@ -3166,7 +3596,22 @@ public function generate_csv($rid='', $userid='', $choicecodes=1, $choicetext=0, if ($prevresprow !== false) { // Add final row to output. May not exist if no response data was ever present. $output[] = $this->process_csv_row($row, $prevresprow, $currentgroupid, $questionsbyposition, - $nbinfocols, $numrespcols, $showincompletes); + $nbinfocols, $numrespcols, $options, $identityfields); + } + + // Add averages row if appropriate. + if ($rankaverages) { + $summaryrow = []; + $summaryrow[0] = get_string('averagesrow', 'questionnaire'); + $i = 1; + for ($i = 1; $i < $nbinfocols; $i++) { + $summaryrow[$i] = ''; + } + $pos = 0; + for ($i = $nbinfocols; $i < $numrespcols; $i++) { + $summaryrow[$i] = isset($averagerow[$i]) ? $averagerow[$i] : ''; + } + $output[] = $summaryrow; } // Change table headers to incorporate actual question numbers. @@ -3211,7 +3656,6 @@ public function generate_csv($rid='', $userid='', $choicecodes=1, $choicetext=0, * @param int $movetopos The position to move question to. * */ - public function move_question($moveqid, $movetopos) { global $DB; @@ -3238,6 +3682,17 @@ public function move_question($moveqid, $movetopos) { return false; } + /** + * Render the response analysis page. + * @param int $rid + * @param array $resps + * @param bool $compare + * @param bool $isgroupmember + * @param bool $allresponses + * @param int $currentgroupid + * @param array $filteredsections + * @return array|string + */ public function response_analysis($rid, $resps, $compare, $isgroupmember, $allresponses, $currentgroupid, $filteredsections = null) { global $DB, $CFG; @@ -3252,10 +3707,16 @@ public function response_analysis($rid, $resps, $compare, $isgroupmember, $allre $action = optional_param('action', 'vall', PARAM_ALPHA); - if ($resp = $DB->get_record('questionnaire_response', ['id' => $rid]) ) { + $resp = $DB->get_record('questionnaire_response', ['id' => $rid]); + if (!empty($resp)) { $userid = $resp->userid; - if ($user = $DB->get_record('user', ['id' => $userid])) { - $ruser = fullname($user); + $user = $DB->get_record('user', ['id' => $userid]); + if (!empty($user)) { + if ($this->respondenttype == 'anonymous') { + $ruser = '- ' . get_string('anonymous', 'questionnaire') . ' -'; + } else { + $ruser = fullname($user); + } } } // Available group modes (0 = no groups; 1 = separate groups; 2 = visible groups). @@ -3350,11 +3811,12 @@ public function response_analysis($rid, $resps, $compare, $isgroupmember, $allre $sectionlabel = $fbsections[$sectionid]->sectionlabel; $sectionheading = $fbsections[$sectionid]->sectionheading; - $feedbacks = $DB->get_records('questionnaire_feedback', ['sectionid' => $sectionid]); $labels = array(); - foreach ($feedbacks as $feedback) { - if ($feedback->feedbacklabel != '') { - $labels[] = $feedback->feedbacklabel; + if ($feedbacks = $DB->get_records('questionnaire_feedback', ['sectionid' => $sectionid])) { + foreach ($feedbacks as $feedback) { + if ($feedback->feedbacklabel != '') { + $labels[] = $feedback->feedbacklabel; + } } } $feedback = $DB->get_record_select('questionnaire_feedback', @@ -3392,8 +3854,8 @@ public function response_analysis($rid, $resps, $compare, $isgroupmember, $allre $usergraph = get_config('questionnaire', 'usergraph'); if ($usergraph && $this->survey->chart_type) { $this->page->add_to_page('feedbackcharts', - draw_chart ($feedbacktype = 'global', $this->survey->chart_type, $labels, - $score, $allscore, $sectionlabel, $groupname, $allresponses)); + draw_chart ($feedbacktype = 'global', $labels, $groupname, + $allresponses, $this->survey->chart_type, $score, $allscore, $sectionlabel)); } // Display class or group score. Pending chart library decision to display? // Find out if this feedback sectionlabel has a pipe separator. @@ -3406,6 +3868,7 @@ public function response_analysis($rid, $resps, $compare, $isgroupmember, $allre $oppositeallscore = ' | '.$allscore[1].'%'; } if ($this->survey->feedbackscores) { + $table = $table ?? new html_table(); if ($compare) { $table->data[] = array($sectionlabel, $score[0].'%'.$oppositescore, $allscore[0].'%'.$oppositeallscore); } else { @@ -3447,13 +3910,13 @@ public function response_analysis($rid, $resps, $compare, $isgroupmember, $allre foreach ($fbsections as $key => $fbsection) { if ($fbsection->section == $section) { $feedbacksectionid = $key; - $scorecalculation = unserialize($fbsection->scorecalculation); + $scorecalculation = section::decode_scorecalculation($fbsection->scorecalculation); if (empty($scorecalculation) && !is_array($scorecalculation)) { $scorecalculation = []; } $sectionheading = $fbsection->sectionheading; $imageid = $fbsection->id; - $chartlabels [$section] = $fbsection->sectionlabel; + $chartlabels[$section] = $fbsection->sectionlabel; } } foreach ($scorecalculation as $qid => $key) { @@ -3534,24 +3997,28 @@ public function response_analysis($rid, $resps, $compare, $isgroupmember, $allre default: } - foreach ($allscore as $key => $sc) { - if (isset($chartlabels[$key])) { - $lb = explode("|", $chartlabels[$key]); - $oppositescore = ''; - $oppositeallscore = ''; - if (count($lb) > 1) { - $sectionlabel = $lb[0] . ' | ' . $lb[1]; - $oppositescore = ' | ' . $oppositescorepercent[$key] . '%'; - $oppositeallscore = ' | ' . $alloppositescorepercent[$key] . '%'; - } else { - $sectionlabel = $chartlabels[$key]; - } - // If all questions of $section are unseen then don't show feedbackscores for this section. - if ($compare && !is_nan($scorepercent[$key])) { - $table->data[] = array($sectionlabel, $scorepercent[$key] . '%' . $oppositescore, - $allscorepercent[$key] . '%' . $oppositeallscore); - } else if (isset($allscorepercent[$key]) && !is_nan($allscorepercent[$key])) { - $table->data[] = array($sectionlabel, $allscorepercent[$key] . '%' . $oppositeallscore); + if ($this->survey->feedbackscores) { + foreach ($allscore as $key => $sc) { + if (isset($chartlabels[$key])) { + $lb = explode("|", $chartlabels[$key]); + $oppositescore = ''; + $oppositeallscore = ''; + if (count($lb) > 1) { + $sectionlabel = $lb[0] . ' | ' . $lb[1]; + $oppositescore = ' | ' . $oppositescorepercent[$key] . '%'; + $oppositeallscore = ' | ' . $alloppositescorepercent[$key] . '%'; + } else { + $sectionlabel = $chartlabels[$key]; + } + // If all questions of $section are unseen then don't show feedbackscores for this section. + if ($compare && !is_nan($scorepercent[$key])) { + $table = $table ?? new html_table(); + $table->data[] = array($sectionlabel, $scorepercent[$key] . '%' . $oppositescore, + $allscorepercent[$key] . '%' . $oppositeallscore); + } else if (isset($allscorepercent[$key]) && !is_nan($allscorepercent[$key])) { + $table = $table ?? new html_table(); + $table->data[] = array($sectionlabel, $allscorepercent[$key] . '%' . $oppositeallscore); + } } } } @@ -3565,9 +4032,19 @@ public function response_analysis($rid, $resps, $compare, $isgroupmember, $allre } if ($usergraph && $this->survey->chart_type) { - $this->page->add_to_page('feedbackcharts', - draw_chart($feedbacktype = 'sections', $this->survey->chart_type, array_values($chartlabels), - array_values($scorepercent), array_values($allscorepercent), $sectionlabel, $groupname, $allresponses)); + $this->page->add_to_page( + 'feedbackcharts', + draw_chart( + 'sections', + array_values($chartlabels), + $groupname, + $allresponses, + $this->survey->chart_type, + array_values($scorepercent), + array_values($allscorepercent), + $sectionlabel + ) + ); } if ($this->survey->feedbackscores) { $this->page->add_to_page('feedbackscores', html_writer::table($table)); @@ -3576,4 +4053,127 @@ public function response_analysis($rid, $resps, $compare, $isgroupmember, $allre return $feedbackmessages; } -} \ No newline at end of file + // Mobile support area. + + /** + * Save the data from the mobile app. + * @param int $userid + * @param int $sec + * @param bool $completed + * @param int $rid + * @param bool $submit + * @param string $action + * @param array $responses + * @return array + */ + public function save_mobile_data($userid, $sec, $completed, $rid, $submit, $action, array $responses) { + global $DB, $CFG; // Do not delete "$CFG". + + $ret = []; + $response = $this->build_response_from_appdata((object)$responses, $sec); + $response->sec = $sec; + $response->rid = $rid; + $response->id = $rid; + + if ($action == 'nextpage') { + $result = $this->next_page_action($response, $userid); + if (is_string($result)) { + $ret['warnings'] = $result; + } else { + $ret['nextpagenum'] = $result; + } + } else if ($action == 'previouspage') { + $ret['nextpagenum'] = $this->previous_page_action($response, $userid); + } else if (!$completed) { + // If reviewing a completed questionnaire, don't insert a response. + $msg = $this->response_check_format($response->sec, $response); + if (empty($msg)) { + $rid = $this->response_insert($response, $userid); + } else { + $ret['warnings'] = $msg; + $ret['response'] = $response; + } + } + + if ($submit && (!isset($ret['warnings']) || empty($ret['warnings']))) { + $this->commit_submission_response($rid, $userid); + } + return $ret; + } + + /** + * Get all of the areas that can have files. + * @return array + * @throws dml_exception + */ + public function get_all_file_areas() { + global $DB; + + $areas = []; + $areas['info'] = $this->sid; + $areas['thankbody'] = $this->sid; + + // Add question areas. + if (empty($this->questions)) { + $this->add_questions(); + } + $areas['question'] = []; + foreach ($this->questions as $question) { + $areas['question'][] = $question->id; + } + + // Add feedback areas. + $areas['feedbacknotes'] = $this->sid; + $fbsections = $DB->get_records('questionnaire_fb_sections', ['surveyid' => $this->sid]); + if (!empty($fbsections)) { + $areas['sectionheading'] = []; + foreach ($fbsections as $section) { + $areas['sectionheading'][] = $section->id; + $feedbacks = $DB->get_records('questionnaire_feedback', ['sectionid' => $section->id]); + if (!empty($feedbacks)) { + $areas['feedback'] = []; + foreach ($feedbacks as $feedback) { + $areas['feedback'][] = $feedback->id; + } + } + } + } + + return $areas; + } + + /** + * Gets the identity fields. + * + * @param array $options + * @return array + */ + protected function get_identity_fields($options) { + $fields = !in_array('useridentityfields', $options) || $this->respondenttype == 'anonymous' ? [] : + \core_user\fields::get_identity_fields($this->context); + return $fields; + } + + /** + * Gets the identity fields values for a user. + * + * @param object $context + * @param int $userid + * @return array + */ + public static function get_user_identity_fields($context, $userid) { + global $DB; + + $fields = \core_user\fields::for_identity($context); + [ + 'selects' => $selects, + 'joins' => $joins, + 'params' => $params + ] = (array)$fields->get_sql('u', false, '', '', false); + $sql = "SELECT $selects + FROM {user} u $joins + WHERE u.id = ?"; + $row = $DB->get_record_sql($sql, array_merge($params, [$userid])); + return $row; + } +} diff --git a/questions.php b/questions.php index 1156aad2..6175512c 100644 --- a/questions.php +++ b/questions.php @@ -14,28 +14,36 @@ // You should have received a copy of the GNU General Public License // along with Moodle. If not, see
\n"; - $output .= $questionnaire->renderer->help_icon('downloadtextformat', 'questionnaire'); - $output .= ' ' . (get_string('downloadtextformat', 'questionnaire')) . ': ' . - get_string('responses', 'questionnaire').' '.$groupname; - $output .= $questionnaire->renderer->heading(get_string('textdownloadoptions', 'questionnaire')); + $output .= html_writer::tag('h2', (get_string('downloadtextformat', 'questionnaire')) + . ': ' . get_string('responses', 'questionnaire') . ' ' . + $groupname . $questionnaire->renderer->help_icon('downloadtextformat', 'questionnaire')); + $output .= $questionnaire->renderer->heading(get_string('textdownloadoptions', 'questionnaire'), 3); $output .= $questionnaire->renderer->box_start(); - $output .= "\n"; + $downloadparams = [ + 'instance' => $instance, + 'user' => $user, + 'sid' => $sid, + 'action' => 'dfs', + 'group' => $currentgroupid + ]; + $extrafields = $questionnaire->renderer->render_from_template('mod_questionnaire/extrafields', []); + $output .= $questionnaire->renderer->download_dataformat_selector(get_string('downloadtypes', 'questionnaire'), + 'report.php', 'downloadformat', $downloadparams, $extrafields); $output .= $questionnaire->renderer->box_end(); $questionnaire->page->add_to_page('respondentinfo', $output); @@ -471,35 +483,58 @@ exit(); break; - case 'dcsv': // Download responses data as text (cvs) format. + case 'dfs': require_capability('mod/questionnaire:downloadresponses', $context); - require_once($CFG->libdir.'/dataformatlib.php'); - // Use the questionnaire name as the file name. Clean it and change any non-filename characters to '_'. $name = clean_param($questionnaire->name, PARAM_FILE); $name = preg_replace("/[^A-Z0-9]+/i", "_", trim($name)); $choicecodes = optional_param('choicecodes', '0', PARAM_INT); - $choicetext = optional_param('choicetext', '0', PARAM_INT); - $showincompletes = optional_param('complete', '0', PARAM_INT); - $output = $questionnaire->generate_csv('', $user, $choicecodes, $choicetext, $currentgroupid, $showincompletes); - - // Use Moodle's core download function for outputting csv. - $rowheaders = array_shift($output); - download_as_dataformat($name, 'csv', $rowheaders, $output); + $choicetext = optional_param('choicetext', '0', PARAM_INT); + $showincompletes = optional_param('complete', '0', PARAM_INT); + $rankaverages = optional_param('rankaverages', '0', PARAM_INT); + $dataformat = optional_param('downloadformat', '', PARAM_ALPHA); + $emailroles = optional_param('emailroles', 0, PARAM_INT); + $emailextra = optional_param('emailextra', '', PARAM_RAW); + + $output = $questionnaire->generate_csv($currentgroupid, '', $user, $choicecodes, $choicetext, $showincompletes, + $rankaverages); + + $columns = $output[0]; + unset($output[0]); + + // Check if email report was selected. + $emailreport = optional_param('emailreport', '', PARAM_ALPHA); + if (empty($emailreport)) { + \core\dataformat::download_data($name, $dataformat, $columns, $output); + } else { + // Emailreport button selected. + if (get_config('questionnaire', 'allowemailreporting') && (!empty($emailroles) || !empty($emailextra))) { + require_once('savefileformat.php'); + $users = !empty($emailroles) ? $questionnaire->get_notifiable_users($USER->id) : []; + $otheremails = explode(',', $emailextra); + if (!empty($users) || !empty($otheremails)) { + $thisurl = new moodle_url('report.php', + ['instance' => $instance, 'action' => 'dwnpg', 'group' => $currentgroupid]); + save_as_dataformat($name, $dataformat, $columns, $output, $users, $otheremails, $thisurl); + } + } else { + redirect(new moodle_url('report.php', ['instance' => $instance, 'action' => 'dwnpg', 'group' => $currentgroupid]), + get_string('emailsnotspecified', 'questionnaire')); + } + } exit(); break; case 'vall': // View all responses. case 'vallasort': // View all responses sorted in ascending order. case 'vallarsort': // View all responses sorted in descending order. - $PAGE->set_title(get_string('questionnairereport', 'questionnaire')); $PAGE->set_heading(format_string($course->fullname)); - echo $questionnaire->renderer->header(); if (!$questionnaire->capabilities->readallresponses && !$questionnaire->capabilities->readallresponseanytime) { + echo $questionnaire->renderer->header(); // Should never happen, unless called directly by a snoop. - print_error('nopermissions', '', '', get_string('viewallresponses', 'questionnaire')); + throw new \moodle_exception('nopermissions', 'mod_questionnaire'); // Finish the page. echo $questionnaire->renderer->footer($course); break; @@ -516,7 +551,9 @@ default: $SESSION->questionnaire->current_tab = 'valldefault'; } - include('tabs.php'); + if ($outputtarget != 'print') { + include('tabs.php'); + } $respinfo = ''; $resps = array(); @@ -584,30 +621,72 @@ 'courseid' => $course->id, 'other' => array('action' => $action, 'instance' => $instance, 'groupid' => $currentgroupid) ); - $event = \mod_questionnaire\event\all_responses_viewed::create($params); - $event->trigger(); - $respinfo .= get_string('viewallresponses', 'questionnaire').'. '.$groupname.'. '; - $strsort = get_string('order_'.$sort, 'questionnaire'); - $respinfo .= $strsort; - $respinfo .= $questionnaire->renderer->help_icon('orderresponses', 'questionnaire'); - $questionnaire->page->add_to_page('respondentinfo', $respinfo); + if ($outputtarget == 'pdf') { + $pdf = questionnaire_report_start_pdf(); + if ($currentgroupid > 0) { + $groupname = get_string('group') . ': ' . groups_get_group_name($currentgroupid) . ''; + } else { + $groupname = '' . get_string('allparticipants') . ''; + } + $respinfo = get_string('viewallresponses', 'questionnaire') . '. ' . $groupname . '. '; + $strsort = get_string('order_' . $sort, 'questionnaire'); + $respinfo .= $strsort; + $questionnaire->page->add_to_page('respondentinfo', $respinfo); + $questionnaire->survey_results('', false, true, $currentgroupid, $sort); + $html = $questionnaire->renderer->render($questionnaire->page); + + // Supress any warnings. There is at least one error in the TCPF library at line 16749 where 'text-align' is + // not an array. + $errorreporting = error_reporting(0); + $pdf->writeHTML($html); + @$pdf->Output(clean_param($questionnaire->name, PARAM_FILE) . '.pdf', 'D'); + error_reporting($errorreporting); + + } else { // Default to HTML. + $event = \mod_questionnaire\event\all_responses_viewed::create($params); + $event->trigger(); - $ret = $questionnaire->survey_results(1, 1, '', '', '', false, $currentgroupid, $sort); + if ($outputtarget != 'print') { + $linkname = get_string('downloadpdf', 'mod_questionnaire'); + $link = new moodle_url('/mod/questionnaire/report.php', + ['action' => 'vall', 'instance' => $instance, 'group' => $currentgroupid, 'target' => 'pdf']); + $downpdficon = new pix_icon('f/pdf', $linkname); + $respinfo .= $questionnaire->renderer->action_link($link, null, null, null, $downpdficon); + + $linkname = get_string('print', 'mod_questionnaire'); + $link = new \moodle_url('/mod/questionnaire/report.php', + ['action' => 'vall', 'instance' => $instance, 'group' => $currentgroupid, 'target' => 'print']); + $htmlicon = new pix_icon('t/print', $linkname); + $options = ['menubar' => true, 'location' => false, 'scrollbars' => true, 'resizable' => true, + 'height' => 600, 'width' => 800, 'title' => $linkname]; + $name = 'popup'; + $action = new popup_action('click', $link, $name, $options); + $class = ''; + $respinfo .= $questionnaire->renderer->action_link($link, null, $action, + ['class' => $class, 'title' => $linkname], $htmlicon) . ' '; + + $respinfo .= get_string('viewallresponses', 'questionnaire') . '. ' . $groupname . '. '; + $strsort = get_string('order_' . $sort, 'questionnaire'); + $respinfo .= $strsort; + $respinfo .= $questionnaire->renderer->help_icon('orderresponses', 'questionnaire'); + $questionnaire->page->add_to_page('respondentinfo', $respinfo); + } - echo $questionnaire->renderer->render($questionnaire->page); + $ret = $questionnaire->survey_results('', false, false, $currentgroupid, $sort); - // Finish the page. - echo $questionnaire->renderer->footer($course); + echo $questionnaire->renderer->header(); + echo $questionnaire->renderer->render($questionnaire->page); + echo $questionnaire->renderer->footer($course); + } break; case 'vresp': // View by response. - default: if (empty($questionnaire->survey)) { - print_error('surveynotexists', 'questionnaire'); + throw new \moodle_exception('surveynotexists', 'mod_questionnaire'); } else if ($questionnaire->survey->courseid != $course->id) { - print_error('surveyowner', 'questionnaire'); + throw new \moodle_exception('surveyowner', 'mod_questionnaire'); } $ruser = false; $noresponses = false; @@ -674,28 +753,48 @@ $rid = $rids[0]; } - // Print the page header. - $PAGE->set_title(get_string('questionnairereport', 'questionnaire')); - $PAGE->set_heading(format_string($course->fullname)); - echo $questionnaire->renderer->header(); - - // Print the tabs. - if ($byresponse) { - $SESSION->questionnaire->current_tab = 'vrespsummary'; - } - if ($individualresponse) { - $SESSION->questionnaire->current_tab = 'individualresp'; - } - include('tabs.php'); - - // Print the main part of the page. - // TODO provide option to select how many columns and/or responses per page. - if ($noresponses) { $questionnaire->page->add_to_page('respondentinfo', - get_string('group').' '.groups_get_group_name($currentgroupid).': '. + get_string('group') . ' ' . groups_get_group_name($currentgroupid) . ': ' . get_string('noresponses', 'questionnaire')); - } else { + + } else if ($outputtarget == 'pdf') { + $pdf = questionnaire_report_start_pdf(); + if ($currentgroupid > 0) { + $groupname = get_string('group') . ': ' . groups_get_group_name($currentgroupid) . ''; + } else { + $groupname = '' . get_string('allparticipants') . ''; + } + if (!$byresponse) { // Show respondents individual responses. + $questionnaire->view_response($rid, '', $resps, true, true, false, $currentgroupid, $outputtarget); + } + $html = $questionnaire->renderer->render($questionnaire->page); + // Supress any warnings. There is at least one error in the TCPF library at line 16749 where 'text-align' is + // not an array. + $errorreporting = error_reporting(0); + $pdf->writeHTML($html); + @$pdf->Output(clean_param($questionnaire->name, PARAM_FILE), 'D'); + error_reporting($errorreporting); + + } else { // Default to HTML. + // Print the page header. + $PAGE->set_title(get_string('questionnairereport', 'questionnaire')); + $PAGE->set_heading(format_string($course->fullname)); + + // Print the tabs. + if ($byresponse) { + $SESSION->questionnaire->current_tab = 'vrespsummary'; + } + if ($individualresponse) { + $SESSION->questionnaire->current_tab = 'individualresp'; + } + if ($outputtarget == 'html') { + include('tabs.php'); + } + + // Print the main part of the page. + // TODO provide option to select how many columns and/or responses per page. + $groupname = get_string('group').': '.groups_get_group_name($currentgroupid).''; if ($currentgroupid == 0 ) { $groupname = get_string('allparticipants'); @@ -708,15 +807,47 @@ $respinfo .= $questionnaire->renderer->box_end(); $questionnaire->page->add_to_page('respondentinfo', $respinfo); } - $questionnaire->survey_results_navbar_alpha($rid, $currentgroupid, $cm, $byresponse); + if ($outputtarget == 'html') { + $questionnaire->survey_results_navbar_alpha($rid, $currentgroupid, $cm, $byresponse); + } if (!$byresponse) { // Show respondents individual responses. - $questionnaire->view_response($rid, '', false, $resps, true, true, false, $currentgroupid); + $questionnaire->view_response($rid, '', $resps, true, true, false, $currentgroupid, $outputtarget); } + echo $questionnaire->renderer->header(); + echo $questionnaire->renderer->render($questionnaire->page); + echo $questionnaire->renderer->footer($course); } - - echo $questionnaire->renderer->render($questionnaire->page); - - // Finish the page. - echo $questionnaire->renderer->footer($course); break; } + +/** + * Return a pdf object. + * @return pdf + */ +function questionnaire_report_start_pdf() { + global $CFG; + + require_once($CFG->libdir . '/pdflib.php'); + $pdf = new pdf(); + $pdf->SetCreator(PDF_CREATOR); + $pdf->SetAuthor('Moodle Questionnaire'); + $pdf->SetTitle('All responses'); + $pdf->setPrintHeader(false); + // Set default monospaced font. + $pdf->SetDefaultMonospacedFont(PDF_FONT_MONOSPACED); + + // Set margins. + $pdf->SetMargins(PDF_MARGIN_LEFT, PDF_MARGIN_TOP, PDF_MARGIN_RIGHT); + $pdf->SetHeaderMargin(PDF_MARGIN_HEADER); + $pdf->SetFooterMargin(PDF_MARGIN_FOOTER); + + // Set auto page breaks. + $pdf->SetAutoPageBreak(true, PDF_MARGIN_BOTTOM); + + // Set image scale factor. + $pdf->setImageScale(PDF_IMAGE_SCALE_RATIO); + // Set background color for headings. + $pdf->SetFillColor(238, 238, 238); + $pdf->AddPage('L'); + return $pdf; +} diff --git a/savefileformat.php b/savefileformat.php new file mode 100644 index 00000000..cb01d211 --- /dev/null +++ b/savefileformat.php @@ -0,0 +1,105 @@ +. + +/** + * savefileformat.php - Replaces dataformatlib.php to capture output into files. + * + * @package mod_questionnaire + * @copyright 2019 onward Mike Churchward (mike.churchward@poetopensource.org) + * @author Mike Churchward + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +/** + * Sends a formated data file to the browser and optionally a file. This is needed until the main data format API provides a way + * to ouput a file as well as stream to the browser. This file relies on capturing output buffers (ugly hack). + * + * @param string $filename The base filename without an extension + * @param string $dataformat A dataformat name + * @param array $columns An ordered map of column keys and labels + * @param Iterator $iterator An iterator over the records, usually a RecordSet + * @param array $users + * @param array $emails + * @param string $redirect + */ +function save_as_dataformat($filename, $dataformat, $columns, $iterator, $users = [], $emails = [], $redirect = '') { + global $CFG, $OUTPUT; + + $classname = 'dataformat_' . $dataformat . '\writer'; + if (!class_exists($classname)) { + throw new coding_exception("Unable to locate dataformat/$dataformat/classes/writer.php"); + } + $format = new $classname; + + // The data format export could take a while to generate... + set_time_limit(0); + + // Close the session so that the users other tabs in the same session are not blocked. + \core\session\manager::write_close(); + + $format->set_filename($filename); + // File creation for any data format is initiated by "send_http_headers()". This is required. But, this also will cause the + // browser to respond with a "save / open" dialogue. To get rid of the dialogue, immediately retract the headers with + // "header_remove()". + $format->send_http_headers(); + header_remove(); + + // Start capturing output to write to a file. + ob_start(); + // This exists to support all dataformats - see MDL-56046. + if (method_exists($format, 'write_header')) { + debugging('The function write_header() does not support multiple sheets. In order to support multiple sheets you ' . + 'must implement start_output() and start_sheet() and remove write_header() in your dataformat.', DEBUG_DEVELOPER); + $format->write_header($columns); + } else { + $format->start_output(); + $format->start_sheet($columns); + } + $c = 0; + foreach ($iterator as $row) { + if ($row === null) { + continue; + } + $format->write_record($row, $c++); + } + // This exists to support all dataformats - see MDL-56046. + if (method_exists($format, 'write_footer')) { + debugging('The function write_footer() does not support multiple sheets. In order to support multiple sheets you ' . + 'must implement close_sheet() and close_output() and remove write_footer() in your dataformat.', DEBUG_DEVELOPER); + $format->write_footer($columns); + } else { + $format->close_sheet($columns); + $format->close_output(); + $output = ob_get_contents(); + $ext = $format->get_extension(); + $filepath = make_temp_directory('mod_questionnaire') . '/' . $filename . $ext; + $fp = fopen($filepath, 'wb'); + fwrite($fp, $output); + fclose($fp); + $subjecttext = get_string('summaryreportattached', 'questionnaire'); + foreach ($users as $user) { + email_to_user($user, $CFG->noreplyaddress, $subjecttext, $subjecttext, '', $filepath, $filename.$ext); + } + foreach ($emails as $email) { + $email = trim($email); + $user = (object)['id' => -10, 'email' => $email, 'firstname' => $email, 'lastname' => $email, 'mailformat' => 1]; + email_to_user($user, $CFG->noreplyaddress, $subjecttext, $subjecttext, '', $filepath, $filename.$ext); + } + unlink($filepath); + } + ob_end_clean(); + echo $OUTPUT->redirect_message($redirect, get_string('emailssent', 'questionnaire'), 3, false); +} diff --git a/settings.php b/settings.php index fede9974..6a21c51d 100644 --- a/settings.php +++ b/settings.php @@ -17,9 +17,10 @@ /** * Setting page for questionaire module * - * @package mod - * @subpackage questionnaire + * @package mod_questionnaire * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @copyright 2016 onward Mike Churchward (mike.churchward@poetgroup.org) + * @author Mike Churchward */ defined('MOODLE_INTERNAL') || die; @@ -42,9 +43,13 @@ 'group' => get_string('group'), 'id' => get_string('id', 'questionnaire'), 'fullname' => get_string('fullname'), - 'username' => get_string('username') + 'username' => get_string('username'), + 'useridentityfields' => get_string('showuseridentity', 'admin') ); $settings->add(new admin_setting_configmultiselect('questionnaire/downloadoptions', get_string('textdownloadoptions', 'questionnaire'), '', array_keys($choices), $choices)); + + $settings->add(new admin_setting_configcheckbox('questionnaire/allowemailreporting', + get_string('configemailreporting', 'questionnaire'), get_string('configemailreportinglong', 'questionnaire'), 0)); } diff --git a/show_nonrespondents.php b/show_nonrespondents.php index ce51da6c..924fd98d 100644 --- a/show_nonrespondents.php +++ b/show_nonrespondents.php @@ -15,11 +15,11 @@ // along with Moodle. If not, see