');
- if (isset($questionnaire->deletequestions)) {
- $restoreimg = $questionnaire->renderer->image_url('i/up');
- $deleteimg = $questionnaire->renderer->image_url('t/delete');
- $rangetimecrontask = questionnaire_get_range_time_permanently();
- foreach ($questionnaire->deletequestions as $deletequestion) {
+ $deletequestions = $questionnaire->survey()->get_delete_questions();
+ if (!empty($deletequestions)) {
+ $restoreimg = $this->renderer->image_url('i/up');
+ $deleteimg = $this->renderer->image_url('t/delete');
+ $rangetimecrontask = survey::question_deletion_duration();
+ foreach ($deletequestions as $deletequestion) {
$delquestiongroup = [];
// Preparing deleted time to display time permanently question.
- $timedeleted = $deletequestion->deleted ?? "";
+ $timedeleted = $deletequestion->deleted() ?? "";
if ($rangetimecrontask == 0) {
$timedeleted = get_string('recylebindisabled', 'questionnaire');
} else {
@@ -466,17 +473,17 @@ public function definition() {
}
}
$qtypeandname = [];
- $qtypeandname['name'] = $deletequestion->name;
- $qtypeandname['type'] = questionnaire_get_type($deletequestion->type_id);
+ $qtypeandname['name'] = $deletequestion->name();
+ $qtypeandname['type'] = \mod_questionnaire\local\question_type::display_name($deletequestion->typeid());
$content = format_text(
file_rewrite_pluginfile_urls(
- $deletequestion->content,
+ $deletequestion->content(),
'pluginfile.php',
$deletequestion->context->id,
'mod_questionnaire',
'question',
- $deletequestion->id
+ $deletequestion->id()
),
FORMAT_HTML,
['noclean' => true]
@@ -484,48 +491,48 @@ public function definition() {
$qnumber = '
';
$restorextra = [
- 'value' => $deletequestion->id,
+ 'value' => $deletequestion->id(),
'alt' => get_string('restorebutton', 'questionnaire'),
'title' => get_string('restorebutton', 'questionnaire'),
'class' => 'mod_questionnaire_recycleq',
];
$deleleextra = [
- 'value' => $deletequestion->id,
+ 'value' => $deletequestion->id(),
'alt' => get_string('deletepermanentlybutton', 'questionnaire'),
'title' => get_string('deletepermanentlybutton', 'questionnaire'),
'class' => 'mod_questionnaire_recycleq',
];
$mform->addElement('html', '
'); // Begin div qn-container.
- $delquestiongroup[] =& $mform->createElement('static', 'opentag_' . $deletequestion->id, '', '');
+ $delquestiongroup[] =& $mform->createElement('static', 'opentag_' . $deletequestion->id(), '', '');
$delquestiongroup[] =& $mform->createElement(
'image',
- 'restorebutton[' . $deletequestion->id . ']',
+ 'restorebutton[' . $deletequestion->id() . ']',
$restoreimg,
$restorextra
);
$delquestiongroup[] =& $mform->createElement(
'image',
- 'deletebutton[' . $deletequestion->id . ']',
+ 'deletebutton[' . $deletequestion->id() . ']',
$deleteimg,
$deleleextra
);
- $delquestiongroup[] =& $mform->createElement('static', 'closetag_' . $deletequestion->id, '', '');
+ $delquestiongroup[] =& $mform->createElement('static', 'closetag_' . $deletequestion->id(), '', '');
$delquestiongroup[] =& $mform->createElement(
'static',
- 'qinfo_' . $deletequestion->id,
+ 'qinfo_' . $deletequestion->id(),
'',
get_string('questiontypeandname', 'questionnaire', $qtypeandname)
);
$delquestiongroup[] =& $mform->createElement(
'static',
- 'qinfo_' . $deletequestion->id,
+ 'qinfo_' . $deletequestion->id(),
'',
$timedeleted
);
$mform->addGroup($delquestiongroup, 'delquestiongroup', '', ' ', false);
$mform->addElement(
'static',
- 'qcontent_' . $deletequestion->id,
+ 'qcontent_' . $deletequestion->id(),
'',
$qnumber . '
' . $content . '
'
);
diff --git a/classes/report_actions.php b/classes/report_actions.php
new file mode 100644
index 000000000..58e2c84f2
--- /dev/null
+++ b/classes/report_actions.php
@@ -0,0 +1,308 @@
+.
+
+namespace mod_questionnaire;
+
+use mod_questionnaire\local\db\response_record;
+
+/**
+ * Controller for staff-side report actions on report.php.
+ *
+ * Each method owns one of the four deletion-related action arms:
+ * confirm-delete-single, delete-single, confirm-delete-all, delete-all.
+ *
+ * Confirm methods render their own confirmation page (capability check,
+ * tabs, confirm dialog) and return; delete methods either redirect on
+ * success or throw a plugin moodle_exception on failure.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class report_actions {
+ /**
+ * Constructor.
+ *
+ * @param questionnaire $questionnaire The active questionnaire.
+ * @param \plugin_renderer_base $renderer Plugin renderer for confirmation pages.
+ */
+ public function __construct(
+ /** @var questionnaire The active questionnaire. */
+ private readonly questionnaire $questionnaire,
+ /** @var \plugin_renderer_base Plugin renderer for confirmation pages. */
+ private readonly \plugin_renderer_base $renderer,
+ ) {
+ }
+
+ /**
+ * Render the "delete this response?" confirmation page.
+ *
+ * Side effects: sets $PAGE title/heading, echoes header/page/footer.
+ *
+ * @param object $page Templatable page object (reportpage).
+ * @param int $rid Response id to delete.
+ * @param int $currentgroupid Group filter context.
+ * @return void
+ */
+ public function confirm_delete_response(object $page, int $rid, int $currentgroupid): void {
+ global $PAGE;
+
+ require_capability('mod/questionnaire:deleteresponses', $this->questionnaire->context());
+
+ if (!$this->questionnaire->survey()) {
+ throw new \moodle_exception('surveynotexists', 'mod_questionnaire');
+ } else if ($this->questionnaire->survey()->owning_courseid() != $this->questionnaire->course()->id) {
+ throw new \moodle_exception('surveyowner', 'mod_questionnaire');
+ } else if (!$rid) {
+ throw new \moodle_exception('invalidresponse', 'mod_questionnaire');
+ } else if (!($resp = response_record::get_or_null($rid))) {
+ throw new \moodle_exception('invalidresponserecord', 'mod_questionnaire');
+ }
+
+ $ruser = $this->describe_respondent((int)$resp->get('userid'));
+ $timesubmitted = '
' . get_string('submitted', 'questionnaire') . ' ' . userdate($resp->get('submitted'));
+ if ($this->questionnaire->respondenttype() == 'anonymous') {
+ $ruser = '- ' . get_string('anonymous', 'questionnaire') . ' -';
+ $timesubmitted = '';
+ }
+
+ $PAGE->set_title(get_string('deletingresp', 'questionnaire'));
+ $PAGE->set_heading(format_string($this->questionnaire->course()->fullname));
+ echo $this->renderer->header();
+
+ (new \mod_questionnaire\output\tabs($this->questionnaire, 'deleteresp', $currentgroupid, $rid))->render($page);
+
+ $instance = $this->questionnaire->id();
+ $msg = '
';
+ $msg .= get_string('confirmdelresp', 'questionnaire', $ruser . $timesubmitted);
+ $msg .= '
';
+ $urlyes = new \moodle_url('report.php', [
+ 'action' => 'dvresp',
+ 'rid' => $rid,
+ 'individualresponse' => 1,
+ 'instance' => $instance,
+ 'group' => $currentgroupid,
+ ]);
+ $urlno = new \moodle_url('report.php', [
+ 'action' => 'vresp',
+ 'instance' => $instance,
+ 'rid' => $rid,
+ 'individualresponse' => 1,
+ 'group' => $currentgroupid,
+ ]);
+ $buttonyes = new \single_button($urlyes, get_string('delete'), 'post');
+ $buttonno = new \single_button($urlno, get_string('cancel'), 'get');
+ $page->add_to_page('notifications', $this->renderer->confirm($msg, $buttonyes, $buttonno));
+ echo $this->renderer->render($page);
+ echo $this->renderer->footer($this->questionnaire->course());
+ }
+
+ /**
+ * Execute the delete of a single response. Redirects on success, throws on failure.
+ *
+ * @param int $rid Response id to delete.
+ * @return void
+ */
+ public function delete_response(int $rid): void {
+ global $CFG;
+
+ require_capability('mod/questionnaire:deleteresponses', $this->questionnaire->context());
+
+ if (!$this->questionnaire->survey()) {
+ throw new \moodle_exception('surveynotexists', 'mod_questionnaire');
+ } else if ($this->questionnaire->survey()->owning_courseid() != $this->questionnaire->course()->id) {
+ throw new \moodle_exception('surveyowner', 'mod_questionnaire');
+ } else if (!$rid) {
+ throw new \moodle_exception('invalidresponse', 'mod_questionnaire');
+ } else if (!($response = response_record::get_or_null($rid))) {
+ throw new \moodle_exception('invalidresponserecord', 'mod_questionnaire');
+ }
+
+ $responseuserid = (int)$response->get('userid');
+ $instance = $this->questionnaire->id();
+
+ if ($this->questionnaire->responses()->delete_response($response->to_record())) {
+ if (!response_record::count_complete_for_questionnaire($instance)) {
+ $redirection = $CFG->wwwroot . '/mod/questionnaire/view.php?id=' .
+ $this->questionnaire->coursemodule()->id;
+ } else {
+ $redirection = $CFG->wwwroot . '/mod/questionnaire/report.php?action=vresp&instance=' .
+ $instance . '&byresponse=1';
+ }
+
+ $event = \mod_questionnaire\event\response_deleted::create([
+ 'objectid' => $this->questionnaire->surveyid(),
+ 'context' => $this->questionnaire->context(),
+ 'courseid' => $this->questionnaire->courseid(),
+ 'relateduserid' => $responseuserid,
+ ]);
+ $event->trigger();
+
+ redirect($redirection);
+ }
+
+ $ruser = ($this->questionnaire->respondenttype() == 'anonymous')
+ ? '- ' . get_string('anonymous', 'questionnaire') . ' -'
+ : $this->describe_respondent($responseuserid);
+ $link = new \moodle_url('/mod/questionnaire/report.php', [
+ 'action' => 'vresp',
+ 'sid' => $this->questionnaire->surveyid(),
+ 'instance' => $instance,
+ 'byresponse' => '1',
+ ]);
+ throw new \moodle_exception(
+ 'couldnotdelrespby',
+ 'mod_questionnaire',
+ $link,
+ ['rid' => $rid, 'user' => $ruser]
+ );
+ }
+
+ /**
+ * Render the "delete all responses?" confirmation page.
+ *
+ * Renders nothing if there are no participants to delete (mirrors original arm behaviour).
+ *
+ * @param object $page Templatable page object (reportpage).
+ * @param int $groupmode Activity group mode (0/1/2).
+ * @param int $currentgroupid Active group filter.
+ * @param string $groupname Pre-formatted group label for the confirm message.
+ * @param array $respsallparticipants Responses to participants in scope.
+ * @return void
+ */
+ public function confirm_delete_all_responses(
+ object $page,
+ int $groupmode,
+ int $currentgroupid,
+ string $groupname,
+ array $respsallparticipants
+ ): void {
+ global $PAGE;
+
+ require_capability('mod/questionnaire:deleteresponses', $this->questionnaire->context());
+
+ if (empty($respsallparticipants)) {
+ return;
+ }
+
+ $PAGE->set_title(get_string('deletingresp', 'questionnaire'));
+ $PAGE->set_heading(format_string($this->questionnaire->course()->fullname));
+ echo $this->renderer->header();
+
+ (new \mod_questionnaire\output\tabs($this->questionnaire, 'deleteall', $currentgroupid))->render($page);
+
+ $instance = $this->questionnaire->id();
+ $msg = '
';
+ if ($groupmode == 0) {
+ $msg .= get_string('confirmdelallresp', 'questionnaire');
+ } else {
+ $msg .= get_string('confirmdelgroupresp', 'questionnaire', $groupname);
+ }
+ $msg .= '
';
+
+ $urlyes = new \moodle_url('report.php', [
+ 'action' => 'dvallresp',
+ 'sid' => $this->questionnaire->surveyid(),
+ 'instance' => $instance,
+ 'group' => $currentgroupid,
+ ]);
+ $urlno = new \moodle_url('report.php', ['instance' => $instance, 'group' => $currentgroupid]);
+ $buttonyes = new \single_button($urlyes, get_string('delete'), 'post');
+ $buttonno = new \single_button($urlno, get_string('cancel'), 'get');
+
+ $page->add_to_page('notifications', $this->renderer->confirm($msg, $buttonyes, $buttonno));
+ echo $this->renderer->render($page);
+ echo $this->renderer->footer($this->questionnaire->course());
+ }
+
+ /**
+ * Execute the delete of all responses (optionally group-scoped). Redirects on success.
+ *
+ * @param int $groupmode Activity group mode.
+ * @param int $currentgroupid Active group filter.
+ * @param array $respsallparticipants Pre-computed all-participants responses.
+ * @return void
+ */
+ public function delete_all_responses(
+ int $groupmode,
+ int $currentgroupid,
+ array $respsallparticipants
+ ): void {
+ global $CFG;
+
+ require_capability('mod/questionnaire:deleteresponses', $this->questionnaire->context());
+
+ if (!$this->questionnaire->survey()) {
+ throw new \moodle_exception('surveynotexists', 'mod_questionnaire');
+ } else if ($this->questionnaire->survey()->owning_courseid() != $this->questionnaire->course()->id) {
+ throw new \moodle_exception('surveyowner', 'mod_questionnaire');
+ }
+
+ if ($groupmode > 0 && $currentgroupid > 0) {
+ $resps = $this->questionnaire->get_responses(false, $currentgroupid) ?: [];
+ } else {
+ $resps = $respsallparticipants;
+ }
+
+ $instance = $this->questionnaire->id();
+ if (!empty($resps)) {
+ foreach ($resps as $response) {
+ $this->questionnaire->responses()->delete_response($response);
+ }
+ $sid = $this->questionnaire->surveyid();
+ if (!$this->questionnaire->count_submissions()) {
+ $redirection = $CFG->wwwroot . '/mod/questionnaire/view.php?id=' .
+ $this->questionnaire->coursemodule()->id;
+ } else {
+ $redirection = $CFG->wwwroot . '/mod/questionnaire/report.php?action=vall&sid=' .
+ $sid . '&instance=' . $instance;
+ }
+
+ $event = \mod_questionnaire\event\all_responses_deleted::create([
+ 'objectid' => $instance,
+ 'anonymous' => $this->questionnaire->respondenttype() == 'anonymous',
+ 'context' => $this->questionnaire->context(),
+ ]);
+ $event->trigger();
+
+ redirect($redirection);
+ }
+
+ $link = new \moodle_url('/mod/questionnaire/report.php', [
+ 'action' => 'vall',
+ 'sid' => $this->questionnaire->surveyid(),
+ 'instance' => $instance,
+ ]);
+ throw new \moodle_exception('couldnotdelresp', 'mod_questionnaire', $link);
+ }
+
+ /**
+ * Return a display string for a respondent (fullname, "unknown", or the empty marker).
+ *
+ * @param int $userid
+ * @return string
+ */
+ private function describe_respondent(int $userid): string {
+ if (empty($userid)) {
+ return (string)$userid;
+ }
+ if ($user = \core_user::get_user($userid)) {
+ return fullname($user);
+ }
+ return '- ' . get_string('unknown', 'questionnaire') . ' -';
+ }
+}
diff --git a/classes/report_downloader.php b/classes/report_downloader.php
new file mode 100644
index 000000000..2378afd82
--- /dev/null
+++ b/classes/report_downloader.php
@@ -0,0 +1,213 @@
+.
+
+namespace mod_questionnaire;
+
+/**
+ * Controller for the staff-side download arms of report.php.
+ *
+ * Owns the two CSV / dataformat arms:
+ * - dwnpg: render the "download options" page (format selector + email options).
+ * - dfs: execute the download (stream it, email it, or redirect back with an error).
+ *
+ * Both methods end with exit() to match the original action-arm behaviour
+ * (so headers sent by dataformat::download_data are not followed by more
+ * output). Under PHPUnit, redirect() throws a moodle_exception, which is
+ * what the tests catch.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class report_downloader {
+ /**
+ * Constructor.
+ *
+ * @param questionnaire $questionnaire The active questionnaire.
+ * @param \plugin_renderer_base $renderer Plugin renderer used for the options page.
+ */
+ public function __construct(
+ /** @var questionnaire The active questionnaire. */
+ private readonly questionnaire $questionnaire,
+ /** @var \plugin_renderer_base Plugin renderer for the options page. */
+ private readonly \plugin_renderer_base $renderer,
+ ) {
+ }
+
+ /**
+ * Render the "download options" page (dwnpg action arm).
+ *
+ * Side effects: sets $PAGE title/heading, echoes header / page / footer,
+ * triggers all_responses_saved_as_text, and exit()s.
+ *
+ * @param object $page Templatable report page.
+ * @param int $groupmode Activity groupmode (0 = none, 1 = separate, 2 = visible).
+ * @param int $currentgroupid Active group filter.
+ * @param array $questionnairegroups Available groups (id => obj) — used to label the selected group.
+ * @param int $user User filter applied to the download (0 = all users).
+ * @return void
+ */
+ public function show_download_options(
+ object $page,
+ int $groupmode,
+ int $currentgroupid,
+ array $questionnairegroups,
+ int $user
+ ): void {
+ global $PAGE;
+
+ require_capability('mod/questionnaire:downloadresponses', $this->questionnaire->context());
+
+ $course = $this->questionnaire->course();
+ $instance = $this->questionnaire->id();
+
+ $PAGE->set_title(get_string('questionnairereport', 'questionnaire'));
+ $PAGE->set_heading(format_string($course->fullname));
+ echo $this->renderer->header();
+
+ $tabname = empty($user) ? 'downloadcsv' : 'mydownloadcsv';
+ (new \mod_questionnaire\output\tabs($this->questionnaire, $tabname, $currentgroupid))->render($page);
+
+ $groupname = '';
+ if ($groupmode > 0) {
+ if ($currentgroupid == 0) {
+ $groupname = get_string('allparticipants');
+ } else {
+ $groupname = get_string('membersofselectedgroup', 'group') . ' ' .
+ get_string('group') . ' ' . $questionnairegroups[$currentgroupid]->name;
+ }
+ }
+
+ $output = '';
+ $output .= "
\n";
+ $output .= \html_writer::tag('h2', get_string('downloadtextformat', 'questionnaire')
+ . ': ' . get_string('responses', 'questionnaire') . ' ' .
+ $groupname . $this->renderer->help_icon('downloadtextformat', 'questionnaire'));
+ $output .= $this->renderer->heading(get_string('textdownloadoptions', 'questionnaire'), 3);
+ $output .= $this->renderer->box_start();
+ $downloadparams = [
+ 'instance' => $instance,
+ 'user' => $user,
+ 'sid' => $this->questionnaire->surveyid(),
+ 'action' => 'dfs',
+ 'group' => $currentgroupid,
+ ];
+ $extrafields = $this->renderer->render_from_template('mod_questionnaire/extrafields', []);
+ $output .= $this->renderer->download_dataformat_selector(
+ get_string('downloadtypes', 'questionnaire'),
+ 'report.php',
+ 'downloadformat',
+ $downloadparams,
+ $extrafields
+ );
+ $output .= $this->renderer->box_end();
+
+ $page->add_to_page('respondentinfo', $output);
+ echo $this->renderer->render($page);
+
+ echo $this->renderer->footer('none');
+
+ $event = \mod_questionnaire\event\all_responses_saved_as_text::create([
+ 'objectid' => $instance,
+ 'context' => $this->questionnaire->context(),
+ 'courseid' => $this->questionnaire->courseid(),
+ 'other' => ['action' => 'dwnpg', 'instance' => $instance, 'currentgroupid' => $currentgroupid],
+ ]);
+ $event->trigger();
+
+ exit();
+ }
+
+ /**
+ * Generate and deliver a dataformat export (dfs action arm).
+ *
+ * Reads dataformat-related parameters directly from the request, since they
+ * are tightly coupled to the download form posted from show_download_options().
+ *
+ * Three terminal paths:
+ * - Streams the file via core\dataformat::download_data (then exit()).
+ * - Emails the file via save_as_dataformat (then exit()).
+ * - Redirects back to the options page with an error if email was selected
+ * but no recipients were specified.
+ *
+ * @param object $page Templatable report page (the reporter needs it).
+ * @param int $currentgroupid Active group filter (echoed in redirect URLs).
+ * @param int $user User filter (passed through to generate_csv).
+ * @return void
+ */
+ public function download_responses(object $page, int $currentgroupid, int $user): void {
+ global $CFG, $USER;
+
+ require_capability('mod/questionnaire:downloadresponses', $this->questionnaire->context());
+
+ // Use the questionnaire name as the file name. Clean it and change any non-filename characters to '_'.
+ $name = clean_param($this->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);
+ $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 = $this->questionnaire->reporter($this->renderer, $page)->generate_csv(
+ $currentgroupid,
+ '',
+ $user,
+ $choicecodes,
+ $choicetext,
+ $showincompletes,
+ $rankaverages
+ );
+
+ $columns = $output[0];
+ unset($output[0]);
+
+ $instance = $this->questionnaire->id();
+ $emailreport = optional_param('emailreport', '', PARAM_ALPHA);
+ if (empty($emailreport)) {
+ \core\dataformat::download_data($name, $dataformat, $columns, $output);
+ exit();
+ }
+
+ if (get_config('questionnaire', 'allowemailreporting') && (!empty($emailroles) || !empty($emailextra))) {
+ require_once($CFG->dirroot . '/mod/questionnaire/savefileformat.php');
+ $users = !empty($emailroles)
+ ? (new submission_notifier($this->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);
+ }
+ exit();
+ }
+
+ redirect(
+ new \moodle_url(
+ 'report.php',
+ ['instance' => $instance, 'action' => 'dwnpg', 'group' => $currentgroupid]
+ ),
+ get_string('emailsnotspecified', 'questionnaire')
+ );
+ }
+}
diff --git a/classes/report_viewer.php b/classes/report_viewer.php
new file mode 100644
index 000000000..4ba323a08
--- /dev/null
+++ b/classes/report_viewer.php
@@ -0,0 +1,431 @@
+.
+
+namespace mod_questionnaire;
+
+use mod_questionnaire\output\pdf_factory;
+
+/**
+ * Controller for the staff-side view arms of report.php.
+ *
+ * Owns the two render arms:
+ * - vall (and the two sort variants vallasort/vallarsort): summary view of all responses.
+ * - vresp (and the default action): per-respondent view, including PDF/print branches.
+ *
+ * Each method handles its own tab/scope setup, group filter UI, response collection,
+ * and the html / pdf rendering branches. Methods echo the page directly and return void
+ * (matching the original action arms).
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class report_viewer {
+ /**
+ * Constructor.
+ *
+ * @param questionnaire $questionnaire The active questionnaire.
+ * @param \plugin_renderer_base $renderer Plugin renderer.
+ */
+ public function __construct(
+ /** @var questionnaire The active questionnaire. */
+ private readonly questionnaire $questionnaire,
+ /** @var \plugin_renderer_base Plugin renderer. */
+ private readonly \plugin_renderer_base $renderer,
+ ) {
+ }
+
+ /**
+ * Render the "view all responses" page (vall / vallasort / vallarsort arms).
+ *
+ * @param object $page Templatable report page.
+ * @param string $action One of 'vall', 'vallasort', 'vallarsort'.
+ * @param string $outputtarget 'html', 'pdf', or 'print'.
+ * @param \moodle_url $url Base URL for the current page (used by group select and action links).
+ * @param int $groupmode Activity group mode (0 = none, 1 = separate, 2 = visible).
+ * @param int $currentgroupid Active group filter id.
+ * @param array $questionnairegroups Available groups (id => obj).
+ * @param array $respsallparticipants All-participant responses (pre-fetched).
+ * @param string $sort 'ascending', 'descending', or 'default'.
+ * @param string $userview The 'responsestats' filter ('y', '0', or 'n').
+ * @param array $responsestatus Map of response-status labels keyed by 'y' / '0' / 'n'.
+ * @param bool $usergraph Whether to inject RGraph JS for chart rendering.
+ * @return void
+ */
+ public function view_all_responses(
+ object $page,
+ string $action,
+ string $outputtarget,
+ \moodle_url $url,
+ int $groupmode,
+ int $currentgroupid,
+ array $questionnairegroups,
+ array $respsallparticipants,
+ string $sort,
+ string $userview,
+ array $responsestatus,
+ bool $usergraph
+ ): void {
+ global $PAGE;
+
+ $course = $this->questionnaire->course();
+ $context = $this->questionnaire->context();
+ $cm = $this->questionnaire->coursemodule();
+ $instance = $this->questionnaire->id();
+
+ $PAGE->set_title(get_string('questionnairereport', 'questionnaire'));
+ $PAGE->set_heading(format_string($course->fullname));
+ $canviewallresponses = has_capability('mod/questionnaire:readallresponses', $context);
+ $canviewallresponsesanytime = has_capability('mod/questionnaire:readallresponseanytime', $context);
+ if (!$canviewallresponses && !$canviewallresponsesanytime) {
+ echo $this->renderer->header();
+ throw new \moodle_exception('nopermissions', 'mod_questionnaire');
+ }
+
+ $this->init_rgraph($usergraph);
+
+ $currenttab = match ($action) {
+ 'vallasort' => 'vallasort',
+ 'vallarsort' => 'vallarsort',
+ default => 'valldefault',
+ };
+ if ($outputtarget != 'print') {
+ (new \mod_questionnaire\output\tabs($this->questionnaire, $currenttab, $currentgroupid))->render($page);
+ }
+
+ $respinfo = '';
+ $resps = [];
+ // Enable choose_group if there are questionnaire groups and groupmode is not set to "no groups"
+ // and if there are more groups than 1 (or if user can view all groups).
+ if (is_array($questionnairegroups) && $groupmode > 0) {
+ $groupselect = groups_print_activity_menu($cm, $url->out(), true);
+ // Count number of responses in each group.
+ foreach ($questionnairegroups as $group) {
+ $respscount = $this->questionnaire->count_submissions(false, $group->id);
+ $thisgroupname = groups_get_group_name($group->id);
+ $escapedgroupname = preg_quote($thisgroupname, '/');
+ if (!empty($respscount)) {
+ $groupselect = preg_replace(
+ '/\
' . $escapedgroupname . '<\/option>/',
+ ' ' . $thisgroupname . ' (' . $respscount . ') ',
+ $groupselect
+ );
+ } else {
+ $groupselect = preg_replace(
+ '/\
' . $escapedgroupname . '<\/option>/',
+ '',
+ $groupselect
+ );
+ }
+ }
+ $respinfo .= isset($groupselect) ? ($groupselect . ' ') : '';
+ $currentgroupid = groups_get_activity_group($cm);
+ }
+ if ($currentgroupid > 0) {
+ $groupname = get_string('group') . ': ' . groups_get_group_name($currentgroupid) . ' ';
+ } else {
+ $groupname = '' . $responsestatus[$userview] . ' ';
+ }
+
+ if ($groupmode > 0) {
+ if ($currentgroupid == 0) {
+ $resps = $respsallparticipants;
+ } else {
+ if (!($resps = $this->questionnaire->get_responses(false, $currentgroupid))) {
+ $resps = '';
+ }
+ }
+ } else {
+ $resps = $respsallparticipants;
+ }
+ if (!empty($resps)) {
+ $feedbackmessages = $this->questionnaire->reporter($this->renderer, $page)
+ ->response_analysis(0, $resps, false, false, true, $currentgroupid);
+ if ($feedbackmessages) {
+ $msgout = '';
+ foreach ($feedbackmessages as $msg) {
+ $msgout .= $msg;
+ }
+ $page->add_to_page('feedbackmessages', $msgout);
+ }
+ }
+
+ $params = [
+ 'objectid' => $instance,
+ 'context' => $context,
+ 'courseid' => $course->id,
+ 'other' => ['action' => $action, 'instance' => $instance, 'groupid' => $currentgroupid],
+ ];
+
+ if ($outputtarget == 'pdf') {
+ $pdf = pdf_factory::create();
+ if ($currentgroupid > 0) {
+ $groupname = get_string('group') . ': ' . groups_get_group_name($currentgroupid) . ' ';
+ } else {
+ $groupname = '' . $responsestatus[$userview] . ' ';
+ }
+ $respinfo = get_string('view') . ' ' . $groupname;
+ $strsort = get_string('order_' . $sort, 'questionnaire');
+ $respinfo .= $strsort;
+ $page->add_to_page('respondentinfo', $respinfo);
+ $this->questionnaire->reporter($this->renderer, $page)
+ ->survey_results('', false, true, $currentgroupid, $sort);
+ $html = $this->renderer->render($page);
+
+ // Suppress warnings: TCPF library bug at line 16749 where 'text-align' is not an array.
+ $errorreporting = error_reporting(0);
+ $pdf->writeHTML($html);
+ @$pdf->Output(clean_param($this->questionnaire->name(), PARAM_FILE) . '.pdf', 'D');
+ error_reporting($errorreporting);
+ return;
+ }
+
+ // Default to HTML.
+ $event = \mod_questionnaire\event\all_responses_viewed::create($params);
+ $event->trigger();
+
+ 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',
+ 'responsestats' => $userview,
+ ]
+ );
+ $downpdficon = new \pix_icon('f/pdf', $linkname);
+ $respinfo .= $this->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',
+ 'responsestats' => $userview,
+ ]
+ );
+ $htmlicon = new \pix_icon('t/print', $linkname);
+ $options = [
+ 'menubar' => true,
+ 'location' => false,
+ 'scrollbars' => true,
+ 'resizable' => true,
+ 'height' => 600,
+ 'width' => 800,
+ 'title' => $linkname,
+ ];
+ $popupaction = new \popup_action('click', $link, 'popup', $options);
+ $respinfo .= $this->renderer->action_link(
+ $link,
+ null,
+ $popupaction,
+ ['class' => '', 'title' => $linkname],
+ $htmlicon
+ ) . ' ';
+
+ $respinfo .= $this->renderer->viewresponse_print_menu($url->out(), $responsestatus, $userview);
+ $strsort = get_string('order_' . $sort, 'questionnaire');
+ $respinfo .= $strsort;
+ $respinfo .= $this->renderer->help_icon('orderresponses', 'questionnaire');
+ $page->add_to_page('respondentinfo', $respinfo);
+ }
+
+ $this->questionnaire->reporter($this->renderer, $page)
+ ->survey_results('', false, false, $currentgroupid, $sort);
+
+ echo $this->renderer->header();
+ echo $this->renderer->render($page);
+ echo $this->renderer->footer($course);
+ }
+
+ /**
+ * Render the "view individual response" page (vresp / default arm).
+ *
+ * @param object $page Templatable report page.
+ * @param string $outputtarget 'html' or 'pdf'.
+ * @param \moodle_url $url Base URL for the current page.
+ * @param int $groupmode Activity group mode.
+ * @param int $currentgroupid Active group filter id.
+ * @param array $respsallparticipants All-participant responses (pre-fetched).
+ * @param int|false $rid Active response id, or false when not specified.
+ * @param bool $byresponse True if browsing the response summary tab.
+ * @param bool $individualresponse True if viewing a single response.
+ * @param bool $usergraph Whether to inject RGraph JS for chart rendering.
+ * @param string $userview The 'responsestats' filter.
+ * @param array $responsestatus Map of response-status labels.
+ * @return void
+ */
+ public function view_individual_response(
+ object $page,
+ string $outputtarget,
+ \moodle_url $url,
+ int $groupmode,
+ int $currentgroupid,
+ array $respsallparticipants,
+ $rid,
+ bool $byresponse,
+ bool $individualresponse,
+ bool $usergraph,
+ string $userview,
+ array $responsestatus
+ ): void {
+ global $PAGE;
+
+ $course = $this->questionnaire->course();
+ $cm = $this->questionnaire->coursemodule();
+
+ if (!$this->questionnaire->survey()) {
+ throw new \moodle_exception('surveynotexists', 'mod_questionnaire');
+ } else if ($this->questionnaire->survey()->owning_courseid() != $course->id) {
+ throw new \moodle_exception('surveyowner', 'mod_questionnaire');
+ }
+ $noresponses = false;
+ $this->init_rgraph($usergraph);
+
+ if ($groupmode > 0) {
+ $groupselect = groups_print_activity_menu($cm, $url->out(), true);
+ $page->add_to_page('respondentinfo', $groupselect);
+ $currentgroupid = groups_get_activity_group($cm);
+ }
+
+ $resps = [];
+ if ($byresponse || $rid) {
+ if ($groupmode > 0) {
+ if ($currentgroupid == 0) {
+ $resps = $respsallparticipants;
+ } else {
+ $resps = $this->questionnaire->get_responses(false, $currentgroupid);
+ }
+ if (empty($resps)) {
+ $noresponses = true;
+ } else if ($rid === false) {
+ $rid = current($resps)->id;
+ }
+ } else {
+ $resps = $respsallparticipants;
+ }
+ }
+ $rids = array_keys($resps);
+ if (!$rid && !$noresponses) {
+ $rid = $rids[0];
+ }
+
+ if ($outputtarget == 'pdf') {
+ $pdf = pdf_factory::create();
+ if (!$byresponse) {
+ $this->questionnaire->reporter($this->renderer, $page)
+ ->view_response($rid, '', $resps, true, true, false, $currentgroupid, $outputtarget);
+ }
+ $html = $this->renderer->render($page);
+
+ // Suppress warnings: TCPF library bug at line 16749 where 'text-align' is not an array.
+ $errorreporting = error_reporting(0);
+ $pdf->writeHTML($html);
+ @$pdf->Output(clean_param($this->questionnaire->name(), PARAM_FILE), 'D');
+ error_reporting($errorreporting);
+ return;
+ }
+
+ // Default to HTML.
+ if ($noresponses) {
+ $page->add_to_page(
+ 'respondentinfo',
+ get_string('group') . ' ' .
+ groups_get_group_name($currentgroupid) . ' : ' . get_string('noresponses', 'questionnaire')
+ );
+ }
+
+ $PAGE->set_title(get_string('questionnairereport', 'questionnaire'));
+ $PAGE->set_heading(format_string($course->fullname));
+
+ $currenttab = $individualresponse ? 'individualresp' : ($byresponse ? 'vrespsummary' : 'vresp');
+ if ($outputtarget == 'html') {
+ (new \mod_questionnaire\output\tabs(
+ $this->questionnaire,
+ $currenttab,
+ $currentgroupid,
+ is_int($rid) ? $rid : null
+ ))->render($page);
+ }
+
+ $groupname = get_string('group') . ': ' . groups_get_group_name($currentgroupid) . ' ';
+ if ($currentgroupid == 0) {
+ $groupname = $responsestatus[$userview];
+ }
+ if ($byresponse) {
+ $respinfo = '';
+ $respinfo .= $this->renderer->box_start();
+ $respinfo .= $this->renderer->help_icon('viewindividualresponse', 'questionnaire') . ' ';
+ $respinfo .= get_string('viewindividualresponse', 'questionnaire') . ' : ' . $groupname . ' ';
+ $respinfo .= $this->renderer->box_end();
+ $page->add_to_page('respondentinfo', $respinfo);
+ }
+ if ($outputtarget == 'html') {
+ $this->questionnaire->reporter($this->renderer, $page)
+ ->survey_results_navbar_alpha($rid, $currentgroupid, $byresponse);
+ }
+ if (!$byresponse) {
+ $this->questionnaire->reporter($this->renderer, $page)
+ ->view_response($rid, '', $resps, true, true, false, $currentgroupid, $outputtarget);
+ }
+ echo $this->renderer->header();
+ echo $this->renderer->render($page);
+ echo $this->renderer->footer($course);
+ }
+
+ /**
+ * Queue the RGraph JS files needed by the survey's chart type, if user-side charts are enabled.
+ *
+ * @param bool $usergraph Site-level usergraph setting.
+ * @return void
+ */
+ private function init_rgraph(bool $usergraph): void {
+ global $PAGE;
+
+ if (!$usergraph) {
+ return;
+ }
+ $charttype = $this->questionnaire->survey()->charttype();
+ if (!$charttype) {
+ return;
+ }
+ $PAGE->requires->js('/mod/questionnaire/javascript/RGraph/RGraph.common.core.js');
+ switch ($charttype) {
+ case 'bipolar':
+ $PAGE->requires->js('/mod/questionnaire/javascript/RGraph/RGraph.bipolar.js');
+ break;
+ case 'hbar':
+ $PAGE->requires->js('/mod/questionnaire/javascript/RGraph/RGraph.hbar.js');
+ break;
+ case 'radar':
+ $PAGE->requires->js('/mod/questionnaire/javascript/RGraph/RGraph.radar.js');
+ break;
+ case 'rose':
+ $PAGE->requires->js('/mod/questionnaire/javascript/RGraph/RGraph.rose.js');
+ break;
+ case 'vprogress':
+ $PAGE->requires->js('/mod/questionnaire/javascript/RGraph/RGraph.vprogress.js');
+ break;
+ }
+ }
+}
diff --git a/classes/reporter.php b/classes/reporter.php
new file mode 100644
index 000000000..c61585c89
--- /dev/null
+++ b/classes/reporter.php
@@ -0,0 +1,1973 @@
+.
+
+namespace mod_questionnaire;
+
+use mod_questionnaire\local\feedback\section;
+use mod_questionnaire\local\question\choice;
+use mod_questionnaire\local\question\question;
+use mod_questionnaire\local\question\rate;
+use mod_questionnaire\local\response\questionnaire_responses;
+use html_writer;
+use html_table;
+use stdClass;
+
+/**
+ * Reporting and data-export operations for a questionnaire.
+ *
+ * Owns all logic for generating CSV exports, response analysis, and result
+ * display that was previously spread across the legacy questionnaire class.
+ * Receives a questionnaire instance at construction and reads survey, question,
+ * context, and response data through it.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 onward Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ */
+class reporter {
+ /** @var questionnaire The questionnaire being reported on. */
+ private questionnaire $questionnaire;
+
+ /** @var \plugin_renderer_base|null The plugin renderer used for HTML output paths. */
+ private ?\plugin_renderer_base $renderer;
+
+ /** @var object|null The templatable page that HTML output is written into. */
+ private ?object $page;
+
+ /** @var questionnaire_responses|null Cached response collection shared across methods. */
+ private ?questionnaire_responses $responsecollection = null;
+
+ /**
+ * Construct a reporter for the given questionnaire.
+ *
+ * Render-path methods (view_all_responses, view_response, survey_results,
+ * response_analysis, survey_results_navbar_*) need both a renderer and a
+ * templatable page. CSV/text-only methods (generate_csv) do not.
+ * Callers that only use the CSV path may pass null for both.
+ *
+ * @param questionnaire $questionnaire
+ * @param \plugin_renderer_base|null $renderer Required by render-path methods.
+ * @param object|null $page Templatable page required by render-path methods.
+ */
+ public function __construct(
+ questionnaire $questionnaire,
+ ?\plugin_renderer_base $renderer = null,
+ ?object $page = null,
+ ) {
+ $this->questionnaire = $questionnaire;
+ $this->renderer = $renderer;
+ $this->page = $page;
+ }
+
+ /**
+ * Load all responses for the given user into the shared response store.
+ *
+ * Must be called before view_all_responses() when using the two-step pattern.
+ *
+ * @param int|null $userid Load for this user, or null for the current user.
+ * @return void
+ */
+ public function add_user_responses(?int $userid = null): void {
+ $this->responsecollection()->add_user_responses($userid);
+ }
+
+ /**
+ * Render all loaded responses for display.
+ *
+ * Uses the response collection populated by add_user_responses().
+ *
+ * @return void
+ */
+ public function view_all_responses(): void {
+ $this->print_survey_start('', 1, 1, 0);
+
+ $loadedresponses = $this->responsecollection()->get_loaded_responses();
+ if (!empty($loadedresponses)) {
+ $this->page->add_to_page(
+ 'responses',
+ $this->renderer->all_response_output(
+ $loadedresponses,
+ $this->questionnaire->questions(),
+ $this->questionnaire
+ )
+ );
+ } else {
+ $this->page->add_to_page(
+ 'responses',
+ $this->renderer->all_response_output(get_string('noresponses', 'questionnaire'))
+ );
+ }
+
+ $this->print_survey_end(1, 1);
+ }
+
+ /**
+ * Render aggregate survey results into the page object.
+ *
+ * @param array|string $rids Response id(s) to show ('' or [] = all responses).
+ * @param int|false $uid User id filter (false = all users).
+ * @param bool $pdf True when rendering to PDF.
+ * @param string $currentgroupid Active group filter ('0' or a group id).
+ * @param string $sort Column sort direction for results tables.
+ * @return void
+ */
+ public function survey_results(
+ $rids = '',
+ $uid = false,
+ bool $pdf = false,
+ string $currentgroupid = '',
+ string $sort = ''
+ ): void {
+ global $DB;
+
+ $survey = $this->questionnaire->survey();
+ $questions = $this->questionnaire->questions();
+
+ if (empty($survey) || empty($questions)) {
+ return;
+ }
+
+ if (!empty($rids)) {
+ $ridlist = $rids;
+ } else {
+ $userview = optional_param('responsestats', 0, PARAM_ALPHA);
+ if ($uid !== false) {
+ $rows = $this->questionnaire->get_responses($uid);
+ } else if ($currentgroupid == 0) {
+ $rows = $this->questionnaire->get_responses();
+ } else {
+ $rows = $this->questionnaire->get_responses(false, (int)$currentgroupid);
+ }
+ if (!$rows) {
+ $this->page->add_to_page(
+ 'respondentinfo',
+ $this->renderer->notification(
+ get_string('noresponses', 'questionnaire'),
+ \core\output\notification::NOTIFY_ERROR
+ )
+ );
+ return;
+ }
+ $numresps = count($rows);
+ $respondentstring = get_string('responses', 'questionnaire');
+ if ($userview === 'y') {
+ $respondentstring = get_string('submissions', 'questionnaire');
+ }
+ if (!$userview) {
+ $completedcount = 0;
+ $inprogresscount = 0;
+ foreach ($rows as $row) {
+ if ($row->complete === 'y') {
+ $completedcount++;
+ } else if ($row->complete === 'n') {
+ $inprogresscount++;
+ }
+ }
+ $numresps .= ' ' . get_string(
+ 'responses_breakdown',
+ 'questionnaire',
+ [
+ 'responses' => $completedcount,
+ 'incomplete' => $inprogresscount,
+ ]
+ );
+ }
+ $respondentinfo = ' ' . $respondentstring . ': ' . $numresps . ' ';
+ $this->page->add_to_page('respondentinfo', $respondentinfo);
+ if (empty($rows)) {
+ return;
+ }
+ $ridlist = [];
+ foreach ($rows as $row) {
+ $ridlist[] = $row->id;
+ }
+ }
+
+ if ($survey->title() !== '') {
+ $this->page->add_to_page('title', format_string($survey->title()));
+ }
+ if ($survey->subtitle() !== '') {
+ $this->page->add_to_page('subtitle', format_string($survey->subtitle()));
+ }
+ if ($survey->info() !== '') {
+ $infotext = file_rewrite_pluginfile_urls(
+ $survey->info(),
+ 'pluginfile.php',
+ $this->questionnaire->context()->id,
+ 'mod_questionnaire',
+ 'info',
+ $this->questionnaire->surveyid()
+ );
+ $this->page->add_to_page('addinfo', format_text($infotext, FORMAT_HTML, ['noclean' => true]));
+ }
+
+ $qnum = 0;
+ $anonymous = $this->questionnaire->respondenttype() == 'anonymous';
+
+ $viewsingleresponse = $this->questionnaire->capabilities()->can_view_single_response();
+ $respondenttype = $this->questionnaire->respondenttype();
+ $surveyid = $this->questionnaire->surveyid();
+ foreach ($questions as $question) {
+ if (isset($question->responsetype) && is_object($question->responsetype)) {
+ $question->responsetype->set_display_context($viewsingleresponse, $respondenttype, $surveyid);
+ }
+ if ($question->typeid() == QUESPAGEBREAK) {
+ continue;
+ }
+ if ($question->is_numbered()) {
+ $qnum++;
+ }
+ $displaycontent = $question->content();
+ if ($displaycontent == '
') {
+ $displaycontent = '';
+ }
+ if ($pdf) {
+ $response = new stdClass();
+ if ($this->questionnaire->questions_autonumbered() && $question->is_numbered()) {
+ $response->qnum = $qnum;
+ }
+ $response->qcontent = format_text(
+ file_rewrite_pluginfile_urls(
+ $displaycontent,
+ 'pluginfile.php',
+ $question->context->id,
+ 'mod_questionnaire',
+ 'question',
+ $question->id()
+ ),
+ FORMAT_HTML,
+ ['noclean' => true]
+ );
+ $response->results = $this->renderer->results_output(
+ $question,
+ $ridlist,
+ $sort,
+ $anonymous,
+ $pdf
+ );
+ $this->page->add_to_page('responses', $response);
+ } else {
+ $this->page->add_to_page(
+ 'responses',
+ $this->renderer->container_start('qn-container')
+ );
+ if ($this->questionnaire->questions_autonumbered() && $question->is_numbered()) {
+ $this->page->add_to_page(
+ 'responses',
+ $this->renderer->container_start('qn-info')
+ );
+ $this->page->add_to_page(
+ 'responses',
+ $this->renderer->heading($qnum, 2, 'qn-number')
+ );
+ $this->page->add_to_page(
+ 'responses',
+ $this->renderer->container_end()
+ );
+ }
+ $this->page->add_to_page(
+ 'responses',
+ $this->renderer->container_start('qn-content')
+ );
+ $this->page->add_to_page(
+ 'responses',
+ $this->renderer->container(
+ format_text(
+ file_rewrite_pluginfile_urls(
+ $displaycontent,
+ '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, $ridlist, $sort, $anonymous)
+ );
+ $this->page->add_to_page(
+ 'responses',
+ $this->renderer->container_end()
+ );
+ $this->page->add_to_page(
+ 'responses',
+ $this->renderer->container_end()
+ );
+ }
+ }
+ }
+
+ /**
+ * Render the alphabetical/by-response navigation bar for the report page.
+ *
+ * @param int $currrid Currently displayed response id.
+ * @param int $currentgroupid Active group id (0 = all).
+ * @param bool $byresponse True when showing respondents list rather than nav arrows.
+ * @return void
+ */
+ public function survey_results_navbar_alpha(
+ int $currrid,
+ int $currentgroupid,
+ bool $byresponse
+ ): void {
+ global $CFG;
+ require_once($CFG->dirroot . '/user/lib.php');
+
+ $isfullname = $this->questionnaire->respondenttype() !== 'anonymous';
+ if ($isfullname) {
+ $responses = $this->questionnaire->get_responses(false, $currentgroupid);
+ } else {
+ $responses = $this->questionnaire->get_responses();
+ }
+ if (!$responses) {
+ return;
+ }
+ $total = count($responses);
+ if ($total === 0) {
+ return;
+ }
+
+ $users = [];
+ if ($isfullname) {
+ $userids = array_filter(array_map(fn($r) => (int)$r->userid, $responses));
+ if (!empty($userids)) {
+ $users = user_get_users_by_id(array_values(array_unique($userids)));
+ }
+ }
+
+ $rids = [];
+ $ridssub = [];
+ $ridsuserfullname = [];
+ $ridsuserid = [];
+ $i = 0;
+ $currpos = -1;
+ foreach ($responses as $response) {
+ $rids[] = $response->id;
+ if ($isfullname) {
+ $ridssub[] = $response->submitted;
+ $ridsuserfullname[] = isset($users[$response->userid]) ? fullname($users[$response->userid]) : '';
+ $ridsuserid[] = $response->userid;
+ }
+ if ($response->id == $currrid) {
+ $currpos = $i;
+ }
+ $i++;
+ }
+
+ $url = $CFG->wwwroot . '/mod/questionnaire/report.php?action=vresp&instance='
+ . $this->questionnaire->id() . '&group=' . $currentgroupid . '&individualresponse=1';
+
+ if (!$byresponse) {
+ $navbar = new stdClass();
+ $prevrid = ($currpos > 0) ? $rids[$currpos - 1] : null;
+ $nextrid = ($currpos < $total - 1) ? $rids[$currpos + 1] : null;
+ $firstrid = $rids[0];
+ $lastrid = $rids[$total - 1];
+ if ($prevrid != null) {
+ $pos = $currpos - 1;
+ $firstuserfullname = '';
+ $navbar->firstrespondent = ['url' => ($url . '&rid=' . $firstrid)];
+ $navbar->previous = ['url' => ($url . '&rid=' . $prevrid)];
+ if ($isfullname) {
+ $responsedate = userdate($ridssub[$pos]);
+ $title = $ridsuserfullname[$pos];
+ if ($ridsuserid[$pos] == $ridsuserid[$currpos]) {
+ $title .= ' | ' . $responsedate;
+ }
+ $firstuserfullname = $ridsuserfullname[0];
+ } else {
+ $title = '';
+ }
+ $navbar->firstrespondent['title'] = $firstuserfullname;
+ $navbar->previous['title'] = $title;
+ }
+ $navbar->respnumber = ['currpos' => ($currpos + 1), 'total' => $total];
+ if ($nextrid != null) {
+ $pos = $currpos + 1;
+ $lastuserfullname = '';
+ $navbar->lastrespondent = ['url' => ($url . '&rid=' . $lastrid)];
+ $navbar->next = ['url' => ($url . '&rid=' . $nextrid)];
+ if ($isfullname) {
+ $responsedate = userdate($ridssub[$pos]);
+ $title = $ridsuserfullname[$pos];
+ if ($ridsuserid[$pos] == $ridsuserid[$currpos]) {
+ $title .= ' | ' . $responsedate;
+ }
+ $lastuserfullname = $ridsuserfullname[$total - 1];
+ } else {
+ $title = '';
+ }
+ $navbar->lastrespondent['title'] = $lastuserfullname;
+ $navbar->next['title'] = $title;
+ }
+ $url = $CFG->wwwroot . '/mod/questionnaire/report.php?action=vresp&byresponse=1&instance='
+ . $this->questionnaire->id() . '&group=' . $currentgroupid;
+ $navbar->listlink = $url;
+
+ $linkname = ' ' . get_string('print', 'questionnaire');
+ $printurl = '/mod/questionnaire/print.php?qid=' . $this->questionnaire->id() .
+ '&rid=' . $currrid . '&courseid=' . $this->questionnaire->courseid() . '&sec=1';
+ $title = get_string('printtooltip', 'questionnaire');
+ $options = [
+ 'menubar' => true,
+ 'location' => false,
+ 'scrollbars' => true,
+ 'resizable' => true,
+ 'height' => 600,
+ 'width' => 800,
+ ];
+ $action = new \popup_action('click', new \moodle_url($printurl), 'popup', $options);
+ $navbar->printaction = $this->renderer->action_link(
+ new \moodle_url($printurl),
+ $linkname,
+ $action,
+ ['title' => $title],
+ new \pix_icon('t/print', $title)
+ );
+ $this->page->add_to_page(
+ 'navigationbar',
+ $this->renderer->navigationbar($navbar)
+ );
+ } else {
+ $resparr = [];
+ for ($i = 0; $i < $total; $i++) {
+ if ($isfullname) {
+ $responsedate = userdate($ridssub[$i]);
+ $resparr[] = '' . $ridsuserfullname[$i] . ' ';
+ } else {
+ $resparr[] = '' .
+ get_string('response', 'questionnaire') . ($i + 1) . ' ';
+ }
+ }
+ $entries = count($resparr);
+ $maxlines = 20;
+ $maxcols = 3;
+ if ($entries >= $maxlines) {
+ $colnumber = min(intval($entries / $maxlines), $maxcols);
+ } else {
+ $colnumber = 1;
+ }
+ $lines = 0;
+ $a = 0;
+ while ($entries / $colnumber > 1) {
+ $lines++;
+ $entries = $entries - $colnumber;
+ }
+ $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++;
+ }
+ if ($entries) {
+ $respcols->{$colname}->respondentlink[] = $resparr[$a];
+ $entries--;
+ $a++;
+ }
+ }
+ $this->page->add_to_page(
+ 'responses',
+ $this->renderer->responselist($respcols)
+ );
+ }
+ }
+
+ /**
+ * Render the student response navigation bar for myreport/report pages.
+ *
+ * @param int $currrid Currently displayed response id.
+ * @param int $userid User whose responses are being navigated.
+ * @param int $instance Questionnaire instance id (for URL construction).
+ * @param array $resps All responses to navigate across.
+ * @param string $reporttype 'myreport' or 'report'.
+ * @param string $sid Survey id (used in report mode URLs).
+ * @return void
+ */
+ public function survey_results_navbar_student(
+ int $currrid,
+ int $userid,
+ int $instance,
+ array $resps,
+ string $reporttype = 'myreport',
+ string $sid = ''
+ ): void {
+ global $DB;
+
+ $stranonymous = get_string('anonymous', 'questionnaire');
+ $total = count($resps);
+ $rids = [];
+ $ridssub = [];
+ $ridsusers = [];
+ $i = 0;
+ $currpos = -1;
+ foreach ($resps as $response) {
+ $rids[] = $response->id;
+ $ridssub[] = $response->submitted;
+ $ruser = '';
+ if ($reporttype === 'report') {
+ if ($this->questionnaire->respondenttype() !== 'anonymous') {
+ if ($user = $DB->get_record('user', ['id' => $response->userid])) {
+ $ruser = ' | ' . fullname($user);
+ }
+ } else {
+ $ruser = ' | ' . $stranonymous;
+ }
+ }
+ $ridsusers[] = $ruser;
+ if ($response->id == $currrid) {
+ $currpos = $i;
+ }
+ $i++;
+ }
+
+ $prevrid = ($currpos > 0) ? $rids[$currpos - 1] : null;
+ $nextrid = ($currpos < $total - 1) ? $rids[$currpos + 1] : null;
+
+ if ($reporttype === 'myreport') {
+ $url = 'myreport.php?instance=' . $instance . '&user=' . $userid .
+ '&action=vresp&byresponse=1&individualresponse=1';
+ } else {
+ $url = 'report.php?instance=' . $instance . '&user=' . $userid .
+ '&action=vresp&byresponse=1&individualresponse=1&sid=' . $sid;
+ }
+
+ $navbar = new stdClass();
+ $displaypos = 1;
+ if ($prevrid !== null) {
+ $title = userdate($ridssub[$currpos - 1]) . $ridsusers[$currpos - 1];
+ $navbar->previous = ['url' => ($url . '&rid=' . $prevrid), 'title' => $title];
+ }
+ for ($i = 0; $i < $currpos; $i++) {
+ $title = userdate($ridssub[$i]) . $ridsusers[$i];
+ $navbar->prevrespnumbers[] = [
+ 'url' => ($url . '&rid=' . $rids[$i]),
+ 'title' => $title,
+ 'respnumber' => $displaypos,
+ ];
+ $displaypos++;
+ }
+ $navbar->currrespnumber = $displaypos;
+ for (++$i; $i < $total; $i++) {
+ $displaypos++;
+ $title = userdate($ridssub[$i]) . $ridsusers[$i];
+ $navbar->nextrespnumbers[] = [
+ 'url' => ($url . '&rid=' . $rids[$i]),
+ 'title' => $title,
+ 'respnumber' => $displaypos,
+ ];
+ }
+ if ($nextrid !== null) {
+ $title = userdate($ridssub[$currpos + 1]) . $ridsusers[$currpos + 1];
+ $navbar->next = ['url' => ($url . '&rid=' . $nextrid), 'title' => $title];
+ }
+ $this->page->add_to_page(
+ 'navigationbar',
+ $this->renderer->usernavigationbar($navbar)
+ );
+ $this->page->add_to_page(
+ 'bottomnavigationbar',
+ $this->renderer->usernavigationbar($navbar)
+ );
+ }
+
+ /**
+ * Generate CSV export data for all (or filtered) responses.
+ *
+ * Returns a 2-D array where row 0 is the column header row and subsequent
+ * rows are individual response data rows.
+ *
+ * @param int $currentgroupid Group id filter (0 = all groups).
+ * @param string $rid Response id filter ('' = all).
+ * @param int|string $userid User id filter ('' = all).
+ * @param int|null $choicecodes Include numeric choice codes in output.
+ * @param int $choicetext Include choice text in output.
+ * @param int $showincompletes Include incomplete responses.
+ * @param int $rankaverages Append a row of rank-question averages.
+ * @return array Rows of CSV data; row 0 is the header row.
+ */
+ public function generate_csv(
+ int $currentgroupid = 0,
+ string $rid = '',
+ $userid = '',
+ ?int $choicecodes = null,
+ int $choicetext = 1,
+ int $showincompletes = 0,
+ int $rankaverages = 0
+ ): array {
+ global $DB;
+
+ raise_memory_limit('1G');
+
+ $questions = $this->questionnaire->questions();
+ $output = [];
+ $stringother = get_string('other', 'questionnaire');
+
+ $config = get_config('questionnaire', 'downloadoptions');
+ $options = empty($config) ? [] : explode(',', $config);
+ if ($showincompletes == 1) {
+ $options[] = 'complete';
+ }
+ $columns = [];
+ $types = [];
+ foreach ($options as $option) {
+ if (in_array($option, ['response', 'submitted', 'id', 'useridnumber'])) {
+ $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 = [
+ '0', // 0: unused
+ '0', // 1: bool -> boolean
+ '1', // 2: text -> string
+ '1', // 3: essay -> string
+ '0', // 4: radio -> string
+ '0', // 5: check -> string
+ '0', // 6: dropdn -> string
+ '0', // 7: rating -> number
+ '0', // 8: rate -> number
+ '1', // 9: date -> string
+ '0', // 10: numeric -> number.
+ '0', // 11: slider -> number.
+ ];
+
+ $sid = $this->questionnaire->surveyid();
+ if (!$DB->get_record('questionnaire_survey', ['id' => $sid])) {
+ throw new \moodle_exception('surveynotexists', 'mod_questionnaire');
+ }
+
+ // Get all responses for this survey in one go.
+ $allresponsesrs = $this->questionnaire->responses()->get_survey_all_responses(
+ $rid,
+ $userid,
+ $currentgroupid,
+ $showincompletes
+ );
+
+ // Do we have any questions of type RADIO, DROP, CHECKBOX OR RATE?
+ $choicetypes = question::typeids_with_choices();
+
+ // Get unique list of question types used in this survey.
+ $uniquetypes = $this->get_survey_questiontypes();
+
+ if (count(array_intersect($choicetypes, $uniquetypes)) > 0) {
+ $choiceparams = [$sid];
+ $choicesql = "
+ SELECT DISTINCT c.id as cid, q.id as qid, q.precise AS precise, q.name, c.content
+ FROM {questionnaire_question} q
+ JOIN {questionnaire_quest_choice} c ON questionid = q.id
+ WHERE q.surveyid = ? ORDER BY cid ASC
+ ";
+ $choicerecords = $DB->get_records_sql($choicesql, $choiceparams);
+ $choicesbyqid = [];
+ if (!empty($choicerecords)) {
+ foreach ($choicerecords as $choicerecord) {
+ if (!isset($choicesbyqid[$choicerecord->qid])) {
+ $choicesbyqid[$choicerecord->qid] = [];
+ }
+ $choicesbyqid[$choicerecord->qid][$choicerecord->cid] = $choicerecord;
+ }
+ }
+ }
+
+ $num = 1;
+
+ $questionidcols = [];
+
+ foreach ($questions as $question) {
+ // Skip questions that aren't response capable.
+ if (!isset($question->responsetype)) {
+ continue;
+ }
+ $qid = $question->id();
+ $qpos = $question->position();
+ $col = $question->name();
+ $type = $question->typeid();
+ if (in_array($type, $choicetypes)) {
+ if (!isset($choicesbyqid[$qid])) {
+ throw new \coding_exception('Choice question has no choices!', 'question id ' . $qid . ' of type ' . $type);
+ }
+ $choices = $choicesbyqid[$qid];
+
+ switch ($type) {
+ case QUESRADIO:
+ case QUESDROP:
+ $columns[][$qpos] = $col;
+ $questionidcols[][$qpos] = $qid;
+ array_push($types, $idtocsvmap[$type]);
+ $thisnum = 1;
+ foreach ($choices as $choicerecord) {
+ $content = $choicerecord->content;
+ if (choice::content_is_other_choice($content)) {
+ $col = $choicerecord->name . '_' . $stringother;
+ $columns[][$qpos] = $col;
+ $questionidcols[][$qpos] = null;
+ array_push($types, '0');
+ }
+ }
+ break;
+
+ case QUESCHECK:
+ $thisnum = 1;
+ foreach ($choices as $choicerecord) {
+ $content = $choicerecord->content;
+ $modality = '';
+ $contents = question::parse_choice_content($content);
+ if ($contents->modname) {
+ $modality = $contents->modname;
+ } else if ($contents->title) {
+ $modality = $contents->title;
+ } else {
+ $modality = strip_tags($contents->text);
+ }
+ $col = $choicerecord->name . '->' . $modality;
+ $columns[][$qpos] = $col;
+ $questionidcols[][$qpos] = $qid . '_' . $choicerecord->cid;
+ array_push($types, '0');
+ if (choice::content_is_other_choice($content)) {
+ $content = $stringother;
+ $col = $choicerecord->name . '->[' . $content . ']';
+ $columns[][$qpos] = $col;
+ $questionidcols[][$qpos] = null;
+ array_push($types, '0');
+ }
+ }
+ break;
+
+ case QUESRATE:
+ foreach ($choices as $choicerecord) {
+ $nameddegrees = 0;
+ $modality = '';
+ $content = $choicerecord->content;
+ $osgood = false;
+ if (rate::type_is_osgood_rate_scale($choicerecord->precise)) {
+ $osgood = true;
+ }
+ if (preg_match("/^[0-9]{1,3}=/", $content, $ndd)) {
+ $nameddegrees++;
+ } else {
+ if ($osgood) {
+ [$contentleft, $contentright] = array_merge(preg_split('/[|]/', $content), [' ']);
+ $contents = question::parse_choice_content($contentleft);
+ if ($contents->title) {
+ $contentleft = $contents->title;
+ }
+ $contents = question::parse_choice_content($contentright);
+ if ($contents->title) {
+ $contentright = $contents->title;
+ }
+ $modality = strip_tags($contentleft . '|' . $contentright);
+ $modality = preg_replace("/[\r\n\t]/", ' ', $modality);
+ } else {
+ $contents = question::parse_choice_content($content);
+ if ($contents->modname) {
+ $modality = $contents->modname;
+ } else if ($contents->title) {
+ $modality = $contents->title;
+ } else {
+ $modality = strip_tags($contents->text);
+ $modality = preg_replace("/[\r\n\t]/", ' ', $modality);
+ }
+ }
+ $col = $choicerecord->name . '->' . $modality;
+ $columns[][$qpos] = $col;
+ $questionidcols[][$qpos] = $qid . '_' . $choicerecord->cid;
+ array_push($types, $idtocsvmap[$type]);
+ }
+ }
+ break;
+ }
+ } else {
+ $columns[][$qpos] = $col;
+ $questionidcols[][$qpos] = $qid;
+ array_push($types, $idtocsvmap[$type]);
+ }
+ $num++;
+ }
+
+ array_push($output, $columns);
+ $numrespcols = count($output[0]);
+
+ // Flatten questionidcols.
+ $tmparr = [];
+ for ($c = 0; $c < $nbinfocols; $c++) {
+ $tmparr[] = null;
+ }
+ foreach ($questionidcols as $i => $positions) {
+ foreach ($positions as $position => $qid) {
+ $tmparr[] = $qid;
+ }
+ }
+ $questionidcols = $tmparr;
+
+ // Create array of question positions hashed by question / question + choiceid.
+ $questionpositions = [];
+ $questionsbyposition = [];
+ $p = 0;
+ foreach ($questionidcols as $qid) {
+ if ($qid === null) {
+ $p++;
+ continue;
+ }
+ $questionpositions[$qid] = $p;
+ if (strpos($qid, '_') !== false) {
+ $tmparr = explode('_', $qid);
+ $questionid = $tmparr[0];
+ } else {
+ $questionid = $qid;
+ }
+ $questionsbyposition[$p] = $questions[$questionid];
+ $p++;
+ }
+
+ $formatoptions = new stdClass();
+ $formatoptions->filter = false;
+
+ if ($rankaverages) {
+ $averages = [];
+ $rids = [];
+ $allresponsesrs2 = $this->questionnaire->responses()->get_survey_all_responses($rid, $userid, $currentgroupid);
+ foreach ($allresponsesrs2 as $responserow) {
+ if (!isset($rids[$responserow->rid])) {
+ $rids[$responserow->rid] = $responserow->rid;
+ }
+ }
+ }
+
+ $prevresprow = false;
+ $row = [];
+ if ($rankaverages) {
+ $averagerow = [];
+ }
+ $useridentityfields = [];
+ foreach ($allresponsesrs as $responserow) {
+ $rid = $responserow->rid;
+ $qid = $responserow->questionid;
+
+ // Ignore responses for deleted questions.
+ if (!isset($questions[$qid])) {
+ continue;
+ }
+
+ if (!empty($identityfields)) {
+ if (isset($useridentityfields[$responserow->userid])) {
+ $customfields = $useridentityfields[$responserow->userid];
+ } else {
+ $customfields = self::get_user_identity_fields($this->questionnaire->context(), $responserow->userid);
+ $useridentityfields[$responserow->userid] = $customfields;
+ }
+ foreach ($identityfields as $field) {
+ $responserow->{$field} = $customfields->{$field};
+ }
+ }
+
+ $question = $questions[$qid];
+ $qtype = intval($question->typeid());
+ if ($rankaverages) {
+ if ($qtype === QUESRATE) {
+ if (empty($averages[$qid])) {
+ $results = $questions[$qid]->responsetype->get_results($rids);
+ foreach ($results as $qresult) {
+ $averages[$qid][$qresult->id] = $qresult->average;
+ }
+ }
+ }
+ }
+ $questionobj = $questions[$qid];
+
+ if ($prevresprow !== false && $prevresprow->rid !== $rid) {
+ $output[] = $this->process_csv_row(
+ $row,
+ $prevresprow,
+ $currentgroupid,
+ $questionsbyposition,
+ $nbinfocols,
+ $numrespcols,
+ $options,
+ $identityfields
+ );
+ $row = [];
+ }
+
+ if ($qtype === QUESRATE || $qtype === QUESCHECK) {
+ $key = $qid . '_' . $responserow->choiceid;
+ $position = $questionpositions[$key];
+ if ($qtype === QUESRATE) {
+ $choicetxt = $responserow->rankvalue;
+ if ($rankaverages) {
+ $averagerow[$position] = $averages[$qid][$responserow->choiceid];
+ }
+ } else {
+ $content = $choicesbyqid[$qid][$responserow->choiceid]->content;
+ if (choice::content_is_other_choice($content)) {
+ $row[$position + 1] = $responserow->response;
+ $choicetxt = empty($responserow->choiceid) ? '0' : '1';
+ } else if (!empty($responserow->choiceid)) {
+ $choicetxt = '1';
+ } else {
+ $choicetxt = '0';
+ }
+ }
+ $responsetxt = $choicetxt;
+ $row[$position] = $responsetxt;
+ } else {
+ $position = $questionpositions[$qid];
+ if ($questionobj->has_choices()) {
+ $c = 0;
+ if (in_array(intval($question->typeid()), $choicetypes)) {
+ $choices = $choicesbyqid[$qid];
+ foreach ($choices as $choicerecord) {
+ $c++;
+ if ($responserow->choiceid === $choicerecord->cid) {
+ break;
+ }
+ }
+ }
+
+ $content = $choicesbyqid[$qid][$responserow->choiceid]->content;
+ if (choice::content_is_other_choice($content)) {
+ $responsetxt = choice::content_other_choice_display($content);
+ $responsetxt1 = $responserow->response;
+ } else if (($choicecodes == 1) && ($choicetext == 1)) {
+ $responsetxt = $c . ' : ' . $content;
+ } else if ($choicecodes == 1) {
+ $responsetxt = $c;
+ } else {
+ $responsetxt = $content;
+ }
+ } else if (intval($qtype) === QUESYESNO) {
+ $responsetxt = $responserow->response === 'y' ? "1" : "0";
+ } else {
+ $responsetxt = $responserow->response;
+ if (!empty($responsetxt)) {
+ $responsetxt = strip_tags($responsetxt);
+ $responsetxt = preg_replace("/[\r\n\t]/", ' ', $responsetxt);
+ }
+ }
+ $row[$position] = $responsetxt;
+ if (!empty($responsetxt1)) {
+ $responsetxt1 = preg_replace("/[\r\n\t]/", ' ', $responsetxt1);
+ $row[$position + 1] = $responsetxt1;
+ unset($responsetxt1);
+ }
+ }
+
+ $prevresprow = $responserow;
+ }
+
+ if ($prevresprow !== false) {
+ $output[] = $this->process_csv_row(
+ $row,
+ $prevresprow,
+ $currentgroupid,
+ $questionsbyposition,
+ $nbinfocols,
+ $numrespcols,
+ $options,
+ $identityfields
+ );
+ }
+
+ if ($rankaverages) {
+ $summaryrow = [];
+ $summaryrow[0] = get_string('averagesrow', 'questionnaire');
+ for ($i = 1; $i < $nbinfocols; $i++) {
+ $summaryrow[$i] = '';
+ }
+ for ($i = $nbinfocols; $i < $numrespcols; $i++) {
+ $summaryrow[$i] = isset($averagerow[$i]) ? $averagerow[$i] : '';
+ }
+ $output[] = $summaryrow;
+ }
+
+ // Rewrite column headers to include question numbers.
+ $numquestion = 0;
+ $oldkey = 0;
+ for ($i = $nbinfocols; $i < $numrespcols; $i++) {
+ $sep = '';
+ $thisoutput = current($output[0][$i]);
+ $thiskey = key($output[0][$i]);
+ if (strstr($thisoutput, '->.')) {
+ $thisoutput = str_replace('->.', '', $thisoutput);
+ }
+ if (
+ $thisoutput == '' ||
+ strstr($thisoutput, '->.') ||
+ substr($thisoutput, 0, 2) == '->' ||
+ substr($thisoutput, 0, 1) == '_'
+ ) {
+ $sep = '';
+ } else {
+ $sep = '_';
+ }
+ if ($thiskey > $oldkey) {
+ $oldkey = $thiskey;
+ $numquestion++;
+ }
+ $pos = strpos($thisoutput, '=');
+ if ($pos) {
+ $thisoutput = substr($thisoutput, 0, $pos);
+ }
+ $out = 'Q' . sprintf("%02d", $numquestion) . $sep . $thisoutput;
+ $output[0][$i] = $out;
+ }
+ return $output;
+ }
+
+ /**
+ * Render all question responses for a single response to the page.
+ *
+ * Writes respondent info, feedback messages, feedback notes, and per-question
+ * response output into the page object.
+ *
+ * @param int $rid Response id to display.
+ * @param string $referer 'print' suppresses feedback; other values allow it.
+ * @param array|string $resps Responses used for feedback comparison.
+ * @param bool $compare True when comparing individual response against group.
+ * @param bool $isgroupmember True when the viewing user is a group member.
+ * @param bool $allresponses True when all responses are included.
+ * @param int $currentgroupid Active group filter id (0 = all).
+ * @param string $outputtarget 'html' or 'pdf'.
+ * @return void
+ */
+ public function view_response(
+ int $rid,
+ string $referer = '',
+ $resps = '',
+ bool $compare = false,
+ bool $isgroupmember = false,
+ bool $allresponses = false,
+ int $currentgroupid = 0,
+ string $outputtarget = 'html'
+ ): void {
+ $this->print_survey_start('', 1, 1, 0, $rid, false, $outputtarget);
+
+ $i = 0;
+ $responses = $this->responsecollection();
+ $responses->add_response($rid);
+ if ($referer != 'print') {
+ $feedbackmessages = $this->response_analysis($rid, $resps, $compare, $isgroupmember, $allresponses, $currentgroupid);
+
+ if ($feedbackmessages) {
+ $msgout = '';
+ foreach ($feedbackmessages as $msg) {
+ $msgout .= $msg;
+ }
+ $this->page->add_to_page('feedbackmessages', $msgout);
+ }
+
+ $survey = $this->questionnaire->survey();
+ if ($survey->feedbacknotes()) {
+ $text = file_rewrite_pluginfile_urls(
+ $survey->feedbacknotes(),
+ 'pluginfile.php',
+ $this->questionnaire->context()->id,
+ 'mod_questionnaire',
+ 'feedbacknotes',
+ $this->questionnaire->surveyid()
+ );
+ $this->page->add_to_page(
+ 'feedbacknotes',
+ $this->renderer->box(format_text($text, FORMAT_HTML))
+ );
+ }
+ }
+ $pdf = ($outputtarget == 'pdf') ? true : false;
+ $questions = $this->questionnaire->questions();
+ foreach ($questions as $question) {
+ if (!$question->dependency_fulfilled($rid, $questions)) {
+ continue;
+ }
+ if ($question->typeid() < QUESPAGEBREAK) {
+ $i++;
+ }
+ if ($question->typeid() != QUESPAGEBREAK) {
+ $this->page->add_to_page(
+ 'responses',
+ $this->renderer->response_output(
+ $question,
+ $responses->get_response($rid),
+ $i,
+ $pdf,
+ $this->questionnaire,
+ true
+ )
+ );
+ }
+ }
+ }
+
+ /**
+ * Analyse responses and return feedback messages for this questionnaire.
+ *
+ * Returns an empty string when the survey has no feedback sections configured,
+ * or an array of HTML fragment strings when feedback data exists.
+ *
+ * @param int $rid Response id of the individual response being viewed (0 for all).
+ * @param array $resps All response objects keyed by response id.
+ * @param bool $compare True when comparing individual response against group.
+ * @param bool $isgroupmember True when the viewing user is a group member.
+ * @param bool $allresponses True when all responses are included (not just one).
+ * @param int $currentgroupid Active group filter id (0 = all).
+ * @param array|null $filteredsections Restrict output to these section numbers (null = all).
+ * @return array|string Feedback message strings, or '' when no feedback is configured.
+ */
+ public function response_analysis(
+ int $rid,
+ array $resps,
+ bool $compare,
+ bool $isgroupmember,
+ bool $allresponses,
+ int $currentgroupid,
+ ?array $filteredsections = null
+ ) {
+ global $DB, $CFG;
+ require_once($CFG->libdir . '/tablelib.php');
+ require_once($CFG->dirroot . '/mod/questionnaire/drawchart.php');
+
+ $sql = "SELECT * FROM {questionnaire_fb_sections} WHERE surveyid = ? AND section IS NOT NULL";
+ if (!$fbsections = $DB->get_records_sql($sql, [$this->questionnaire->surveyid()])) {
+ return '';
+ }
+
+ $action = optional_param('action', 'vall', PARAM_ALPHA);
+
+ $resp = $DB->get_record('questionnaire_response', ['id' => $rid]);
+ if (!empty($resp)) {
+ $userid = $resp->userid;
+ $user = $DB->get_record('user', ['id' => $userid]);
+ if (!empty($user)) {
+ if ($this->questionnaire->respondenttype() == 'anonymous') {
+ $ruser = '- ' . get_string('anonymous', 'questionnaire') . ' -';
+ } else {
+ $ruser = fullname($user);
+ }
+ }
+ }
+
+ $groupmode = groups_get_activity_groupmode($this->questionnaire->coursemodule(), $this->questionnaire->course());
+ $groupname = get_string('allparticipants');
+ if ($groupmode > 0) {
+ if ($currentgroupid > 0) {
+ $groupname = groups_get_group_name($currentgroupid);
+ } else {
+ $groupname = get_string('allparticipants');
+ }
+ }
+
+ $survey = $this->questionnaire->survey();
+ if ($survey->feedbackscores()) {
+ $table = new html_table();
+ $table->size = [null, null];
+ $table->align = ['left', 'right', 'right'];
+ $table->head = [];
+ $table->wrap = [];
+ if ($compare) {
+ $table->head = [get_string('feedbacksection', 'questionnaire'), $ruser, $groupname];
+ } else {
+ $table->head = [get_string('feedbacksection', 'questionnaire'), $groupname];
+ }
+ }
+
+ $fbsectionsnb = array_keys($fbsections);
+ $numsections = count($fbsections);
+
+ $rids = [];
+ foreach ($resps as $key => $resp) {
+ $rids[] = $key;
+ }
+ $nbparticipants = count($rids);
+ $responsescores = [];
+
+ $qmax = [];
+ $maxtotalscore = 0;
+ $questions = $this->questionnaire->questions();
+ foreach ($questions as $question) {
+ $qid = $question->id();
+ if ($question->valid_feedback()) {
+ $qmax[$qid] = $question->get_feedback_maxscore();
+ $maxtotalscore += $qmax[$qid];
+ $responsescores[$qid] = $question->get_feedback_scores($rids);
+ }
+ }
+ if ($maxtotalscore === 0) {
+ return '';
+ }
+ $feedbackmessages = [];
+
+ $qscore = [];
+ $allqscore = [];
+
+ if (!$allresponses && $groupmode != 0) {
+ $nbparticipants = max(1, $nbparticipants - !$isgroupmember);
+ }
+ foreach ($responsescores as $qid => $responsescore) {
+ if (!empty($responsescore)) {
+ foreach ($responsescore as $rrid => $response) {
+ if ($rrid == $rid || $allresponses) {
+ if (!isset($qscore[$qid])) {
+ $qscore[$qid] = 0;
+ }
+ $qscore[$qid] = $response->score;
+ }
+ if (!isset($allqscore[$qid])) {
+ $allqscore[$qid] = 0;
+ }
+ if ($groupmode == 0 || $isgroupmember || (!$isgroupmember && $rrid != $rid) || $allresponses) {
+ $allqscore[$qid] += $response->score;
+ }
+ }
+ }
+ }
+ $totalscore = array_sum($qscore);
+ $scorepercent = round($totalscore / $maxtotalscore * 100);
+ $oppositescorepercent = 100 - $scorepercent;
+ $alltotalscore = array_sum($allqscore);
+ $allscorepercent = round($alltotalscore / $nbparticipants / $maxtotalscore * 100);
+
+ if ($survey->feedbacksections() == 1) {
+ $sectionid = $fbsectionsnb[0];
+ $sectionlabel = $fbsections[$sectionid]->sectionlabel;
+ $sectionheading = $fbsections[$sectionid]->sectionheading;
+ $labels = [];
+ 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',
+ 'sectionid = ? AND minscore <= ? AND ? < maxscore',
+ [$sectionid, $scorepercent, $scorepercent]
+ );
+
+ $sectionheading = str_replace('%', '', $sectionheading);
+ $original = ['$scorepercent', '$oppositescorepercent'];
+ $result = ['%s%%', '%s%%'];
+ $sectionheading = str_replace($original, $result, $sectionheading);
+ $sectionheading = sprintf($sectionheading, $scorepercent, $oppositescorepercent);
+ $sectionheading = file_rewrite_pluginfile_urls(
+ $sectionheading,
+ 'pluginfile.php',
+ $this->questionnaire->context()->id,
+ 'mod_questionnaire',
+ 'sectionheading',
+ $sectionid
+ );
+ $feedbackmessages[] = $this->renderer->box_start();
+ $feedbackmessages[] = format_text($sectionheading, FORMAT_HTML, ['noclean' => true]);
+ $feedbackmessages[] = $this->renderer->box_end();
+
+ if (!empty($feedback->feedbacktext)) {
+ $formatoptions = new stdClass();
+ $formatoptions->noclean = true;
+ $feedbacktext = file_rewrite_pluginfile_urls(
+ $feedback->feedbacktext,
+ 'pluginfile.php',
+ $this->questionnaire->context()->id,
+ 'mod_questionnaire',
+ 'feedback',
+ $feedback->id
+ );
+ $feedbacktext = format_text($feedbacktext, $feedback->feedbacktextformat, $formatoptions);
+ $feedbackmessages[] = $this->renderer->box_start();
+ $feedbackmessages[] = $feedbacktext;
+ $feedbackmessages[] = $this->renderer->box_end();
+ }
+ $score = [$scorepercent, 100 - $scorepercent];
+ $allscore = null;
+ if ($compare || $allresponses) {
+ $allscore = [$allscorepercent, 100 - $allscorepercent];
+ }
+ $usergraph = get_config('questionnaire', 'usergraph');
+ if ($usergraph && $survey->charttype()) {
+ $this->page->add_to_page(
+ 'feedbackcharts',
+ draw_chart(
+ $feedbacktype = 'global',
+ $labels,
+ $groupname,
+ $allresponses,
+ $survey->charttype(),
+ $score,
+ $allscore,
+ $sectionlabel
+ )
+ );
+ }
+ $lb = explode("|", $sectionlabel);
+ $oppositescore = '';
+ $oppositeallscore = '';
+ if (count($lb) > 1) {
+ $sectionlabel = $lb[0] . ' | ' . $lb[1];
+ $oppositescore = ' | ' . $score[1] . '%';
+ $oppositeallscore = ' | ' . $allscore[1] . '%';
+ }
+ if ($survey->feedbackscores()) {
+ $table = $table ?? new html_table();
+ if ($compare) {
+ $table->data[] = [$sectionlabel, $score[0] . '%' . $oppositescore, $allscore[0] . '%' . $oppositeallscore];
+ } else {
+ $table->data[] = [$sectionlabel, $allscore[0] . '%' . $oppositeallscore];
+ }
+ $this->page->add_to_page('feedbackscores', html_writer::table($table));
+ }
+
+ return $feedbackmessages;
+ }
+
+ // Now process scores for more than one section.
+
+ $score = [];
+ $allscore = [];
+ $maxscore = [];
+ $scorepercent = [];
+ $allscorepercent = [];
+ $oppositescorepercent = [];
+ $alloppositescorepercent = [];
+ $chartlabels = [];
+ $nanscores = [];
+
+ for ($i = 1; $i <= $numsections; $i++) {
+ $score[$i] = 0;
+ $allscore[$i] = 0;
+ $maxscore[$i] = 0;
+ $scorepercent[$i] = 0;
+ }
+
+ for ($section = 1; $section <= $numsections; $section++) {
+ if (($filteredsections != null) && !in_array($section, $filteredsections)) {
+ continue;
+ }
+ foreach ($fbsections as $key => $fbsection) {
+ if ($fbsection->section == $section) {
+ $feedbacksectionid = $key;
+ $scorecalculation = section::decode_scorecalculation($fbsection->scorecalculation);
+ if (empty($scorecalculation) && !is_array($scorecalculation)) {
+ $scorecalculation = [];
+ }
+ $sectionheading = $fbsection->sectionheading;
+ $imageid = $fbsection->id;
+ $chartlabels[$section] = $fbsection->sectionlabel;
+ }
+ }
+ foreach ($scorecalculation as $qid => $key) {
+ if (isset($qscore[$qid])) {
+ $key = empty($key) ? 1 : $key;
+ $score[$section] += round($qscore[$qid] * $key);
+ $maxscore[$section] += round($qmax[$qid] * $key);
+ if ($compare || $allresponses) {
+ $allscore[$section] += round($allqscore[$qid] * $key);
+ }
+ }
+ }
+
+ if ($maxscore[$section] == 0) {
+ array_push($nanscores, $section);
+ }
+
+ $scorepercent[$section] = ($maxscore[$section] > 0) ? (round($score[$section] / $maxscore[$section] * 100)) : 0;
+ $oppositescorepercent[$section] = 100 - $scorepercent[$section];
+
+ if (($compare || $allresponses) && $nbparticipants != 0) {
+ $allscorepercent[$section] = ($maxscore[$section] > 0)
+ ? (round(($allscore[$section] / $nbparticipants) / $maxscore[$section] * 100))
+ : 0;
+ $alloppositescorepercent[$section] = 100 - $allscorepercent[$section];
+ }
+
+ if (!$allresponses) {
+ if (is_nan($scorepercent[$section])) {
+ continue;
+ }
+ $sectionheading = str_replace('%', '', $sectionheading);
+ $original = ['$scorepercent', '$oppositescorepercent'];
+ $result = ["$scorepercent[$section]%", "$oppositescorepercent[$section]%"];
+ $sectionheading = str_replace($original, $result, $sectionheading);
+ $formatoptions = new stdClass();
+ $formatoptions->noclean = true;
+ $sectionheading = file_rewrite_pluginfile_urls(
+ $sectionheading,
+ 'pluginfile.php',
+ $this->questionnaire->context()->id,
+ 'mod_questionnaire',
+ 'sectionheading',
+ $imageid
+ );
+ $sectionheading = format_text($sectionheading, 1, $formatoptions);
+ $feedbackmessages[] = $this->renderer->box_start('reportQuestionTitle');
+ $feedbackmessages[] = format_text($sectionheading, FORMAT_HTML, $formatoptions);
+ $feedback = $DB->get_record_select(
+ 'questionnaire_feedback',
+ 'sectionid = ? AND minscore <= ? AND ? < maxscore',
+ [$feedbacksectionid, $scorepercent[$section], $scorepercent[$section]],
+ 'id,feedbacktext,feedbacktextformat'
+ );
+ $feedbackmessages[] = $this->renderer->box_end();
+ if (!empty($feedback->feedbacktext)) {
+ $formatoptions = new stdClass();
+ $formatoptions->noclean = true;
+ $feedbacktext = file_rewrite_pluginfile_urls(
+ $feedback->feedbacktext,
+ 'pluginfile.php',
+ $this->questionnaire->context()->id,
+ 'mod_questionnaire',
+ 'feedback',
+ $feedback->id
+ );
+ $feedbacktext = format_text($feedbacktext, $feedback->feedbacktextformat, $formatoptions);
+ $feedbackmessages[] = $this->renderer->box_start('feedbacktext');
+ $feedbackmessages[] = $feedbacktext;
+ $feedbackmessages[] = $this->renderer->box_end();
+ }
+ }
+ }
+
+ switch ($action) {
+ case 'vallasort':
+ asort($allscore);
+ break;
+ case 'vallarsort':
+ arsort($allscore);
+ break;
+ default:
+ }
+
+ if ($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 ($compare && !is_nan($scorepercent[$key])) {
+ $table = $table ?? new html_table();
+ $table->data[] = [
+ $sectionlabel,
+ $scorepercent[$key] . '%' . $oppositescore,
+ $allscorepercent[$key] . '%' . $oppositeallscore,
+ ];
+ } else if (isset($allscorepercent[$key]) && !is_nan($allscorepercent[$key])) {
+ $table = $table ?? new html_table();
+ $table->data[] = [$sectionlabel, $allscorepercent[$key] . '%' . $oppositeallscore];
+ }
+ }
+ }
+ }
+ $usergraph = get_config('questionnaire', 'usergraph');
+
+ foreach ($nanscores as $val) {
+ unset($chartlabels[$val]);
+ unset($scorepercent[$val]);
+ unset($allscorepercent[$val]);
+ }
+
+ if ($usergraph && $survey->charttype()) {
+ $this->page->add_to_page(
+ 'feedbackcharts',
+ draw_chart(
+ 'sections',
+ array_values($chartlabels),
+ $groupname,
+ $allresponses,
+ $survey->charttype(),
+ array_values($scorepercent),
+ array_values($allscorepercent),
+ $sectionlabel
+ )
+ );
+ }
+ if ($survey->feedbackscores()) {
+ $this->page->add_to_page('feedbackscores', html_writer::table($table));
+ }
+
+ return $feedbackmessages;
+ }
+
+ // Private helpers.
+
+ /**
+ * Return the shared response collection, creating it on first access.
+ *
+ * @return questionnaire_responses
+ */
+ private function responsecollection(): questionnaire_responses {
+ $this->responsecollection ??= $this->questionnaire->responses();
+ return $this->responsecollection;
+ }
+
+ /**
+ * Render the page/section count footer into the page (no-op when autonumbering is off).
+ *
+ * @param int $section Current section number.
+ * @param int $numsections Total number of sections.
+ * @return void
+ */
+ private function print_survey_end(int $section, int $numsections): void {
+ if (!$this->pages_autonumbered()) {
+ return;
+ }
+ if ($numsections > 1) {
+ $a = new stdClass();
+ $a->page = $section;
+ $a->totpages = $numsections;
+ $this->page->add_to_page(
+ 'pageinfo',
+ $this->renderer->container(
+ get_string('pageof', 'questionnaire', $a) . ' ',
+ 'surveyPage'
+ )
+ );
+ }
+ }
+
+ /**
+ * Render the survey header (respondent info, title, subtitle, description) into the page.
+ *
+ * Triggers a response_viewed event when the respondenttype is 'fullname'.
+ *
+ * @param string $message Error message to display (empty string = none).
+ * @param int $section Current page/section number.
+ * @param int $numsections Total number of pages/sections.
+ * @param int $hasrequired Whether the survey has required questions (unused; kept for signature compat).
+ * @param int|string $rid Response id ('' for blank/preview display).
+ * @param bool $blankquestionnaire True when displaying a blank preview.
+ * @param string $outputtarget 'html' or 'pdf'.
+ * @return void
+ */
+ private function print_survey_start(
+ string $message,
+ int $section,
+ int $numsections,
+ int $hasrequired,
+ $rid = '',
+ bool $blankquestionnaire = false,
+ string $outputtarget = 'html'
+ ): void {
+ global $CFG, $DB;
+ require_once($CFG->libdir . '/filelib.php');
+
+ $userid = '';
+ $resp = '';
+ $groupname = '';
+ $currentgroupid = 0;
+ $timesubmitted = '';
+ if ($rid) {
+ $courseid = $this->questionnaire->course()->id;
+ if ($resp = $DB->get_record('questionnaire_response', ['id' => $rid])) {
+ if ($this->questionnaire->respondenttype() == 'fullname') {
+ $userid = $resp->userid;
+ if (groups_get_activity_groupmode($this->questionnaire->coursemodule(), $this->questionnaire->course())) {
+ if ($groups = groups_get_all_groups($courseid, $resp->userid)) {
+ if (count($groups) == 1) {
+ $group = current($groups);
+ $currentgroupid = $group->id;
+ $groupname = ' (' . get_string('group') . ': ' . $group->name . ')';
+ } else {
+ $groupname = ' (' . get_string('groups') . ': ';
+ foreach ($groups as $group) {
+ $groupname .= $group->name . ', ';
+ }
+ $groupname = substr($groupname, 0, strlen($groupname) - 2) . ')';
+ }
+ } else {
+ $groupname = ' (' . get_string('groupnonmembers') . ')';
+ }
+ }
+
+ $params = [
+ 'objectid' => $this->questionnaire->surveyid(),
+ 'context' => $this->questionnaire->context(),
+ 'courseid' => $this->questionnaire->course()->id,
+ 'relateduserid' => $userid,
+ 'other' => ['action' => 'vresp', 'currentgroupid' => $currentgroupid, 'rid' => $rid],
+ ];
+ $event = \mod_questionnaire\event\response_viewed::create($params);
+ $event->trigger();
+ }
+ }
+ }
+ $ruser = '';
+ if ($resp && !$blankquestionnaire) {
+ if ($userid) {
+ if ($user = $DB->get_record('user', ['id' => $userid])) {
+ $ruser = fullname($user);
+ }
+ }
+ if ($this->questionnaire->respondenttype() == 'anonymous') {
+ $ruser = '- ' . get_string('anonymous', 'questionnaire') . ' -';
+ } else {
+ if ($resp->submitted) {
+ $timesubmitted = ' ' . get_string('submitted', 'questionnaire') . ' ' . userdate($resp->submitted);
+ }
+ }
+ }
+ if ($ruser) {
+ $respinfo = '';
+ if ($outputtarget == 'html') {
+ $linkname = get_string('print', 'mod_questionnaire');
+ $link = new \moodle_url(
+ '/mod/questionnaire/report.php',
+ [
+ 'action' => 'vresp',
+ 'instance' => $this->questionnaire->id(),
+ 'target' => 'print',
+ 'individualresponse' => 1,
+ 'rid' => $rid,
+ ]
+ );
+ $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);
+ $respinfo .= $this->renderer->action_link(
+ $link,
+ null,
+ $action,
+ ['title' => $linkname],
+ $htmlicon
+ ) . ' ';
+ }
+ $respinfo .= get_string('respondent', 'questionnaire') . ': ' . $ruser . ' ';
+ if ($this->questionnaire->survey_is_public()) {
+ $coursename = '';
+ $sql = 'SELECT q.id, q.course, c.fullname ' .
+ 'FROM {questionnaire_response} qr ' .
+ 'INNER JOIN {questionnaire} q ON qr.questionnaireid = q.id ' .
+ 'INNER JOIN {course} c ON q.course = c.id ' .
+ 'WHERE qr.id = ? AND qr.complete = ? ';
+ if ($record = $DB->get_record_sql($sql, [$rid, 'y'])) {
+ $coursename = $record->fullname;
+ }
+ $respinfo .= ' ' . get_string('course') . ': ' . $coursename;
+ }
+ $respinfo .= $groupname;
+ $respinfo .= $timesubmitted;
+ $this->page->add_to_page(
+ 'respondentinfo',
+ $this->renderer->respondent_info($respinfo)
+ );
+ }
+
+ if ($this->questionnaire->capabilities()->can_print_blank() && $blankquestionnaire && $section == 1) {
+ $linkname = ' ' . get_string('printblank', 'questionnaire');
+ $title = get_string('printblanktooltip', 'questionnaire');
+ $url = '/mod/questionnaire/print.php?qid=' . $this->questionnaire->id() .
+ '&rid=0&courseid=' . $this->questionnaire->course()->id . '&sec=1';
+ $options = [
+ 'menubar' => true,
+ 'location' => false,
+ 'scrollbars' => true,
+ 'resizable' => true,
+ 'height' => 600,
+ 'width' => 800,
+ 'title' => $title,
+ ];
+ $name = 'popup';
+ $link = new \moodle_url($url);
+ $action = new \popup_action('click', $link, $name, $options);
+ $class = "floatprinticon";
+ $this->page->add_to_page(
+ 'printblank',
+ $this->renderer->action_link(
+ $link,
+ $linkname,
+ $action,
+ ['class' => $class, 'title' => $title],
+ new \pix_icon('t/print', $title)
+ )
+ );
+ }
+ if ($section == 1) {
+ $survey = $this->questionnaire->survey();
+ if ($survey->title() !== '') {
+ $this->page->add_to_page('title', format_string($survey->title()));
+ }
+ if ($survey->subtitle() !== '') {
+ $this->page->add_to_page('subtitle', format_string($survey->subtitle()));
+ }
+ if ($survey->info() !== '') {
+ $infotext = file_rewrite_pluginfile_urls(
+ $survey->info(),
+ 'pluginfile.php',
+ $this->questionnaire->context()->id,
+ 'mod_questionnaire',
+ 'info',
+ $this->questionnaire->surveyid()
+ );
+ $this->page->add_to_page('addinfo', format_text($infotext, FORMAT_HTML, ['noclean' => true]));
+ }
+ }
+
+ if ($message) {
+ $this->page->add_to_page(
+ 'message',
+ $this->renderer->notification($message, \core\output\notification::NOTIFY_ERROR)
+ );
+ }
+ }
+
+ /**
+ * Process one response row into a positioned CSV row array.
+ *
+ * @param array $row Sparse response data array keyed by column position.
+ * @param stdClass $resprow Raw response resultset row.
+ * @param int $currentgroupid Active group id (0 = all).
+ * @param array $questionsbyposition Questions keyed by column position.
+ * @param int $nbinfocols Number of leading info columns.
+ * @param int $numrespcols Total number of columns.
+ * @param array $options Enabled download option strings.
+ * @param array $identityfields Identity field names.
+ * @return array Flat positioned row for CSV output.
+ */
+ private function process_csv_row(
+ array &$row,
+ stdClass $resprow,
+ int $currentgroupid,
+ array &$questionsbyposition,
+ int $nbinfocols,
+ int $numrespcols,
+ array $options,
+ array $identityfields
+ ): array {
+ global $DB;
+
+ static $anonumap = [];
+
+ $positioned = [];
+ $user = new stdClass();
+ foreach ($this->user_fields() as $userfield) {
+ $user->$userfield = $resprow->$userfield;
+ }
+ $user->id = $resprow->userid;
+ $isanonymous = ($this->questionnaire->respondenttype() == 'anonymous');
+
+ $course = $this->questionnaire->course();
+ if (!$this->questionnaire->survey_is_public()) {
+ $courseid = $course->id;
+ $coursename = $course->fullname;
+ } else {
+ $sql = 'SELECT q.id, q.course, c.fullname ' .
+ 'FROM {questionnaire_response} qr ' .
+ 'INNER JOIN {questionnaire} q ON qr.questionnaireid = q.id ' .
+ 'INNER JOIN {course} c ON q.course = c.id ' .
+ 'WHERE qr.id = ? AND qr.complete = ? ';
+ if ($record = $DB->get_record_sql($sql, [$resprow->rid, 'y'])) {
+ $courseid = $record->course;
+ $coursename = $record->fullname;
+ } else {
+ $courseid = $course->id;
+ $coursename = $course->fullname;
+ }
+ }
+
+ $cm = $this->questionnaire->coursemodule();
+ $groupname = '';
+ if (groups_get_activity_groupmode($cm, $course)) {
+ if ($currentgroupid > 0) {
+ $groupname = groups_get_group_name($currentgroupid);
+ } else {
+ if ($user->id) {
+ if ($groups = groups_get_all_groups($courseid, $user->id)) {
+ foreach ($groups as $group) {
+ $groupname .= $group->name . ', ';
+ }
+ $groupname = substr($groupname, 0, strlen($groupname) - 2);
+ } else {
+ $groupname = ' (' . get_string('groupnonmembers') . ')';
+ }
+ }
+ }
+ }
+
+ if ($isanonymous) {
+ if (!isset($anonumap[$user->id])) {
+ $anonumap[$user->id] = count($anonumap) + 1;
+ }
+ $fullname = get_string('anonymous', 'questionnaire') . $anonumap[$user->id];
+ $username = '';
+ $uid = '';
+ } else {
+ $uid = $user->id;
+ $fullname = fullname($user);
+ $username = $user->username;
+ }
+
+ if (in_array('response', $options)) {
+ array_push($positioned, $resprow->rid);
+ }
+ if (in_array('submitted', $options)) {
+ $submitted = date(get_string('strfdateformatcsv', 'questionnaire'), $resprow->submitted);
+ array_push($positioned, $submitted);
+ }
+ if (in_array('institution', $options)) {
+ array_push($positioned, $user->institution);
+ }
+ if (in_array('department', $options)) {
+ array_push($positioned, $user->department);
+ }
+ if (in_array('course', $options)) {
+ array_push($positioned, $coursename);
+ }
+ if (in_array('group', $options)) {
+ array_push($positioned, $groupname);
+ }
+ if (in_array('id', $options)) {
+ array_push($positioned, $uid);
+ }
+ if (in_array('useridnumber', $options)) {
+ array_push($positioned, $user->idnumber);
+ }
+ if (in_array('fullname', $options)) {
+ array_push($positioned, $fullname);
+ }
+ if (in_array('username', $options)) {
+ array_push($positioned, $username);
+ }
+ 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])) {
+ $positioned[] = $row[$c];
+ } else if (isset($questionsbyposition[$c])) {
+ $question = $questionsbyposition[$c];
+ $qtype = intval($question->typeid());
+ if ($qtype === QUESCHECK) {
+ $positioned[] = '0';
+ } else {
+ $positioned[] = null;
+ }
+ } else {
+ $positioned[] = null;
+ }
+ }
+ return $positioned;
+ }
+
+ /**
+ * Return the unique question type ids used across this survey's questions.
+ *
+ * @param bool $uniquebytable When true, also de-duplicates by response table.
+ * @return array
+ */
+ private function get_survey_questiontypes(bool $uniquebytable = false): array {
+ $uniquetypes = [];
+ $uniquetables = [];
+ foreach ($this->questionnaire->questions() as $question) {
+ $type = $question->typeid();
+ $responsetable = $question->responsetable();
+ if (!$uniquebytable || !in_array($responsetable, $uniquetables)) {
+ if (!in_array($type, $uniquetypes)) {
+ $uniquetypes[] = $type;
+ }
+ if (!in_array($responsetable, $uniquetables)) {
+ $uniquetables[] = $responsetable;
+ }
+ }
+ }
+ return $uniquetypes;
+ }
+
+ /**
+ * Return the identity fields to include for each user in the CSV.
+ *
+ * Returns an empty array when the 'useridentityfields' option is not set or
+ * when the questionnaire is anonymous.
+ *
+ * @param array $options Enabled download option strings.
+ * @return array Field names.
+ */
+ private function get_identity_fields(array $options): array {
+ if (!in_array('useridentityfields', $options) || $this->questionnaire->respondenttype() == 'anonymous') {
+ return [];
+ }
+ return \core_user\fields::get_identity_fields($this->questionnaire->context());
+ }
+
+ /**
+ * Return a stdClass of identity field values for the given user.
+ *
+ * @param \context $context
+ * @param int $userid
+ * @return stdClass|false
+ */
+ private static function get_user_identity_fields(\context $context, int $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 = ?";
+ return $DB->get_record_sql($sql, array_merge($params, [$userid]));
+ }
+
+ /**
+ * Return the user field names used when building CSV rows.
+ *
+ * @return array
+ */
+ private function user_fields(): array {
+ $userfieldsarr = \core_user\fields::get_name_fields();
+ $userfieldsarr = array_merge($userfieldsarr, ['username', 'department', 'institution', 'idnumber']);
+ return $userfieldsarr;
+ }
+}
diff --git a/classes/responsetype/response/response.php b/classes/responsetype/response/response.php
deleted file mode 100644
index b24378a2b..000000000
--- a/classes/responsetype/response/response.php
+++ /dev/null
@@ -1,186 +0,0 @@
-.
-
-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 bool $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 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);
- $this->answers += \mod_questionnaire\responsetype\file::response_answers_by_question($this->id);
- }
-}
diff --git a/classes/settings_form.php b/classes/settings_form.php
index c702f6a9b..92aed7c02 100644
--- a/classes/settings_form.php
+++ b/classes/settings_form.php
@@ -32,22 +32,22 @@ class settings_form extends \moodleform {
* Defines the form.
*/
public function definition() {
- global $questionnaire, $questionnairerealms;
+ global $questionnaire;
$mform =& $this->_form;
$mform->addElement('header', 'contenthdr', get_string('contentoptions', 'questionnaire'));
- $capabilities = questionnaire_load_capabilities($questionnaire->cm->id);
- if (!$capabilities->createtemplates) {
- unset($questionnairerealms['template']);
+ $realms = \mod_questionnaire\form_options::realm();
+ if (!$questionnaire->capabilities()->can_create_templates()) {
+ unset($realms['template']);
}
- if (!$capabilities->createpublic) {
- unset($questionnairerealms['public']);
+ if (!$questionnaire->capabilities()->can_create_public()) {
+ unset($realms['public']);
}
- if (isset($questionnairerealms['public']) || isset($questionnairerealms['template'])) {
- $mform->addElement('select', 'realm', get_string('realm', 'questionnaire'), $questionnairerealms);
- $mform->setDefault('realm', $questionnaire->survey->realm);
+ if (isset($realms['public']) || isset($realms['template'])) {
+ $mform->addElement('select', 'realm', get_string('realm', 'questionnaire'), $realms);
+ $mform->setDefault('realm', $questionnaire->survey()->realm());
$mform->addHelpButton('realm', 'realm', 'questionnaire');
} else {
$mform->addElement('hidden', 'realm', 'private');
@@ -55,40 +55,40 @@ public function definition() {
$mform->setType('realm', PARAM_RAW);
$mform->addElement('text', 'title', get_string('title', 'questionnaire'), ['size' => '60']);
- $mform->setDefault('title', $questionnaire->survey->title);
+ $mform->setDefault('title', $questionnaire->surveytitle());
$mform->setType('title', PARAM_TEXT);
$mform->addRule('title', null, 'required', null, 'client');
$mform->addHelpButton('title', 'title', 'questionnaire');
$mform->addElement('text', 'subtitle', get_string('subtitle', 'questionnaire'), ['size' => '60']);
- $mform->setDefault('subtitle', $questionnaire->survey->subtitle);
+ $mform->setDefault('subtitle', $questionnaire->surveysubtitle());
$mform->setType('subtitle', PARAM_TEXT);
$mform->addHelpButton('subtitle', 'subtitle', 'questionnaire');
$editoroptions = ['maxfiles' => EDITOR_UNLIMITED_FILES, 'trusttext' => true];
$mform->addElement('editor', 'info', get_string('additionalinfo', 'questionnaire'), null, $editoroptions);
- $mform->setDefault('info', $questionnaire->survey->info);
+ $mform->setDefault('info', $questionnaire->surveyinfo());
$mform->setType('info', PARAM_RAW);
$mform->addHelpButton('info', 'additionalinfo', 'questionnaire');
$mform->addElement('header', 'submithdr', get_string('submitoptions', 'questionnaire'));
- $mform->addElement('text', 'thanks_page', get_string('url', 'questionnaire'), ['size' => '60']);
- $mform->setType('thanks_page', PARAM_TEXT);
- $mform->setDefault('thanks_page', $questionnaire->survey->thanks_page);
- $mform->addHelpButton('thanks_page', 'url', 'questionnaire');
+ $mform->addElement('text', 'thankspage', get_string('url', 'questionnaire'), ['size' => '60']);
+ $mform->setType('thankspage', PARAM_TEXT);
+ $mform->setDefault('thankspage', $questionnaire->survey()->thankspage());
+ $mform->addHelpButton('thankspage', 'url', 'questionnaire');
$mform->addElement('static', 'confmes', get_string('confalts', 'questionnaire'));
$mform->addHelpButton('confmes', 'confpage', 'questionnaire');
- $mform->addElement('text', 'thank_head', get_string('headingtext', 'questionnaire'), ['size' => '30']);
- $mform->setType('thank_head', PARAM_TEXT);
- $mform->setDefault('thank_head', $questionnaire->survey->thank_head);
+ $mform->addElement('text', 'thankhead', get_string('headingtext', 'questionnaire'), ['size' => '30']);
+ $mform->setType('thankhead', PARAM_TEXT);
+ $mform->setDefault('thankhead', $questionnaire->survey()->thankhead());
$editoroptions = ['maxfiles' => EDITOR_UNLIMITED_FILES, 'trusttext' => true];
- $mform->addElement('editor', 'thank_body', get_string('bodytext', 'questionnaire'), null, $editoroptions);
- $mform->setType('thank_body', PARAM_RAW);
- $mform->setDefault('thank_body', $questionnaire->survey->thank_body);
+ $mform->addElement('editor', 'thankbody', get_string('bodytext', 'questionnaire'), null, $editoroptions);
+ $mform->setType('thankbody', PARAM_RAW);
+ $mform->setDefault('thankbody', $questionnaire->survey()->thankbody());
$allowemailreporting = get_config('questionnaire', 'allowemailreporting');
if (!$allowemailreporting) {
@@ -98,7 +98,7 @@ public function definition() {
}
$mform->addElement('text', 'email', get_string('email', 'questionnaire'), $attributes);
$mform->setType('email', PARAM_TEXT);
- $mform->setDefault('email', $questionnaire->survey->email);
+ $mform->setDefault('email', $questionnaire->survey()->email());
$mform->addHelpButton('email', 'sendemail', 'questionnaire');
// Hidden fields.
diff --git a/classes/submission_controller.php b/classes/submission_controller.php
new file mode 100644
index 000000000..d3e14d1a2
--- /dev/null
+++ b/classes/submission_controller.php
@@ -0,0 +1,90 @@
+.
+
+namespace mod_questionnaire;
+
+/**
+ * Controller for in-progress submission flow: page navigation and section saves.
+ *
+ * Coordinates the responses handler and question navigator when a user is
+ * working through a multi-page questionnaire: replacing the answers for the
+ * current section, then deciding which page to go to next.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 onward Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class submission_controller {
+ /** @var questionnaire The questionnaire instance this controller operates on. */
+ private readonly questionnaire $questionnaire;
+
+ /**
+ * Constructor.
+ *
+ * @param questionnaire $questionnaire
+ */
+ public function __construct(questionnaire $questionnaire) {
+ $this->questionnaire = $questionnaire;
+ }
+
+ /**
+ * Delete the current response section and insert a fresh one; return the new response id.
+ *
+ * @param object $response Response data object (must have ->rid and ->sec).
+ * @param int $userid
+ * @return int New response id.
+ */
+ public function existing_response_action(object $response, int $userid): int {
+ $responses = $this->questionnaire->responses();
+ $responses->response_delete($response->rid, $response->sec);
+ return $responses->response_insert($response, $userid);
+ }
+
+ /**
+ * Validate and save the current page, then return the next page number (or an error string).
+ *
+ * @param object $response Response data object.
+ * @param int $userid
+ * @return int|bool|string Next section number, false if no next page, or error message string.
+ */
+ public function next_page_action(object $response, int $userid): int|bool|string {
+ $msg = $this->questionnaire->responses()->response_check_format(
+ $response->sec,
+ $response,
+ true,
+ true,
+ $this->questionnaire->questions()
+ );
+ if (!empty($msg)) {
+ return $msg;
+ }
+ $response->rid = $this->existing_response_action($response, $userid);
+ return $this->questionnaire->navigator()->next_page($response->sec, $response->rid);
+ }
+
+ /**
+ * Save the current page and return the previous page number.
+ *
+ * @param object $response Response data object.
+ * @param int $userid
+ * @return int|bool Previous section number, or false if none.
+ */
+ public function previous_page_action(object $response, int $userid): int|bool {
+ $response->rid = $this->existing_response_action($response, $userid);
+ return $this->questionnaire->navigator()->prev_page($response->sec, $response->rid);
+ }
+}
diff --git a/classes/submission_notifier.php b/classes/submission_notifier.php
new file mode 100644
index 000000000..66d171538
--- /dev/null
+++ b/classes/submission_notifier.php
@@ -0,0 +1,312 @@
+.
+
+namespace mod_questionnaire;
+
+use stdClass;
+
+/**
+ * Notification dispatcher for questionnaire submissions.
+ *
+ * Encapsulates the post-submit fan-out: emailing the survey-defined address,
+ * messaging users with the submissionnotification capability, and formatting
+ * the submission body for both delivery channels.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 onward Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ */
+class submission_notifier {
+ /** @var questionnaire The questionnaire whose submissions this notifier handles. */
+ private questionnaire $questionnaire;
+
+ /**
+ * Constructor.
+ *
+ * @param questionnaire $questionnaire
+ */
+ public function __construct(questionnaire $questionnaire) {
+ $this->questionnaire = $questionnaire;
+ }
+
+ /**
+ * Notify subscribers that a response has been submitted.
+ *
+ * Sends the survey-configured email and, when the questionnaire's notifications
+ * setting is non-zero, dispatches a Moodle message to each capable user.
+ *
+ * @param int $rid The response id.
+ * @return bool True if all delivery attempts succeeded.
+ */
+ public function notify(int $rid): bool {
+ $success = true;
+ $email = $this->questionnaire->survey()->email();
+ if (!empty($email)) {
+ $success = $this->send_email($rid, $email);
+ }
+ if ($this->questionnaire->notifications()) {
+ $success = $this->send_notifications($rid) && $success;
+ }
+ return $success;
+ }
+
+ /**
+ * Return users who should be notified of a new submission by $userid.
+ *
+ * In SEPARATEGROUPS mode only users who share a group with $userid are notified.
+ * Users with no group are notified only if the submitter also has no group.
+ *
+ * @param int $userid Submitting user id.
+ * @return array Indexed by user id.
+ */
+ public function get_notifiable_users(int $userid): array {
+ $potentialusers = get_enrolled_users(
+ $this->questionnaire->context(),
+ 'mod/questionnaire:submissionnotification',
+ null,
+ 'u.*',
+ null,
+ null,
+ null,
+ true
+ );
+
+ $cm = $this->questionnaire->coursemodule();
+ $notifiableusers = [];
+ if (groups_get_activity_groupmode($cm) == SEPARATEGROUPS) {
+ if ($groups = groups_get_all_groups($this->questionnaire->courseid(), $userid, $cm->groupingid)) {
+ foreach ($groups as $group) {
+ foreach ($potentialusers as $potentialuser) {
+ if ($potentialuser->id == $userid) {
+ continue;
+ }
+ if (groups_is_member($group->id, $potentialuser->id)) {
+ $notifiableusers[$potentialuser->id] = $potentialuser;
+ }
+ }
+ }
+ } else {
+ foreach ($potentialusers as $potentialuser) {
+ if ($potentialuser->id == $userid) {
+ continue;
+ }
+ if (!groups_has_membership($cm, $potentialuser->id)) {
+ $notifiableusers[$potentialuser->id] = $potentialuser;
+ }
+ }
+ }
+ } else {
+ foreach ($potentialusers as $potentialuser) {
+ if ($potentialuser->id == $userid) {
+ continue;
+ }
+ $notifiableusers[$potentialuser->id] = $potentialuser;
+ }
+ }
+ return $notifiableusers;
+ }
+
+ /**
+ * Send a Moodle message to each user with the submissionnotification capability.
+ *
+ * @param int $rid The response id.
+ * @return bool
+ */
+ private function send_notifications(int $rid): bool {
+ global $CFG, $USER;
+
+ $this->questionnaire->add_response($rid);
+ $message = '';
+ if ($this->questionnaire->notifications() == 2) {
+ $message .= $this->build_full_submission_message($rid);
+ }
+
+ $success = true;
+ if ($notifyusers = $this->get_notifiable_users($USER->id)) {
+ $info = new stdClass();
+ if ($this->questionnaire->respondenttype() != 'anonymous') {
+ $info->userfrom = $USER;
+ $info->username = fullname($info->userfrom, true);
+ $info->profileurl = $CFG->wwwroot . '/user/view.php?id=' . $info->userfrom->id .
+ '&course=' . $this->questionnaire->courseid();
+ $langstringtext = 'submissionnotificationtextuser';
+ $langstringhtml = 'submissionnotificationhtmluser';
+ } else {
+ $info->userfrom = \core_user::get_noreply_user();
+ $info->username = '';
+ $info->profileurl = '';
+ $langstringtext = 'submissionnotificationtextanon';
+ $langstringhtml = 'submissionnotificationhtmlanon';
+ }
+ $info->name = format_string($this->questionnaire->name());
+ $info->submissionurl = $CFG->wwwroot . '/mod/questionnaire/report.php?action=vresp&sid=' .
+ $this->questionnaire->surveyid() . '&rid=' . $rid . '&instance=' . $this->questionnaire->id();
+ $info->coursename = format_string($this->questionnaire->course()->fullname);
+ $info->postsubject = get_string('submissionnotificationsubject', 'questionnaire');
+ $info->posttext = get_string($langstringtext, 'questionnaire', $info);
+ $info->posthtml = '' . get_string($langstringhtml, 'questionnaire', $info) . '
';
+ if (!empty($message)) {
+ $info->posttext .= html_to_text($message);
+ $info->posthtml .= $message;
+ }
+ foreach ($notifyusers as $notifyuser) {
+ $info->userto = $notifyuser;
+ $this->dispatch_message($info, 'notification');
+ }
+ }
+ return $success;
+ }
+
+ /**
+ * Format every question and answer for a single submission as HTML for inline message bodies.
+ *
+ * @param int $rid The response id.
+ * @return string
+ */
+ private function build_full_submission_message(int $rid): string {
+ $responses = $this->questionnaire->responses()->get_full_submission_for_export($rid);
+ $message = '';
+ foreach ($responses as $response) {
+ $message .= html_to_text(format_string($response->questionname)) . "' . $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'];
+
+ $altbody = "\n$bodyplaintext\n";
+ $return = true;
+ $userfrom = \core_user::get_noreply_user();
+ foreach (preg_split('/,|;/', $email) as $addr) {
+ $userto = new stdClass();
+ $userto->email = trim($addr);
+ $userto->mailformat = 1;
+ $userto->id = -10;
+ if (!email_to_user($userto, $userfrom, $subject, $altbody, $bodyhtml)) {
+ $return = false;
+ }
+ }
+ return $return;
+ }
+
+ /**
+ * Format submission answers for email delivery.
+ *
+ * @param array $answers Raw answers array from generate_csv.
+ * @return array Keys 'plaintext' and 'html'.
+ */
+ private function format_answers_for_email(array $answers): array {
+ global $USER;
+
+ $formatted = ['plaintext' => '', 'html' => ''];
+ // The generate_csv result is an array of rows; we need at least a header row (0) and
+ // a data row (1). Anything less means there is nothing to format.
+ if (count($answers) < 2) {
+ return $formatted;
+ }
+
+ $endhtml = "\r\n
-
@@ -49,13 +49,13 @@
@@ -104,8 +104,8 @@
@@ -238,7 +238,7 @@
-
diff --git a/db/upgrade.php b/db/upgrade.php
index 5f02d1085..90aa9be22 100644
--- a/db/upgrade.php
+++ b/db/upgrade.php
@@ -408,7 +408,6 @@ function xmldb_questionnaire_upgrade($oldversion = 0) {
// Replace the = separator with :: separator in quest_choice content.
// This fixes radio button options using old "value"="display" formats.
- require_once($CFG->dirroot . '/mod/questionnaire/locallib.php');
$choices = $DB->get_recordset('questionnaire_quest_choice', null);
$total = $DB->count_records('questionnaire_quest_choice');
if ($total > 0) {
@@ -419,7 +418,7 @@ function xmldb_questionnaire_upgrade($oldversion = 0) {
($choice->value == null || $choice->value == 'NULL') &&
!preg_match("/^([0-9]{1,3}=.*|!other=.*)$/", $choice->content)
) {
- $content = questionnaire_choice_values($choice->content);
+ $content = \mod_questionnaire\local\question\question::parse_choice_content($choice->content);
if (strpos($content->text, '=')) {
$newcontent = str_replace('=', '::', $content->text);
$choice->content = $newcontent;
@@ -836,7 +835,7 @@ function xmldb_questionnaire_upgrade($oldversion = 0) {
}
// Need to move rank named degree choices to the new field.
- \mod_questionnaire\question\rate::move_all_nameddegree_choices();
+ \mod_questionnaire\local\question\rate::move_all_nameddegree_choices();
// Questionnaire savepoint reached.
upgrade_mod_savepoint(true, 2018110103, 'questionnaire');
@@ -1090,49 +1089,389 @@ function xmldb_questionnaire_upgrade($oldversion = 0) {
upgrade_mod_savepoint(true, 2025041400.03, 'questionnaire');
}
- return true;
-}
+ if ($oldversion < 2025111100.01) {
+ // Setup table for renaming fields.
+ $table = new xmldb_table('questionnaire');
-/**
- * Supporting functions used once.
- * @return bool
- */
-function questionnaire_upgrade_2007120101() {
- global $DB;
+ // Rename field resp_eligible on table questionnaire to respeligible.
+ $field = new xmldb_field('resp_eligible', XMLDB_TYPE_CHAR, '8', null, XMLDB_NOTNULL, null, 'all', 'respondenttype');
+ // Launch rename field respeligible.
+ $dbman->rename_field($table, $field, 'respeligible');
+ // Define index respview (not unique) to be dropped form questionnaire.
+ $index = new xmldb_index('respview', XMLDB_INDEX_NOTUNIQUE, ['resp_view']);
+ // Conditionally launch drop index respview.
+ if ($dbman->index_exists($table, $index)) {
+ $dbman->drop_index($table, $index);
+ }
- $dbman = $DB->get_manager(); // Loads ddl manager and xmldb classes.
- $status = true;
-
- // Shorten table names to bring them in accordance with the XML DB schema.
- $qtable = new xmldb_table('questionnaire_question_choice');
- $dbman->rename_table($qtable, 'questionnaire_quest_choice', false);
- unset($qtable);
-
- $qtable = new xmldb_table('questionnaire_response_multiple');
- $dbman->rename_table($qtable, 'questionnaire_resp_multiple', false);
- unset($qtable);
-
- $qtable = new xmldb_table('questionnaire_response_single');
- $dbman->rename_table($qtable, 'questionnaire_resp_single', false);
- unset($qtable);
-
- // Upgrade the questionnaire_question_type table to use typeid.
- $table = new xmldb_table('questionnaire_question_type');
- $field = new xmldb_field('typeid');
- $field->set_attributes(XMLDB_TYPE_CHAR, '20', true, true, false, false, null, '0', 'id');
- $dbman->add_field($table, $field);
- if (($numrecs = $dbman->count_records('questionnaire_question_type')) > 0) {
- $recstart = 0;
- $recstoget = 100;
- while ($recstart < $numrecs) {
- if ($records = $dbman->get_records('questionnaire_question_type', [], '', '*', $recstart, $recstoget)) {
- foreach ($records as $record) {
- $dbman->set_field('questionnaire_question_type', 'typeid', $record->id, ['id' => $record->id]);
- }
- }
- $recstart += $recstoget;
+ // Rename field resp_view on table questionnaire to respview.
+ $field = new xmldb_field('resp_view', XMLDB_TYPE_INTEGER, '2', null, XMLDB_NOTNULL, null, '0', 'respeligible');
+ // Launch rename field resp_view.
+ $dbman->rename_field($table, $field, 'respview');
+ // Define index respview (not unique) to be added to questionnaire.
+ $index = new xmldb_index('respview', XMLDB_INDEX_NOTUNIQUE, ['respview']);
+ // Conditionally launch add index respview.
+ if (!$dbman->index_exists($table, $index)) {
+ $dbman->add_index($table, $index);
+ }
+
+ // Setup table for renaming fields.
+ $table = new xmldb_table('questionnaire_survey');
+
+ // Rename field thanks_page on table questionnaire_survey to thankspage.
+ $field = new xmldb_field('thanks_page', XMLDB_TYPE_CHAR, '255', null, null, null, null, 'theme');
+ // Launch rename field thankspage.
+ $dbman->rename_field($table, $field, 'thankspage');
+
+ // Rename field thanks_page on table questionnaire_survey to thankspage.
+ $field = new xmldb_field('thank_head', XMLDB_TYPE_CHAR, '255', null, null, null, null, 'thankspage');
+ // Launch rename field thank_head.
+ $dbman->rename_field($table, $field, 'thankhead');
+
+ // Rename field thank_body on table questionnaire_survey to thankbody.
+ $field = new xmldb_field('thank_body', XMLDB_TYPE_TEXT, null, null, null, null, null, 'thankhead');
+ // Launch rename field thank_body.
+ $dbman->rename_field($table, $field, 'thankbody');
+
+ // Rename field chart_type on table questionnaire_survey to charttype.
+ $field = new xmldb_field('chart_type', XMLDB_TYPE_CHAR, '64', null, null, null, null, 'feedbackscores');
+ // Launch rename field chart_type.
+ $dbman->rename_field($table, $field, 'charttype');
+
+ // Questionnaire savepoint reached.
+ upgrade_mod_savepoint(true, 2025111100.01, 'questionnaire');
+ }
+
+ if ($oldversion < 2025111100.02) {
+ $table = new xmldb_table('questionnaire_question');
+
+ // Rename the field from type_id to typeid.
+ $field = new xmldb_field('type_id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0');
+ if ($dbman->field_exists($table, 'type_id')) {
+ $dbman->rename_field($table, $field, 'typeid');
+ }
+
+ // Rename the field from result_id to resultid.
+ $field = new xmldb_field('result_id', XMLDB_TYPE_INTEGER, '10', null, null, null, null);
+ if ($dbman->field_exists($table, 'result_id')) {
+ $dbman->rename_field($table, $field, 'resultid');
+ }
+
+ upgrade_mod_savepoint(true, 2025111100.02, 'questionnaire');
+ }
+
+ if ($oldversion < 2025111100.03) {
+ $table = new xmldb_table('questionnaire_question_type');
+
+ // Rename field has_choices on table questionnaire_question_type to haschoices.
+ if ($dbman->field_exists($table, 'has_choices')) {
+ $field = new xmldb_field('has_choices', XMLDB_TYPE_CHAR, '1', null, XMLDB_NOTNULL, null, 'y', 'type');
+ $dbman->rename_field($table, $field, 'haschoices');
+ }
+
+ // Rename field response_table on table questionnaire_question_type to responsetable.
+ if ($dbman->field_exists($table, 'response_table')) {
+ $field = new xmldb_field('response_table', XMLDB_TYPE_CHAR, '32', null, null, null, null, 'haschoices');
+ $dbman->rename_field($table, $field, 'responsetable');
+ }
+
+ upgrade_mod_savepoint(true, 2025111100.03, 'questionnaire');
+ }
+
+ if ($oldversion < 2025111100.04) {
+ // Rename field question_id on table questionnaire_quest_choice to questionid.
+ $table = new xmldb_table('questionnaire_quest_choice');
+ if ($dbman->field_exists($table, 'question_id')) {
+ // Launch drop key questionid.
+ $key = new xmldb_key('questionid', XMLDB_KEY_FOREIGN, ['question_id'], 'questionnaire_question', ['id']);
+ $dbman->drop_key($table, $key);
+
+ $field = new xmldb_field('question_id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0');
+ $dbman->rename_field($table, $field, 'questionid');
+
+ // Launch add key questionid.
+ $key = new xmldb_key('questionid', XMLDB_KEY_FOREIGN, ['questionid'], 'questionnaire_question', ['id']);
+ $dbman->add_key($table, $key);
+ }
+
+ upgrade_mod_savepoint(true, 2025111100.04, 'questionnaire');
+ }
+
+ if ($oldversion < 2025111100.05) {
+ // Rename underscore fields and appropriate indeces.
+
+ // Update questionnaire_response_bool table.
+ $table = new xmldb_table('questionnaire_response_bool');
+
+ // Define index response_question (not unique) to be dropped form questionnaire_response_bool.
+ $index = new xmldb_index('response_question', XMLDB_INDEX_NOTUNIQUE, ['response_id', 'question_id']);
+ // Conditionally launch drop index response_question.
+ if ($dbman->index_exists($table, $index)) {
+ $dbman->drop_index($table, $index);
+ }
+ // Rename field response_id on table questionnaire_response_bool to responseid.
+ $field = new xmldb_field('response_id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'id');
+ if ($dbman->field_exists($table, 'response_id')) {
+ // Launch rename field response_id.
+ $dbman->rename_field($table, $field, 'responseid');
+ }
+
+ // Rename field question_id on table questionnaire_response_bool to questionid.
+ $field = new xmldb_field('question_id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'responseid');
+ if ($dbman->field_exists($table, 'question_id')) {
+ // Launch rename field question_id.
+ $dbman->rename_field($table, $field, 'questionid');
+ }
+
+ // Rename field choice_id on table questionnaire_response_bool to choiceid.
+ $field = new xmldb_field('choice_id', XMLDB_TYPE_CHAR, '1', null, XMLDB_NOTNULL, null, 'y', 'questionid');
+ if ($dbman->field_exists($table, 'choice_id')) {
+ // Launch rename field choice_id.
+ $dbman->rename_field($table, $field, 'choiceid');
+ }
+
+ // Define index response_question (not unique) to be added to questionnaire_response_bool.
+ $index = new xmldb_index('response_question', XMLDB_INDEX_NOTUNIQUE, ['responseid', 'questionid']);
+ // Conditionally launch add index response_question.
+ if (!$dbman->index_exists($table, $index)) {
+ $dbman->add_index($table, $index);
+ }
+
+ // Update questionnaire_response_date table.
+ $table = new xmldb_table('questionnaire_response_date');
+
+ // Define index response_question (not unique) to be dropped form questionnaire_response_date.
+ $index = new xmldb_index('response_question', XMLDB_INDEX_NOTUNIQUE, ['response_id', 'question_id']);
+ // Conditionally launch drop index response_question.
+ if ($dbman->index_exists($table, $index)) {
+ $dbman->drop_index($table, $index);
+ }
+
+ // Rename field response_id on table questionnaire_response_bool to responseid.
+ $field = new xmldb_field('response_id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'id');
+ if ($dbman->field_exists($table, 'response_id')) {
+ // Launch rename field response_id.
+ $dbman->rename_field($table, $field, 'responseid');
+ }
+
+ // Rename field question_id on table questionnaire_response_bool to questionid.
+ $field = new xmldb_field('question_id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'responseid');
+ if ($dbman->field_exists($table, 'question_id')) {
+ // Launch rename field question_id.
+ $dbman->rename_field($table, $field, 'questionid');
+ }
+
+ // Define index response_question (not unique) to be added to questionnaire_response_date.
+ $index = new xmldb_index('response_question', XMLDB_INDEX_NOTUNIQUE, ['responseid', 'questionid']);
+ // Conditionally launch add index response_question.
+ if (!$dbman->index_exists($table, $index)) {
+ $dbman->add_index($table, $index);
+ }
+
+ // Rename field response_id on table questionnaire_resp_multiple to responseid.
+ $table = new xmldb_table('questionnaire_resp_multiple');
+
+ // Define index response_question (not unique) to be dropped form questionnaire_resp_multiple.
+ $index = new xmldb_index('response_question', XMLDB_INDEX_NOTUNIQUE, ['response_id', 'question_id', 'choice_id']);
+ // Conditionally launch drop index response_question.
+ if ($dbman->index_exists($table, $index)) {
+ $dbman->drop_index($table, $index);
+ }
+
+ // Launch rename field response_id.
+ $field = new xmldb_field('response_id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'id');
+ if ($dbman->field_exists($table, 'response_id')) {
+ $dbman->rename_field($table, $field, 'responseid');
+ }
+
+ // Launch rename field question_id.
+ $field = new xmldb_field('question_id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'responseid');
+ if ($dbman->field_exists($table, 'question_id')) {
+ $dbman->rename_field($table, $field, 'questionid');
+ }
+
+ // Launch rename field choice_id.
+ $field = new xmldb_field('choice_id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'questionid');
+ if ($dbman->field_exists($table, 'choice_id')) {
+ $dbman->rename_field($table, $field, 'choiceid');
+ }
+
+ // Define index response_question (not unique) to be added to questionnaire_resp_multiple.
+ $index = new xmldb_index('response_question', XMLDB_INDEX_NOTUNIQUE, ['responseid', 'questionid', 'choiceid']);
+ // Conditionally launch add index response_question.
+ if (!$dbman->index_exists($table, $index)) {
+ $dbman->add_index($table, $index);
+ }
+
+ // Rename field response_id on table questionnaire_response_other to responseid.
+ $table = new xmldb_table('questionnaire_response_other');
+
+ // Define index response_question (not unique) to be dropped form questionnaire_response_other.
+ $index = new xmldb_index('response_question', XMLDB_INDEX_NOTUNIQUE, ['response_id', 'question_id', 'choice_id']);
+ // Conditionally launch drop index response_question.
+ if ($dbman->index_exists($table, $index)) {
+ $dbman->drop_index($table, $index);
+ }
+
+ // Launch rename field response_id.
+ $field = new xmldb_field('response_id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'id');
+ if ($dbman->field_exists($table, 'response_id')) {
+ $dbman->rename_field($table, $field, 'responseid');
+ }
+
+ // Launch rename field question_id.
+ $field = new xmldb_field('question_id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'responseid');
+ if ($dbman->field_exists($table, 'question_id')) {
+ $dbman->rename_field($table, $field, 'questionid');
+ }
+
+ // Launch rename field choice_id.
+ $field = new xmldb_field('choice_id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'questionid');
+ if ($dbman->field_exists($table, 'choice_id')) {
+ $dbman->rename_field($table, $field, 'choiceid');
+ }
+
+ // Define index response_question (not unique) to be added to questionnaire_response_other.
+ $index = new xmldb_index('response_question', XMLDB_INDEX_NOTUNIQUE, ['responseid', 'questionid', 'choiceid']);
+ // Conditionally launch add index response_question.
+ if (!$dbman->index_exists($table, $index)) {
+ $dbman->add_index($table, $index);
+ }
+
+ // Rename field response_id on table questionnaire_response_rank to responseid.
+ $table = new xmldb_table('questionnaire_response_rank');
+
+ // Define index response_question (not unique) to be dropped form questionnaire_response_rank.
+ $index = new xmldb_index('response_question', XMLDB_INDEX_NOTUNIQUE, ['response_id', 'question_id', 'choice_id']);
+ // Conditionally launch drop index response_question.
+ if ($dbman->index_exists($table, $index)) {
+ $dbman->drop_index($table, $index);
+ }
+
+ // Launch rename field response_id.
+ $field = new xmldb_field('response_id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'id');
+ if ($dbman->field_exists($table, 'response_id')) {
+ $dbman->rename_field($table, $field, 'responseid');
+ }
+
+ // Launch rename field question_id.
+ $field = new xmldb_field('question_id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'responseid');
+ if ($dbman->field_exists($table, 'question_id')) {
+ $dbman->rename_field($table, $field, 'questionid');
+ }
+
+ // Launch rename field choice_id.
+ $field = new xmldb_field('choice_id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'questionid');
+ if ($dbman->field_exists($table, 'choice_id')) {
+ $dbman->rename_field($table, $field, 'choiceid');
+ }
+
+ // Define index response_question (not unique) to be added to questionnaire_resp_multiple.
+ $index = new xmldb_index('response_question', XMLDB_INDEX_NOTUNIQUE, ['responseid', 'questionid', 'choiceid']);
+ // Conditionally launch add index response_question.
+ if (!$dbman->index_exists($table, $index)) {
+ $dbman->add_index($table, $index);
+ }
+
+ // Update questionnaire_resp_single table.
+ $table = new xmldb_table('questionnaire_resp_single');
+
+ // Define index response_question (not unique) to be dropped form questionnaire_resp_single.
+ $index = new xmldb_index('response_question', XMLDB_INDEX_NOTUNIQUE, ['response_id', 'question_id']);
+ // Conditionally launch drop index response_question.
+ if ($dbman->index_exists($table, $index)) {
+ $dbman->drop_index($table, $index);
+ }
+
+ // Rename field response_id on table questionnaire_response_bool to responseid.
+ $field = new xmldb_field('response_id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'id');
+ if ($dbman->field_exists($table, 'response_id')) {
+ // Launch rename field response_id.
+ $dbman->rename_field($table, $field, 'responseid');
+ }
+
+ // Rename field question_id on table questionnaire_response_bool to questionid.
+ $field = new xmldb_field('question_id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'responseid');
+ if ($dbman->field_exists($table, 'question_id')) {
+ // Launch rename field question_id.
+ $dbman->rename_field($table, $field, 'questionid');
+ }
+
+ // Launch rename field choice_id.
+ $field = new xmldb_field('choice_id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'questionid');
+ if ($dbman->field_exists($table, 'choice_id')) {
+ $dbman->rename_field($table, $field, 'choiceid');
+ }
+
+ // Define index response_question (not unique) to be added to questionnaire_resp_single.
+ $index = new xmldb_index('response_question', XMLDB_INDEX_NOTUNIQUE, ['responseid', 'questionid']);
+ // Conditionally launch add index response_question.
+ if (!$dbman->index_exists($table, $index)) {
+ $dbman->add_index($table, $index);
+ }
+
+ // Rename field response_id on table questionnaire_response_text to responseid.
+ $table = new xmldb_table('questionnaire_response_text');
+
+ // Define index response_question (not unique) to be dropped form questionnaire_response_text.
+ $index = new xmldb_index('response_question', XMLDB_INDEX_NOTUNIQUE, ['response_id', 'question_id']);
+ // Conditionally launch drop index response_question.
+ if ($dbman->index_exists($table, $index)) {
+ $dbman->drop_index($table, $index);
+ }
+
+ // Launch rename field response_id.
+ $field = new xmldb_field('response_id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'id');
+ if ($dbman->field_exists($table, 'response_id')) {
+ $dbman->rename_field($table, $field, 'responseid');
+ }
+
+ // Launch rename field question_id.
+ $field = new xmldb_field('question_id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'responseid');
+ if ($dbman->field_exists($table, 'question_id')) {
+ $dbman->rename_field($table, $field, 'questionid');
+ }
+
+ // Define index response_question (not unique) to be added to questionnaire_response_text.
+ $index = new xmldb_index('response_question', XMLDB_INDEX_NOTUNIQUE, ['responseid', 'questionid']);
+ // Conditionally launch add index response_question.
+ if (!$dbman->index_exists($table, $index)) {
+ $dbman->add_index($table, $index);
+ }
+
+ // Update questionnaire_response_file table.
+ $table = new xmldb_table('questionnaire_response_file');
+
+ // Define index response_question (not unique) to be dropped form questionnaire_response_file.
+ $index = new xmldb_index('response_question', XMLDB_INDEX_NOTUNIQUE, ['response_id', 'question_id']);
+ // Conditionally launch drop index response_question.
+ if ($dbman->index_exists($table, $index)) {
+ $dbman->drop_index($table, $index);
}
+
+ // Rename field response_id on table questionnaire_response_bool to responseid.
+ $field = new xmldb_field('response_id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'id');
+ if ($dbman->field_exists($table, 'response_id')) {
+ // Launch rename field response_id.
+ $dbman->rename_field($table, $field, 'responseid');
+ }
+
+ // Rename field question_id on table questionnaire_response_bool to questionid.
+ $field = new xmldb_field('question_id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'responseid');
+ if ($dbman->field_exists($table, 'question_id')) {
+ // Launch rename field question_id.
+ $dbman->rename_field($table, $field, 'questionid');
+ }
+
+ // Define index response_question (not unique) to be added to questionnaire_response_file.
+ $index = new xmldb_index('response_question', XMLDB_INDEX_NOTUNIQUE, ['responseid', 'questionid']);
+ // Conditionally launch add index response_question.
+ if (!$dbman->index_exists($table, $index)) {
+ $dbman->add_index($table, $index);
+ }
+
+ upgrade_mod_savepoint(true, 2025111100.05, 'questionnaire');
}
- return $status;
+ return true;
}
diff --git a/externallib.php b/externallib.php
index 0b9836f23..df1f3c970 100644
--- a/externallib.php
+++ b/externallib.php
@@ -37,9 +37,6 @@
use external_value;
use external_warnings;
-require_once($CFG->dirroot . '/mod/questionnaire/lib.php');
-require_once($CFG->dirroot . '/mod/questionnaire/questionnaire.class.php');
-
/**
* Questionnaire module external functions
*
@@ -126,13 +123,11 @@ public static function submit_questionnaire_response(
]
);
- [$cm, $course, $questionnaire] = questionnaire_get_standard_page_items($cmid);
- $questionnaire = new \questionnaire($course, $cm, 0, $questionnaire);
+ $questionnaire = \mod_questionnaire\questionnaire::from_cmid($cmid);
- $context = \context_module::instance($cm->id);
- self::validate_context($context);
+ self::validate_context($questionnaire->context());
- require_capability('mod/questionnaire:submit', $context);
+ require_capability('mod/questionnaire:submit', $questionnaire->context());
$result = $questionnaire->save_mobile_data($userid, $sec, $completed, $rid, $submit, $action, $responses);
$result['submitted'] = true;
diff --git a/fbsections.php b/fbsections.php
index e0638906a..e7b15a6c4 100644
--- a/fbsections.php
+++ b/fbsections.php
@@ -24,7 +24,9 @@
*/
require_once("../../config.php");
-require_once($CFG->dirroot . '/mod/questionnaire/questionnaire.class.php');
+
+use mod_questionnaire\questionnaire;
+use mod_questionnaire\output\feedbackpage;
$id = required_param('id', PARAM_INT); // Course module ID.
$section = optional_param('section', 1, PARAM_INT);
@@ -35,65 +37,47 @@
$action = optional_param('action', '', PARAM_ALPHA);
$sectionid = optional_param('sectionid', 0, PARAM_INT);
-if (! $cm = get_coursemodule_from_id('questionnaire', $id)) {
- throw new \moodle_exception('invalidcoursemodule', 'mod_questionnaire');
-}
-
-if (! $course = $DB->get_record("course", ["id" => $cm->course])) {
- throw new \moodle_exception('coursemisconf', 'mod_questionnaire');
-}
-
-if (! $questionnaire = $DB->get_record("questionnaire", ["id" => $cm->instance])) {
- throw new \moodle_exception('invalidcoursemodule', 'mod_questionnaire');
-}
+$questionnaire = questionnaire::from_cmid($id);
// Needed here for forced language courses.
-require_course_login($course, true, $cm);
-$context = context_module::instance($cm->id);
+require_course_login($questionnaire->course(), true, $questionnaire->coursemodule());
-$url = new moodle_url('/mod/questionnaire/fbsections.php', ['id' => $id]);
-$PAGE->set_url($url);
-$PAGE->set_context($context);
-if (!isset($SESSION->questionnaire)) {
- $SESSION->questionnaire = new stdClass();
-}
+$PAGE->set_url(new moodle_url('/mod/questionnaire/fbsections.php', ['id' => $id]));
+$PAGE->set_context($questionnaire->context());
-$questionnaire = new questionnaire($course, $cm, 0, $questionnaire);
+$surveyid = $questionnaire->surveyid();
if ($sectionid) {
// Get the specified section by its id.
- $feedbacksection = new mod_questionnaire\feedback\section($questionnaire->questions, ['id' => $sectionid]);
-} else if (!$DB->count_records('questionnaire_fb_sections', ['surveyid' => $questionnaire->sid])) {
+ $feedbacksection = new mod_questionnaire\local\feedback\section($questionnaire->questions(), ['id' => $sectionid]);
+} else if (!$DB->count_records('questionnaire_fb_sections', ['surveyid' => $surveyid])) {
// There are no sections currently, so create one.
- if ($questionnaire->survey->feedbacksections == 1) {
+ if ($questionnaire->survey()->feedbacksections() == 1) {
$sectionlabel = get_string('feedbackglobal', 'questionnaire');
} else {
$sectionlabel = get_string('feedbackdefaultlabel', 'questionnaire');
}
- $feedbacksection = mod_questionnaire\feedback\section::new_section($questionnaire->sid, $sectionlabel);
+ $feedbacksection = mod_questionnaire\local\feedback\section::new_section($surveyid, $sectionlabel);
} else {
// Get the specified section by section number.
- $feedbacksection = new mod_questionnaire\feedback\section(
- $questionnaire->questions,
- ['surveyid' => $questionnaire->survey->id, 'sectionnum' => $section]
+ $feedbacksection = new mod_questionnaire\local\feedback\section(
+ $questionnaire->questions(),
+ ['surveyid' => $surveyid, 'sectionnum' => $section]
);
}
// Get all questions that are valid feedback questions.
$validquestions = [];
-foreach ($questionnaire->questions as $question) {
+foreach ($questionnaire->questions() as $question) {
if ($question->valid_feedback()) {
- $validquestions[$question->id] = $question->name;
+ $validquestions[$question->id()] = $question->name();
}
}
-// Add renderer and page objects to the questionnaire object for display use.
-$questionnaire->add_renderer($PAGE->get_renderer('mod_questionnaire'));
-$questionnaire->add_page(new \mod_questionnaire\output\feedbackpage());
-
-$SESSION->questionnaire->current_tab = 'feedback';
+$renderer = $PAGE->get_renderer('mod_questionnaire');
+$page = new feedbackpage();
-if (!$questionnaire->capabilities->editquestions) {
+if (!$questionnaire->capabilities()->can_edit_questions()) {
throw new \moodle_exception('nopermissions', 'mod_questionnaire');
}
@@ -106,31 +90,31 @@
$sectionid = required_param('sectionid', PARAM_INT);
if ($sectionid == $feedbacksection->id) {
$feedbacksection->delete();
- redirect(new moodle_url('/mod/questionnaire/fbsections.php', ['id' => $cm->id]));
+ redirect(new moodle_url('/mod/questionnaire/fbsections.php', ['id' => $questionnaire->coursemodule()->id]));
}
}
$customdata = new stdClass();
$customdata->feedbacksection = $feedbacksection;
$customdata->validquestions = $validquestions;
-$customdata->survey = $questionnaire->survey;
+$customdata->survey = $questionnaire->survey()->to_stdclass();
$customdata->sectionselect = $DB->get_records_menu(
'questionnaire_fb_sections',
- ['surveyid' => $questionnaire->survey->id],
+ ['surveyid' => $surveyid],
'section',
'id,sectionlabel'
);
-$feedbackform = new \mod_questionnaire\feedback_section_form('fbsections.php', $customdata);
+$feedbackform = new \mod_questionnaire\feedback_section_form('fbsections.php', $customdata, $renderer);
$sdata = clone($feedbacksection);
-$sdata->sid = $questionnaire->survey->id;
+$sdata->sid = $surveyid;
$sdata->sectionid = $feedbacksection->id;
-$sdata->id = $cm->id;
+$sdata->id = $questionnaire->coursemodule()->id;
$draftideditor = file_get_submitted_draft_itemid('sectionheading');
$currentinfo = file_prepare_draft_area(
$draftideditor,
- $context->id,
+ $questionnaire->context()->id,
'mod_questionnaire',
'sectionheading',
$feedbacksection->id,
@@ -142,7 +126,7 @@
$feedbackform->set_data($sdata);
if ($feedbackform->is_cancelled()) {
- redirect(new moodle_url('/mod/questionnaire/feedback.php', ['id' => $cm->id]));
+ redirect(new moodle_url('/mod/questionnaire/feedback.php', ['id' => $questionnaire->coursemodule()->id]));
}
if ($settings = $feedbackform->get_data()) {
@@ -154,18 +138,22 @@
redirect(
new moodle_url(
'/mod/questionnaire/fbsections.php',
- ['id' => $cm->id, 'sectionid' => $settings->navigatesections]
+ ['id' => $questionnaire->coursemodule()->id, 'sectionid' => $settings->navigatesections]
)
);
}
} else if (isset($settings->addnewsection)) {
- $newsection = mod_questionnaire\feedback\section::new_section($questionnaire->survey->id, $settings->newsectionlabel);
- redirect(new moodle_url('/mod/questionnaire/fbsections.php', ['id' => $cm->id, 'sectionid' => $newsection->id]));
+ $newsection = mod_questionnaire\local\feedback\section::new_section($surveyid, $settings->newsectionlabel);
+ redirect(new moodle_url(
+ '/mod/questionnaire/fbsections.php',
+ ['id' => $questionnaire->coursemodule()->id, 'sectionid' => $newsection->id]
+ ));
} else if (isset($fullform->confirmdeletesection)) {
redirect(
new moodle_url(
'/mod/questionnaire/fbsections.php',
- ['id' => $cm->id, 'sectionid' => $feedbacksection->id, 'action' => 'confirmdeletesection']
+ ['id' => $questionnaire->coursemodule()->id, 'sectionid' => $feedbacksection->id,
+ 'action' => 'confirmdeletesection']
)
);
} else if (isset($fullform->confirmremovequestion)) {
@@ -173,14 +161,15 @@
redirect(
new moodle_url(
'/mod/questionnaire/fbsections.php',
- ['id' => $cm->id, 'sectionid' => $settings->sectionid, 'action' => 'confirmremovequestion', 'qid' => $qid]
+ ['id' => $questionnaire->coursemodule()->id, 'sectionid' => $settings->sectionid,
+ 'action' => 'confirmremovequestion', 'qid' => $qid]
)
);
} else if (isset($settings->addquestion)) {
$scorecalculation = [];
// Check for added question.
if (isset($settings->addquestionselect) && ($settings->addquestionselect != 0)) {
- if ($questionnaire->questions[$settings->addquestionselect]->supports_feedback_scores()) {
+ if ($questionnaire->questions()[$settings->addquestionselect]->supports_feedback_scores()) {
$scorecalculation[$settings->addquestionselect] = 1;
} else {
$scorecalculation[$settings->addquestionselect] = -1;
@@ -203,7 +192,7 @@
$feedbacksection->sectionlabel = $settings->sectionlabel;
$feedbacksection->sectionheading = file_save_draft_area_files(
(int)$settings->sectionheading['itemid'],
- $context->id,
+ $questionnaire->context()->id,
'mod_questionnaire',
'sectionheading',
$feedbacksection->id,
@@ -255,7 +244,7 @@
$feedbacktext = file_save_draft_area_files(
(int)$settings->feedbacktext[$i]['itemid'],
- $context->id,
+ $questionnaire->context()->id,
'mod_questionnaire',
'feedback',
$fbid,
@@ -268,46 +257,46 @@
// Update all feedback data.
$feedbacksection->update();
}
- $feedbackform = new \mod_questionnaire\feedback_section_form('fbsections.php', $customdata);
+ $feedbackform = new \mod_questionnaire\feedback_section_form('fbsections.php', $customdata, $renderer);
}
// Print the page header.
$PAGE->set_title(get_string('editingfeedback', 'questionnaire'));
-$PAGE->set_heading(format_string($course->fullname));
+$PAGE->set_heading(format_string($questionnaire->course()->fullname));
$PAGE->navbar->add(get_string('editingfeedback', 'questionnaire'));
-echo $questionnaire->renderer->header();
-require('tabs.php');
+echo $renderer->header();
+(new \mod_questionnaire\output\tabs($questionnaire, 'feedback'))->render($page);
// Handle confirmations differently.
if ($action == 'confirmremovequestion') {
$sectionid = required_param('sectionid', PARAM_INT);
$qid = required_param('qid', PARAM_INT);
$msgargs = new stdClass();
- $msgargs->qname = $questionnaire->questions[$qid]->name;
+ $msgargs->qname = $questionnaire->questions()[$qid]->name();
$msgargs->sname = $feedbacksection->sectionlabel;
$msg = '' . get_string('confirmremovequestion', 'questionnaire', $msgargs) . '
' .
get_string('confirmdeletesection', 'questionnaire', $feedbacksection->sectionlabel) . '
wwwroot/mod/questionnaire/view.php?id=$questionnaire->coursemodule\">" .
- format_string($questionnaire->name) . '',
- 'name'
- );
-
- // Deadline.
- $str .= $OUTPUT->box(get_string('closeson', 'questionnaire', userdate($questionnaire->closedate)), 'info');
- $attempts = $DB->get_records(
- 'questionnaire_response',
- ['questionnaireid' => $questionnaire->id, 'userid' => $USER->id, 'complete' => 'y']
- );
- $nbattempts = count($attempts);
-
- // Do not display a questionnaire as due if it can only be sumbitted once and it has already been submitted!
- if ($nbattempts != 0 && $questionnaire->qtype == QUESTIONNAIREONCE) {
- continue;
- }
-
- // Attempt information.
- if (has_capability('mod/questionnaire:manage', context_module::instance($questionnaire->coursemodule))) {
- // Number of user attempts.
- $attempts = $DB->count_records(
- 'questionnaire_response',
- ['questionnaireid' => $questionnaire->id, 'complete' => 'y']
- );
- $str .= $OUTPUT->box(get_string('numattemptsmade', 'questionnaire', $attempts), 'info');
- } else {
- if ($responses = questionnaire_get_user_responses($questionnaire->id, $USER->id, false)) {
- foreach ($responses as $response) {
- if ($response->complete == 'y') {
- $str .= $OUTPUT->box($strattempted, 'info');
- break;
- } else {
- $str .= $OUTPUT->box($strsavedbutnotsubmitted, 'info');
- }
- }
- } else {
- $str .= $OUTPUT->box($strnotattempted, 'info');
- }
- }
- $str = $OUTPUT->box($str, 'questionnaire overview');
-
- if (empty($htmlarray[$questionnaire->course]['questionnaire'])) {
- $htmlarray[$questionnaire->course]['questionnaire'] = $str;
- } else {
- $htmlarray[$questionnaire->course]['questionnaire'] .= $str;
- }
- }
- }
+ \mod_questionnaire\questionnaire::print_recent_mod_activity($activity, $courseid, $detail, $modnames);
}
-
/**
* Implementation of the function for printing the form elements that control
* whether the course reset functionality affects the questionnaire.
@@ -1377,79 +471,7 @@ function questionnaire_reset_course_form_defaults($course) {
* @return array status array
*/
function questionnaire_reset_userdata($data) {
- global $CFG, $DB;
- require_once($CFG->libdir . '/questionlib.php');
- require_once($CFG->dirroot . '/mod/questionnaire/locallib.php');
-
- $componentstr = get_string('modulenameplural', 'questionnaire');
- $status = [];
-
- if (!empty($data->reset_questionnaire)) {
- $surveys = questionnaire_get_survey_list($data->courseid, '');
-
- // Delete responses.
- foreach ($surveys as $survey) {
- // Get all responses for this questionnaire.
- $sql = "SELECT qr.id, qr.questionnaireid, qr.submitted, qr.userid, q.sid
- FROM {questionnaire} q
- INNER JOIN {questionnaire_response} qr ON q.id = qr.questionnaireid
- WHERE q.sid = ?
- ORDER BY qr.id";
- $resps = $DB->get_records_sql($sql, [$survey->id]);
- if (!empty($resps)) {
- $questionnaire = $DB->get_record("questionnaire", ["sid" => $survey->id, "course" => $survey->courseid]);
- $questionnaire->course = $DB->get_record("course", ["id" => $questionnaire->course]);
- foreach ($resps as $response) {
- questionnaire_delete_response($response, $questionnaire);
- }
- }
- // Remove this questionnaire's grades (and feedback) from gradebook (if any).
- $select = "itemmodule = 'questionnaire' AND iteminstance = " . $survey->qid;
- $fields = 'id';
- if ($itemid = $DB->get_record_select('grade_items', $select, null, $fields)) {
- $itemid = $itemid->id;
- $DB->delete_records_select('grade_grades', 'itemid = ' . $itemid);
- }
- }
- $status[] = [
- 'component' => $componentstr,
- 'item' => get_string('deletedallresp', 'questionnaire'),
- 'error' => false,
- ];
-
- $status[] = [
- 'component' => $componentstr,
- 'item' => get_string('gradesdeleted', 'questionnaire'),
- 'error' => false,
- ];
- }
- return $status;
-}
-
-/**
- * Obtains the automatic completion state for this questionnaire based on the condition
- * in questionnaire settings.
- *
- * @param object $cm Course-module
- * @param int $userid User ID
- * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
- * @return bool True if completed, false if not, $type if conditions not set.
- *
- */
-function questionnaire_get_completion_state($cm, $userid, $type) {
- global $DB;
-
- // Get questionnaire details.
- $questionnaire = $DB->get_record('questionnaire', ['id' => $cm->instance], '*', MUST_EXIST);
-
- // If completion option is enabled, evaluate it and return true/false.
- if ($questionnaire->completionsubmit) {
- $params = ['userid' => $userid, 'questionnaireid' => $questionnaire->id, 'complete' => 'y'];
- return $DB->record_exists('questionnaire_response', $params);
- } else {
- // Completion option is not enabled so just return $type.
- return $type;
- }
+ return \mod_questionnaire\instance_admin::reset_userdata($data);
}
/**
@@ -1493,45 +515,5 @@ function mod_questionnaire_core_calendar_provide_event_action(
* @throws coding_exception
*/
function mod_questionnaire_coursemodule_edit_post_actions($data, $course) {
- global $DB;
-
- if (!empty($data->copyid)) {
- $cm = (object)['id' => $data->coursemodule];
- $questionnaire = new questionnaire($course, $cm, 0, $data);
- $oldquestionnaireid = $DB->get_field('questionnaire', 'id', ['sid' => $data->copyid]);
- $oldcm = get_coursemodule_from_instance('questionnaire', $oldquestionnaireid);
- $oldquestionnaire = new questionnaire($course, $oldcm, $oldquestionnaireid, null);
- $oldcontext = context_module::instance($oldcm->id);
- $newcontext = context_module::instance($data->coursemodule);
- $areas = $questionnaire->get_all_file_areas();
- $oldareas = $oldquestionnaire->get_all_file_areas();
- $fs = new \mod_questionnaire\file_storage();
- foreach ($areas as $area => $ids) {
- if (is_array($ids)) {
- $oldid = current($oldareas[$area]);
- foreach ($ids as $id) {
- $fs->copy_area_files_to_new_context(
- $oldcontext->id,
- $newcontext->id,
- 'mod_questionnaire',
- $area,
- $oldid,
- $id
- );
- $oldid = next($oldareas[$area]);
- }
- } else {
- $fs->copy_area_files_to_new_context(
- $oldcontext->id,
- $newcontext->id,
- 'mod_questionnaire',
- $area,
- $oldareas[$area],
- $ids
- );
- }
- }
- }
-
- return $data;
+ return \mod_questionnaire\questionnaire::coursemodule_edit_post_actions($data, $course);
}
diff --git a/locallib.php b/locallib.php
deleted file mode 100644
index 6d1933e7a..000000000
--- a/locallib.php
+++ /dev/null
@@ -1,1199 +0,0 @@
-.
-
-/**
- * Updates the contents of the survey with the provided data. If no data is provided, it checks for posted data.
- *
- * This library replaces the phpESP application with Moodle specific code. It will eventually
- * replace all of the phpESP application, removing the dependency on that.
- *
- * @package mod_questionnaire
- * @copyright 2016 Mike Churchward (mike.churchward@poetgroup.org)
- * @author Mike Churchward
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- *
- */
-
-defined('MOODLE_INTERNAL') || die();
-
-require_once($CFG->dirroot . '/calendar/lib.php');
-// Constants.
-
-define('QUESTIONNAIREUNLIMITED', 0);
-define('QUESTIONNAIREONCE', 1);
-define('QUESTIONNAIREDAILY', 2);
-define('QUESTIONNAIREWEEKLY', 3);
-define('QUESTIONNAIREMONTHLY', 4);
-
-define('QUESTIONNAIRE_STUDENTVIEWRESPONSES_NEVER', 0);
-define('QUESTIONNAIRE_STUDENTVIEWRESPONSES_WHENANSWERED', 1);
-define('QUESTIONNAIRE_STUDENTVIEWRESPONSES_WHENCLOSED', 2);
-define('QUESTIONNAIRE_STUDENTVIEWRESPONSES_ALWAYS', 3);
-
-define('QUESTIONNAIRE_MAX_EVENT_LENGTH', 5 * 24 * 60 * 60); // 5 days maximum.
-
-define('QUESTIONNAIRE_DEFAULT_PAGE_COUNT', 20);
-
-define('QUESTIONNAIRE_CONFIRM_DELETE_PERMANENTLY', 'confirmdelpermanentlyq');
-define('QUESTIONNAIRE_RESTORE_PARAM', 'restoreq');
-
-global $questionnairetypes;
-$questionnairetypes = [
- QUESTIONNAIREUNLIMITED => get_string('qtypeunlimited', 'questionnaire'),
- QUESTIONNAIREONCE => get_string('qtypeonce', 'questionnaire'),
- QUESTIONNAIREDAILY => get_string('qtypedaily', 'questionnaire'),
- QUESTIONNAIREWEEKLY => get_string('qtypeweekly', 'questionnaire'),
- QUESTIONNAIREMONTHLY => get_string('qtypemonthly', 'questionnaire'),
-];
-
-global $questionnairerespondents;
-$questionnairerespondents = [
- 'fullname' => get_string('respondenttypefullname', 'questionnaire'),
- 'anonymous' => get_string('respondenttypeanonymous', 'questionnaire'),
-];
-
-global $questionnairerealms;
-$questionnairerealms = [
- 'private' => get_string('private', 'questionnaire'),
- 'public' => get_string('public', 'questionnaire'),
- 'template' => get_string('template', 'questionnaire'),
-];
-
-global $questionnaireresponseviewers;
-$questionnaireresponseviewers = [
- QUESTIONNAIRE_STUDENTVIEWRESPONSES_WHENANSWERED => get_string('responseviewstudentswhenanswered', 'questionnaire'),
- QUESTIONNAIRE_STUDENTVIEWRESPONSES_WHENCLOSED => get_string('responseviewstudentswhenclosed', 'questionnaire'),
- QUESTIONNAIRE_STUDENTVIEWRESPONSES_ALWAYS => get_string('responseviewstudentsalways', 'questionnaire'),
- QUESTIONNAIRE_STUDENTVIEWRESPONSES_NEVER => get_string('responseviewstudentsnever', 'questionnaire'),
-];
-
-global $autonumbering;
-$autonumbering = [
- 0 => get_string('autonumberno', 'questionnaire'),
- 1 => get_string('autonumberquestions', 'questionnaire'),
- 2 => get_string('autonumberpages', 'questionnaire'),
- 3 => get_string('autonumberpagesandquestions', 'questionnaire'),
-];
-
-/**
- * Return the choice values for the content.
- * @param string $content
- * @return stdClass
- */
-function questionnaire_choice_values($content) {
-
- // If we run the content through format_text first, any filters we want to use (e.g. multilanguage) should work.
- // examines the content of a possible answer from radio button, check boxes or rate question
- // returns ->text to be displayed, ->image if present, ->modname name of modality, image ->title.
- $contents = new stdClass();
- $contents->text = '';
- $contents->image = '';
- $contents->modname = '';
- $contents->title = '';
- // Has image.
- if (preg_match('/(image = $matches[0];
- $imageurl = $matches[3];
- // Image has a title or alt text: use one of them.
- if (
- preg_match('/(title=.)([^"]{1,})/', $content, $matches) ||
- preg_match('/(alt=.)([^"]{1,})/', $content, $matches)
- ) {
- $contents->title = $matches[2];
- } else {
- // Image has no title nor alt text: use its filename (without the extension).
- preg_match("/.*\/(.*)\..*$/", $imageurl, $matches);
- $contents->title = $matches[1];
- }
- // Content has text or named modality plus an image.
- if (preg_match('/(.*)(text = $content;
- // DEV JR from version 2.5, a double colon :: must be used here instead of the equal sign.
- if ($pos = strpos($content, '::')) {
- $contents->text = substr($content, $pos + 2);
- $contents->modname = substr($content, 0, $pos);
- }
- return $contents;
-}
-
-/**
- * Get the information about the standard questionnaire JavaScript module.
- * @return array a standard jsmodule structure.
- */
-function questionnaire_get_js_module() {
- return [
- 'name' => 'mod_questionnaire',
- 'fullpath' => '/mod/questionnaire/module.js',
- 'requires' => ['base', 'dom', 'event-delegate', 'event-key',
- 'core_question_engine', 'moodle-core-formchangechecker'],
- 'strings' => [
- ['cancel', 'moodle'],
- ['flagged', 'question'],
- ['functiondisabledbysecuremode', 'quiz'],
- ['startattempt', 'quiz'],
- ['timesup', 'quiz'],
- ['changesmadereallygoaway', 'moodle'],
- ['leftpart', 'questionnaire'],
- ['leftpartdefault', 'questionnaire'],
- ['middlepart', 'questionnaire'],
- ['middlepartdefault', 'questionnaire'],
- ['middlepartwithtwovalues', 'questionnaire'],
- ['middlepartwithtwovaluesdefault', 'questionnaire'],
- ['rightpart', 'questionnaire'],
- ['rightpartdefault', 'questionnaire'],
- ['where', 'questionnaire'],
- ],
- ];
-}
-
-/**
- * Get all the questionnaire responses for a user.
- * @param int $questionnaireid
- * @param int $userid
- * @param bool $complete
- * @return array
- */
-function questionnaire_get_user_responses($questionnaireid, $userid, $complete = true) {
- global $DB;
- $andcomplete = '';
- if ($complete) {
- $andcomplete = " AND complete = 'y' ";
- }
- return $DB->get_records_sql("SELECT *
- FROM {questionnaire_response}
- WHERE questionnaireid = ?
- AND userid = ?
- " . $andcomplete . "
- ORDER BY submitted ASC ", [$questionnaireid, $userid]) ?? [];
-}
-
-/**
- * get the capabilities for the questionnaire
- * @param int $cmid
- * @return object the available capabilities from current user
- */
-function questionnaire_load_capabilities($cmid) {
- static $cb;
-
- if (isset($cb)) {
- return $cb;
- }
-
- $context = questionnaire_get_context($cmid);
-
- $cb = new stdClass();
- $cb->view = has_capability('mod/questionnaire:view', $context);
- $cb->submit = has_capability('mod/questionnaire:submit', $context);
- $cb->viewsingleresponse = has_capability('mod/questionnaire:viewsingleresponse', $context);
- $cb->submissionnotification = has_capability('mod/questionnaire:submissionnotification', $context);
- $cb->downloadresponses = has_capability('mod/questionnaire:downloadresponses', $context);
- $cb->deleteresponses = has_capability('mod/questionnaire:deleteresponses', $context);
- $cb->manage = has_capability('mod/questionnaire:manage', $context);
- $cb->editquestions = has_capability('mod/questionnaire:editquestions', $context);
- $cb->createtemplates = has_capability('mod/questionnaire:createtemplates', $context);
- $cb->createpublic = has_capability('mod/questionnaire:createpublic', $context);
- $cb->readownresponses = has_capability('mod/questionnaire:readownresponses', $context);
- $cb->readallresponses = has_capability('mod/questionnaire:readallresponses', $context);
- $cb->readallresponseanytime = has_capability('mod/questionnaire:readallresponseanytime', $context);
- $cb->printblank = has_capability('mod/questionnaire:printblank', $context);
- $cb->preview = has_capability('mod/questionnaire:preview', $context);
-
- $cb->viewhiddenactivities = has_capability('moodle/course:viewhiddenactivities', $context, null, false);
-
- return $cb;
-}
-
-/**
- * returns the context-id related to the given coursemodule-id
- * @param int $cmid the coursemodule-id
- * @return object $context
- */
-function questionnaire_get_context($cmid) {
- static $context;
-
- if (isset($context)) {
- return $context;
- }
-
- if (!$context = context_module::instance($cmid)) {
- throw new \moodle_exception('badcontext', 'mod_questionnaire');
- }
- return $context;
-}
-
-/**
- * This function *really* shouldn't be needed, but since sometimes we can end up with
- * orphaned surveys, this will clean them up.
- * @return bool
- * @throws dml_exception
- */
-function questionnaire_cleanup() {
- global $DB;
-
- // Find surveys that don't have questionnaires associated with them.
- $sql = 'SELECT qs.* FROM {questionnaire_survey} qs ' .
- 'LEFT JOIN {questionnaire} q ON q.sid = qs.id ' .
- 'WHERE q.sid IS NULL';
-
- if ($surveys = $DB->get_records_sql($sql)) {
- foreach ($surveys as $survey) {
- questionnaire_delete_survey($survey->id, 0);
- }
- }
- // Find deleted questions and remove them from database (with their associated choices, etc.).
- return true;
-}
-
-/**
- * Delete the survey.
- * @param int $sid
- * @param int $questionnaireid
- * @return bool
- */
-function questionnaire_delete_survey($sid, $questionnaireid) {
- global $DB;
- $status = true;
- // Delete all survey attempts and responses.
- if ($responses = $DB->get_records('questionnaire_response', ['questionnaireid' => $questionnaireid], 'id')) {
- foreach ($responses as $response) {
- $status = $status && questionnaire_delete_response($response);
- }
- }
-
- // There really shouldn't be any more, but just to make sure...
- $DB->delete_records('questionnaire_response', ['questionnaireid' => $questionnaireid]);
-
- // Delete all question data for the survey.
- if ($questions = $DB->get_records('questionnaire_question', ['surveyid' => $sid], 'id')) {
- foreach ($questions as $question) {
- $DB->delete_records('questionnaire_quest_choice', ['question_id' => $question->id]);
- questionnaire_delete_dependencies($question->id);
- }
- $status = $status && $DB->delete_records('questionnaire_question', ['surveyid' => $sid]);
- // Just to make sure.
- $status = $status && $DB->delete_records('questionnaire_dependency', ['surveyid' => $sid]);
- }
-
- // Delete all feedback sections and feedback messages for the survey.
- if ($fbsections = $DB->get_records('questionnaire_fb_sections', ['surveyid' => $sid], 'id')) {
- foreach ($fbsections as $fbsection) {
- $DB->delete_records('questionnaire_feedback', ['sectionid' => $fbsection->id]);
- }
- $status = $status && $DB->delete_records('questionnaire_fb_sections', ['surveyid' => $sid]);
- }
-
- $status = $status && $DB->delete_records('questionnaire_survey', ['id' => $sid]);
-
- return $status;
-}
-
-/**
- * Delete permanently questions and data reference.
- *
- * @param int $qid question id.
- * @param int $sid survey question id.
- * @return void
- */
-function questionnaire_delete_permanently_questions($qid, $sid) {
- global $DB;
- $select = 'id = :id AND surveyid = :sid AND deleted IS NOT NULL';
- $DB->delete_records_select('questionnaire_question', $select, ['id' => $qid, 'sid' => $sid]);
- questionnaire_delete_responses($qid);
- questionnaire_delete_dependencies($qid);
-}
-
-/**
- * Log question deleted event.
- *
- * @param int $cmid of module.
- * @param string $questiontype of question.
- * @param int $courseid of question.
- * @return void.
- */
-function questionnaire_observe_event_delete($cmid, $questiontype, $courseid) {
- $context = context_module::instance($cmid);
- $params = [
- 'context' => $context,
- 'courseid' => $courseid,
- 'other' => ['questiontype' => $questiontype],
- ];
- $event = \mod_questionnaire\event\question_deleted::create($params);
- $event->trigger();
-}
-
-/**
- * Restore deleted questions.
- *
- * @param int $qid question id.
- * @param int $sid survey id.
- * @return void
- */
-function questionnaire_restore_deleted_question($qid, $sid) {
- global $DB;
- // Get current deleted question and last position.
- $sql = "SELECT *, (
- SELECT position + 1
- FROM {questionnaire_question}
- WHERE surveyid = ?
- AND deleted IS NULL
- ORDER BY position DESC
- LIMIT 1 ) as lastposition
- FROM {questionnaire_question}
- WHERE id = ?
- AND surveyid = ?
- AND deleted IS NOT NULL";
- $question = $DB->get_record_sql($sql, [$sid, $qid, $sid]);
- if ($question) {
- // Update question using Moodle API. Only 'id' is needed for update_record.
- $question->deleted = null;
- $question->position = $question->lastposition ?? 1;
- $DB->update_record('questionnaire_question', $question);
- }
-}
-
-/**
- * Get range of time permanently in setup cron task.
- */
-function questionnaire_get_range_time_permanently() {
- return get_config('questionnaire_questiondeletion', 'duration');
-}
-
-/**
- * Delete the response.
- * @param stdClass $response
- * @param string $questionnaire
- * @return bool
- */
-function questionnaire_delete_response($response, $questionnaire = '') {
- global $DB;
- $status = true;
- $cm = '';
- $rid = $response->id;
- // The questionnaire_delete_survey function does not send the questionnaire array.
- if ($questionnaire != '') {
- $cm = get_coursemodule_from_instance(
- "questionnaire",
- $questionnaire->id,
- $questionnaire->course->id
- );
- }
-
- // Delete all of the response data for a response.
- $DB->delete_records('questionnaire_response_bool', ['response_id' => $rid]);
- $DB->delete_records('questionnaire_response_date', ['response_id' => $rid]);
- $DB->delete_records('questionnaire_resp_multiple', ['response_id' => $rid]);
- $DB->delete_records('questionnaire_response_other', ['response_id' => $rid]);
- $DB->delete_records('questionnaire_response_rank', ['response_id' => $rid]);
- $DB->delete_records('questionnaire_resp_single', ['response_id' => $rid]);
- $DB->delete_records('questionnaire_response_text', ['response_id' => $rid]);
- $DB->delete_records('questionnaire_response_file', ['response_id' => $rid]);
-
- $status = $status && $DB->delete_records('questionnaire_response', ['id' => $rid]);
-
- if ($status && $cm) {
- // Update completion state if necessary.
- $completion = new completion_info($questionnaire->course);
- if ($completion->is_enabled($cm) == COMPLETION_TRACKING_AUTOMATIC && $questionnaire->completionsubmit) {
- $completion->update_state($cm, COMPLETION_INCOMPLETE, $response->userid);
- }
- }
-
- return $status;
-}
-
-/**
- * Delete all responses for the questionnaire.
- * @param int $qid
- * @return bool
- */
-function questionnaire_delete_responses($qid) {
- global $DB;
-
- // Delete all of the response data for a question.
- $DB->delete_records('questionnaire_response_bool', ['question_id' => $qid]);
- $DB->delete_records('questionnaire_response_date', ['question_id' => $qid]);
- $DB->delete_records('questionnaire_resp_multiple', ['question_id' => $qid]);
- $DB->delete_records('questionnaire_response_other', ['question_id' => $qid]);
- $DB->delete_records('questionnaire_response_rank', ['question_id' => $qid]);
- $DB->delete_records('questionnaire_resp_single', ['question_id' => $qid]);
- $DB->delete_records('questionnaire_response_text', ['question_id' => $qid]);
- $DB->delete_records('questionnaire_response_file', ['question_id' => $qid]);
-
- return true;
-}
-
-/**
- * Delete all dependencies for the questionnaire.
- * @param int $qid
- * @return bool
- */
-function questionnaire_delete_dependencies($qid) {
- global $DB;
-
- // Delete all dependencies for this question.
- $DB->delete_records('questionnaire_dependency', ['questionid' => $qid]);
- $DB->delete_records('questionnaire_dependency', ['dependquestionid' => $qid]);
-
- return true;
-}
-
-/**
- * Delete all page break deleted.
- *
- * @param int $sid question survey id.
- */
-function questionnaire_delete_pagebreaks($sid) {
- global $DB;
- $DB->delete_records_select(
- 'questionnaire_question',
- 'surveyid = :sid AND deleted IS NOT NULL AND type_id = :type_id',
- [
- 'sid' => $sid,
- 'type_id' => QUESPAGEBREAK,
- ]
- );
-}
-
-/**
- * Get a survey selection records.
- * @param int $courseid
- * @param string $type
- * @return array|false
- */
-function questionnaire_get_survey_list($courseid = 0, $type = '') {
- global $DB;
-
- if ($courseid == 0) {
- if (isadmin()) {
- $sql = "SELECT id,name,courseid,realm,status " .
- "{questionnaire_survey} " .
- "ORDER BY realm,name ";
- $params = null;
- } else {
- return false;
- }
- } else {
- if ($type == 'public') {
- $sql = "SELECT s.id,s.name,s.courseid,s.realm,s.status,s.title,q.id as qid,q.name as qname " .
- "FROM {questionnaire} q " .
- "INNER JOIN {questionnaire_survey} s ON s.id = q.sid AND s.courseid = q.course " .
- "WHERE realm = ? " .
- "ORDER BY realm,name ";
- $params = [$type];
- } else if ($type == 'template') {
- $sql = "SELECT s.id,s.name,s.courseid,s.realm,s.status,s.title,q.id as qid,q.name as qname " .
- "FROM {questionnaire} q " .
- "INNER JOIN {questionnaire_survey} s ON s.id = q.sid AND s.courseid = q.course " .
- "WHERE (realm = ?) " .
- "ORDER BY realm,name ";
- $params = [$type];
- } else if ($type == 'private') {
- $sql = "SELECT s.id,s.name,s.courseid,s.realm,s.status,q.id as qid,q.name as qname " .
- "FROM {questionnaire} q " .
- "INNER JOIN {questionnaire_survey} s ON s.id = q.sid " .
- "WHERE s.courseid = ? and realm = ? " .
- "ORDER BY realm,name ";
- $params = [$courseid, $type];
- } else {
- // Current get_survey_list is called from function questionnaire_reset_userdata so we need to get a
- // complete list of all questionnaires in current course to reset them.
- $sql = "SELECT s.id,s.name,s.courseid,s.realm,s.status,q.id as qid,q.name as qname " .
- "FROM {questionnaire} q " .
- "INNER JOIN {questionnaire_survey} s ON s.id = q.sid AND s.courseid = q.course " .
- "WHERE s.courseid = ? " .
- "ORDER BY realm,name ";
- $params = [$courseid];
- }
- }
- return $DB->get_records_sql($sql, $params) ?? [];
-}
-
-/**
- * Get survey selection list.
- * @param int $courseid
- * @param string $type
- * @return array
- */
-function questionnaire_get_survey_select($courseid = 0, $type = '') {
- global $OUTPUT, $DB;
-
- $surveylist = [];
-
- if ($surveys = questionnaire_get_survey_list($courseid, $type)) {
- $strpreview = get_string('preview_questionnaire', 'questionnaire');
- foreach ($surveys as $survey) {
- $originalcourse = $DB->get_record('course', ['id' => $survey->courseid]);
- if (!$originalcourse) {
- // This should not happen, but we found a case where a public survey
- // still existed in a course that had been deleted, and so this
- // code lead to a notice, and a broken link. Since that is useless
- // we just skip surveys like this.
- continue;
- }
-
- // Prevent creating a copy of a public questionnaire IN THE SAME COURSE as the original.
- if (($type == 'public') && ($survey->courseid == $courseid)) {
- continue;
- } else {
- $args = "sid={$survey->id}&popup=1";
- if (!empty($survey->qid)) {
- $args .= "&qid={$survey->qid}";
- }
- $link = new moodle_url("/mod/questionnaire/preview.php?{$args}");
- $action = new popup_action('click', $link);
- $label = $OUTPUT->action_link(
- $link,
- $survey->qname . ' [' . $originalcourse->fullname . ']',
- $action,
- ['title' => $strpreview]
- );
- $surveylist[$type . '-' . $survey->id] = $label;
- }
- }
- }
- return $surveylist;
-}
-
-/**
- * Return the language string for the specified question type.
- * @param int $id
- * @return lang_string|mixed|string
- * @throws coding_exception
- */
-function questionnaire_get_type($id) {
- switch ($id) {
- case 1:
- return get_string('yesno', 'questionnaire');
- case 2:
- return get_string('textbox', 'questionnaire');
- case 3:
- return get_string('essaybox', 'questionnaire');
- case 4:
- return get_string('radiobuttons', 'questionnaire');
- case 5:
- return get_string('checkboxes', 'questionnaire');
- case 6:
- return get_string('dropdown', 'questionnaire');
- case 8:
- return get_string('ratescale', 'questionnaire');
- case 9:
- return get_string('date', 'questionnaire');
- case 10:
- return get_string('numeric', 'questionnaire');
- case 11:
- return get_string('slider', 'questionnaire');
- case 12:
- return get_string('file', 'questionnaire');
- case 100:
- return get_string('sectiontext', 'questionnaire');
- case 99:
- return get_string('sectionbreak', 'questionnaire');
- default:
- return $id;
- }
-}
-
-/**
- * This creates new events given as opendate and closedate by $questionnaire.
- * @param object $questionnaire
- * @return void
- */
-function questionnaire_set_events($questionnaire) {
- // Adding the questionnaire to the eventtable.
- global $DB;
- if ($events = $DB->get_records('event', ['modulename' => 'questionnaire', 'instance' => $questionnaire->id])) {
- foreach ($events as $event) {
- $event = calendar_event::load($event);
- $event->delete();
- }
- }
-
- // The open-event.
- $event = new stdClass();
- $event->description = $questionnaire->name;
- $event->courseid = $questionnaire->course;
- $event->groupid = 0;
- $event->userid = 0;
- $event->modulename = 'questionnaire';
- $event->instance = $questionnaire->id;
- $event->eventtype = 'open';
- $event->type = CALENDAR_EVENT_TYPE_ACTION;
- $event->timestart = $questionnaire->opendate;
- $event->visible = instance_is_visible('questionnaire', $questionnaire);
- $event->timeduration = ($questionnaire->closedate - $questionnaire->opendate);
-
- if ($questionnaire->closedate && $questionnaire->opendate && ($event->timeduration <= QUESTIONNAIRE_MAX_EVENT_LENGTH)) {
- // Single event for the whole questionnaire.
- $event->name = $questionnaire->name;
- $event->timesort = $questionnaire->opendate;
- calendar_event::create($event);
- } else {
- // Separate start and end events.
- $event->timeduration = 0;
- if ($questionnaire->opendate) {
- $event->name = $questionnaire->name .
- ' (' . get_string('questionnaireopens', 'questionnaire') . ')';
- $event->timesort = $questionnaire->opendate;
- calendar_event::create($event);
- unset($event->id); // So we can use the same object for the close event.
- }
- if ($questionnaire->closedate) {
- $event->name = $questionnaire->name .
- ' (' . get_string('questionnairecloses', 'questionnaire') . ')';
- $event->timestart = $questionnaire->closedate;
- $event->timesort = $questionnaire->closedate;
- $event->eventtype = 'close';
- calendar_event::create($event);
- }
- }
-}
-
-/**
- * Get users who have not completed the questionnaire
- *
- * @param object $cm
- * @param int $sid
- * @param bool $group single groupid
- * @param string $sort
- * @param bool $startpage
- * @param bool $pagecount
- * @return object the userrecords
- * @throws coding_exception
- * @throws dml_exception
- */
-function questionnaire_get_incomplete_users(
- $cm,
- $sid,
- $group = false,
- $sort = '',
- $startpage = false,
- $pagecount = false
-) {
-
- global $DB;
-
- $context = context_module::instance($cm->id);
-
- // First get all users who can complete this questionnaire.
- $cap = 'mod/questionnaire:submit';
- $fields = 'u.id, u.username';
- if (!$allusers = get_enrolled_users($context, $cap, $group, $fields, $sort)) {
- return false;
- }
- $allusers = array_keys($allusers);
-
- // Nnow get all completed questionnaires.
- $params = ['questionnaireid' => $cm->instance, 'complete' => 'y'];
- $sql = "SELECT userid FROM {questionnaire_response} " .
- "WHERE questionnaireid = :questionnaireid AND complete = :complete " .
- "GROUP BY userid ";
-
- if (!$completedusers = $DB->get_records_sql($sql, $params)) {
- return $allusers;
- }
- $completedusers = array_keys($completedusers);
- // Now strike all completedusers from allusers.
- $allusers = array_diff($allusers, $completedusers);
- // For paging I use array_slice().
- if (($startpage !== false) && ($pagecount !== false)) {
- $allusers = array_slice($allusers, $startpage, $pagecount);
- }
- return $allusers;
-}
-
-/**
- * Called by HTML editor in showrespondents and Essay question. Based on question/essay/renderer.
- * Pending general solution to using the HTML editor outside of moodleforms in Moodle pages.
- * @param int $context
- * @return array
- */
-function questionnaire_get_editor_options($context) {
- return [
- 'subdirs' => 0,
- 'maxbytes' => 0,
- 'maxfiles' => -1,
- 'context' => $context,
- 'noclean' => 0,
- 'trusttext' => 0,
- ];
-}
-
-/**
- * Get the parent of a child question.
- * @param stdClass $question
- * @return array
- */
-function questionnaire_get_parent($question) {
- global $DB;
- $qid = $question->id;
- $parent = [];
- $dependquestion = $DB->get_record(
- 'questionnaire_question',
- ['id' => $question->dependquestionid],
- 'id, position, name, type_id'
- );
- if (is_object($dependquestion)) {
- $qdependchoice = '';
- switch ($dependquestion->type_id) {
- case QUESRADIO:
- case QUESDROP:
- case QUESCHECK:
- $dependchoice = $DB->get_record('questionnaire_quest_choice', ['id' => $question->dependchoiceid], 'id,content');
- $qdependchoice = $dependchoice->id;
- $dependchoice = $dependchoice->content;
-
- $contents = questionnaire_choice_values($dependchoice);
- if ($contents->modname) {
- $dependchoice = $contents->modname;
- }
- break;
- case QUESYESNO:
- switch ($question->dependchoiceid) {
- case 0:
- $dependchoice = get_string('yes');
- $qdependchoice = 'y';
- break;
- case 1:
- $dependchoice = get_string('no');
- $qdependchoice = 'n';
- break;
- }
- break;
- }
- // Qdependquestion, parenttype and qdependchoice fields to be used in preview mode.
- $parent[$qid]['qdependquestion'] = 'q' . $dependquestion->id;
- $parent[$qid]['qdependchoice'] = $qdependchoice;
- $parent[$qid]['parenttype'] = $dependquestion->type_id;
- // Other fields to be used in Questions edit mode.
- $parent[$qid]['position'] = $question->position;
- $parent[$qid]['name'] = $question->name;
- $parent[$qid]['content'] = $question->content;
- $parent[$qid]['parentposition'] = $dependquestion->position;
- $parent[$qid]['parent'] = format_string($dependquestion->name) . '->' . format_string($dependchoice);
- }
- return $parent;
-}
-
-/**
- * Get parent position of all child questions in current questionnaire.
- * Use the parent with the largest position value.
- *
- * @param array $questions
- * @return array An array with Child-ID->Parentposition.
- */
-function questionnaire_get_parent_positions($questions) {
- $parentpositions = [];
- foreach ($questions as $question) {
- foreach ($question->dependencies as $dependency) {
- $dependquestion = $dependency->dependquestionid;
- if (isset($dependquestion) && $dependquestion != 0) {
- $childid = $question->id;
- $parentpos = $questions[$dependquestion]->position;
-
- if (!isset($parentpositions[$childid])) {
- $parentpositions[$childid] = $parentpos;
- }
- if (isset($parentpositions[$childid]) && $parentpos > $parentpositions[$childid]) {
- $parentpositions[$childid] = $parentpos;
- }
- }
- }
- }
- return $parentpositions;
-}
-
-/**
- * Get child position of all parent questions in current questionnaire.
- * Use the child with the smallest position value.
- *
- * @param array $questions
- * @return array An array with Parent-ID->Childposition.
- */
-function questionnaire_get_child_positions($questions) {
- $childpositions = [];
- foreach ($questions as $question) {
- foreach ($question->dependencies as $dependency) {
- $dependquestion = $dependency->dependquestionid;
- if (isset($dependquestion) && $dependquestion != 0) {
- $parentid = $questions[$dependquestion]->id; // Equals $dependquestion?.
- $childpos = $question->position;
-
- if (!isset($childpositions[$parentid])) {
- $childpositions[$parentid] = $childpos;
- }
-
- if (isset($childpositions[$parentid]) && $childpos < $childpositions[$parentid]) {
- $childpositions[$parentid] = $childpos;
- }
- }
- }
- }
- return $childpositions;
-}
-
-/**
- * Check that the needed page breaks are present to separate child questions.
- * @param stdClass $questionnaire
- * @return false|lang_string|string
- */
-function questionnaire_check_page_breaks($questionnaire) {
- global $DB;
- $msg = '';
- // Store the new page breaks ids.
- $newpbids = [];
- $delpb = 0;
- $sid = $questionnaire->survey->id;
- $positions = [];
- if (
- $questions = $DB->get_records_select(
- 'questionnaire_question',
- 'surveyid = :sid AND deleted IS NULL',
- ['sid' => $sid],
- 'position'
- )
- ) {
- foreach ($questions as $key => $qu) {
- $newqu = new stdClass();
- $newqu->question_id = $key;
- $newqu->type_id = $qu->type_id;
- $newqu->qname = $qu->name;
- $newqu->qpos = $qu->position;
-
- $dependencies = $DB->get_records(
- 'questionnaire_dependency',
- ['questionid' => $key,
- 'surveyid' => $sid],
- 'id ASC',
- 'id, dependquestionid, dependchoiceid, dependlogic'
- );
- $newqu->dependencies = $dependencies ?? [];
- $positions[] = (array)$newqu;
- }
- }
- $count = count($positions);
-
- for ($i = $count - 1; $i >= 0; $i--) {
- $qu = $positions[$i];
- $questionnb = $i;
- $prevqu = null;
- $prevtypeid = null;
- if ($i > 0) {
- $prevqu = $positions[$i - 1];
- $prevtypeid = $prevqu['type_id'];
- }
- if ($qu['type_id'] == QUESPAGEBREAK) {
- $questionnb--;
- // If more than one consecutive page breaks, remove extra one(s).
- // Remove that extra page break in 1st position.
- if ($prevtypeid == QUESPAGEBREAK || $i == $count - 1 || $qu['qpos'] == 1) {
- $qid = $qu['question_id'];
- $delpb++;
- $msg .= get_string("checkbreaksremoved", "questionnaire", $delpb) . '' . $ruser . ' ';
- if ($this->survey_is_public()) {
- // For a public questionnaire, look for the course that used it.
- $coursename = '';
- $sql = 'SELECT q.id, q.course, c.fullname ' .
- 'FROM {questionnaire_response} qr ' .
- 'INNER JOIN {questionnaire} q ON qr.questionnaireid = q.id ' .
- 'INNER JOIN {course} c ON q.course = c.id ' .
- 'WHERE qr.id = ? AND qr.complete = ? ';
- if ($record = $DB->get_record_sql($sql, [$rid, 'y'])) {
- $coursename = $record->fullname;
- }
- $respinfo .= ' ' . get_string('course') . ': ' . $coursename;
- }
- $respinfo .= $groupname;
- $respinfo .= $timesubmitted;
- $this->page->add_to_page('respondentinfo', $this->renderer->respondent_info($respinfo));
- }
-
- // We don't want to display the print icon in the print popup window itself!
- if ($this->capabilities->printblank && $blankquestionnaire && $section == 1) {
- // Open print friendly as popup window.
- $linkname = ' ' . get_string('printblank', 'questionnaire');
- $title = get_string('printblanktooltip', 'questionnaire');
- $url = '/mod/questionnaire/print.php?qid=' . $this->id . '&rid=0&' . 'courseid=' .
- $this->course->id . '&sec=1';
- $options = [
- 'menubar' => true,
- 'location' => false,
- 'scrollbars' => true,
- 'resizable' => true,
- 'height' => 600,
- 'width' => 800,
- 'title' => $title,
- ];
- $name = 'popup';
- $link = new moodle_url($url);
- $action = new popup_action('click', $link, $name, $options);
- $class = "floatprinticon";
- $this->page->add_to_page(
- 'printblank',
- $this->renderer->action_link(
- $link,
- $linkname,
- $action,
- ['class' => $class, 'title' => $title],
- new pix_icon('t/print', $title)
- )
- );
- }
- if ($section == 1) {
- if (!empty($this->survey->title)) {
- $this->survey->title = format_string($this->survey->title);
- $this->page->add_to_page('title', $this->survey->title);
- }
- if (!empty($this->survey->subtitle)) {
- $this->survey->subtitle = format_string($this->survey->subtitle);
- $this->page->add_to_page('subtitle', $this->survey->subtitle);
- }
- if ($this->survey->info) {
- $infotext = file_rewrite_pluginfile_urls(
- $this->survey->info,
- 'pluginfile.php',
- $this->context->id,
- 'mod_questionnaire',
- 'info',
- $this->survey->id
- );
- $this->page->add_to_page('addinfo', format_text($infotext, FORMAT_HTML, ['noclean' => true]));
- }
- }
-
- if ($message) {
- $this->page->add_to_page('message', $this->renderer->notification($message, \core\output\notification::NOTIFY_ERROR));
- }
- }
-
- /**
- * Print the end of the survey page.
- * @param int $section
- * @param int $numsections
- */
- private function print_survey_end($section, $numsections) {
- // If no pages autonumbering.
- if (!$this->pages_autonumbered()) {
- return;
- }
- if ($numsections > 1) {
- $a = new stdClass();
- $a->page = $section;
- $a->totpages = $numsections;
- $this->page->add_to_page(
- 'pageinfo',
- $this->renderer->container(
- get_string('pageof', 'questionnaire', $a) . ' ',
- 'surveyPage'
- )
- );
- }
- }
-
- /**
- * Display a survey suitable for printing.
- * @param int $courseid
- * @param string $message
- * @param string $referer
- * @param int $rid
- * @param bool $blankquestionnaire If we are printing a blank questionnaire.
- * @return false|void
- */
- public function survey_print_render($courseid, $message = '', $referer = '', $rid = 0, $blankquestionnaire = false) {
- global $DB, $CFG;
-
- if (! $course = $DB->get_record("course", ["id" => $courseid])) {
- throw new \moodle_exception('incorrectcourseid', 'mod_questionnaire');
- }
-
- $this->course = $course;
-
- if (!empty($rid)) {
- // If we're viewing a response, use this method.
- $this->view_response($rid, $referer);
- return;
- }
-
- if (empty($section)) {
- $section = 1;
- }
-
- if (isset($this->questionsbysec)) {
- $numsections = count($this->questionsbysec);
- } else {
- $numsections = 0;
- }
-
- if ($section > $numsections) {
- return(false); // Invalid section.
- }
-
- $hasrequired = $this->has_required();
-
- // Find out what question number we are on $i.
- $i = 1;
- for ($j = 2; $j <= $section; $j++) {
- $i += count($this->questionsbysec[$j - 1]);
- }
-
- $action = $CFG->wwwroot . '/mod/questionnaire/preview.php?id=' . $this->cm->id;
- $this->page->add_to_page(
- 'formstart',
- $this->renderer->complete_formstart($action)
- );
- // Print all sections.
- $formdata = new stdClass();
- $errors = 1;
- if (data_submitted()) {
- $formdata = data_submitted();
- $formdata->rid = $formdata->rid ?? 0;
- $this->add_response_from_formdata($formdata);
- $pageerror = '';
- $s = 1;
- $errors = 0;
- foreach ($this->questionsbysec as $section) {
- $errormessage = $this->response_check_format($s, $formdata);
- if ($errormessage) {
- if ($numsections > 1) {
- $pageerror = get_string('page', 'questionnaire') . ' ' . $s . ' : ';
- }
- $this->page->add_to_page(
- 'notifications',
- $this->renderer->notification($pageerror . $errormessage, \core\output\notification::NOTIFY_ERROR)
- );
- $errors++;
- }
- $s++;
- }
- }
-
- $this->print_survey_start($message, 1, 1, $hasrequired, '');
-
- if (($referer == 'preview') && $this->has_dependencies()) {
- $allqdependants = $this->get_dependants_and_choices();
- } else {
- $allqdependants = [];
- }
- if ($errors == 0) {
- $this->page->add_to_page(
- 'message',
- $this->renderer->notification(
- get_string('submitpreviewcorrect', 'questionnaire'),
- \core\output\notification::NOTIFY_SUCCESS
- )
- );
- }
-
- $page = 1;
- foreach ($this->questionsbysec as $section) {
- $output = '';
- if ($numsections > 1) {
- $output .= $this->renderer->print_preview_pagenumber(get_string('page', 'questionnaire') . ' ' . $page);
- $page++;
- }
- foreach ($section as $questionid) {
- if (!$this->questions[$questionid]->is_numbered()) {
- $i--;
- }
- if (isset($allqdependants[$questionid])) {
- $dependants = $allqdependants[$questionid];
- } else {
- $dependants = [];
- }
- $this->questions[$questionid]->set_isprint($referer === 'print');
- $output .= $this->renderer->question_output(
- $this->questions[$questionid],
- $this->responses[0] ?? new \mod_questionnaire\responsetype\response\response(),
- $i++,
- null,
- $dependants
- );
- $this->page->add_to_page('questions', $output);
- $output = '';
- }
- }
- // End of questions.
- if ($referer == 'preview' && !$blankquestionnaire) {
- $url = $CFG->wwwroot . '/mod/questionnaire/preview.php?id=' . $this->cm->id;
- $this->page->add_to_page(
- 'formend',
- $this->renderer->print_preview_formend(
- $url,
- get_string('submitpreview', 'questionnaire'),
- get_string('reset')
- )
- );
- }
- return;
- }
-
- /**
- * Update an existing survey.
- * @param stdClass $sdata
- * @return bool|int
- */
- public function survey_update($sdata) {
- global $DB;
-
- $errstr = ''; // TODO: notused!
-
- // New survey.
- if (empty($this->survey->id)) {
- // Create a new survey in the database.
- $fields = [
- 'name',
- 'realm',
- 'title',
- 'subtitle',
- 'email',
- 'theme',
- 'thanks_page',
- 'thank_head',
- 'thank_body',
- 'feedbacknotes',
- 'info',
- 'feedbacksections',
- 'feedbackscores',
- 'chart_type',
- ];
- // Theme field deprecated.
- $record = new stdClass();
- $record->id = 0;
- $record->courseid = $sdata->courseid;
- foreach ($fields as $f) {
- if (isset($sdata->$f)) {
- $record->$f = $sdata->$f;
- }
- }
-
- $this->survey = new stdClass();
- $this->survey->id = $DB->insert_record('questionnaire_survey', $record);
- $this->add_survey($this->survey->id);
-
- if (!$this->survey->id) {
- $errstr = get_string('errnewname', 'questionnaire') . ' [ : ]'; // TODO: notused!
- return(false);
- }
- } else {
- if (empty($sdata->name) || empty($sdata->title) || empty($sdata->realm)) {
- return(false);
- }
- if (!isset($sdata->chart_type)) {
- $sdata->chart_type = '';
- }
-
- $fields = [
- 'name',
- 'realm',
- 'title',
- 'subtitle',
- 'email',
- 'theme',
- 'thanks_page',
- 'thank_head',
- 'thank_body',
- 'feedbacknotes',
- 'info',
- 'feedbacksections',
- 'feedbackscores',
- 'chart_type',
- ];
- $name = $DB->get_field('questionnaire_survey', 'name', ['id' => $this->survey->id]);
-
- // Trying to change survey name.
- if (trim($name) != trim(stripslashes($sdata->name))) { // Var $sdata will already have slashes added to it.
- $count = $DB->count_records('questionnaire_survey', ['name' => $sdata->name]);
- if ($count != 0) {
- $errstr = get_string('errnewname', 'questionnaire'); // TODO: notused!
- return(false);
- }
- }
-
- // UPDATE the row in the DB with current values.
- $surveyrecord = new stdClass();
- $surveyrecord->id = $this->survey->id;
- foreach ($fields as $f) {
- if (isset($sdata->{$f})) {
- $surveyrecord->$f = trim($sdata->{$f});
- }
- }
-
- $result = $DB->update_record('questionnaire_survey', $surveyrecord);
- if (!$result) {
- $errstr = get_string('warning', 'questionnaire') . ' [ : ]'; // TODO: notused!
- return(false);
- }
- }
-
- return($this->survey->id);
- }
-
- /**
- * Creates an editable copy of a survey.
- * @param int $owner
- * @return bool|int
- */
- public function survey_copy($owner) {
- global $DB;
-
- // Clear the sid, clear the creation date, change the name, and clear the status.
- $survey = clone($this->survey);
-
- unset($survey->id);
- $survey->courseid = $owner;
- // Make sure that the survey name is not larger than the field size (CONTRIB-2999). Leave room for extra chars.
- $survey->name = core_text::substr($survey->name, 0, (64 - 10));
-
- $survey->name .= '_copy';
- $survey->status = 0;
-
- // Check for 'name' conflict, and resolve.
- $i = 0;
- $name = $survey->name;
- while ($DB->count_records('questionnaire_survey', ['name' => $name]) > 0) {
- $name = $survey->name . (++$i);
- }
- if ($i) {
- $survey->name .= $i;
- }
-
- // Create new survey.
- if (!($newsid = $DB->insert_record('questionnaire_survey', $survey))) {
- return(false);
- }
-
- // Make copies of all the questions.
- $pos = 1;
- // Skip logic: some changes needed here for dependencies down below.
- $qidarray = [];
- $cidarray = [];
- foreach ($this->questions as $question) {
- // Fix some fields first.
- $oldid = $question->id;
- unset($question->id);
- $question->surveyid = $newsid;
- $question->position = $pos++;
-
- // Copy question to new survey.
- if (!($newqid = $DB->insert_record('questionnaire_question', $question))) {
- return(false);
- }
- $qidarray[$oldid] = $newqid;
- foreach ($question->choices as $key => $choice) {
- $oldcid = $key;
- $newchoice = (object) [
- 'question_id' => $newqid,
- 'content' => $choice->content,
- 'value' => $choice->value,
- ];
- if (!$newcid = $DB->insert_record('questionnaire_quest_choice', $newchoice)) {
- return(false);
- }
- $cidarray[$oldcid] = $newcid;
- }
- }
-
- // Replicate all dependency data.
- if ($dependquestions = $DB->get_records('questionnaire_dependency', ['surveyid' => $this->survey->id], 'questionid')) {
- foreach ($dependquestions as $dquestion) {
- $record = new stdClass();
- $record->questionid = $qidarray[$dquestion->questionid];
- $record->surveyid = $newsid;
- $record->dependquestionid = $qidarray[$dquestion->dependquestionid];
- // The response may not use choice id's (example boolean). If not, just copy the value.
- $responsetype = $this->questions[$dquestion->dependquestionid]->responsetype;
- if ($responsetype->transform_choiceid($dquestion->dependchoiceid) == $dquestion->dependchoiceid) {
- $record->dependchoiceid = $cidarray[$dquestion->dependchoiceid];
- } else {
- $record->dependchoiceid = $dquestion->dependchoiceid;
- }
- $record->dependlogic = $dquestion->dependlogic;
- $record->dependandor = $dquestion->dependandor;
- $DB->insert_record('questionnaire_dependency', $record);
- }
- }
-
- // Replicate any feedback data.
- // TODO: Need to handle image attachments (same for other copies above).
- if ($fbsections = $DB->get_records('questionnaire_fb_sections', ['surveyid' => $this->survey->id], 'id')) {
- foreach ($fbsections as $fbsid => $fbsection) {
- $fbsection->surveyid = $newsid;
- $scorecalculation = section::decode_scorecalculation($fbsection->scorecalculation);
- $newscorecalculation = [];
- foreach ($scorecalculation as $qid => $val) {
- $newscorecalculation[$qidarray[$qid]] = $val;
- }
- $fbsection->scorecalculation = serialize($newscorecalculation);
- unset($fbsection->id);
- $newfbsid = $DB->insert_record('questionnaire_fb_sections', $fbsection);
- if ($feedbackrecs = $DB->get_records('questionnaire_feedback', ['sectionid' => $fbsid], 'id')) {
- foreach ($feedbackrecs as $feedbackrec) {
- $feedbackrec->sectionid = $newfbsid;
- unset($feedbackrec->id);
- $DB->insert_record('questionnaire_feedback', $feedbackrec);
- }
- }
- }
- }
-
- return($newsid);
- }
-
- // RESPONSE LIBRARY.
-
- /**
- * Check that all questions have been answered in a suitable way.
- * @param int $section
- * @param stdClass $formdata
- * @param bool $checkmissing
- * @param bool $checkwrongformat
- * @return string
- */
- private function response_check_format($section, $formdata, $checkmissing = true, $checkwrongformat = true) {
- $missing = 0;
- $strmissing = ''; // Missing questions.
- $wrongformat = 0;
- $strwrongformat = ''; // Wrongly formatted questions (Numeric, 5:Check Boxes, Date).
- $i = 1;
- for ($j = 2; $j <= $section; $j++) {
- // ADDED A SIMPLE LOOP FOR MAKING SURE PAGE BREAKS (type 99) AND LABELS (type 100) ARE NOT ALLOWED.
- foreach ($this->questionsbysec[$j - 1] as $questionid) {
- $tid = $this->questions[$questionid]->type_id;
- if ($tid < QUESPAGEBREAK) {
- $i++;
- }
- }
- }
- $qnum = $i - 1;
-
- if (key_exists($section, $this->questionsbysec)) {
- foreach ($this->questionsbysec[$section] as $questionid) {
- if ($this->questions[$questionid]->is_numbered()) {
- $qnum++;
- }
- if (!$this->questions[$questionid]->response_complete($formdata)) {
- $missing++;
- $strnum = get_string('num', 'questionnaire') . $qnum . '. ';
- $strmissing .= $strnum;
- // Pop-up notification at the point of the error.
- $strnoti = get_string('missingquestion', 'questionnaire') . $strnum;
- $this->questions[$questionid]->add_notification($strnoti);
- }
- if (!$this->questions[$questionid]->response_valid($formdata)) {
- $wrongformat++;
- $strwrongformat .= get_string('num', 'questionnaire') . $qnum . '. ';
- }
- }
- }
- $message = '';
- $nonumbering = false;
- // If no questions autonumbering do not display missing question(s) number(s).
- if (!$this->questions_autonumbered()) {
- $nonumbering = true;
- }
- if ($checkmissing && $missing) {
- if ($nonumbering) {
- $strmissing = '';
- }
- if ($missing == 1) {
- $message = get_string('missingquestion', 'questionnaire') . $strmissing;
- } else {
- $message = get_string('missingquestions', 'questionnaire') . $strmissing;
- }
- if ($wrongformat) {
- $message .= '' . get_string($langstringhtml, 'questionnaire', $info) . '
';
- if (!empty($message)) {
- $info->posttext .= html_to_text($message);
- $info->posthtml .= $message;
- }
-
- foreach ($notifyusers as $notifyuser) {
- $info->userto = $notifyuser;
- $this->send_message($info, 'notification');
- }
- }
-
- return $success;
- }
-
- /**
- * Message someone about something.
- *
- * @param object $info The information for the message.
- * @param string $eventtype
- * @return void
- */
- private function send_message($info, $eventtype) {
- $eventdata = new \core\message\message();
- $eventdata->courseid = $this->course->id;
- $eventdata->modulename = 'questionnaire';
- $eventdata->userfrom = $info->userfrom;
- $eventdata->userto = $info->userto;
- $eventdata->subject = $info->postsubject;
- $eventdata->fullmessage = $info->posttext;
- $eventdata->fullmessageformat = FORMAT_PLAIN;
- $eventdata->fullmessagehtml = $info->posthtml;
- $eventdata->smallmessage = $info->postsubject;
-
- $eventdata->name = $eventtype;
- $eventdata->component = 'mod_questionnaire';
- $eventdata->notification = 1;
- $eventdata->contexturl = $info->submissionurl;
- $eventdata->contexturlname = $info->name;
-
- message_send($eventdata);
- }
-
- /**
- * Returns a list of users that should receive notification about given submission.
- *
- * @param int $userid The submission to grade
- * @return array
- */
- public function get_notifiable_users($userid) {
- // Potential users should be active users only.
- $potentialusers = get_enrolled_users(
- $this->context,
- 'mod/questionnaire:submissionnotification',
- null,
- 'u.*',
- null,
- null,
- null,
- true
- );
-
- $notifiableusers = [];
- if (groups_get_activity_groupmode($this->cm) == SEPARATEGROUPS) {
- if ($groups = groups_get_all_groups($this->course->id, $userid, $this->cm->groupingid)) {
- foreach ($groups as $group) {
- foreach ($potentialusers as $potentialuser) {
- if ($potentialuser->id == $userid) {
- // Do not send self.
- continue;
- }
- if (groups_is_member($group->id, $potentialuser->id)) {
- $notifiableusers[$potentialuser->id] = $potentialuser;
- }
- }
- }
- } else {
- // User not in group, try to find graders without group.
- foreach ($potentialusers as $potentialuser) {
- if ($potentialuser->id == $userid) {
- // Do not send self.
- continue;
- }
- if (!groups_has_membership($this->cm, $potentialuser->id)) {
- $notifiableusers[$potentialuser->id] = $potentialuser;
- }
- }
- }
- } else {
- foreach ($potentialusers as $potentialuser) {
- if ($potentialuser->id == $userid) {
- // Do not send self.
- continue;
- }
- $notifiableusers[$potentialuser->id] = $potentialuser;
- }
- }
- return $notifiableusers;
- }
-
- /**
- * Return a formatted string containing all the questions and answers for a specific submission.
- * @param int $rid
- * @return string
- */
- private function get_full_submission_for_notifications($rid) {
- $responses = $this->get_full_submission_for_export($rid);
- $message = '';
- foreach ($responses as $response) {
- $message .= html_to_text(format_string($response->questionname)) . "' . $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'];
-
- // Use plaintext version for altbody.
- $altbody = "\n$bodyplaintext\n";
-
- $return = true;
- $mailaddresses = preg_split('/,|;/', $email);
- foreach ($mailaddresses as $email) {
- $userto = new stdClass();
- $userto->email = trim($email);
- $userto->mailformat = 1;
- // Dummy userid to keep email_to_user happy in moodle 2.6.
- $userto->id = -10;
- $userfrom = $CFG->noreplyaddress;
- if (email_to_user($userto, $userfrom, $subject, $altbody, $bodyhtml)) {
- $return = $return && true;
- } else {
- $return = false;
- }
- }
- return $return;
- }
-
- /**
- * 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($responsedata->rid)) {
- // Create a uniqe id for this response.
- $record->questionnaireid = $this->id;
- $record->userid = $userid;
- $responsedata->rid = $DB->insert_record('questionnaire_response', $record);
- $responsedata->id = $responsedata->rid;
- } else {
- $record->id = $responsedata->rid;
- $DB->update_record('questionnaire_response', $record);
- }
- if ($resume) {
- // Log this saved response.
- // Needed for the event logging.
- $context = context_module::instance($this->cm->id);
- $anonymous = $this->respondenttype == 'anonymous';
- $params = [
- 'context' => $context,
- 'courseid' => $this->course->id,
- 'relateduserid' => $userid,
- 'anonymous' => $anonymous,
- 'other' => ['questionnaireid' => $this->id],
- ];
- $event = \mod_questionnaire\event\attempt_saved::create($params);
- $event->trigger();
- }
-
- 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($responsedata->rid);
- }
-
- /**
- * 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\responsetype\boolean::response_select($rid);
-
- // Response_single (radio button or dropdown).
- $values += \mod_questionnaire\responsetype\single::response_select($rid);
-
- // Response_multiple.
- $values += \mod_questionnaire\responsetype\multiple::response_select($rid);
-
- // Response_rank.
- $values += \mod_questionnaire\responsetype\rank::response_select($rid);
-
- // Response_text.
- $values += \mod_questionnaire\responsetype\text::response_select($rid);
-
- // Response_date.
- $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;
-
- $select = 'id = ' . $this->survey->id;
- $fields = 'thanks_page, thank_head, thank_body';
- if ($result = $DB->get_record_select('questionnaire_survey', $select, null, $fields)) {
- $thankurl = $result->thanks_page;
- $thankhead = $result->thank_head;
- $thankbody = $result->thank_body;
- } else {
- $thankurl = '';
- $thankhead = '';
- $thankbody = '';
- }
- if (!empty($thankurl)) {
- if (!headers_sent()) {
- header("Location: $thankurl");
- exit;
- }
- echo '
-
-
- Thank You for completing this survey.
- Please click
- here to continue.
-
- ';
- exit;
- }
- 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', format_string($thankhead));
- $this->page->add_to_page(
- 'addinfo',
- format_text(
- file_rewrite_pluginfile_urls(
- $thankbody,
- 'pluginfile.php',
- $this->context->id,
- 'mod_questionnaire',
- 'thankbody',
- $this->survey->id
- ),
- FORMAT_HTML,
- ['noclean' => true]
- )
- );
- // Default set currentgroup to view all participants.
- // TODO why not set to current respondent's groupid (if any)?
- $currentgroupid = 0;
- $currentgroupid = groups_get_activity_group($this->cm);
- if (!groups_is_member($currentgroupid, $USER->id)) {
- $currentgroupid = 0;
- }
- if ($this->capabilities->readownresponses) {
- $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 {
- $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, $USER;
- $resumesurvey = get_string('resumesurvey', 'questionnaire');
- $savedprogress = get_string('savedprogress', 'questionnaire', '' . $resumesurvey . ' ');
-
- $this->page->add_to_page(
- 'notifications',
- $this->renderer->notification($savedprogress, \core\output\notification::NOTIFY_SUCCESS)
- );
- $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;
-
- // Is this questionnaire set to fullname or anonymous?
- $isfullname = $this->respondenttype != 'anonymous';
- if ($isfullname) {
- $responses = $this->get_responses(false, $currentgroupid);
- } else {
- $responses = $this->get_responses();
- }
- if (!$responses) {
- return;
- }
- $total = count($responses);
- if ($total === 0) {
- return;
- }
- $rids = [];
- if ($isfullname) {
- $ridssub = [];
- $ridsuserfullname = [];
- $ridsuserid = [];
- }
- $i = 0;
- $currpos = -1;
- foreach ($responses as $response) {
- array_push($rids, $response->id);
- if ($isfullname) {
- $user = $DB->get_record('user', ['id' => $response->userid]);
- array_push($ridssub, $response->submitted);
- array_push($ridsuserfullname, fullname($user));
- array_push($ridsuserid, $response->userid);
- }
- if ($response->id == $currrid) {
- $currpos = $i;
- }
- $i++;
- }
-
- $url = $CFG->wwwroot . '/mod/questionnaire/report.php?action=vresp&group=' . $currentgroupid . '&individualresponse=1';
- if (!$byresponse) { // Display navbar.
- // Build navbar.
- $navbar = new \stdClass();
- $prevrid = ($currpos > 0) ? $rids[$currpos - 1] : null;
- $nextrid = ($currpos < $total - 1) ? $rids[$currpos + 1] : null;
- $firstrid = $rids[0];
- $lastrid = $rids[$total - 1];
- if ($prevrid != null) {
- $pos = $currpos - 1;
- $title = '';
- $firstuserfullname = '';
- $navbar->firstrespondent = ['url' => ($url . '&rid=' . $firstrid)];
- $navbar->previous = ['url' => ($url . '&rid=' . $prevrid)];
- if ($isfullname) {
- $responsedate = userdate($ridssub[$pos]);
- $title = $ridsuserfullname[$pos];
- // Only add date if more than one response by a student.
- if ($ridsuserid[$pos] == $ridsuserid[$currpos]) {
- $title .= ' | ' . $responsedate;
- }
- $firstuserfullname = $ridsuserfullname[0];
- }
- $navbar->firstrespondent['title'] = $firstuserfullname;
- $navbar->previous['title'] = $title;
- }
- $navbar->respnumber = ['currpos' => ($currpos + 1), 'total' => $total];
- if ($nextrid != null) {
- $pos = $currpos + 1;
- $responsedate = '';
- $title = '';
- $lastuserfullname = '';
- $navbar->lastrespondent = ['url' => ($url . '&rid=' . $lastrid)];
- $navbar->next = ['url' => ($url . '&rid=' . $nextrid)];
- if ($isfullname) {
- $responsedate = userdate($ridssub[$pos]);
- $title = $ridsuserfullname[$pos];
- // Only add date if more than one response by a student.
- if ($ridsuserid[$pos] == $ridsuserid[$currpos]) {
- $title .= ' | ' . $responsedate;
- }
- $lastuserfullname = $ridsuserfullname[$total - 1];
- }
- $navbar->lastrespondent['title'] = $lastuserfullname;
- $navbar->next['title'] = $title;
- }
- $url = $CFG->wwwroot . '/mod/questionnaire/report.php?action=vresp&byresponse=1&group=' . $currentgroupid;
- // Display navbar.
- $navbar->listlink = $url;
-
- // Display a "print this response" icon here in prevision of total removal of tabs in version 2.6.
- $linkname = ' ' . get_string('print', 'questionnaire');
- $url = '/mod/questionnaire/print.php?qid=' . $this->id . '&rid=' . $currrid .
- '&courseid=' . $this->course->id . '&sec=1';
- $title = get_string('printtooltip', 'questionnaire');
- $options = [
- 'menubar' => true,
- 'location' => false,
- 'scrollbars' => true,
- 'resizable' => true,
- 'height' => 600,
- 'width' => 800,
- ];
- $name = 'popup';
- $link = new moodle_url($url);
- $action = new popup_action('click', $link, $name, $options);
- $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));
- } else { // Display respondents list.
- $resparr = [];
- for ($i = 0; $i < $total; $i++) {
- if ($isfullname) {
- $responsedate = userdate($ridssub[$i]);
- $resparr[] = '' . $ridsuserfullname[$i] . ' ';
- } else {
- $responsedate = '';
- $resparr[] = '' .
- get_string('response', 'questionnaire') . ($i + 1) . ' ';
- }
- }
- // Table formatting from http://wikkawiki.org/PageAndCategoryDivisionInACategory.
- $total = count($resparr);
- $entries = count($resparr);
- // Default max 3 columns, max 25 lines per column.
- // TODO make this setting customizable.
- $maxlines = 20;
- $maxcols = 3;
- if ($entries >= $maxlines) {
- $colnumber = min(intval($entries / $maxlines), $maxcols);
- } else {
- $colnumber = 1;
- }
- $lines = 0;
- $a = 0;
- // How many lines with an entry in every column do we have?
- while ($entries / $colnumber > 1) {
- $lines++;
- $entries = $entries - $colnumber;
- }
- // Prepare output.
- $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++;
- }
- // The rest of the entries (less than the number of cols).
- if ($entries) {
- $respcols->{$colname}->respondentlink[] = $resparr[$a];
- $entries--;
- $a++;
- }
- }
-
- $this->page->add_to_page('responses', $this->renderer->responselist($respcols));
- }
- }
-
- /**
- * 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');
-
- $total = count($resps);
- $rids = [];
- $ridssub = [];
- $ridsusers = [];
- $i = 0;
- $currpos = -1;
- $title = '';
- foreach ($resps as $response) {
- array_push($rids, $response->id);
- array_push($ridssub, $response->submitted);
- $ruser = '';
- if ($reporttype == 'report') {
- if ($this->respondenttype != 'anonymous') {
- if ($user = $DB->get_record('user', ['id' => $response->userid])) {
- $ruser = ' | ' . fullname($user);
- }
- } else {
- $ruser = ' | ' . $stranonymous;
- }
- }
- array_push($ridsusers, $ruser);
- if ($response->id == $currrid) {
- $currpos = $i;
- }
- $i++;
- }
- $prevrid = ($currpos > 0) ? $rids[$currpos - 1] : null;
- $nextrid = ($currpos < $total - 1) ? $rids[$currpos + 1] : null;
-
- if ($reporttype == 'myreport') {
- $url = 'myreport.php?instance=' . $instance . '&user=' . $userid . '&action=vresp&byresponse=1&individualresponse=1';
- } else {
- $url = 'report.php?instance=' . $instance . '&user=' . $userid .
- '&action=vresp&byresponse=1&individualresponse=1&sid=' . $sid;
- }
- $navbar = new \stdClass();
- $displaypos = 1;
- if ($prevrid != null) {
- $title = userdate($ridssub[$currpos - 1] . $ridsusers[$currpos - 1]);
- $navbar->previous = ['url' => ($url . '&rid=' . $prevrid), 'title' => $title];
- }
- for ($i = 0; $i < $currpos; $i++) {
- $title = userdate($ridssub[$i]) . $ridsusers[$i];
- $navbar->prevrespnumbers[] = ['url' => ($url . '&rid=' . $rids[$i]), 'title' => $title, 'respnumber' => $displaypos];
- $displaypos++;
- }
- $navbar->currrespnumber = $displaypos;
- for (++$i; $i < $total; $i++) {
- $displaypos++;
- $title = userdate($ridssub[$i]) . $ridsusers[$i];
- $navbar->nextrespnumbers[] = ['url' => ($url . '&rid=' . $rids[$i]), 'title' => $title, 'respnumber' => $displaypos];
- }
- if ($nextrid != null) {
- $title = userdate($ridssub[$currpos + 1]) . $ridsusers[$currpos + 1];
- $navbar->next = ['url' => ($url . '&rid=' . $nextrid), 'title' => $title];
- }
- $this->page->add_to_page('navigationbar', $this->renderer->usernavigationbar($navbar));
- $this->page->add_to_page('bottomnavigationbar', $this->renderer->usernavigationbar($navbar));
- }
-
- /**
- * 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;
-
- // Build associative array holding whether each question
- // type has answer choices or not and the table the answers are in
- // TO DO - FIX BELOW TO USE STANDARD FUNCTIONS.
- $haschoices = [];
- $responsetable = [];
- if (!($types = $DB->get_records('questionnaire_question_type', [], 'typeid', 'typeid, has_choices, response_table'))) {
- $errmsg = sprintf(
- '%s [ %s: question_type ]',
- get_string('errortable', 'questionnaire'),
- 'Table'
- );
- return($errmsg);
- }
- foreach ($types as $type) {
- $haschoices[$type->typeid] = $type->has_choices; // TODO is that variable actually used?
- $responsetable[$type->typeid] = $type->response_table;
- }
-
- // Load survey title (and other globals).
- if (empty($this->survey)) {
- $errmsg = get_string('erroropening', 'questionnaire') . " [ ID:{$this->sid} R:";
- return($errmsg);
- }
-
- if (empty($this->questions)) {
- $errmsg = get_string('erroropening', 'questionnaire') . ' ' . 'No questions found.';
- return($errmsg);
- }
-
- // Find total number of survey responses and relevant response ID's.
- if (!empty($rid)) {
- $rids = $rid;
- if (is_array($rids)) {
- $navbar = false;
- } else {
- $navbar = true;
- }
- $numresps = 1;
- } else {
- $navbar = false;
- $userview = optional_param('responsestats', 0, PARAM_ALPHA);
- if ($uid !== false) { // One participant only.
- $rows = $this->get_responses($uid);
- // All participants or all members of a group.
- } else if ($currentgroupid == 0) {
- $rows = $this->get_responses();
- } else { // Members of a specific group.
- $rows = $this->get_responses(false, $currentgroupid);
- }
- if (!$rows) {
- $this->page->add_to_page(
- 'respondentinfo',
- $this->renderer->notification(
- get_string('noresponses', 'questionnaire'),
- \core\output\notification::NOTIFY_ERROR
- )
- );
- $SESSION->questionnaire->noresponses = true;
- return;
- }
- $numresps = count($rows);
- $respondentstring = get_string('responses', 'questionnaire');
- if ($userview === 'y') {
- $respondentstring = get_string('submissions', 'questionnaire');
- }
- if (!$userview) {
- $completedcount = 0;
- $inprogresscount = 0;
-
- foreach ($rows as $row) {
- if ($row->complete === 'y') {
- $completedcount++;
- } else if ($row->complete === 'n') {
- $inprogresscount++;
- }
- }
- $numresps .= ' ' . get_string(
- 'responses_breakdown',
- 'questionnaire',
- [
- 'responses' => $completedcount,
- 'incomplete' => $inprogresscount,
- ]
- );
- }
- $this->page->add_to_page('respondentinfo', ' ' . $respondentstring . ': ' . $numresps . ' ');
- if (empty($rows)) {
- $errmsg = get_string('erroropening', 'questionnaire') . ' ' . get_string('noresponsedata', 'questionnaire');
- return($errmsg);
- }
-
- $rids = [];
- foreach ($rows as $row) {
- array_push($rids, $row->id);
- }
- }
-
- if ($navbar) {
- // Show response navigation bar.
- $this->survey_results_navbar($rid);
- }
-
- $this->page->add_to_page('title', format_string($this->survey->title));
- if ($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',
- $this->context->id,
- 'mod_questionnaire',
- 'info',
- $this->survey->id
- );
- $this->page->add_to_page('addinfo', format_text($infotext, FORMAT_HTML, ['noclean' => true]));
- }
-
- $qnum = 0;
-
- $anonymous = $this->respondenttype == 'anonymous';
-
- foreach ($this->questions as $question) {
- if ($question->type_id == QUESPAGEBREAK) {
- continue;
- }
- if ($question->is_numbered()) {
- $qnum++;
- }
- if (!$pdf) {
- $this->page->add_to_page('responses', $this->renderer->container_start('qn-container'));
- if ($this->questions_autonumbered() && $question->is_numbered()) {
- $this->page->add_to_page('responses', $this->renderer->container_start('qn-info'));
- $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'));
- }
- // If question text is "empty", i.e. 2 non-breaking spaces were inserted, do not display any question text.
- if ($question->content == '
') {
- $question->content = '';
- }
- if ($pdf) {
- $response = new stdClass();
- if ($this->questions_autonumbered() && $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]
- );
- $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;
- }
-
- /**
- * Get unique list of question types used in the current survey.
- * author: Guy Thomas
- * @param bool $uniquebytable
- * @return array
- */
- protected function get_survey_questiontypes($uniquebytable = false) {
-
- $uniquetypes = [];
- $uniquetables = [];
-
- foreach ($this->questions as $question) {
- $type = $question->type_id;
- $responsetable = $question->responsetable;
- // Build SQL for this question type if not already done.
- if (!$uniquebytable || !in_array($responsetable, $uniquetables)) {
- if (!in_array($type, $uniquetypes)) {
- $uniquetypes[] = $type;
- }
- if (!in_array($responsetable, $uniquetables)) {
- $uniquetables[] = $responsetable;
- }
- }
- }
-
- return $uniquetypes;
- }
-
- /**
- * Return array of all types considered to be choices.
- *
- * @return array
- */
- protected function choice_types() {
- return [QUESRADIO, QUESDROP, QUESCHECK, QUESRATE];
- }
-
- /**
- * Return all the fields to be used for users in questionnaire sql.
- * author: Guy Thomas
- * @return array|string
- */
- protected function user_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']);
- $userfieldsarr = array_merge($userfieldsarr, ['username', 'department', 'institution', 'idnumber']);
- return $userfieldsarr;
- }
-
- /**
- * Get all survey responses in one go.
- * 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) {
- global $DB;
- $uniquetypes = $this->get_survey_questiontypes(true);
- $allresponsessql = "";
- $allresponsesparams = [];
-
- // 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') ?? []);
- } else {
- $qids = $this->id;
- }
-
- foreach ($uniquetypes as $type) {
- $question = \mod_questionnaire\question\question::question_builder($type);
- if (!isset($question->responsetype)) {
- continue;
- }
- $allresponsessql .= $allresponsessql == '' ? '' : ' UNION ALL ';
- [$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 true if the survey is a 'public' one.
- *
- * @return boolean
- */
- public function survey_is_public() {
- return is_object($this->survey) && ($this->survey->realm == 'public');
- }
-
- /**
- * Return true if the survey is a 'public' one and this is the master instance.
- *
- * @return boolean
- */
- public function survey_is_public_master() {
- return $this->survey_is_public() && ($this->course->id == $this->survey->courseid);
- }
-
- /**
- * Process individual row for csv output
- * @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
- */
- protected function process_csv_row(
- array &$row,
- stdClass $resprow,
- $currentgroupid,
- array &$questionsbyposition,
- $nbinfocols,
- $numrespcols,
- $options,
- $identityfields
- ) {
- global $DB;
-
- // If using an anonymous response, map users to unique user numbers so that number of unique anonymous users can be seen.
- static $anonumap = [];
-
- $positioned = [];
- $user = new stdClass();
- foreach ($this->user_fields() as $userfield) {
- $user->$userfield = $resprow->$userfield;
- }
- $user->id = $resprow->userid;
- $isanonymous = ($this->respondenttype == 'anonymous');
-
- // Moodle:
- // Get the course name that this questionnaire belongs to.
- if (!$this->survey_is_public()) {
- $courseid = $this->course->id;
- $coursename = $this->course->fullname;
- } else {
- // For a public questionnaire, look for the course that used it.
- $sql = 'SELECT q.id, q.course, c.fullname ' .
- 'FROM {questionnaire_response} qr ' .
- 'INNER JOIN {questionnaire} q ON qr.questionnaireid = q.id ' .
- 'INNER JOIN {course} c ON q.course = c.id ' .
- 'WHERE qr.id = ? AND qr.complete = ? ';
- if ($record = $DB->get_record_sql($sql, [$resprow->rid, 'y'])) {
- $courseid = $record->course;
- $coursename = $record->fullname;
- } else {
- $courseid = $this->course->id;
- $coursename = $this->course->fullname;
- }
- }
-
- // Moodle:
- // Determine if the user is a member of a group in this course or not.
- // TODO - review for performance.
- $groupname = '';
- if (groups_get_activity_groupmode($this->cm, $this->course)) {
- if ($currentgroupid > 0) {
- $groupname = groups_get_group_name($currentgroupid);
- } else {
- if ($user->id) {
- if ($groups = groups_get_all_groups($courseid, $user->id)) {
- foreach ($groups as $group) {
- $groupname .= $group->name . ', ';
- }
- $groupname = substr($groupname, 0, strlen($groupname) - 2);
- } else {
- $groupname = ' (' . get_string('groupnonmembers') . ')';
- }
- }
- }
- }
-
- if ($isanonymous) {
- if (!isset($anonumap[$user->id])) {
- $anonumap[$user->id] = count($anonumap) + 1;
- }
- $fullname = get_string('anonymous', 'questionnaire') . $anonumap[$user->id];
- $username = '';
- $uid = '';
- } else {
- $uid = $user->id;
- $fullname = fullname($user);
- $username = $user->username;
- }
-
- if (in_array('response', $options)) {
- array_push($positioned, $resprow->rid);
- }
- if (in_array('submitted', $options)) {
- // For better compabitility & readability with Excel.
- $submitted = date(get_string('strfdateformatcsv', 'questionnaire'), $resprow->submitted);
- array_push($positioned, $submitted);
- }
- if (in_array('institution', $options)) {
- array_push($positioned, $user->institution);
- }
- if (in_array('department', $options)) {
- array_push($positioned, $user->department);
- }
- if (in_array('course', $options)) {
- array_push($positioned, $coursename);
- }
- if (in_array('group', $options)) {
- array_push($positioned, $groupname);
- }
- if (in_array('id', $options)) {
- array_push($positioned, $uid);
- }
- if (in_array('useridnumber', $options)) {
- array_push($positioned, $user->idnumber);
- }
- if (in_array('fullname', $options)) {
- array_push($positioned, $fullname);
- }
- if (in_array('username', $options)) {
- array_push($positioned, $username);
- }
- 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])) {
- $positioned[] = $row[$c];
- } else if (isset($questionsbyposition[$c])) {
- $question = $questionsbyposition[$c];
- $qtype = intval($question->type_id);
- if ($qtype === QUESCHECK) {
- $positioned[] = '0';
- } else {
- $positioned[] = null;
- }
- } else {
- $positioned[] = null;
- }
- }
- return $positioned;
- }
-
- /**
- * 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');
-
- $output = [];
- $stringother = get_string('other', 'questionnaire');
-
- $config = get_config('questionnaire', 'downloadoptions');
- $options = empty($config) ? [] : explode(',', $config);
- if ($showincompletes == 1) {
- $options[] = 'complete';
- }
- $columns = [];
- $types = [];
- foreach ($options as $option) {
- if (in_array($option, ['response', 'submitted', 'id', 'useridnumber'])) {
- $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 = [
- '0', // 0: unused
- '0', // 1: bool -> boolean
- '1', // 2: text -> string
- '1', // 3: essay -> string
- '0', // 4: radio -> string
- '0', // 5: check -> string
- '0', // 6: dropdn -> string
- '0', // 7: rating -> number
- '0', // 8: rate -> number
- '1', // 9: date -> string
- '0', // 10: numeric -> number.
- '0', // 11: slider -> number.
- ];
-
- if (!$survey = $DB->get_record('questionnaire_survey', ['id' => $this->survey->id])) {
- throw new \moodle_exception('surveynotexists', 'mod_questionnaire');
- }
-
- // Get all responses for this survey in one go.
- $allresponsesrs = $this->get_survey_all_responses($rid, $userid, $currentgroupid, $showincompletes);
-
- // Do we have any questions of type RADIO, DROP, CHECKBOX OR RATE? If so lets get all their choices in one go.
- $choicetypes = $this->choice_types();
-
- // Get unique list of question types used in this survey.
- $uniquetypes = $this->get_survey_questiontypes();
-
- if (count(array_intersect($choicetypes, $uniquetypes)) > 0) {
- $choiceparams = [$this->survey->id];
- $choicesql = "
- SELECT DISTINCT c.id as cid, q.id as qid, q.precise AS precise, q.name, c.content
- FROM {questionnaire_question} q
- JOIN {questionnaire_quest_choice} c ON question_id = q.id
- WHERE q.surveyid = ? ORDER BY cid ASC
- ";
- $choicerecords = $DB->get_records_sql($choicesql, $choiceparams);
- $choicesbyqid = [];
- if (!empty($choicerecords)) {
- // Hash the options by question id.
- foreach ($choicerecords as $choicerecord) {
- if (!isset($choicesbyqid[$choicerecord->qid])) {
- // New question id detected, intialise empty array to store choices.
- $choicesbyqid[$choicerecord->qid] = [];
- }
- $choicesbyqid[$choicerecord->qid][$choicerecord->cid] = $choicerecord;
- }
- }
- }
-
- $num = 1;
-
- $questionidcols = [];
-
- foreach ($this->questions as $question) {
- // Skip questions that aren't response capable.
- if (!isset($question->responsetype)) {
- continue;
- }
- // Establish the table's field names.
- $qid = $question->id;
- $qpos = $question->position;
- $col = $question->name;
- $type = $question->type_id;
- if (in_array($type, $choicetypes)) {
- /* single or multiple or rate */
- if (!isset($choicesbyqid[$qid])) {
- throw new coding_exception('Choice question has no choices!', 'question id ' . $qid . ' of type ' . $type);
- }
- $choices = $choicesbyqid[$qid];
-
- switch ($type) {
- case QUESRADIO: // Single.
- case QUESDROP:
- $columns[][$qpos] = $col;
- $questionidcols[][$qpos] = $qid;
- array_push($types, $idtocsvmap[$type]);
- $thisnum = 1;
- foreach ($choices as $choice) {
- $content = $choice->content;
- // If "Other" add a column for the actual "other" text entered.
- if (\mod_questionnaire\question\choice::content_is_other_choice($content)) {
- $col = $choice->name . '_' . $stringother;
- $columns[][$qpos] = $col;
- $questionidcols[][$qpos] = null;
- array_push($types, '0');
- }
- }
- break;
-
- case QUESCHECK: // Multiple.
- $thisnum = 1;
- foreach ($choices as $choice) {
- $content = $choice->content;
- $modality = '';
- $contents = questionnaire_choice_values($content);
- if ($contents->modname) {
- $modality = $contents->modname;
- } else if ($contents->title) {
- $modality = $contents->title;
- } else {
- $modality = strip_tags($contents->text);
- }
- $col = $choice->name . '->' . $modality;
- $columns[][$qpos] = $col;
- $questionidcols[][$qpos] = $qid . '_' . $choice->cid;
- array_push($types, '0');
- // If "Other" add a column for the "other" checkbox.
- // Then add a column for the actual "other" text entered.
- if (\mod_questionnaire\question\choice::content_is_other_choice($content)) {
- $content = $stringother;
- $col = $choice->name . '->[' . $content . ']';
- $columns[][$qpos] = $col;
- $questionidcols[][$qpos] = null;
- array_push($types, '0');
- }
- }
- break;
-
- case QUESRATE: // Rate.
- foreach ($choices as $choice) {
- $nameddegrees = 0;
- $modality = '';
- $content = $choice->content;
- $osgood = false;
- if (\mod_questionnaire\question\rate::type_is_osgood_rate_scale($choice->precise)) {
- $osgood = true;
- }
- if (preg_match("/^[0-9]{1,3}=/", $content, $ndd)) {
- $nameddegrees++;
- } else {
- if ($osgood) {
- [$contentleft, $contentright] = array_merge(preg_split('/[|]/', $content), [' ']);
- $contents = questionnaire_choice_values($contentleft);
- if ($contents->title) {
- $contentleft = $contents->title;
- }
- $contents = questionnaire_choice_values($contentright);
- if ($contents->title) {
- $contentright = $contents->title;
- }
- $modality = strip_tags($contentleft . '|' . $contentright);
- $modality = preg_replace("/[\r\n\t]/", ' ', $modality);
- } else {
- $contents = questionnaire_choice_values($content);
- if ($contents->modname) {
- $modality = $contents->modname;
- } else if ($contents->title) {
- $modality = $contents->title;
- } else {
- $modality = strip_tags($contents->text);
- $modality = preg_replace("/[\r\n\t]/", ' ', $modality);
- }
- }
- $col = $choice->name . '->' . $modality;
- $columns[][$qpos] = $col;
- $questionidcols[][$qpos] = $qid . '_' . $choice->cid;
- array_push($types, $idtocsvmap[$type]);
- }
- }
- break;
- }
- } else {
- $columns[][$qpos] = $col;
- $questionidcols[][$qpos] = $qid;
- array_push($types, $idtocsvmap[$type]);
- }
- $num++;
- }
-
- array_push($output, $columns);
- $numrespcols = count($output[0]); // Number of columns used for storing question responses.
-
- // Flatten questionidcols.
- $tmparr = [];
- for ($c = 0; $c < $nbinfocols; $c++) {
- $tmparr[] = null; // Pad with non question columns.
- }
- foreach ($questionidcols as $i => $positions) {
- foreach ($positions as $position => $qid) {
- $tmparr[] = $qid;
- }
- }
- $questionidcols = $tmparr;
-
- // Create array of question positions hashed by question / question + choiceid.
- // And array of questions hashed by position.
- $questionpositions = [];
- $questionsbyposition = [];
- $p = 0;
- foreach ($questionidcols as $qid) {
- if ($qid === null) {
- // This is just padding, skip.
- $p++;
- continue;
- }
- $questionpositions[$qid] = $p;
- if (strpos($qid, '_') !== false) {
- $tmparr = explode('_', $qid);
- $questionid = $tmparr[0];
- } else {
- $questionid = $qid;
- }
- $questionsbyposition[$p] = $this->questions[$questionid];
- $p++;
- }
-
- $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,
- $options,
- $identityfields
- );
- $row = [];
- }
-
- if ($qtype === QUESRATE || $qtype === QUESCHECK) {
- $key = $qid . '_' . $responserow->choice_id;
- $position = $questionpositions[$key];
- if ($qtype === QUESRATE) {
- $choicetxt = $responserow->rankvalue;
- if ($rankaverages) {
- $averagerow[$position] = $averages[$qid][$responserow->choice_id];
- }
- } else {
- $content = $choicesbyqid[$qid][$responserow->choice_id]->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';
- } else if (!empty($responserow->choice_id)) {
- $choicetxt = '1';
- } else {
- $choicetxt = '0';
- }
- }
- $responsetxt = $choicetxt;
- $row[$position] = $responsetxt;
- } else {
- $position = $questionpositions[$qid];
- if ($questionobj->has_choices()) {
- // This is choice type question, so process as so.
- $c = 0;
- if (in_array(intval($question->type_id), $choicetypes)) {
- $choices = $choicesbyqid[$qid];
- // Get position of choice.
- foreach ($choices as $choice) {
- $c++;
- if ($responserow->choice_id === $choice->cid) {
- break;
- }
- }
- }
-
- $content = $choicesbyqid[$qid][$responserow->choice_id]->content;
- if (\mod_questionnaire\question\choice::content_is_other_choice($content)) {
- // If this has an "other" text, use it.
- $responsetxt = \mod_questionnaire\question\choice::content_other_choice_display($content);
- $responsetxt1 = $responserow->response;
- } else if (($choicecodes == 1) && ($choicetext == 1)) {
- $responsetxt = $c . ' : ' . $content;
- } else if ($choicecodes == 1) {
- $responsetxt = $c;
- } else {
- $responsetxt = $content;
- }
- } else if (intval($qtype) === QUESYESNO) {
- // At this point, the boolean responses are returned as characters in the "response"
- // field instead of "choice_id" for csv exports (CONTRIB-6436).
- $responsetxt = $responserow->response === 'y' ? "1" : "0";
- } else {
- // Strip potential html tags from modality name.
- $responsetxt = $responserow->response;
- if (!empty($responsetxt)) {
- $responsetxt = $responserow->response;
- $responsetxt = strip_tags($responsetxt);
- $responsetxt = preg_replace("/[\r\n\t]/", ' ', $responsetxt);
- }
- }
- $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);
- }
- }
-
- $prevresprow = $responserow;
- }
-
- 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,
- $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.
- $numquestion = 0;
- $oldkey = 0;
-
- for ($i = $nbinfocols; $i < $numrespcols; $i++) {
- $sep = '';
- $thisoutput = current($output[0][$i]);
- $thiskey = key($output[0][$i]);
- // Case of unnamed rate single possible answer (full stop char is used for support).
- if (strstr($thisoutput, '->.')) {
- $thisoutput = str_replace('->.', '', $thisoutput);
- }
- // If variable is not named no separator needed between Question number and potential sub-variables.
- if (
- $thisoutput == '' ||
- strstr($thisoutput, '->.') ||
- substr($thisoutput, 0, 2) == '->' ||
- substr($thisoutput, 0, 1) == '_'
- ) {
- $sep = '';
- } else {
- $sep = '_';
- }
- if ($thiskey > $oldkey) {
- $oldkey = $thiskey;
- $numquestion++;
- }
- // Abbreviated modality name in multiple or rate questions (COLORS->blue=the color of the sky...).
- $pos = strpos($thisoutput, '=');
- if ($pos) {
- $thisoutput = substr($thisoutput, 0, $pos);
- }
- $out = 'Q' . sprintf("%02d", $numquestion) . $sep . $thisoutput;
- $output[0][$i] = $out;
- }
- return $output;
- }
-
- /**
- * Function to move a question to a new position.
- * Adapted from feedback plugin.
- *
- * @param int $moveqid The id of the question to be moved.
- * @param int $movetopos The position to move question to.
- *
- */
- public function move_question($moveqid, $movetopos) {
- global $DB;
-
- $questions = $this->questions;
- $movequestion = $this->questions[$moveqid];
-
- if (is_array($questions)) {
- $index = 1;
- foreach ($questions as $question) {
- if ($index == $movetopos) {
- $index++;
- }
- if ($question->id == $movequestion->id) {
- $movequestion->position = $movetopos;
- $DB->update_record("questionnaire_question", $movequestion);
- continue;
- }
- $question->position = $index;
- $DB->update_record("questionnaire_question", $question);
- $index++;
- }
- return true;
- }
- 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;
- require_once($CFG->libdir . '/tablelib.php');
- require_once($CFG->dirroot . '/mod/questionnaire/drawchart.php');
-
- // Find if there are any feedbacks in this questionnaire.
- $sql = "SELECT * FROM {questionnaire_fb_sections} WHERE surveyid = ? AND section IS NOT NULL";
- if (!$fbsections = $DB->get_records_sql($sql, [$this->survey->id])) {
- return '';
- }
-
- $action = optional_param('action', 'vall', PARAM_ALPHA);
-
- $resp = $DB->get_record('questionnaire_response', ['id' => $rid]);
- if (!empty($resp)) {
- $userid = $resp->userid;
- $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).
- $groupmode = groups_get_activity_groupmode($this->cm, $this->course);
- $groupname = get_string('allparticipants');
- if ($groupmode > 0) {
- if ($currentgroupid > 0) {
- $groupname = groups_get_group_name($currentgroupid);
- } else {
- $groupname = get_string('allparticipants');
- }
- }
- if ($this->survey->feedbackscores) {
- $table = new html_table();
- $table->size = [null, null];
- $table->align = ['left', 'right', 'right'];
- $table->head = [];
- $table->wrap = [];
- if ($compare) {
- $table->head = [get_string('feedbacksection', 'questionnaire'), $ruser, $groupname];
- } else {
- $table->head = [get_string('feedbacksection', 'questionnaire'), $groupname];
- }
- }
-
- $fbsectionsnb = array_keys($fbsections);
- $numsections = count($fbsections);
-
- // Get all response ids for all respondents.
- $rids = [];
- foreach ($resps as $key => $resp) {
- $rids[] = $key;
- }
- $nbparticipants = count($rids);
- $responsescores = [];
-
- // Calculate max score per question in questionnaire.
- $qmax = [];
- $maxtotalscore = 0;
- foreach ($this->questions as $question) {
- $qid = $question->id;
- if ($question->valid_feedback()) {
- $qmax[$qid] = $question->get_feedback_maxscore();
- $maxtotalscore += $qmax[$qid];
- // Get all the feedback scores for this question.
- $responsescores[$qid] = $question->get_feedback_scores($rids);
- }
- }
- // Just in case no values have been entered in the various questions possible answers field.
- if ($maxtotalscore === 0) {
- return '';
- }
- $feedbackmessages = [];
-
- // Get individual scores for each question in this responses set.
- $qscore = [];
- $allqscore = [];
-
- if (!$allresponses && $groupmode != 0) {
- $nbparticipants = max(1, $nbparticipants - !$isgroupmember);
- }
- foreach ($responsescores as $qid => $responsescore) {
- if (!empty($responsescore)) {
- foreach ($responsescore as $rrid => $response) {
- // If this is current user's response OR if current user is viewing another group's results.
- if ($rrid == $rid || $allresponses) {
- if (!isset($qscore[$qid])) {
- $qscore[$qid] = 0;
- }
- $qscore[$qid] = $response->score;
- }
- // Course score.
- if (!isset($allqscore[$qid])) {
- $allqscore[$qid] = 0;
- }
- // Only add current score if conditions below are met.
- if ($groupmode == 0 || $isgroupmember || (!$isgroupmember && $rrid != $rid) || $allresponses) {
- $allqscore[$qid] += $response->score;
- }
- }
- }
- }
- $totalscore = array_sum($qscore);
- $scorepercent = round($totalscore / $maxtotalscore * 100);
- $oppositescorepercent = 100 - $scorepercent;
- $alltotalscore = array_sum($allqscore);
- $allscorepercent = round($alltotalscore / $nbparticipants / $maxtotalscore * 100);
-
- // No need to go further if feedback is global, i.e. only relying on total score.
- if ($this->survey->feedbacksections == 1) {
- $sectionid = $fbsectionsnb[0];
- $sectionlabel = $fbsections[$sectionid]->sectionlabel;
-
- $sectionheading = $fbsections[$sectionid]->sectionheading;
- $labels = [];
- 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',
- 'sectionid = ? AND minscore <= ? AND ? < maxscore',
- [$sectionid, $scorepercent, $scorepercent]
- );
-
- // To eliminate all potential % chars in heading text (might interfere with the sprintf function).
- $sectionheading = str_replace('%', '', $sectionheading);
- // Replace section heading placeholders with their actual value (if any).
- $original = ['$scorepercent', '$oppositescorepercent'];
- $result = ['%s%%', '%s%%'];
- $sectionheading = str_replace($original, $result, $sectionheading);
- $sectionheading = sprintf($sectionheading, $scorepercent, $oppositescorepercent);
- $sectionheading = file_rewrite_pluginfile_urls(
- $sectionheading,
- 'pluginfile.php',
- $this->context->id,
- 'mod_questionnaire',
- 'sectionheading',
- $sectionid
- );
- $feedbackmessages[] = $this->renderer->box_start();
- $feedbackmessages[] = format_text($sectionheading, FORMAT_HTML, ['noclean' => true]);
- $feedbackmessages[] = $this->renderer->box_end();
-
- if (!empty($feedback->feedbacktext)) {
- // Clean the text, ready for display.
- $formatoptions = new stdClass();
- $formatoptions->noclean = true;
- $feedbacktext = file_rewrite_pluginfile_urls(
- $feedback->feedbacktext,
- 'pluginfile.php',
- $this->context->id,
- 'mod_questionnaire',
- 'feedback',
- $feedback->id
- );
- $feedbacktext = format_text($feedbacktext, $feedback->feedbacktextformat, $formatoptions);
- $feedbackmessages[] = $this->renderer->box_start();
- $feedbackmessages[] = $feedbacktext;
- $feedbackmessages[] = $this->renderer->box_end();
- }
- $score = [$scorepercent, 100 - $scorepercent];
- $allscore = null;
- if ($compare || $allresponses) {
- $allscore = [$allscorepercent, 100 - $allscorepercent];
- }
- $usergraph = get_config('questionnaire', 'usergraph');
- if ($usergraph && $this->survey->chart_type) {
- $this->page->add_to_page(
- 'feedbackcharts',
- 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.
- $lb = explode("|", $sectionlabel);
- $oppositescore = '';
- $oppositeallscore = '';
- if (count($lb) > 1) {
- $sectionlabel = $lb[0] . ' | ' . $lb[1];
- $oppositescore = ' | ' . $score[1] . '%';
- $oppositeallscore = ' | ' . $allscore[1] . '%';
- }
- if ($this->survey->feedbackscores) {
- $table = $table ?? new html_table();
- if ($compare) {
- $table->data[] = [$sectionlabel, $score[0] . '%' . $oppositescore, $allscore[0] . '%' . $oppositeallscore];
- } else {
- $table->data[] = [$sectionlabel, $allscore[0] . '%' . $oppositeallscore];
- }
-
- $this->page->add_to_page('feedbackscores', html_writer::table($table));
- }
-
- return $feedbackmessages;
- }
-
- // Now process scores for more than one section.
-
- // Initialize scores and maxscores to 0.
- $score = [];
- $allscore = [];
- $maxscore = [];
- $scorepercent = [];
- $allscorepercent = [];
- $oppositescorepercent = [];
- $alloppositescorepercent = [];
- $chartlabels = [];
- // Sections where all questions are unseen because of the $advdependencies.
- $nanscores = [];
-
- for ($i = 1; $i <= $numsections; $i++) {
- $score[$i] = 0;
- $allscore[$i] = 0;
- $maxscore[$i] = 0;
- $scorepercent[$i] = 0;
- }
-
- for ($section = 1; $section <= $numsections; $section++) {
- // Get feedback messages only for this sections.
- if (($filteredsections != null) && !in_array($section, $filteredsections)) {
- continue;
- }
- foreach ($fbsections as $key => $fbsection) {
- if ($fbsection->section == $section) {
- $feedbacksectionid = $key;
- $scorecalculation = section::decode_scorecalculation($fbsection->scorecalculation);
- if (empty($scorecalculation) && !is_array($scorecalculation)) {
- $scorecalculation = [];
- }
- $sectionheading = $fbsection->sectionheading;
- $imageid = $fbsection->id;
- $chartlabels[$section] = $fbsection->sectionlabel;
- }
- }
- foreach ($scorecalculation as $qid => $key) {
- // Just in case a question pertaining to a section has been deleted or made not required
- // after being included in scorecalculation.
- if (isset($qscore[$qid])) {
- $key = empty($key) ? 1 : $key;
- $score[$section] += round($qscore[$qid] * $key);
- $maxscore[$section] += round($qmax[$qid] * $key);
- if ($compare || $allresponses) {
- $allscore[$section] += round($allqscore[$qid] * $key);
- }
- }
- }
-
- if ($maxscore[$section] == 0) {
- array_push($nanscores, $section);
- }
-
- $scorepercent[$section] = ($maxscore[$section] > 0) ? (round($score[$section] / $maxscore[$section] * 100)) : 0;
- $oppositescorepercent[$section] = 100 - $scorepercent[$section];
-
- if (($compare || $allresponses) && $nbparticipants != 0) {
- $allscorepercent[$section] = ($maxscore[$section] > 0) ? (round(($allscore[$section] / $nbparticipants) /
- $maxscore[$section] * 100)) : 0;
- $alloppositescorepercent[$section] = 100 - $allscorepercent[$section];
- }
-
- if (!$allresponses) {
- if (is_nan($scorepercent[$section])) {
- // Info: all questions of $section are unseen
- // -> $scorepercent[$section] = round($score[$section] / $maxscore[$section] * 100) == NAN
- // -> $maxscore[$section] == 0 -> division by zero
- // $DB->get_record_select(...) fails, don't show feedbackmessage.
- continue;
- }
- // To eliminate all potential % chars in heading text (might interfere with the sprintf function).
- $sectionheading = str_replace('%', '', $sectionheading);
-
- // Replace section heading placeholders with their actual value (if any).
- $original = ['$scorepercent', '$oppositescorepercent'];
- $result = ["$scorepercent[$section]%", "$oppositescorepercent[$section]%"];
- $sectionheading = str_replace($original, $result, $sectionheading);
- $formatoptions = new stdClass();
- $formatoptions->noclean = true;
- $sectionheading = file_rewrite_pluginfile_urls(
- $sectionheading,
- 'pluginfile.php',
- $this->context->id,
- 'mod_questionnaire',
- 'sectionheading',
- $imageid
- );
- $sectionheading = format_text($sectionheading, 1, $formatoptions);
- $feedbackmessages[] = $this->renderer->box_start('reportQuestionTitle');
- $feedbackmessages[] = format_text($sectionheading, FORMAT_HTML, $formatoptions);
- $feedback = $DB->get_record_select(
- 'questionnaire_feedback',
- 'sectionid = ? AND minscore <= ? AND ? < maxscore',
- [$feedbacksectionid, $scorepercent[$section], $scorepercent[$section]],
- 'id,feedbacktext,feedbacktextformat'
- );
- $feedbackmessages[] = $this->renderer->box_end();
- if (!empty($feedback->feedbacktext)) {
- // Clean the text, ready for display.
- $formatoptions = new stdClass();
- $formatoptions->noclean = true;
- $feedbacktext = file_rewrite_pluginfile_urls(
- $feedback->feedbacktext,
- 'pluginfile.php',
- $this->context->id,
- 'mod_questionnaire',
- 'feedback',
- $feedback->id
- );
- $feedbacktext = format_text($feedbacktext, $feedback->feedbacktextformat, $formatoptions);
- $feedbackmessages[] = $this->renderer->box_start('feedbacktext');
- $feedbackmessages[] = $feedbacktext;
- $feedbackmessages[] = $this->renderer->box_end();
- }
- }
- }
-
- // Display class or group score.
- switch ($action) {
- case 'vallasort':
- asort($allscore);
- break;
- case 'vallarsort':
- arsort($allscore);
- break;
- default:
- }
-
- 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[] = [
- $sectionlabel,
- $scorepercent[$key] . '%' . $oppositescore,
- $allscorepercent[$key] . '%' . $oppositeallscore,
- ];
- } else if (isset($allscorepercent[$key]) && !is_nan($allscorepercent[$key])) {
- $table = $table ?? new html_table();
- $table->data[] = [$sectionlabel, $allscorepercent[$key] . '%' . $oppositeallscore];
- }
- }
- }
- }
- $usergraph = get_config('questionnaire', 'usergraph');
-
- // Don't show feedbackcharts for sections in $nanscores -> remove sections from array.
- foreach ($nanscores as $val) {
- unset($chartlabels[$val]);
- unset($scorepercent[$val]);
- unset($allscorepercent[$val]);
- }
-
- if ($usergraph && $this->survey->chart_type) {
- $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));
- }
-
- return $feedbackmessages;
- }
-
- // 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;
- }
-
- /**
- * Output the questionnaire information.
- *
- * @return string
- */
- public function view_information() {
- $messages = [];
-
- if (isset($this->qtype)) {
- switch ($this->qtype) {
- case QUESTIONNAIREUNLIMITED:
- $typestring = get_string('unlimited', 'questionnaire');
- break;
- case QUESTIONNAIREONCE:
- $typestring = get_string('once', 'questionnaire');
- break;
- case QUESTIONNAIREDAILY:
- $typestring = get_string('daily', 'questionnaire');
- break;
- case QUESTIONNAIREWEEKLY:
- $typestring = get_string('weekly', 'questionnaire');
- break;
- case QUESTIONNAIREMONTHLY:
- $typestring = get_string('monthly', 'questionnaire');
- break;
- default:
- $typestring = '';
- break;
- }
- array_push($messages, get_string('attemptsallowed', 'questionnaire', $typestring));
- }
-
- if ($this->is_open() && !$this->is_closed()) {
- if ($this->opendate > 0) {
- array_push($messages, get_string('openedat', 'questionnaire', userdate($this->opendate)));
- }
- if ($this->closedate > 0) {
- array_push($messages, get_string('closesat', 'questionnaire', userdate($this->closedate)));
- }
- }
-
- return $messages;
- }
-
- /**
- * Print each message in an array, surrounded by <p>, </p> tags.
- *
- * @param array $messages the array of message strings.
- * @return string HTML to output.
- */
- public function access_messages($messages) {
- $output = '';
- foreach ($messages as $message) {
- $output .= html_writer::tag('p', $message) . "\n";
- }
- return $output;
- }
-}
diff --git a/questions.php b/questions.php
index f1775f700..25542864f 100644
--- a/questions.php
+++ b/questions.php
@@ -23,33 +23,30 @@
*/
require_once("../../config.php");
-require_once($CFG->dirroot . '/mod/questionnaire/questionnaire.class.php');
-require_once($CFG->dirroot . '/mod/questionnaire/classes/question/question.php'); // Needed for question type constants.
+require_once($CFG->dirroot . '/mod/questionnaire/classes/local/question/question.php'); // Needed for question type constants.
+
+use mod_questionnaire\questionnaire;
+use mod_questionnaire\local\question_type;
+use mod_questionnaire\local\response\questionnaire_responses;
+use mod_questionnaire\output\questionspage;
+use mod_questionnaire\survey;
$id = required_param('id', PARAM_INT); // Course module ID.
$action = optional_param('action', 'main', PARAM_ALPHA); // Screen.
$qid = optional_param('qid', 0, PARAM_INT); // Question id.
$moveq = optional_param('moveq', 0, PARAM_INT); // Question id to move.
$delq = optional_param('delq', 0, PARAM_INT); // Question id to delete.
-$qtype = optional_param('type_id', 0, PARAM_INT); // Question type.
+$qtype = optional_param('typeid', 0, PARAM_INT); // Question type.
$currentgroupid = optional_param('group', 0, PARAM_INT); // Group id.
$delpermanentlyq = optional_param('delpermanentlyq', 0, PARAM_INT); // Question id to delete.
-$restoreq = optional_param(QUESTIONNAIRE_RESTORE_PARAM, 0, PARAM_INT); // Question id to restore question.
-
-if (! $cm = get_coursemodule_from_id('questionnaire', $id)) {
- throw new \moodle_exception('invalidcoursemodule', 'mod_questionnaire');
-}
+$restoreq = optional_param(questionnaire::restore_param(), 0, PARAM_INT); // Question id to restore question.
-if (! $course = $DB->get_record("course", ["id" => $cm->course])) {
- throw new \moodle_exception('coursemisconf', 'mod_questionnaire');
-}
-
-if (! $questionnaire = $DB->get_record("questionnaire", ["id" => $cm->instance])) {
- throw new \moodle_exception('invalidcoursemodule', 'mod_questionnaire');
-}
+$questionnaire = questionnaire::from_cmid($id);
+$course = $questionnaire->course();
+$cm = $questionnaire->coursemodule();
require_course_login($course, true, $cm);
-$context = context_module::instance($cm->id);
+$context = $questionnaire->context();
$url = new moodle_url($CFG->wwwroot . '/mod/questionnaire/questions.php');
$url->param('id', $id);
@@ -60,41 +57,39 @@
$PAGE->set_url($url);
$PAGE->set_context($context);
-$questionnaire = new questionnaire($course, $cm, 0, $questionnaire);
-$questionnaire->get_delete_questions();
+$deletequestions = $questionnaire->survey()->get_delete_questions();
+$questions = $questionnaire->questions();
-// Add renderer and page objects to the questionnaire object for display use.
-$questionnaire->add_renderer($PAGE->get_renderer('mod_questionnaire'));
-$questionnaire->add_page(new \mod_questionnaire\output\questionspage());
+$renderer = $PAGE->get_renderer('mod_questionnaire');
+$page = new questionspage();
-if (!$questionnaire->capabilities->editquestions) {
+if (!$questionnaire->capabilities()->can_edit_questions()) {
throw new \moodle_exception('nopermissions', 'mod_questionnaire');
}
-$questionnairehasdependencies = $questionnaire->has_dependencies();
+$questionnairehasdependencies = $questionnaire->navigator()->has_dependencies();
$dependants = null;
if (!isset($SESSION->questionnaire)) {
$SESSION->questionnaire = new stdClass();
}
-$SESSION->questionnaire->current_tab = 'questions';
$reload = false;
-$sid = $questionnaire->survey->id;
+$sid = $questionnaire->surveyid();
// Process form data.
// Delete question button has been pressed in questions_form AND deletion has been confirmed on the confirmation page.
if ($delq) {
$qid = $delq;
- $sid = $questionnaire->survey->id;
- $questionnaireid = $questionnaire->id;
+ $sid = $questionnaire->surveyid();
+ $questionnaireid = $questionnaire->id();
// Need to reload questions before setting deleted question to 'y'.
- $questions = $DB->get_records_select(
+ $dbquestions = $DB->get_records_select(
'questionnaire_question',
'surveyid = :sid AND deleted IS NULL',
['sid' => $sid],
'id'
);
- if (isset($questions[$qid]) && $questions[$qid]->type_id == QUESPAGEBREAK) {
+ if (isset($dbquestions[$qid]) && $dbquestions[$qid]->typeid == QUESPAGEBREAK) {
$DB->delete_records('questionnaire_question', ['id' => $qid]);
} else {
$updatesql = "UPDATE {questionnaire_question}
@@ -105,15 +100,16 @@
}
// Delete all dependency records for this question.
- questionnaire_delete_dependencies($qid);
+ $DB->delete_records('questionnaire_dependency', ['questionid' => $qid]);
+ $DB->delete_records('questionnaire_dependency', ['dependquestionid' => $qid]);
// Delete all page break that references to question deleted.
- questionnaire_delete_pagebreaks($sid);
+ survey::delete_pagebreaks($sid);
// Just in case the page is refreshed (F5) after a question has been deleted.
- if (isset($questions[$qid])) {
- $select = 'surveyid = ' . $sid . ' AND deleted IS NULL AND position > ' . $questions[$qid]->position;
+ if (isset($dbquestions[$qid])) {
+ $select = 'surveyid = ' . $sid . ' AND deleted IS NULL AND position > ' . $dbquestions[$qid]->position;
} else {
- redirect($CFG->wwwroot . '/mod/questionnaire/questions.php?id=' . $questionnaire->cm->id);
+ redirect($CFG->wwwroot . '/mod/questionnaire/questions.php?id=' . $cm->id);
}
if ($records = $DB->get_records_select('questionnaire_question', $select, null, 'position ASC')) {
@@ -123,11 +119,11 @@
}
// Delete section breaks without asking for confirmation.
// No need to delete responses to those "question types" which are not real questions.
- if (!$questionnaire->questions[$qid]->supports_responses()) {
+ if (!$questions[$qid]->supports_responses()) {
$reload = true;
} else {
// Delete responses to that deleted question.
- questionnaire_delete_responses($qid);
+ $questionnaire->responses()->delete_responses($qid);
// If no questions left in this questionnaire, remove all responses.
if (
@@ -142,11 +138,11 @@
}
// Log question deleted event.
- $questiontype = \mod_questionnaire\question\question::qtypename($questionnaire->questions[$qid]->type_id);
- questionnaire_observe_event_delete($questionnaire->cm->id, $questiontype, $questionnaire->course->id);
+ $questiontype = \mod_questionnaire\local\question\question::qtypename($questions[$qid]->typeid());
+ survey::trigger_question_deleted_event($cm->id, $questiontype, $questionnaire->courseid());
if ($questionnairehasdependencies) {
- $SESSION->questionnaire->validateresults = questionnaire_check_page_breaks($questionnaire);
+ $SESSION->questionnaire->validateresults = $questionnaire->survey()->check_page_breaks();
}
$reload = true;
}
@@ -154,13 +150,13 @@
// Delete question permanently.
if ($delpermanentlyq) {
$qid = $delpermanentlyq;
- $sid = $questionnaire->survey->id;
- questionnaire_delete_permanently_questions($qid, $sid);
- $deletedquestion = $questionnaire->deletequestions[$qid] ?? null;
+ $sid = $questionnaire->surveyid();
+ survey::delete_question_permanently($qid, $sid);
+ $deletedquestion = $deletequestions[$qid] ?? null;
if ($deletedquestion !== null) {
- $questiontype = \mod_questionnaire\question\question::qtypename($deletedquestion->type_id);
- questionnaire_observe_event_delete($questionnaire->cm->id, $questiontype, $questionnaire->course->id);
- $url = new moodle_url('/mod/questionnaire/questions.php', ['id' => $questionnaire->cm->id]);
+ $questiontype = \mod_questionnaire\local\question\question::qtypename($deletedquestion->typeid());
+ survey::trigger_question_deleted_event($cm->id, $questiontype, $questionnaire->courseid());
+ $url = new moodle_url('/mod/questionnaire/questions.php', ['id' => $cm->id]);
$PAGE->set_url($url->out(false));
$reload = true;
}
@@ -169,23 +165,23 @@
// Restore question.
if ($restoreq) {
$qid = $restoreq;
- $qdeleted = isset($questionnaire->deletequestions[$qid]) ? $questionnaire->deletequestions[$qid] : false;
+ $qdeleted = $deletequestions[$qid] ?? false;
if ($qid && $qdeleted) {
- questionnaire_restore_deleted_question($qid, $qdeleted->surveyid);
+ survey::restore_deleted_question($qid, $qdeleted->surveyid());
}
- $url = new moodle_url('/mod/questionnaire/questions.php', ['id' => $questionnaire->cm->id]);
+ $url = new moodle_url('/mod/questionnaire/questions.php', ['id' => $cm->id]);
$PAGE->set_url($url->out(false));
$reload = true;
}
if ($action == 'main') {
- $questionsform = new \mod_questionnaire\questions_form('questions.php', $moveq);
- $sdata = clone($questionnaire->survey);
- $sdata->sid = $questionnaire->survey->id;
+ $questionsform = new \mod_questionnaire\questions_form('questions.php', $moveq, $renderer);
+ $sdata = $questionnaire->survey()->to_stdclass();
+ $sdata->sid = $questionnaire->surveyid();
$sdata->id = $cm->id;
- if (!empty($questionnaire->questions)) {
+ if (!empty($questions)) {
$pos = 1;
- foreach ($questionnaire->questions as $qidx => $question) {
+ foreach ($questions as $qidx => $question) {
$sdata->{'pos_' . $qidx} = $pos;
$pos++;
}
@@ -194,7 +190,7 @@
if ($questionsform->is_cancelled()) {
// Switch to main screen.
$action = 'main';
- redirect($CFG->wwwroot . '/mod/questionnaire/questions.php?id=' . $questionnaire->cm->id);
+ redirect($CFG->wwwroot . '/mod/questionnaire/questions.php?id=' . $cm->id);
$reload = true;
}
if ($qformdata = $questionsform->get_data()) {
@@ -223,18 +219,18 @@
// Need to use the key, since IE returns the image position as the value rather than the specified
// value in the
') {
- $question->content = '';
+ $displaycontent = $question->content();
+ if ($displaycontent == '
') {
+ $displaycontent = '';
}
$qname = '';
- if ($question->name) {
- $qname = ' (' . $question->name . ')';
+ if ($question->name()) {
+ $qname = ' (' . $question->name() . ')';
}
$num = get_string('position', 'questionnaire');
- $pos = $question->position . $qname;
+ $pos = $question->position() . $qname;
$msg = '' . get_string('confirmdelquestion', 'questionnaire', $pos) . '
';
if ($countresps !== 0) {
$msg .= '
' . get_string('confirmdelquestionresps', 'questionnaire', $countresps) . '
';
}
$msg .= '
' . $num . ' ' . $pos . '
' . $question->content . '
' . $num . ' ' . $pos . '
' . $displaycontent . '
' . get_string('confirmdelpermanentlyq', 'questionnaire') . '
';
@@ -463,12 +458,12 @@
$msg .= '
' . get_string('confirmdelquestionresps', 'questionnaire', $countresps) . '
';
}
$msg .= '
NA (' . $questiondelete->name . ')
-
' . $questiondelete->content . '
NA (' . $questiondelete->name() . ')
+
' . $questiondelete->content() . '
' . get_string('allparticipants') . ' ';
}
}
-if ($usergraph) {
- $charttype = $questionnaire->survey->chart_type;
- if ($charttype) {
- $PAGE->requires->js('/mod/questionnaire/javascript/RGraph/RGraph.common.core.js');
-
- switch ($charttype) {
- case 'bipolar':
- $PAGE->requires->js('/mod/questionnaire/javascript/RGraph/RGraph.bipolar.js');
- break;
- case 'hbar':
- $PAGE->requires->js('/mod/questionnaire/javascript/RGraph/RGraph.hbar.js');
- break;
- case 'radar':
- $PAGE->requires->js('/mod/questionnaire/javascript/RGraph/RGraph.radar.js');
- break;
- case 'rose':
- $PAGE->requires->js('/mod/questionnaire/javascript/RGraph/RGraph.rose.js');
- break;
- case 'vprogress':
- $PAGE->requires->js('/mod/questionnaire/javascript/RGraph/RGraph.vprogress.js');
- break;
- }
- }
-}
-
$responsestatus = [
'y' => get_string('fullsubmissions', 'questionnaire'),
'0' => get_string('allresponses', 'questionnaire'),
@@ -218,735 +173,68 @@
switch ($action) {
case 'dresp': // Delete individual response? Ask for confirmation.
- require_capability('mod/questionnaire:deleteresponses', $context);
-
- if (empty($questionnaire->survey)) {
- throw new \moodle_exception('surveynotexists', 'mod_questionnaire');
- } else if ($questionnaire->survey->courseid != $course->id) {
- throw new \moodle_exception('surveyowner', 'mod_questionnaire');
- } else if (!$rid || !is_numeric($rid)) {
- throw new \moodle_exception('invalidresponse', 'mod_questionnaire');
- } else if (!($resp = $DB->get_record('questionnaire_response', ['id' => $rid]))) {
- throw new \moodle_exception('invalidresponserecord', 'mod_questionnaire');
- }
-
- $ruser = false;
- if (!empty($resp->userid)) {
- if ($user = $DB->get_record('user', ['id' => $resp->userid])) {
- $ruser = fullname($user);
- } else {
- $ruser = '- ' . get_string('unknown', 'questionnaire') . ' -';
- }
- } else {
- $ruser = $resp->userid;
- }
-
- // Print the page header.
- $PAGE->set_title(get_string('deletingresp', 'questionnaire'));
- $PAGE->set_heading(format_string($course->fullname));
- echo $questionnaire->renderer->header();
-
- // Print the tabs.
- $SESSION->questionnaire->current_tab = 'deleteresp';
- include('tabs.php');
-
- $timesubmitted = '';
- $msg .= get_string('confirmdelresp', 'questionnaire', $ruser . $timesubmitted);
- $msg .= '
';
- $urlyes = new moodle_url('report.php', [
- 'action' => 'dvresp',
- 'rid' => $rid,
- 'individualresponse' => 1,
- 'instance' => $instance,
- 'group' => $currentgroupid,
- ]);
- $urlno = new moodle_url('report.php', [
- 'action' => 'vresp',
- 'instance' => $instance,
- 'rid' => $rid,
- 'individualresponse' => 1,
- 'group' => $currentgroupid,
- ]);
- $buttonyes = new single_button($urlyes, get_string('delete'), 'post');
- $buttonno = new single_button($urlno, get_string('cancel'), 'get');
- $questionnaire->page->add_to_page('notifications', $questionnaire->renderer->confirm($msg, $buttonyes, $buttonno));
- echo $questionnaire->renderer->render($questionnaire->page);
- // Finish the page.
- echo $questionnaire->renderer->footer($course);
+ (new report_actions($questionnaire, $renderer))
+ ->confirm_delete_response($page, (int)$rid, $currentgroupid);
break;
case 'delallresp': // Delete all responses? Ask for confirmation.
- require_capability('mod/questionnaire:deleteresponses', $context);
-
- if (!empty($respsallparticipants)) {
- // Print the page header.
- $PAGE->set_title(get_string('deletingresp', 'questionnaire'));
- $PAGE->set_heading(format_string($course->fullname));
- echo $questionnaire->renderer->header();
-
- // Print the tabs.
- $SESSION->questionnaire->current_tab = 'deleteall';
- include('tabs.php');
-
- // Print the confirmation.
- $msg = '';
- if ($groupmode == 0) { // No groups or visible groups.
- $msg .= get_string('confirmdelallresp', 'questionnaire');
- } else { // Separate groups.
- $msg .= get_string('confirmdelgroupresp', 'questionnaire', $groupname);
- }
- $msg .= '
';
-
- $urlyes = new moodle_url('report.php', [
- 'action' => 'dvallresp',
- 'sid' => $sid,
- 'instance' => $instance,
- 'group' => $currentgroupid,
- ]);
- $urlno = new moodle_url('report.php', ['instance' => $instance, 'group' => $currentgroupid]);
- $buttonyes = new single_button($urlyes, get_string('delete'), 'post');
- $buttonno = new single_button($urlno, get_string('cancel'), 'get');
-
- $questionnaire->page->add_to_page('notifications', $questionnaire->renderer->confirm($msg, $buttonyes, $buttonno));
- echo $questionnaire->renderer->render($questionnaire->page);
- // Finish the page.
- echo $questionnaire->renderer->footer($course);
- }
+ (new report_actions($questionnaire, $renderer))
+ ->confirm_delete_all_responses($page, $groupmode, $currentgroupid, $groupname ?? '', $respsallparticipants);
break;
case 'dvresp': // Delete single response. Do it!
- require_capability('mod/questionnaire:deleteresponses', $context);
-
- if (empty($questionnaire->survey)) {
- throw new \moodle_exception('surveynotexists', 'mod_questionnaire');
- } else if ($questionnaire->survey->courseid != $course->id) {
- throw new \moodle_exception('surveyowner', 'mod_questionnaire');
- } else if (!$rid || !is_numeric($rid)) {
- throw new \moodle_exception('invalidresponse', 'mod_questionnaire');
- } else if (!($response = $DB->get_record('questionnaire_response', ['id' => $rid]))) {
- throw new \moodle_exception('invalidresponserecord', 'mod_questionnaire');
- }
-
- if (questionnaire_delete_response($response, $questionnaire)) {
- if (!$DB->count_records('questionnaire_response', ['questionnaireid' => $questionnaire->id, 'complete' => 'y'])) {
- $redirection = $CFG->wwwroot . '/mod/questionnaire/view.php?id=' . $cm->id;
- } else {
- $redirection = $CFG->wwwroot . '/mod/questionnaire/report.php?action=vresp&instance=' .
- $instance . '&byresponse=1';
- }
-
- // Log this questionnaire delete single response action.
- $params = [
- 'objectid' => $questionnaire->survey->id,
- 'context' => $questionnaire->context,
- 'courseid' => $questionnaire->course->id,
- 'relateduserid' => $response->userid,
- ];
- $event = \mod_questionnaire\event\response_deleted::create($params);
- $event->trigger();
-
- redirect($redirection);
- } else {
- if ($questionnaire->respondenttype == 'anonymous') {
- $ruser = '- ' . get_string('anonymous', 'questionnaire') . ' -';
- } else if (!empty($response->userid)) {
- if ($user = $DB->get_record('user', ['id' => $response->userid])) {
- $ruser = fullname($user);
- } else {
- $ruser = '- ' . get_string('unknown', 'questionnaire') . ' -';
- }
- } else {
- $ruser = $response->userid;
- }
- $link = new \moodle_url('/mod/questionnaire/report.php', [
- 'action' => 'vresp',
- 'sid' => $sid,
- 'instance' => $instance,
- 'byresponse' => '1',
- ]);
- throw new \moodle_exception(
- 'couldnotdelrespby',
- 'mod_questionnaire',
- $link,
- ['rid' => $rid, 'user' => $ruser]
- );
- }
+ (new report_actions($questionnaire, $renderer))->delete_response((int)$rid);
break;
case 'dvallresp': // Delete all responses in questionnaire (or group). Do it!
- require_capability('mod/questionnaire:deleteresponses', $context);
-
- if (empty($questionnaire->survey)) {
- throw new \moodle_exception('surveynotexists', 'mod_questionnaire');
- } else if ($questionnaire->survey->courseid != $course->id) {
- throw new \moodle_exception('surveyowner', 'mod_questionnaire');
- }
-
- // Available group modes (0 = no groups; 1 = separate groups; 2 = visible groups).
- if ($groupmode > 0) {
- switch ($currentgroupid) {
- case 0: // All participants.
- $resps = $respsallparticipants;
- break;
- default: // Members of a specific group.
- if (!($resps = $questionnaire->get_responses(false, $currentgroupid))) {
- $resps = [];
- }
- }
- if (empty($resps)) {
- $noresponses = true;
- } else {
- if ($rid === false) {
- $resp = current($resps);
- $rid = $resp->id;
- } else {
- $resp = $DB->get_record('questionnaire_response', ['id' => $rid]);
- }
- if (!empty($resp->userid)) {
- if ($user = $DB->get_record('user', ['id' => $resp->userid])) {
- $ruser = fullname($user);
- } else {
- $ruser = '- ' . get_string('unknown', 'questionnaire') . ' -';
- }
- } else {
- $ruser = $resp->userid;
- }
- }
- } else {
- $resps = $respsallparticipants;
- }
-
- if (!empty($resps)) {
- foreach ($resps as $response) {
- questionnaire_delete_response($response, $questionnaire);
- }
- if (!$questionnaire->count_submissions()) {
- $redirection = $CFG->wwwroot . '/mod/questionnaire/view.php?id=' . $cm->id;
- } else {
- $redirection = $CFG->wwwroot . '/mod/questionnaire/report.php?action=vall&sid=' . $sid . '&instance=' .
- $instance;
- }
-
- // Log this questionnaire delete all responses action.
- $context = context_module::instance($questionnaire->cm->id);
- $anonymous = $questionnaire->respondenttype == 'anonymous';
-
- $event = \mod_questionnaire\event\all_responses_deleted::create([
- 'objectid' => $questionnaire->id,
- 'anonymous' => $anonymous,
- 'context' => $context,
- ]);
- $event->trigger();
-
- redirect($redirection);
- } else {
- $link = new \moodle_url('/mod/questionnaire/report.php', [
- 'action' => 'vall',
- 'sid' => $sid,
- 'instance' => $instance,
- ]);
- throw new \moodle_exception('couldnotdelresp', 'mod_questionnaire', $link);
- }
+ (new report_actions($questionnaire, $renderer))
+ ->delete_all_responses($groupmode, $currentgroupid, $respsallparticipants);
break;
case 'dwnpg': // Download page options.
- require_capability('mod/questionnaire:downloadresponses', $context);
-
- $PAGE->set_title(get_string('questionnairereport', 'questionnaire'));
- $PAGE->set_heading(format_string($course->fullname));
- echo $questionnaire->renderer->header();
-
- // Print the tabs.
- // Tab setup.
- if (empty($user)) {
- $SESSION->questionnaire->current_tab = 'downloadcsv';
- } else {
- $SESSION->questionnaire->current_tab = 'mydownloadcsv';
- }
-
- include('tabs.php');
-
- $groupname = '';
- if ($groupmode > 0) {
- switch ($currentgroupid) {
- case 0: // All participants.
- $groupname = get_string('allparticipants');
- break;
- default: // Members of a specific group.
- $groupname = get_string('membersofselectedgroup', 'group') . ' ' .
- get_string('group') . ' ' . $questionnairegroups[$currentgroupid]->name;
- }
- }
- $output = '';
- $output .= "' . $escapedgroupname . '<\/option>/',
- ' ' . $thisgroupname . ' (' . $respscount . ') ',
- $groupselect
- );
- } else {
- // Remove groups with no responses from the groups select list.
- $groupselect = preg_replace(
- '/\' . $escapedgroupname . '<\/option>/',
- '',
- $groupselect
- );
- }
- }
- $respinfo .= isset($groupselect) ? ($groupselect . ' ') : '';
- $currentgroupid = groups_get_activity_group($cm);
- }
- if ($currentgroupid > 0) {
- $groupname = get_string('group') . ': ' . groups_get_group_name($currentgroupid) . ' ';
- } else {
- $groupname = '' . $responsestatus[$userview] . ' ';
- }
-
- // Available group modes (0 = no groups; 1 = separate groups; 2 = visible groups).
- if ($groupmode > 0) {
- switch ($currentgroupid) {
- case 0: // All participants.
- $resps = $respsallparticipants;
- break;
- default: // Members of a specific group.
- if (!($resps = $questionnaire->get_responses(false, $currentgroupid))) {
- $resps = '';
- }
- }
- if (empty($resps)) {
- $noresponses = true;
- }
- } else {
- $resps = $respsallparticipants;
- }
- if (!empty($resps)) {
- // NOTE: response_analysis uses $resps to get the id's of the responses only.
- // Need to figure out what this function does.
- $feedbackmessages = $questionnaire->response_analysis(0, $resps, false, false, true, $currentgroupid);
-
- if ($feedbackmessages) {
- $msgout = '';
- foreach ($feedbackmessages as $msg) {
- $msgout .= $msg;
- }
- $questionnaire->page->add_to_page('feedbackmessages', $msgout);
- }
- }
-
- $params = [
- 'objectid' => $questionnaire->id,
- 'context' => $context,
- 'courseid' => $course->id,
- 'other' => ['action' => $action, 'instance' => $instance, 'groupid' => $currentgroupid],
- ];
-
- if ($outputtarget == 'pdf') {
- $pdf = questionnaire_report_start_pdf();
- if ($currentgroupid > 0) {
- $groupname = get_string('group') . ': ' . groups_get_group_name($currentgroupid) . ' ';
- } else {
- $groupname = '' . $responsestatus[$userview] . ' ';
- }
- $respinfo = get_string('view') . ' ' . $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();
-
- 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',
- 'responsestats' => $userview,
- ]
- );
- $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',
- 'responsestats' => $userview,
- ]
- );
- $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 .= $questionnaire->renderer->viewresponse_print_menu($url->out(), $responsestatus, $userview);
- $strsort = get_string('order_' . $sort, 'questionnaire');
- $respinfo .= $strsort;
- $respinfo .= $questionnaire->renderer->help_icon('orderresponses', 'questionnaire');
- $questionnaire->page->add_to_page('respondentinfo', $respinfo);
- }
-
- $ret = $questionnaire->survey_results('', false, false, $currentgroupid, $sort);
-
- echo $questionnaire->renderer->header();
- echo $questionnaire->renderer->render($questionnaire->page);
- echo $questionnaire->renderer->footer($course);
- }
+ (new report_viewer($questionnaire, $renderer))->view_all_responses(
+ $page,
+ $action,
+ $outputtarget,
+ $url,
+ $groupmode,
+ $currentgroupid,
+ $questionnairegroups ?: [],
+ $respsallparticipants,
+ $sort,
+ $userview,
+ $responsestatus,
+ (bool)$usergraph
+ );
break;
case 'vresp': // View by response.
default:
- if (empty($questionnaire->survey)) {
- throw new \moodle_exception('surveynotexists', 'mod_questionnaire');
- } else if ($questionnaire->survey->courseid != $course->id) {
- throw new \moodle_exception('surveyowner', 'mod_questionnaire');
- }
- $ruser = false;
- $noresponses = false;
- if ($usergraph) {
- $charttype = $questionnaire->survey->chart_type;
- if ($charttype) {
- $PAGE->requires->js('/mod/questionnaire/javascript/RGraph/RGraph.common.core.js');
-
- switch ($charttype) {
- case 'bipolar':
- $PAGE->requires->js('/mod/questionnaire/javascript/RGraph/RGraph.bipolar.js');
- break;
- case 'hbar':
- $PAGE->requires->js('/mod/questionnaire/javascript/RGraph/RGraph.hbar.js');
- break;
- case 'radar':
- $PAGE->requires->js('/mod/questionnaire/javascript/RGraph/RGraph.radar.js');
- break;
- case 'rose':
- $PAGE->requires->js('/mod/questionnaire/javascript/RGraph/RGraph.rose.js');
- break;
- case 'vprogress':
- $PAGE->requires->js('/mod/questionnaire/javascript/RGraph/RGraph.vprogress.js');
- break;
- }
- }
- }
-
- // Add group filter dropdown.
- if ($groupmode > 0) {
- $groupselect = groups_print_activity_menu($cm, $url->out(), true);
- $questionnaire->page->add_to_page('respondentinfo', $groupselect);
- $currentgroupid = groups_get_activity_group($cm);
- }
-
- if ($byresponse || $rid) {
- // Available group modes (0 = no groups; 1 = separate groups; 2 = visible groups).
- if ($groupmode > 0) {
- switch ($currentgroupid) {
- case 0: // All participants.
- $resps = $respsallparticipants;
- break;
- default: // Members of a specific group.
- $resps = $questionnaire->get_responses(false, $currentgroupid);
- }
- if (empty($resps)) {
- $noresponses = true;
- } else {
- if ($rid === false) {
- $resp = current($resps);
- $rid = $resp->id;
- } else {
- $resp = $DB->get_record('questionnaire_response', ['id' => $rid]);
- }
- if (!empty($resp->userid)) {
- if ($user = $DB->get_record('user', ['id' => $resp->userid])) {
- $ruser = fullname($user);
- } else {
- $ruser = '- ' . get_string('unknown', 'questionnaire') . ' -';
- }
- } else {
- $ruser = $resp->userid;
- }
- }
- } else {
- $resps = $respsallparticipants;
- }
- }
- $rids = array_keys($resps);
- if (!$rid && !$noresponses) {
- $rid = $rids[0];
- }
-
- if ($outputtarget == 'pdf') {
- $pdf = questionnaire_report_start_pdf();
- if ($currentgroupid > 0) {
- $groupname = get_string('group') . ': ' . groups_get_group_name($currentgroupid) . ' ';
- } else {
- $groupname = '' . $responsestatus[$userview] . ' ';
- }
- 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.
- if ($noresponses) {
- $questionnaire->page->add_to_page(
- 'respondentinfo',
- get_string('group') . ' ' .
- groups_get_group_name($currentgroupid) . ' : ' . get_string('noresponses', 'questionnaire')
- );
- }
-
- // 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 = $responsestatus[$userview];
- }
- if ($byresponse) {
- $respinfo = '';
- $respinfo .= $questionnaire->renderer->box_start();
- $respinfo .= $questionnaire->renderer->help_icon('viewindividualresponse', 'questionnaire') . ' ';
- $respinfo .= get_string('viewindividualresponse', 'questionnaire') . ' : ' . $groupname . ' ';
- $respinfo .= $questionnaire->renderer->box_end();
- $questionnaire->page->add_to_page('respondentinfo', $respinfo);
- }
- if ($outputtarget == 'html') {
- $questionnaire->survey_results_navbar_alpha($rid, $currentgroupid, $cm, $byresponse);
- }
- if (!$byresponse) { // Show respondents individual responses.
- $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);
- }
+ (new report_viewer($questionnaire, $renderer))->view_individual_response(
+ $page,
+ $outputtarget,
+ $url,
+ $groupmode,
+ $currentgroupid,
+ $respsallparticipants,
+ $rid,
+ (bool)$byresponse,
+ (bool)$individualresponse,
+ (bool)$usergraph,
+ $userview,
+ $responsestatus
+ );
break;
}
-
-/**
- * Return a pdf object.
- *
- * @package mod_questionnaire
- * @copyright 2016 Mike Churchward (mike.churchward@poetgroup.org)
- * @author Mike Churchward
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- *
- * @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
index 7cdc4b0b2..0003c1839 100644
--- a/savefileformat.php
+++ b/savefileformat.php
@@ -90,10 +90,11 @@ function save_as_dataformat($filename, $dataformat, $columns, $iterator, $users
fwrite($fp, $output);
fclose($fp);
$subjecttext = get_string('summaryreportattached', 'questionnaire');
+ $noreplyuser = \core_user::get_noreply_user();
foreach ($users as $user) {
email_to_user(
$user,
- $CFG->noreplyaddress,
+ $noreplyuser,
$subjecttext,
$subjecttext,
'',
@@ -106,7 +107,7 @@ function save_as_dataformat($filename, $dataformat, $columns, $iterator, $users
$user = (object)['id' => -10, 'email' => $email, 'firstname' => $email, 'lastname' => $email, 'mailformat' => 1];
email_to_user(
$user,
- $CFG->noreplyaddress,
+ $noreplyuser,
$subjecttext,
$subjecttext,
'',
diff --git a/settings.php b/settings.php
index 39ac51c48..309947d1d 100644
--- a/settings.php
+++ b/settings.php
@@ -24,7 +24,6 @@
*/
defined('MOODLE_INTERNAL') || die;
-require_once($CFG->dirroot . '/mod/questionnaire/locallib.php');
if ($ADMIN->fulltree) {
$options = [0 => get_string('no'), 1 => get_string('yes')];
@@ -99,7 +98,7 @@
$setting = new admin_setting_configselect('questionnaire/autodeleteresponse', $name, $desc, 0, $options);
$settings->add($setting);
- $options = questionnaire_create_remove_options();
+ $options = \mod_questionnaire\form_options::response_removal();
$settings->add(
new admin_setting_configselect(
'questionnaire/removeoldresponses',
diff --git a/show_nonrespondents.php b/show_nonrespondents.php
index d05df86e1..ddf12adbc 100644
--- a/show_nonrespondents.php
+++ b/show_nonrespondents.php
@@ -24,10 +24,12 @@
*/
require_once("../../config.php");
-require_once($CFG->dirroot . '/mod/questionnaire/locallib.php');
-require_once($CFG->dirroot . '/mod/questionnaire/questionnaire.class.php');
require_once($CFG->libdir . '/tablelib.php');
+use mod_questionnaire\questionnaire;
+use mod_questionnaire\local\response\questionnaire_responses;
+use mod_questionnaire\output\nonrespondentspage;
+
// Get the params.
$id = required_param('id', PARAM_INT);
$subject = optional_param('subject', '', PARAM_CLEANHTML);
@@ -36,37 +38,16 @@
$messageuser = optional_param_array('messageuser', false, PARAM_INT);
$action = optional_param('action', '', PARAM_ALPHA);
$selectedanonymous = optional_param('selectedanonymous', '', PARAM_ALPHA);
-$perpage = optional_param('perpage', QUESTIONNAIRE_DEFAULT_PAGE_COUNT, PARAM_INT); // How many per page.
+$perpage = optional_param('perpage', questionnaire::default_page_count(), PARAM_INT); // How many per page.
$showall = optional_param('showall', false, PARAM_INT); // Should we show all users?
$sid = optional_param('sid', 0, PARAM_INT);
$qid = optional_param('qid', 0, PARAM_INT);
$currentgroupid = optional_param('group', 0, PARAM_INT); // Groupid.
-if (!isset($SESSION->questionnaire)) {
- $SESSION->questionnaire = new stdClass();
-}
-
-$SESSION->questionnaire->current_tab = 'nonrespondents';
-
-// Get the objects.
-
-if ($id) {
- if (! $cm = get_coursemodule_from_id('questionnaire', $id)) {
- throw new \moodle_exception('invalidcoursemodule', 'mod_questionnaire');
- }
-
- if (! $course = $DB->get_record("course", ["id" => $cm->course])) {
- throw new \moodle_exception('coursemisconf', 'mod_questionnaire');
- }
-
- if (! $questionnaire = $DB->get_record("questionnaire", ["id" => $cm->instance])) {
- throw new \moodle_exception('invalidcoursemodule', 'mod_questionnaire');
- }
-}
-
-if (!$context = context_module::instance($cm->id)) {
- throw new \moodle_exception('badcontext', 'mod_questionnaire');
-}
+$questionnaire = questionnaire::from_cmid($id);
+$course = $questionnaire->course();
+$cm = $questionnaire->coursemodule();
+$context = $questionnaire->context();
// We need the coursecontext to allow sending of mass mails.
if (!$coursecontext = context_course::instance($course->id)) {
@@ -78,15 +59,12 @@
$url = new moodle_url('/mod/questionnaire/show_nonrespondents.php', ['id' => $cm->id]);
$PAGE->set_url($url);
-$questionnaire = new questionnaire($course, $cm, $sid, $questionnaire);
-
-// Add renderer and page objects to the questionnaire object for display use.
-$questionnaire->add_renderer($PAGE->get_renderer('mod_questionnaire'));
-$questionnaire->add_page(new \mod_questionnaire\output\nonrespondentspage());
+$renderer = $PAGE->get_renderer('mod_questionnaire');
+$page = new nonrespondentspage();
-$resume = $questionnaire->resume;
-$fullname = $questionnaire->respondenttype == 'fullname';
-$sid = $questionnaire->sid;
+$resume = $questionnaire->resume();
+$fullname = $questionnaire->respondenttype() == 'fullname';
+$sid = $questionnaire->surveyid();
if (($formdata = data_submitted()) && !confirm_sesskey()) {
throw new \moodle_exception('invalidsesskey', 'mod_questionnaire');
@@ -96,12 +74,12 @@
// Anonymous questionnaire.
if (!$fullname) {
- $nonrespondents = questionnaire_get_incomplete_users($cm, $sid);
+ $nonrespondents = questionnaire_responses::get_incomplete_users($cm, $sid);
$countnonrespondents = count($nonrespondents);
if ($resume) {
$countstarted = 0;
$countnotstarted = 0;
- $params = ['questionnaireid' => $questionnaire->id, 'complete' => 'n'];
+ $params = ['questionnaireid' => $questionnaire->id(), 'complete' => 'n'];
if ($startedusers = $DB->get_records('questionnaire_response', $params, '', 'userid')) {
$startedusers = array_keys($startedusers);
$countstarted = count($startedusers);
@@ -139,7 +117,7 @@
$link1 = $CFG->wwwroot . '/mod/questionnaire/view.php?id= ' . $cm->id;
$htmlmessage .= '';
$htmlmessage .= $message;
@@ -164,9 +142,9 @@
$good = $good && message_send($eventdata);
}
if (!empty($good)) {
- $msg = $questionnaire->renderer->heading(get_string('messagedselectedusers'));
+ $msg = $renderer->heading(get_string('messagedselectedusers'));
} else {
- $msg = $questionnaire->renderer->heading(get_string('messagedselectedusersfailed'));
+ $msg = $renderer->heading(get_string('messagedselectedusersfailed'));
}
$url = new moodle_url('/mod/questionnaire/view.php', ['id' => $cm->id]);
@@ -179,10 +157,10 @@
// Print the page header.
$PAGE->navbar->add(get_string('show_nonrespondents', 'questionnaire'));
$PAGE->set_heading(format_string($course->fullname));
-$PAGE->set_title(format_string($questionnaire->name));
-echo $questionnaire->renderer->header();
+$PAGE->set_title(format_string($questionnaire->name()));
+echo $renderer->header();
-require('tabs.php');
+(new \mod_questionnaire\output\tabs($questionnaire, 'nonrespondents', $currentgroupid))->render($page);
$usedgroupid = false;
$sort = '';
@@ -276,7 +254,7 @@
} else {
$usedgroupid = false;
}
- $nonrespondents = questionnaire_get_incomplete_users($cm, $sid, $usedgroupid);
+ $nonrespondents = questionnaire_responses::get_incomplete_users($cm, $sid, $usedgroupid);
if (is_array($nonrespondents) || is_object($nonrespondents)) {
$countnonrespondents = count($nonrespondents);
} else {
@@ -295,14 +273,14 @@
}
}
-$nonrespondents = questionnaire_get_incomplete_users($cm, $sid, $usedgroupid, $sort, $startpage, $pagecount);
+$nonrespondents = questionnaire_responses::get_incomplete_users($cm, $sid, $usedgroupid, $sort, $startpage, $pagecount);
// Viewreports-start.
// Print the list of students.
-$questionnaire->page->add_to_page('formarea', (isset($groupselect) ? $groupselect : ''));
-$questionnaire->page->add_to_page('formarea', html_writer::tag('div', '', ['class' => 'clearer']));
-$questionnaire->page->add_to_page('formarea', $questionnaire->renderer->box_start('left-align'));
+$page->add_to_page('formarea', (isset($groupselect) ? $groupselect : ''));
+$page->add_to_page('formarea', html_writer::tag('div', '', ['class' => 'clearer']));
+$page->add_to_page('formarea', $renderer->box_start('left-align'));
$countries = get_string_manager()->get_list_of_countries();
@@ -321,17 +299,17 @@
$datestring->secs = get_string('secs');
if (!$nonrespondents) {
- $questionnaire->page->add_to_page(
+ $page->add_to_page(
'formarea',
- $questionnaire->renderer->notification(get_string('noexistingparticipants', 'enrol'))
+ $renderer->notification(get_string('noexistingparticipants', 'enrol'))
);
} else {
- $questionnaire->page->add_to_page('formarea', get_string('non_respondents', 'questionnaire'));
- $questionnaire->page->add_to_page('formarea', ' (' . $countnonrespondents . ')');
+ $page->add_to_page('formarea', get_string('non_respondents', 'questionnaire'));
+ $page->add_to_page('formarea', ' (' . $countnonrespondents . ')');
if (!$fullname) {
- $questionnaire->page->add_to_page('formarea', ' [' . get_string('anonymous', 'questionnaire') . ']');
+ $page->add_to_page('formarea', ' [' . get_string('anonymous', 'questionnaire') . ']');
}
- $questionnaire->page->add_to_page(
+ $page->add_to_page(
'formarea',
html_writer::start_tag(
'form',
@@ -354,7 +332,7 @@
// Userpicture and link to the profilepage.
$profileurl = $CFG->wwwroot . '/user/view.php?id=' . $user->id . '&course=' . $course->id;
$profilelink = '' . fullname($user) . ' ');
- $questionnaire->page->add_to_page('formarea', '' . get_string('send_message_to', 'questionnaire') .
+ $page->add_to_page('formarea', ' ');
+ $page->add_to_page('formarea', '' . get_string('send_message_to', 'questionnaire') .
' ');
$checked = ($selectedanonymous == '' || $selectedanonymous == 'none') ? 'checked = "checked"' : '';
- $questionnaire->page->add_to_page(
+ $page->add_to_page(
'formarea',
' ' . get_string('none') . ' '
);
$checked = ($selectedanonymous == 'all') ? 'checked = "checked"' : '';
- $questionnaire->page->add_to_page(
+ $page->add_to_page(
'formarea',
'' . get_string('all', 'questionnaire') . ' '
@@ -476,7 +454,7 @@
if ($resume) {
if ($countstarted > 0) {
$checked = ($selectedanonymous == 'started') ? 'checked = "checked"' : '';
- $questionnaire->page->add_to_page(
+ $page->add_to_page(
'formarea',
'' . get_string('status') . ': ' .
@@ -490,7 +468,7 @@
$checked = '';
}
$checked = ($selectedanonymous == 'notstarted') ? 'checked = "checked"' : '';
- $questionnaire->page->add_to_page(
+ $page->add_to_page(
'formarea',
'' . get_string('status') . ': ' .
@@ -499,22 +477,22 @@
}
}
if ($action == 'sendmessage' && $selectedanonymous == 'none') {
- $questionnaire->page->add_to_page(
+ $page->add_to_page(
'formarea',
- $questionnaire->renderer->notification(get_string('nousersselected', 'questionnaire'))
+ $renderer->notification(get_string('nousersselected', 'questionnaire'))
);
}
- $questionnaire->page->add_to_page('formarea', ' ');
+ $page->add_to_page('formarea', ' ');
}
}
if (has_capability('mod/questionnaire:message', $context)) {
// Message editor.
// Prepare data.
- $questionnaire->page->add_to_page('formarea', '');
+ $page->add_to_page('formarea', '');
if ($action == 'sendmessage' && (empty($subject) || empty($message))) {
- $questionnaire->page->add_to_page('formarea', $questionnaire->renderer->notification(get_string('allfieldsrequired')));
+ $page->add_to_page('formarea', $renderer->notification(get_string('allfieldsrequired')));
}
- $questionnaire->page->add_to_page(
+ $page->add_to_page(
'formarea',
'' . get_string('send_message', 'questionnaire') . ' '
);
@@ -523,7 +501,7 @@
maxlength="255" name="subject" value="' . $subject . '" />';
$format = '';
$editor = editors_get_preferred_editor();
- $editor->use_editor($id, questionnaire_get_editor_options($context));
+ $editor->use_editor($id, \mod_questionnaire\form_options::editor($context));
$texteditor = html_writer::tag(
'div',
html_writer::tag(
@@ -532,7 +510,7 @@
['id' => $id, 'name' => "message", 'class' => "form-control", 'rows' => '10', 'cols' => '60']
)
);
- $questionnaire->page->add_to_page('formarea', '' . get_string('subject', 'questionnaire') . ' ', $subjecteditor];
$table->data[] = ['' . get_string('messagebody') . ' ', $texteditor];
- $questionnaire->page->add_to_page('formarea', html_writer::table($table));
+ $page->add_to_page('formarea', html_writer::table($table));
// Send button.
- $questionnaire->page->add_to_page('formarea', $questionnaire->renderer->box_start('mdl-left'));
- $questionnaire->page->add_to_page('formarea', '');
- $questionnaire->page->add_to_page('formarea', '
');
- $questionnaire->page->add_to_page('formarea', $questionnaire->renderer->box_end());
+ $page->add_to_page('formarea', '');
+ $page->add_to_page('formarea', $renderer->box_end());
- $questionnaire->page->add_to_page('formarea', ' ');
+ $page->add_to_page('formarea', ' ');
- $questionnaire->page->add_to_page('formarea', html_writer::end_tag('form'));
+ $page->add_to_page('formarea', html_writer::end_tag('form'));
// Include the needed js.
$module = ['name' => 'mod_questionnaire', 'fullpath' => '/mod/questionnaire/module.js'];
$PAGE->requires->js_init_call('M.mod_questionnaire.init_sendmessage', null, false, $module);
}
}
-$questionnaire->page->add_to_page('formarea', $questionnaire->renderer->box_end());
+$page->add_to_page('formarea', $renderer->box_end());
// Finish the page.
-echo $questionnaire->renderer->render($questionnaire->page);
-echo $questionnaire->renderer->footer();
+echo $renderer->render($page);
+echo $renderer->footer();
// Log this questionnaire show non-respondents action.
-$context = context_module::instance($questionnaire->cm->id);
-$anonymous = $questionnaire->respondenttype == 'anonymous';
+$anonymous = $questionnaire->respondenttype() == 'anonymous';
$event = \mod_questionnaire\event\non_respondents_viewed::create(
[
- 'objectid' => $questionnaire->id,
+ 'objectid' => $questionnaire->id(),
'anonymous' => $anonymous,
- 'context' => $context,
+ 'context' => $questionnaire->context(),
]
);
$event->trigger();
diff --git a/tabs.php b/tabs.php
deleted file mode 100644
index aa3fabcab..000000000
--- a/tabs.php
+++ /dev/null
@@ -1,331 +0,0 @@
-.
-
-/**
- * prints the tabbed bar
- *
- * @package mod_questionnaire
- * @copyright 2016 Mike Churchward (mike.churchward@poetgroup.org)
- * @author Mike Churchward
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-defined('MOODLE_INTERNAL') || die();
-
-global $DB, $SESSION;
-$tabs = [];
-$row = [];
-$inactive = [];
-$activated = [];
-if (!isset($SESSION->questionnaire)) {
- $SESSION->questionnaire = new stdClass();
-}
-$currenttab = $SESSION->questionnaire->current_tab;
-
-// In a questionnaire instance created "using" a PUBLIC questionnaire, prevent anyone from editing settings, editing questions,
-// viewing all responses...except in the course where that PUBLIC questionnaire was originally created.
-
-$owner = $questionnaire->is_survey_owner();
-if ($questionnaire->capabilities->manage && $owner) {
- $row[] = new tabobject(
- 'settings',
- $CFG->wwwroot . htmlspecialchars('/mod/questionnaire/qsettings.php?' . 'id=' . $questionnaire->cm->id),
- get_string('advancedsettings')
- );
-}
-
-if ($questionnaire->capabilities->editquestions && $owner) {
- $row[] = new tabobject(
- 'questions',
- $CFG->wwwroot . htmlspecialchars('/mod/questionnaire/questions.php?' . 'id=' . $questionnaire->cm->id),
- get_string('questions', 'questionnaire')
- );
-}
-
-if ($questionnaire->capabilities->editquestions && $owner) {
- $row[] = new tabobject(
- 'feedback',
- $CFG->wwwroot . htmlspecialchars('/mod/questionnaire/feedback.php?' . 'id=' . $questionnaire->cm->id),
- get_string('feedback')
- );
-}
-
-if ($questionnaire->capabilities->preview && $owner) {
- if (!empty($questionnaire->questions)) {
- $row[] = new tabobject(
- 'preview',
- $CFG->wwwroot . htmlspecialchars('/mod/questionnaire/preview.php?' . 'id=' . $questionnaire->cm->id),
- get_string('preview_label', 'questionnaire')
- );
- }
-}
-
-$usernumresp = $questionnaire->count_submissions($USER->id);
-
-if ($questionnaire->capabilities->readownresponses && ($usernumresp > 0)) {
- $argstr = 'instance=' . $questionnaire->id . '&user=' . $USER->id . '&group=' . $currentgroupid;
- if ($usernumresp == 1) {
- $argstr .= '&byresponse=1&action=vresp';
- $yourrespstring = get_string('yourresponse', 'questionnaire');
- } else {
- $yourrespstring = get_string('yourresponses', 'questionnaire');
- }
- $row[] = new tabobject(
- 'myreport',
- $CFG->wwwroot . htmlspecialchars('/mod/questionnaire/myreport.php?' . $argstr),
- $yourrespstring
- );
-
- if ($usernumresp > 1 && in_array($currenttab, ['mysummary', 'mybyresponse', 'myvall', 'mydownloadcsv'])) {
- $inactive[] = 'myreport';
- $activated[] = 'myreport';
- $row2 = [];
- $argstr2 = $argstr . '&action=summary';
- $row2[] = new tabobject(
- 'mysummary',
- $CFG->wwwroot . htmlspecialchars('/mod/questionnaire/myreport.php?' . $argstr2),
- get_string('summary', 'questionnaire')
- );
- $argstr2 = $argstr . '&byresponse=1&action=vresp';
- $row2[] = new tabobject(
- 'mybyresponse',
- $CFG->wwwroot . htmlspecialchars('/mod/questionnaire/myreport.php?' . $argstr2),
- get_string('viewindividualresponse', 'questionnaire')
- );
- $argstr2 = $argstr . '&byresponse=0&action=vall&group=' . $currentgroupid;
- $row2[] = new tabobject(
- 'myvall',
- $CFG->wwwroot . htmlspecialchars('/mod/questionnaire/myreport.php?' . $argstr2),
- get_string('myresponses', 'questionnaire')
- );
- if ($questionnaire->capabilities->downloadresponses) {
- $argstr2 = $argstr . '&action=dwnpg';
- $link = $CFG->wwwroot . htmlspecialchars('/mod/questionnaire/report.php?' . $argstr2);
- $row2[] = new tabobject('mydownloadcsv', $link, get_string('downloadtextformat', 'questionnaire'));
- }
- } else if (in_array($currenttab, ['mybyresponse', 'mysummary'])) {
- $inactive[] = 'myreport';
- $activated[] = 'myreport';
- }
-}
-
-$numresp = $questionnaire->count_submissions();
-// Number of responses in currently selected group (or all participants etc.).
-if (isset($SESSION->questionnaire->numselectedresps)) {
- $numselectedresps = $SESSION->questionnaire->numselectedresps;
-} else {
- $numselectedresps = $numresp;
-}
-
-// If questionnaire is set to separate groups, prevent user who is not member of any group
-// to view All responses.
-$canviewgroups = true;
-$groupmode = groups_get_activity_groupmode($cm, $course);
-if ($groupmode == 1) {
- $canviewgroups = groups_has_membership($cm, $USER->id);
-}
-$canviewallgroups = has_capability('moodle/site:accessallgroups', $context);
-$grouplogic = $canviewallgroups || $canviewgroups;
-$resplogic = ($numresp > 0) && ($numselectedresps > 0);
-
-if ($questionnaire->can_view_all_responses_anytime($grouplogic, $resplogic)) {
- $argstr = 'instance=' . $questionnaire->id;
- $row[] = new tabobject(
- 'allreport',
- $CFG->wwwroot . htmlspecialchars('/mod/questionnaire/report.php?' . $argstr . '&action=vall'),
- get_string('viewallresponses', 'questionnaire')
- );
- if (
- in_array(
- $currenttab,
- [
- 'vall',
- 'vresp',
- 'valldefault',
- 'vallasort',
- 'vallarsort',
- 'deleteall',
- 'downloadcsv',
- 'vrespsummary',
- 'individualresp',
- 'printresp',
- 'deleteresp',
- ]
- )
- ) {
- $inactive[] = 'allreport';
- $activated[] = 'allreport';
- if ($currenttab == 'vrespsummary' || $currenttab == 'valldefault') {
- $inactive[] = 'vresp';
- }
- $row2 = [];
- $argstr2 = $argstr . '&action=vall&group=' . $currentgroupid;
- $row2[] = new tabobject(
- 'vall',
- $CFG->wwwroot . htmlspecialchars('/mod/questionnaire/report.php?' . $argstr2),
- get_string('summary', 'questionnaire')
- );
- if ($questionnaire->capabilities->viewsingleresponse) {
- $argstr2 = $argstr . '&byresponse=1&action=vresp&group=' . $currentgroupid;
- $row2[] = new tabobject(
- 'vrespsummary',
- $CFG->wwwroot . htmlspecialchars('/mod/questionnaire/report.php?' . $argstr2),
- get_string('viewbyresponse', 'questionnaire')
- );
- if ($currenttab == 'individualresp' || $currenttab == 'deleteresp') {
- $argstr2 = $argstr . '&byresponse=1&action=vresp';
- $row2[] = new tabobject(
- 'vresp',
- $CFG->wwwroot . htmlspecialchars('/mod/questionnaire/report.php?' . $argstr2),
- get_string('viewindividualresponse', 'questionnaire')
- );
- }
- }
- }
- if (in_array($currenttab, ['valldefault', 'vallasort', 'vallarsort', 'deleteall', 'downloadcsv'])) {
- $activated[] = 'vall';
- $row3 = [];
-
- $argstr2 = $argstr . '&action=vall&group=' . $currentgroupid;
- $row3[] = new tabobject(
- 'valldefault',
- $CFG->wwwroot . htmlspecialchars('/mod/questionnaire/report.php?' . $argstr2),
- get_string('order_default', 'questionnaire')
- );
- if ($currenttab != 'downloadcsv' && $currenttab != 'deleteall') {
- $argstr2 = $argstr . '&action=vallasort&group=' . $currentgroupid;
- $row3[] = new tabobject(
- 'vallasort',
- $CFG->wwwroot . htmlspecialchars('/mod/questionnaire/report.php?' . $argstr2),
- get_string('order_ascending', 'questionnaire')
- );
- $argstr2 = $argstr . '&action=vallarsort&group=' . $currentgroupid;
- $row3[] = new tabobject(
- 'vallarsort',
- $CFG->wwwroot . htmlspecialchars('/mod/questionnaire/report.php?' . $argstr2),
- get_string('order_descending', 'questionnaire')
- );
- }
- if ($questionnaire->capabilities->deleteresponses) {
- $argstr2 = $argstr . '&action=delallresp&group=' . $currentgroupid;
- $row3[] = new tabobject(
- 'deleteall',
- $CFG->wwwroot . htmlspecialchars('/mod/questionnaire/report.php?' . $argstr2),
- get_string('deleteallresponses', 'questionnaire')
- );
- }
-
- if ($questionnaire->capabilities->downloadresponses) {
- $argstr2 = $argstr . '&action=dwnpg&group=' . $currentgroupid;
- $link = $CFG->wwwroot . htmlspecialchars('/mod/questionnaire/report.php?' . $argstr2);
- $row3[] = new tabobject('downloadcsv', $link, get_string('downloadtextformat', 'questionnaire'));
- }
- }
-
- if (in_array($currenttab, ['individualresp', 'deleteresp'])) {
- $inactive[] = 'vresp';
- if ($currenttab != 'deleteresp') {
- $activated[] = 'vresp';
- }
- if ($questionnaire->capabilities->deleteresponses) {
- $argstr2 = $argstr . '&action=dresp&rid=' . $rid . '&individualresponse=1';
- $row2[] = new tabobject(
- 'deleteresp',
- $CFG->wwwroot . htmlspecialchars('/mod/questionnaire/report.php?' . $argstr2),
- get_string('deleteresp', 'questionnaire')
- );
- }
- }
-} else if ($questionnaire->can_view_all_responses_with_restrictions($usernumresp, $grouplogic, $resplogic)) {
- $argstr = 'instance=' . $questionnaire->id . '&sid=' . $questionnaire->sid;
- $row[] = new tabobject(
- 'allreport',
- $CFG->wwwroot . htmlspecialchars('/mod/questionnaire/report.php?' . $argstr . '&action=vall&group=' . $currentgroupid),
- get_string('viewallresponses', 'questionnaire')
- );
- if (in_array($currenttab, ['valldefault', 'vallasort', 'vallarsort', 'deleteall', 'downloadcsv'])) {
- $inactive[] = 'vall';
- $activated[] = 'vall';
- $row2 = [];
- $argstr2 = $argstr . '&action=vall&group=' . $currentgroupid;
- $row2[] = new tabobject(
- 'valldefault',
- $CFG->wwwroot . htmlspecialchars('/mod/questionnaire/report.php?' . $argstr2),
- get_string('summary', 'questionnaire')
- );
- $inactive[] = $currenttab;
- $activated[] = $currenttab;
- $row3 = [];
- $argstr2 = $argstr . '&action=vall&group=' . $currentgroupid;
- $row3[] = new tabobject(
- 'valldefault',
- $CFG->wwwroot . htmlspecialchars('/mod/questionnaire/report.php?' . $argstr2),
- get_string('order_default', 'questionnaire')
- );
- $argstr2 = $argstr . '&action=vallasort&group=' . $currentgroupid;
- $row3[] = new tabobject(
- 'vallasort',
- $CFG->wwwroot . htmlspecialchars('/mod/questionnaire/report.php?' . $argstr2),
- get_string('order_ascending', 'questionnaire')
- );
- $argstr2 = $argstr . '&action=vallarsort&group=' . $currentgroupid;
- $row3[] = new tabobject(
- 'vallarsort',
- $CFG->wwwroot . htmlspecialchars('/mod/questionnaire/report.php?' . $argstr2),
- get_string('order_descending', 'questionnaire')
- );
- if ($questionnaire->capabilities->deleteresponses) {
- $argstr2 = $argstr . '&action=delallresp';
- $row2[] = new tabobject(
- 'deleteall',
- $CFG->wwwroot . htmlspecialchars('/mod/questionnaire/report.php?' . $argstr2),
- get_string('deleteallresponses', 'questionnaire')
- );
- }
-
- if ($questionnaire->capabilities->downloadresponses) {
- $argstr2 = $argstr . '&action=dwnpg';
- $link = htmlspecialchars('/mod/questionnaire/report.php?' . $argstr2);
- $row2[] = new tabobject('downloadcsv', $link, get_string('downloadtextformat', 'questionnaire'));
- }
- if (count($row2) <= 1) {
- $currenttab = 'allreport';
- }
- }
-}
-
-if ($questionnaire->capabilities->viewsingleresponse && ($canviewallgroups || $canviewgroups)) {
- $nonrespondenturl = new moodle_url('/mod/questionnaire/show_nonrespondents.php', ['id' => $questionnaire->cm->id]);
- $row[] = new tabobject(
- 'nonrespondents',
- $nonrespondenturl->out(),
- get_string('show_nonrespondents', 'questionnaire')
- );
-}
-
-if ((count($row) > 1) || (!empty($row2) && (count($row2) > 1))) {
- $tabs[] = $row;
-
- if (!empty($row2) && (count($row2) > 1)) {
- $tabs[] = $row2;
- }
-
- if (!empty($row3) && (count($row3) > 1)) {
- $tabs[] = $row3;
- }
-
- $questionnaire->page->add_to_page('tabsarea', print_tabs($tabs, $currenttab, $inactive, $activated, true));
-}
diff --git a/templates/dependencylist.mustache b/templates/dependencylist.mustache
new file mode 100644
index 000000000..35adb7bf9
--- /dev/null
+++ b/templates/dependencylist.mustache
@@ -0,0 +1,41 @@
+{{!
+ This file is part of Moodle - http://moodle.org/
+
+ Moodle is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ Moodle is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with Moodle. If not, see {{dependquestion}} : {{position}} {{parentposition}} ({{parent}}) {{logicstr}}
+{{/dependencies}}
diff --git a/tests/behat/add_questions.feature b/tests/behat/add_questions.feature
index 4f020693b..8ff595b4b 100644
--- a/tests/behat/add_questions.feature
+++ b/tests/behat/add_questions.feature
@@ -97,7 +97,7 @@ Feature: Add questions to a questionnaire activity
| Question Text | Choose yes or no |
Then I should see "[Yes/No] (Q9)"
And I should see "Choose yes or no"
- And I set the field "id_type_id" to "----- Page Break -----"
+ And I set the field "id_typeid" to "----- Page Break -----"
And I press "Add selected question type"
And I add a "File" question and I fill the form with:
| Question Name | Q10 |
diff --git a/tests/behat/behat_mod_questionnaire.php b/tests/behat/behat_mod_questionnaire.php
index a0d42e20b..87612c530 100644
--- a/tests/behat/behat_mod_questionnaire.php
+++ b/tests/behat/behat_mod_questionnaire.php
@@ -33,7 +33,6 @@
Behat\Gherkin\Node\PyStringNode,
Behat\Mink\Exception\ExpectationException;
-#[\AllowDynamicProperties]
/**
* Questionnaire-related steps definitions.
*
@@ -43,6 +42,13 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class behat_mod_questionnaire extends behat_base {
+ /** @var array Maps old question IDs to new IDs when importing test data. */
+ public $questionmap = [];
+ /** @var array Maps old choice IDs to new IDs when importing test data. */
+ public $choicemap = [];
+ /** @var array Maps old response IDs to new IDs when importing test data. */
+ public $responsemap = [];
+
/**
* Convert page names to URLs for steps like 'When I am on the "[page name]" page'.
*
@@ -164,7 +170,7 @@ public function i_add_a_question_and_i_fill_the_form_with($questiontype, TableNo
$fielddata = new TableNode($rows);
}
- $this->execute('behat_forms::i_set_the_field_to', ['id_type_id', $questiontype]);
+ $this->execute('behat_forms::i_set_the_field_to', ['id_typeid', $questiontype]);
$this->execute('behat_forms::press_button', 'Add selected question type');
if (isset($hashrows['id_dependquestions_and_1'])) {
$this->execute('behat_forms::press_button', 'id_adddependencies_and');
@@ -240,7 +246,7 @@ private function add_question_data($sid) {
"id",
"surveyid",
"name",
- "type_id",
+ "typeid",
"result_id",
"length",
"precise",
@@ -312,7 +318,7 @@ private function add_question_data($sid) {
];
$choicedata = [
- ["id", "question_id", "content", "value"],
+ ["id", "questionid", "content", "value"],
["1", "7", "1", null],
["2", "7", "2", null],
["3", "7", "3", null],
@@ -338,7 +344,7 @@ private function add_question_data($sid) {
];
$this->add_data($questiondata, 'questionnaire_question', 'questionmap');
- $this->add_data($choicedata, 'questionnaire_quest_choice', 'choicemap', ['questionmap' => 'question_id']);
+ $this->add_data($choicedata, 'questionnaire_quest_choice', 'choicemap', ['questionmap' => 'questionid']);
}
/**
@@ -364,7 +370,7 @@ private function add_response_data($qid, $sid) {
$this->add_data($responses, 'questionnaire_response', 'responsemap');
$responsebool = [
- ["id", "response_id", "question_id", "choice_id"],
+ ["id", "responseid", "questionid", "choiceid"],
["", "1", "1", "y"],
["", "1", "4", "n"],
["", "2", "1", "y"],
@@ -384,11 +390,11 @@ private function add_response_data($qid, $sid) {
$responsebool,
'questionnaire_response_bool',
'',
- ['responsemap' => 'response_id', 'questionmap' => 'question_id']
+ ['responsemap' => 'responseid', 'questionmap' => 'questionid']
);
$responsedate = [
- ["id", "response_id", "question_id", "response"],
+ ["id", "responseid", "questionid", "response"],
["", "1", "8", "2014-12-19"],
["", "2", "8", "2015-12-02"],
["", "3", "8", "2015-12-04"],
@@ -400,11 +406,11 @@ private function add_response_data($qid, $sid) {
$responsedate,
'questionnaire_response_date',
'',
- ['responsemap' => 'response_id', 'questionmap' => 'question_id']
+ ['responsemap' => 'responseid', 'questionmap' => 'questionid']
);
$responseother = [
- ["id", "response_id", "question_id", "choice_id", "response"],
+ ["id", "responseid", "questionid", "choiceid", "response"],
["", "5", "7", "21", "Forty-four"],
["", "6", "12", "22", "Green"],
["", "7", "7", "21", "5"],
@@ -413,11 +419,11 @@ private function add_response_data($qid, $sid) {
$responseother,
'questionnaire_response_other',
'',
- ['responsemap' => 'response_id', 'questionmap' => 'question_id', 'choicemap' => 'choice_id']
+ ['responsemap' => 'responseid', 'questionmap' => 'questionid', 'choicemap' => 'choiceid']
);
$responserank = [
- ["id", "response_id", "question_id", "choice_id", "rankvalue"],
+ ["id", "responseid", "questionid", "choiceid", "rankvalue"],
["", "1", "13", "16", "0"],
["", "1", "13", "17", "1"],
["", "1", "13", "18", "2"],
@@ -458,11 +464,11 @@ private function add_response_data($qid, $sid) {
$responserank,
'questionnaire_response_rank',
'',
- ['responsemap' => 'response_id', 'questionmap' => 'question_id', 'choicemap' => 'choice_id']
+ ['responsemap' => 'responseid', 'questionmap' => 'questionid', 'choicemap' => 'choiceid']
);
$respmultiple = [
- ["id", "response_id", "question_id", "choice_id"],
+ ["id", "responseid", "questionid", "choiceid"],
["", "1", "7", "1"],
["", "1", "7", "3"],
["", "1", "7", "5"],
@@ -483,11 +489,11 @@ private function add_response_data($qid, $sid) {
$respmultiple,
'questionnaire_resp_multiple',
'',
- ['responsemap' => 'response_id', 'questionmap' => 'question_id', 'choicemap' => 'choice_id']
+ ['responsemap' => 'responseid', 'questionmap' => 'questionid', 'choicemap' => 'choiceid']
);
$respsingle = [
- ["id", "response_id", "question_id", "choice_id"],
+ ["id", "responseid", "questionid", "choiceid"],
["", "1", "9", "7"],
["", "1", "12", "15"],
["", "2", "9", "7"],
@@ -505,7 +511,7 @@ private function add_response_data($qid, $sid) {
$respsingle,
'questionnaire_resp_single',
'',
- ['responsemap' => 'response_id', 'questionmap' => 'question_id', 'choicemap' => 'choice_id']
+ ['responsemap' => 'responseid', 'questionmap' => 'questionid', 'choicemap' => 'choiceid']
);
}
diff --git a/tests/behat/check_responses_capabilities.feature b/tests/behat/check_responses_capabilities.feature
index 348d88708..c99088d02 100644
--- a/tests/behat/check_responses_capabilities.feature
+++ b/tests/behat/check_responses_capabilities.feature
@@ -84,7 +84,7 @@ Feature: Review responses with different capabilities
| mod/questionnaire:readallresponseanytime | Prohibit |
| mod/questionnaire:readallresponses | Allow |
And the following "activities" exist:
- | activity | name | description | course | idnumber | resp_view |
+ | activity | name | description | course | idnumber | respview |
| questionnaire | Test questionnaire | Test questionnaire description | C1 | questionnaire0 | 0 |
| questionnaire | Test questionnaire 2 | Test questionnaire 2 description | C1 | questionnaire2 | 3 |
And "Test questionnaire" has questions and responses
diff --git a/tests/behat/dependency_question.feature b/tests/behat/dependency_question.feature
index a35213892..09aecf13f 100644
--- a/tests/behat/dependency_question.feature
+++ b/tests/behat/dependency_question.feature
@@ -74,7 +74,7 @@ Feature: Questions can be defined to be dependent on answers to multiple previou
And I am on "Course 1" course homepage
And I follow "Test questionnaire 2"
And I navigate to "Questions" in current page administration
- And I set the field "id_type_id" to "Dropdown Box"
+ And I set the field "id_typeid" to "Dropdown Box"
And I press "Add selected question type"
And I set the field "Question Name" to "Q1"
And I set the field "No" to "n"
diff --git a/tests/capabilities_test.php b/tests/capabilities_test.php
new file mode 100644
index 000000000..14f12be04
--- /dev/null
+++ b/tests/capabilities_test.php
@@ -0,0 +1,452 @@
+.
+
+/**
+ * Unit tests for the mod_questionnaire capabilities helper.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 onward Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire;
+
+use mod_questionnaire\local\db\questionnaire_record;
+use mod_questionnaire\local\db\survey_record;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+require_once($CFG->dirroot . '/mod/questionnaire/lib.php');
+require_once($CFG->dirroot . '/mod/questionnaire/tests/questionnaire_testable.php');
+
+/**
+ * Unit tests for {@see capabilities}.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\capabilities
+ */
+final class capabilities_test extends \advanced_testcase {
+ /**
+ * Build a questionnaire_record persistent populated from an in-memory object (no DB read).
+ *
+ * @param array $fields
+ * @return questionnaire_record
+ */
+ private function make_module_record(array $fields = []): questionnaire_record {
+ return new questionnaire_record(0, (object)array_merge([
+ 'id' => 1,
+ 'course' => 1,
+ 'name' => 'Test questionnaire',
+ 'intro' => '',
+ 'introformat' => FORMAT_HTML,
+ 'qtype' => questionnaire::QTYPE_UNLIMITED,
+ 'respondenttype' => 'fullname',
+ 'respeligible' => 'all',
+ 'respview' => questionnaire::RESPVIEW_NEVER,
+ 'notifications' => 0,
+ 'opendate' => 0,
+ 'closedate' => 0,
+ 'resume' => 0,
+ 'navigate' => 0,
+ 'grade' => 0,
+ 'sid' => 1,
+ 'timemodified' => 0,
+ 'completionsubmit' => 0,
+ 'autonum' => 3,
+ 'progressbar' => 0,
+ 'removeafter' => 0,
+ ], $fields));
+ }
+
+ /**
+ * Build a survey_record persistent from an in-memory object (no DB read).
+ *
+ * @param array $fields
+ * @return survey_record
+ */
+ private function make_survey_record(array $fields = []): survey_record {
+ return new survey_record(0, (object)array_merge([
+ 'id' => 1,
+ 'name' => 'Test survey',
+ 'courseid' => 1,
+ 'realm' => 'private',
+ 'status' => 0,
+ 'title' => '',
+ 'email' => null,
+ 'subtitle' => null,
+ 'info' => null,
+ 'theme' => null,
+ 'thankspage' => null,
+ 'thankhead' => null,
+ 'thankbody' => null,
+ 'feedbacksections' => 0,
+ 'feedbacknotes' => null,
+ 'feedbackscores' => 0,
+ 'charttype' => null,
+ ], $fields));
+ }
+
+ /**
+ * Return a questionnaire_testable with optional field overrides.
+ *
+ * @param array $modulefields Overrides for questionnaire_record.
+ * @param array $surveyfields Overrides for survey_record.
+ * @return questionnaire_testable
+ */
+ private function make_questionnaire(array $modulefields = [], array $surveyfields = []): questionnaire_testable {
+ if (!array_key_exists('id', $surveyfields)) {
+ $surveyfields['id'] = $modulefields['sid'] ?? 1;
+ }
+ return new questionnaire_testable(
+ $this->make_module_record($modulefields),
+ $this->make_survey_record($surveyfields)
+ );
+ }
+
+ // Tests for user_time_for_new_attempt().
+
+ /**
+ * Asserts user_time_for_new_attempt() always returns true for unlimited questionnaires.
+ */
+ public function test_user_time_unlimited_always_allowed(): void {
+ $q = $this->make_questionnaire(['qtype' => questionnaire::QTYPE_UNLIMITED]);
+ $this->assertTrue($q->capabilities()->user_time_for_new_attempt(1));
+ }
+
+ /**
+ * Asserts user_time_for_new_attempt() returns true when no prior responses exist.
+ */
+ public function test_user_time_with_no_previous_responses(): void {
+ $this->resetAfterTest();
+ $q = $this->make_questionnaire(['id' => 88881, 'qtype' => questionnaire::QTYPE_ONCE]);
+ $this->assertTrue($q->capabilities()->user_time_for_new_attempt(1));
+ }
+
+ /**
+ * Asserts user_time_for_new_attempt() returns false for ONCE when a prior response exists.
+ */
+ public function test_user_time_once_blocked_by_existing_response(): void {
+ global $DB;
+ $this->resetAfterTest();
+
+ $qid = 88882;
+ $q = $this->make_questionnaire(['id' => $qid, 'qtype' => questionnaire::QTYPE_ONCE]);
+ $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $qid, 'userid' => 1,
+ 'submitted' => time() - 3600, 'complete' => 'y', 'grade' => 0,
+ ]);
+
+ $this->assertFalse($q->capabilities()->user_time_for_new_attempt(1));
+ }
+
+ /**
+ * Asserts user_time_for_new_attempt() returns false for DAILY when a same-day response exists.
+ */
+ public function test_user_time_daily_blocked_same_day(): void {
+ global $DB;
+ $this->resetAfterTest();
+
+ $qid = 88883;
+ $q = $this->make_questionnaire(['id' => $qid, 'qtype' => questionnaire::QTYPE_DAILY]);
+ $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $qid, 'userid' => 1,
+ 'submitted' => mktime(0, 0, 0, (int)date('n'), (int)date('j'), (int)date('Y')),
+ 'complete' => 'y', 'grade' => 0,
+ ]);
+
+ $this->assertFalse($q->capabilities()->user_time_for_new_attempt(1));
+ }
+
+ /**
+ * Asserts user_time_for_new_attempt() returns true for DAILY when the prior response is from a previous day.
+ */
+ public function test_user_time_daily_allowed_previous_day(): void {
+ global $DB;
+ $this->resetAfterTest();
+
+ $qid = 88884;
+ $q = $this->make_questionnaire(['id' => $qid, 'qtype' => questionnaire::QTYPE_DAILY]);
+ $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $qid, 'userid' => 1,
+ 'submitted' => mktime(0, 0, 0, date('n'), date('j') - 1, date('Y')),
+ 'complete' => 'y', 'grade' => 0,
+ ]);
+
+ $this->assertTrue($q->capabilities()->user_time_for_new_attempt(1));
+ }
+
+ /**
+ * Asserts user_time_for_new_attempt() returns false for WEEKLY when a same-week response exists.
+ */
+ public function test_user_time_weekly_blocked_same_week(): void {
+ global $DB;
+ $this->resetAfterTest();
+
+ $qid = 88885;
+ $q = $this->make_questionnaire(['id' => $qid, 'qtype' => questionnaire::QTYPE_WEEKLY]);
+ $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $qid, 'userid' => 1,
+ 'submitted' => time() - DAYSECS, 'complete' => 'y', 'grade' => 0,
+ ]);
+
+ // Blocked because the attempt was in the same ISO week.
+ if (date('W', time() - DAYSECS) === date('W', time())) {
+ $this->assertFalse($q->capabilities()->user_time_for_new_attempt(1));
+ } else {
+ $this->markTestSkipped('Response crossed a week boundary during test execution.');
+ }
+ }
+
+ /**
+ * Asserts user_time_for_new_attempt() returns false for MONTHLY when a same-month response exists.
+ */
+ public function test_user_time_monthly_blocked_same_month(): void {
+ global $DB;
+ $this->resetAfterTest();
+
+ $qid = 88886;
+ $q = $this->make_questionnaire(['id' => $qid, 'qtype' => questionnaire::QTYPE_MONTHLY]);
+ $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $qid, 'userid' => 1,
+ 'submitted' => mktime(0, 0, 0, date('n'), 1, date('Y')),
+ 'complete' => 'y', 'grade' => 0,
+ ]);
+
+ $this->assertFalse($q->capabilities()->user_time_for_new_attempt(1));
+ }
+
+ /**
+ * Asserts user_time_for_new_attempt() returns true for MONTHLY when the prior response is from a previous month.
+ */
+ public function test_user_time_monthly_allowed_previous_month(): void {
+ global $DB;
+ $this->resetAfterTest();
+
+ $qid = 88887;
+ $q = $this->make_questionnaire(['id' => $qid, 'qtype' => questionnaire::QTYPE_MONTHLY]);
+ $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $qid, 'userid' => 1,
+ 'submitted' => mktime(0, 0, 0, date('n') - 1, 1, date('Y')),
+ 'complete' => 'y', 'grade' => 0,
+ ]);
+
+ $this->assertTrue($q->capabilities()->user_time_for_new_attempt(1));
+ }
+
+ // Tests for capability methods (require a real course module and context).
+
+ /**
+ * Asserts can_manage_questionnaire() returns true for an editing teacher and false for a student.
+ */
+ public function test_can_manage_questionnaire_teacher_vs_student(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $instance = $generator->get_plugin_generator('mod_questionnaire')->create_instance(['course' => $course->id]);
+
+ $teacher = $generator->create_user();
+ $student = $generator->create_user();
+ $teacherrole = $DB->get_record('role', ['shortname' => 'editingteacher'], '*', MUST_EXIST);
+ $studentrole = $DB->get_record('role', ['shortname' => 'student'], '*', MUST_EXIST);
+ $generator->enrol_user($teacher->id, $course->id, $teacherrole->id);
+ $generator->enrol_user($student->id, $course->id, $studentrole->id);
+
+ $this->assertTrue($instance->capabilities()->can_manage_questionnaire($teacher->id));
+ $this->assertFalse($instance->capabilities()->can_manage_questionnaire($student->id));
+ }
+
+ /**
+ * Asserts can_edit_questions() returns true for an editing teacher and false for a student.
+ */
+ public function test_can_edit_questions_teacher_vs_student(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $instance = $generator->get_plugin_generator('mod_questionnaire')->create_instance(['course' => $course->id]);
+
+ $teacher = $generator->create_user();
+ $student = $generator->create_user();
+ $teacherrole = $DB->get_record('role', ['shortname' => 'editingteacher'], '*', MUST_EXIST);
+ $studentrole = $DB->get_record('role', ['shortname' => 'student'], '*', MUST_EXIST);
+ $generator->enrol_user($teacher->id, $course->id, $teacherrole->id);
+ $generator->enrol_user($student->id, $course->id, $studentrole->id);
+
+ $this->assertTrue($instance->capabilities()->can_edit_questions($teacher->id));
+ $this->assertFalse($instance->capabilities()->can_edit_questions($student->id));
+ }
+
+ /**
+ * Asserts can_view() returns true for the current user when set to a student.
+ */
+ public function test_can_view_returns_true_for_enrolled_user(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $instance = $generator->get_plugin_generator('mod_questionnaire')->create_instance(['course' => $course->id]);
+
+ $student = $generator->create_user();
+ $studentrole = $DB->get_record('role', ['shortname' => 'student'], '*', MUST_EXIST);
+ $generator->enrol_user($student->id, $course->id, $studentrole->id);
+
+ $this->setUser($student);
+ $this->assertTrue($instance->capabilities()->can_view());
+ }
+
+ /**
+ * Asserts can_preview() returns true for a teacher and false for a student.
+ */
+ public function test_can_preview_teacher_vs_student(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $instance = $generator->get_plugin_generator('mod_questionnaire')->create_instance(['course' => $course->id]);
+
+ $teacher = $generator->create_user();
+ $student = $generator->create_user();
+ $teacherrole = $DB->get_record('role', ['shortname' => 'teacher'], '*', MUST_EXIST);
+ $studentrole = $DB->get_record('role', ['shortname' => 'student'], '*', MUST_EXIST);
+ $generator->enrol_user($teacher->id, $course->id, $teacherrole->id);
+ $generator->enrol_user($student->id, $course->id, $studentrole->id);
+
+ $this->setUser($teacher);
+ $this->assertTrue($instance->capabilities()->can_preview());
+ $this->setUser($student);
+ $this->assertFalse($instance->capabilities()->can_preview());
+ }
+
+ /**
+ * Asserts user_is_eligible() returns true for an enrolled student and false for a guest.
+ */
+ public function test_user_is_eligible_enrolled_vs_unenrolled(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $instance = $generator->get_plugin_generator('mod_questionnaire')->create_instance(['course' => $course->id]);
+
+ $student = $generator->create_user();
+ $guest = $generator->create_user();
+ $studentrole = $DB->get_record('role', ['shortname' => 'student'], '*', MUST_EXIST);
+ $generator->enrol_user($student->id, $course->id, $studentrole->id);
+
+ $this->assertTrue($instance->capabilities()->user_is_eligible($student->id));
+ $this->assertFalse($instance->capabilities()->user_is_eligible($guest->id));
+ }
+
+ /**
+ * Asserts can_read_own_responses() returns true for a student (default role capability).
+ */
+ public function test_can_read_own_responses_for_enrolled_student(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $instance = $generator->get_plugin_generator('mod_questionnaire')->create_instance(['course' => $course->id]);
+
+ $student = $generator->create_user();
+ $studentrole = $DB->get_record('role', ['shortname' => 'student'], '*', MUST_EXIST);
+ $generator->enrol_user($student->id, $course->id, $studentrole->id);
+
+ $this->assertTrue($instance->capabilities()->can_read_own_responses($student->id));
+ }
+
+ /**
+ * Asserts can_delete_responses() returns true for an editing teacher and false for a student.
+ */
+ public function test_can_delete_responses_teacher_vs_student(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $instance = $generator->get_plugin_generator('mod_questionnaire')->create_instance(['course' => $course->id]);
+
+ $teacher = $generator->create_user();
+ $student = $generator->create_user();
+ $teacherrole = $DB->get_record('role', ['shortname' => 'editingteacher'], '*', MUST_EXIST);
+ $studentrole = $DB->get_record('role', ['shortname' => 'student'], '*', MUST_EXIST);
+ $generator->enrol_user($teacher->id, $course->id, $teacherrole->id);
+ $generator->enrol_user($student->id, $course->id, $studentrole->id);
+
+ $this->assertTrue($instance->capabilities()->can_delete_responses($teacher->id));
+ $this->assertFalse($instance->capabilities()->can_delete_responses($student->id));
+ }
+
+ /**
+ * Asserts can_download_responses() returns true for a teacher and false for a student.
+ */
+ public function test_can_download_responses_teacher_vs_student(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $instance = $generator->get_plugin_generator('mod_questionnaire')->create_instance(['course' => $course->id]);
+
+ $teacher = $generator->create_user();
+ $student = $generator->create_user();
+ $teacherrole = $DB->get_record('role', ['shortname' => 'teacher'], '*', MUST_EXIST);
+ $studentrole = $DB->get_record('role', ['shortname' => 'student'], '*', MUST_EXIST);
+ $generator->enrol_user($teacher->id, $course->id, $teacherrole->id);
+ $generator->enrol_user($student->id, $course->id, $studentrole->id);
+
+ $this->assertTrue($instance->capabilities()->can_download_responses($teacher->id));
+ $this->assertFalse($instance->capabilities()->can_download_responses($student->id));
+ }
+
+ /**
+ * Asserts can_view_single_response() returns true for a teacher and false for a student.
+ */
+ public function test_can_view_single_response_teacher_vs_student(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $instance = $generator->get_plugin_generator('mod_questionnaire')->create_instance(['course' => $course->id]);
+
+ $teacher = $generator->create_user();
+ $student = $generator->create_user();
+ $teacherrole = $DB->get_record('role', ['shortname' => 'teacher'], '*', MUST_EXIST);
+ $studentrole = $DB->get_record('role', ['shortname' => 'student'], '*', MUST_EXIST);
+ $generator->enrol_user($teacher->id, $course->id, $teacherrole->id);
+ $generator->enrol_user($student->id, $course->id, $studentrole->id);
+
+ $this->assertTrue($instance->capabilities()->can_view_single_response($teacher->id));
+ $this->assertFalse($instance->capabilities()->can_view_single_response($student->id));
+ }
+}
diff --git a/tests/csvexport_test.php b/tests/csvexport_test.php
index 714f3da99..1fbfc9f88 100644
--- a/tests/csvexport_test.php
+++ b/tests/csvexport_test.php
@@ -28,6 +28,7 @@
/**
* Unit tests for questionnaire_csvexport_test.
* @group mod_questionnaire
+ * @covers \mod_questionnaire\reporter::generate_csv
*/
final class csvexport_test extends \advanced_testcase {
public function setUp(): void {
@@ -60,8 +61,6 @@ private function get_csv_text(array $rows) {
/**
* Tests the CSV export.
- *
- * @covers \questionnaire::generate_csv
*/
public function test_csvexport(): void {
$this->resetAfterTest();
@@ -69,21 +68,17 @@ public function test_csvexport(): void {
$qdg = $dg->get_plugin_generator('mod_questionnaire');
$qdg->create_and_fully_populate(1, 5, 1, 1);
- // The following line simply.
$questionnaires = $qdg->questionnaires();
foreach ($questionnaires as $questionnaire) {
- [$course, $cm] = get_course_and_cm_from_instance($questionnaire->id, 'questionnaire', $questionnaire->course);
- $questionnaireinst = new \questionnaire($course, $cm, 0, $questionnaire);
-
// Test for only complete responses.
- $newoutput = $this->get_csv_text($questionnaireinst->generate_csv(0, '', '', 0, 0, 0));
+ $newoutput = $this->get_csv_text($questionnaire->reporter()->generate_csv(0, '', '', 0, 0, 0));
$this->assertEquals(count($newoutput), count($this->expected_complete_output()));
foreach ($newoutput as $key => $output) {
$this->assertEquals($this->expected_complete_output()[$key], $output);
}
// Test for all responses.
- $newoutput = $this->get_csv_text($questionnaireinst->generate_csv(0, '', '', 0, 0, 1));
+ $newoutput = $this->get_csv_text($questionnaire->reporter()->generate_csv(0, '', '', 0, 0, 1));
$this->assertEquals(count($newoutput), count($this->expected_incomplete_output()));
foreach ($newoutput as $key => $output) {
$this->assertEquals($this->expected_incomplete_output()[$key], $output);
@@ -93,8 +88,6 @@ public function test_csvexport(): void {
/**
* Tests the CSV export with identity fields and anonymous questionnaires.
- *
- * @covers \questionnaire::generate_csv
*/
public function test_csvexport_identity_fields(): void {
global $DB;
@@ -116,7 +109,7 @@ public function test_csvexport_identity_fields(): void {
$questionnaires = $qdg->questionnaires();
foreach ($questionnaires as $item) {
- [$course, $cm] = get_course_and_cm_from_instance($item->id, 'questionnaire', $item->course);
+ [$course, $cm] = get_course_and_cm_from_instance($item->id(), 'questionnaire', $item->courseid());
$this->do_test_csvexport_identity_fields($course, $cm, $user, $roleid, $profilefields, $item, false);
$this->do_test_csvexport_identity_fields($course, $cm, $user, $roleid, $profilefields, $item, true);
@@ -131,11 +124,8 @@ public function test_csvexport_identity_fields(): void {
* @param object $user
* @param int $roleid
* @param array $profilefields
- * @param object $item
+ * @param \mod_questionnaire\questionnaire $item
* @param bool $anonymous
- * @throws coding_exception
- * @throws dml_exception
- * @throws moodle_exception
*/
private function do_test_csvexport_identity_fields($course, $cm, $user, $roleid, $profilefields, $item, $anonymous): void {
global $DB;
@@ -143,7 +133,7 @@ private function do_test_csvexport_identity_fields($course, $cm, $user, $roleid,
if ($anonymous) {
// Make questionnaire anonymous.
$row = new \stdClass();
- $row->id = $item->id;
+ $row->id = $item->id();
$row->respondenttype = 'anonymous';
$DB->update_record('questionnaire', $row);
}
@@ -153,8 +143,8 @@ private function do_test_csvexport_identity_fields($course, $cm, $user, $roleid,
assign_capability('moodle/site:viewuseridentity', CAP_ALLOW, $roleid, $context);
// Generate CSV output.
- $questionnaire = new \questionnaire($course, $cm, $item->id);
- $output = $questionnaire->generate_csv(0, '', '', 0, 0, 1);
+ $questionnaire = \mod_questionnaire\questionnaire::from_cmid($cm->id);
+ $output = $questionnaire->reporter()->generate_csv(0, '', '', 0, 0, 1);
$this->assertNotNull($output);
$this->assertCount(3, $output);
diff --git a/tests/custom_completion_test.php b/tests/custom_completion_test.php
index 6d8a5b9f9..374a976a4 100644
--- a/tests/custom_completion_test.php
+++ b/tests/custom_completion_test.php
@@ -35,7 +35,7 @@
global $CFG;
require_once($CFG->libdir . '/completionlib.php');
-require_once($CFG->dirroot . '/mod/questionnaire/classes/question/question.php');
+require_once($CFG->dirroot . '/mod/questionnaire/classes/local/question/question.php');
/**
* Class for unit testing mod_questionnaire/custom_completion.
@@ -94,8 +94,8 @@ public function test_get_state(string $rule, int $available, ?bool $submitted, ?
$questionnaire = $generator->create_instance(['course' => $course->id, 'completion' => COMPLETION_TRACKING_AUTOMATIC,
$rule => $available]);
- $questiondata['type_id'] = 1;
- $questiondata['surveyid'] = $questionnaire->sid;
+ $questiondata['typeid'] = 1;
+ $questiondata['surveyid'] = $questionnaire->surveyid();
$questiondata['name'] = 'Q1';
$questiondata['content'] = 'Test content';
$question = $generator->create_question($questionnaire, $questiondata);
@@ -106,7 +106,7 @@ public function test_get_state(string $rule, int $available, ?bool $submitted, ?
}
$this->setUser($student);
- $cm = get_coursemodule_from_instance('questionnaire', $questionnaire->id);
+ $cm = get_coursemodule_from_instance('questionnaire', $questionnaire->id());
$cm = cm_info::create($cm);
$customcompletion = new custom_completion($cm, (int)$student->id);
diff --git a/tests/deletion_question_test.php b/tests/deletion_question_test.php
index 3ea41c7fd..c1d9f2bee 100644
--- a/tests/deletion_question_test.php
+++ b/tests/deletion_question_test.php
@@ -27,9 +27,7 @@
defined('MOODLE_INTERNAL') || die();
global $CFG;
-require_once($CFG->dirroot . '/mod/questionnaire/locallib.php');
-require_once($CFG->dirroot . '/mod/questionnaire/classes/question/question.php');
-require_once($CFG->dirroot . '/mod/questionnaire/questionnaire.class.php');
+require_once($CFG->dirroot . '/mod/questionnaire/classes/local/question/question.php');
/**
* Unit tests for questionnaire_deletion_question_testcase.
@@ -68,7 +66,7 @@ public function setUp(): void {
public function test_restore_deleted_question(): void {
global $DB;
$question = $DB->get_record_select('questionnaire_question', 'name = ?', ['DEMODATE1']);
- questionnaire_restore_deleted_question($question->id, $question->surveyid);
+ survey::restore_deleted_question($question->id, $question->surveyid);
$question = $DB->get_record('questionnaire_question', ['id' => $question->id]);
$this->assertEquals($question->position, 1);
}
@@ -83,7 +81,7 @@ public function test_restore_deleted_question(): void {
public function test_delete_permanently_question(): void {
global $DB;
$question = $DB->get_record_select('questionnaire_question', 'name = ?', ['DEMODATE1']);
- questionnaire_delete_permanently_questions($question->id, $question->surveyid);
+ survey::delete_question_permanently($question->id, $question->surveyid);
$question = $DB->get_record('questionnaire_question', ['id' => $question->id]);
$this->assertEquals($question, false);
}
@@ -99,8 +97,8 @@ public function create_question_by_type($qtype, $qdata): void {
$course = $this->getDataGenerator()->create_course();
$generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
$questionnaire = $generator->create_instance(['course' => $course->id]);
- $qdata['type_id'] = $qtype;
- $qdata['surveyid'] = $questionnaire->sid;
+ $qdata['typeid'] = $qtype;
+ $qdata['surveyid'] = $questionnaire->surveyid();
$qdata['name'] = isset($qdata['name']) ? $qdata['name'] : 'Q1';
$qdata['content'] = isset($qdata['content']) ? $qdata['content'] : 'Test content';
$qdata['position'] = isset($qdata['position']) ? $qdata['position'] : 1;
diff --git a/tests/feedback_settings_controller_test.php b/tests/feedback_settings_controller_test.php
new file mode 100644
index 000000000..99b5530e4
--- /dev/null
+++ b/tests/feedback_settings_controller_test.php
@@ -0,0 +1,166 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\feedback_settings_controller.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire;
+
+/**
+ * Unit tests for mod_questionnaire\feedback_settings_controller.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\feedback_settings_controller
+ */
+final class feedback_settings_controller_test extends \advanced_testcase {
+ /**
+ * Build a course + questionnaire fixture and return its domain object.
+ *
+ * @return questionnaire
+ */
+ private function setup_questionnaire(): questionnaire {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+ $course = $this->getDataGenerator()->create_course();
+ return $this->getDataGenerator()
+ ->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id]);
+ }
+
+ /**
+ * Asserts save() writes feedbacksections / feedbackscores onto the survey row.
+ */
+ public function test_save_persists_feedbacksections_and_feedbackscores(): void {
+ global $DB;
+
+ $questionnaire = $this->setup_questionnaire();
+ $formdata = (object) [
+ 'feedbacksections' => 1,
+ 'feedbackscores' => 1,
+ 'feedbacknotes' => ['itemid' => 0, 'format' => FORMAT_HTML, 'text' => 'Note text'],
+ ];
+
+ $result = (new feedback_settings_controller($questionnaire))->save($formdata);
+
+ $this->assertSame($questionnaire->surveyid(), $result);
+ $row = $DB->get_record('questionnaire_survey', ['id' => $questionnaire->surveyid()]);
+ $this->assertEquals(1, $row->feedbacksections);
+ $this->assertEquals(1, $row->feedbackscores);
+ $this->assertStringContainsString('Note text', $row->feedbacknotes);
+ }
+
+ /**
+ * Asserts save() resets feedbacksections to 0 when the form submits a zero value.
+ */
+ public function test_save_resets_feedbacksections_to_zero(): void {
+ global $DB;
+
+ $questionnaire = $this->setup_questionnaire();
+ // Seed feedbacksections = 2 first.
+ $questionnaire->survey()->update_settings(['feedbacksections' => 2]);
+
+ $formdata = (object) [
+ 'feedbacksections' => 0,
+ 'feedbackscores' => 0,
+ 'feedbacknotes' => ['itemid' => 0, 'format' => FORMAT_HTML, 'text' => ''],
+ ];
+ (new feedback_settings_controller($questionnaire))->save($formdata);
+
+ $this->assertEquals(0, $DB->get_field('questionnaire_survey', 'feedbacksections', ['id' => $questionnaire->surveyid()]));
+ }
+
+ /**
+ * Asserts save() picks chart_type_global when sections=1 and usergraph is on.
+ */
+ public function test_save_picks_chart_type_global_when_one_section_with_usergraph(): void {
+ global $DB;
+
+ $questionnaire = $this->setup_questionnaire();
+ set_config('usergraph', 1, 'questionnaire');
+
+ $formdata = (object) [
+ 'feedbacksections' => 1,
+ 'feedbackscores' => 1,
+ 'feedbacknotes' => ['itemid' => 0, 'format' => FORMAT_HTML, 'text' => ''],
+ 'chart_type_global' => 'bipolar',
+ 'chart_type_two_sections' => 'rose',
+ 'chart_type_sections' => 'hbar',
+ ];
+ (new feedback_settings_controller($questionnaire))->save($formdata);
+
+ $this->assertEquals('bipolar', $DB->get_field('questionnaire_survey', 'charttype', ['id' => $questionnaire->surveyid()]));
+ }
+
+ /**
+ * Asserts save() picks chart_type_sections when sections > 2 and usergraph is on.
+ */
+ public function test_save_picks_chart_type_sections_when_many_with_usergraph(): void {
+ global $DB;
+
+ $questionnaire = $this->setup_questionnaire();
+ set_config('usergraph', 1, 'questionnaire');
+
+ $formdata = (object) [
+ 'feedbacksections' => 4,
+ 'feedbackscores' => 1,
+ 'feedbacknotes' => ['itemid' => 0, 'format' => FORMAT_HTML, 'text' => ''],
+ 'chart_type_global' => 'bipolar',
+ 'chart_type_two_sections' => 'rose',
+ 'chart_type_sections' => 'radar',
+ ];
+ (new feedback_settings_controller($questionnaire))->save($formdata);
+
+ $this->assertEquals('radar', $DB->get_field('questionnaire_survey', 'charttype', ['id' => $questionnaire->surveyid()]));
+ }
+
+ /**
+ * Asserts ensure_first_section() creates a section when none exist and feedback is enabled.
+ */
+ public function test_ensure_first_section_creates_section_when_missing(): void {
+ global $DB;
+
+ $questionnaire = $this->setup_questionnaire();
+ $questionnaire->survey()->update_settings(['feedbacksections' => 1]);
+
+ $surveyid = $questionnaire->surveyid();
+ $this->assertEquals(0, $DB->count_records('questionnaire_fb_sections', ['surveyid' => $surveyid]));
+
+ (new feedback_settings_controller($questionnaire))->ensure_first_section();
+
+ $this->assertEquals(1, $DB->count_records('questionnaire_fb_sections', ['surveyid' => $surveyid]));
+ }
+
+ /**
+ * Asserts ensure_first_section() does NOT create a section when feedbacksections == 0.
+ */
+ public function test_ensure_first_section_no_op_when_feedback_disabled(): void {
+ global $DB;
+
+ $questionnaire = $this->setup_questionnaire();
+ $surveyid = $questionnaire->surveyid();
+ $this->assertEquals(0, $DB->count_records('questionnaire_fb_sections', ['surveyid' => $surveyid]));
+
+ (new feedback_settings_controller($questionnaire))->ensure_first_section();
+
+ $this->assertEquals(0, $DB->count_records('questionnaire_fb_sections', ['surveyid' => $surveyid]));
+ }
+}
diff --git a/tests/form_options_test.php b/tests/form_options_test.php
new file mode 100644
index 000000000..032cf1ffa
--- /dev/null
+++ b/tests/form_options_test.php
@@ -0,0 +1,122 @@
+.
+
+/**
+ * Unit tests for the mod_questionnaire form_options helper.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 onward Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ */
+
+declare(strict_types=1);
+
+namespace mod_questionnaire;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+
+/**
+ * Unit tests for {@see form_options}.
+ *
+ * @covers \mod_questionnaire\form_options
+ */
+final class form_options_test extends \advanced_testcase {
+ public function test_response_frequency_returns_five_options(): void {
+ $this->resetAfterTest();
+ $options = form_options::response_frequency();
+ $this->assertIsArray($options);
+ $this->assertCount(5, $options);
+ }
+
+ public function test_response_frequency_has_expected_keys(): void {
+ $this->resetAfterTest();
+ $options = form_options::response_frequency();
+ $this->assertArrayHasKey(questionnaire::QTYPE_UNLIMITED, $options);
+ $this->assertArrayHasKey(questionnaire::QTYPE_ONCE, $options);
+ $this->assertArrayHasKey(questionnaire::QTYPE_DAILY, $options);
+ $this->assertArrayHasKey(questionnaire::QTYPE_WEEKLY, $options);
+ $this->assertArrayHasKey(questionnaire::QTYPE_MONTHLY, $options);
+ }
+
+ public function test_response_viewer_returns_four_options(): void {
+ $this->resetAfterTest();
+ $options = form_options::response_viewer();
+ $this->assertIsArray($options);
+ $this->assertCount(4, $options);
+ }
+
+ public function test_response_viewer_has_expected_keys(): void {
+ $this->resetAfterTest();
+ $options = form_options::response_viewer();
+ $this->assertArrayHasKey(questionnaire::RESPVIEW_NEVER, $options);
+ $this->assertArrayHasKey(questionnaire::RESPVIEW_WHENANSWERED, $options);
+ $this->assertArrayHasKey(questionnaire::RESPVIEW_WHENCLOSED, $options);
+ $this->assertArrayHasKey(questionnaire::RESPVIEW_ALWAYS, $options);
+ }
+
+ public function test_respondent_type_has_fullname_and_anonymous(): void {
+ $options = form_options::respondent_type();
+ $this->assertArrayHasKey('fullname', $options);
+ $this->assertArrayHasKey('anonymous', $options);
+ }
+
+ public function test_realm_has_three_options(): void {
+ $options = form_options::realm();
+ $this->assertCount(3, $options);
+ $this->assertArrayHasKey('private', $options);
+ $this->assertArrayHasKey('public', $options);
+ $this->assertArrayHasKey('template', $options);
+ }
+
+ public function test_auto_numbering_has_four_options(): void {
+ $options = form_options::auto_numbering();
+ $this->assertCount(4, $options);
+ $this->assertArrayHasKey(0, $options);
+ $this->assertArrayHasKey(3, $options);
+ }
+
+ public function test_editor_returns_expected_keys(): void {
+ $context = \context_system::instance();
+ $options = form_options::editor($context);
+ $this->assertIsArray($options);
+ $this->assertArrayHasKey('subdirs', $options);
+ $this->assertArrayHasKey('maxbytes', $options);
+ $this->assertArrayHasKey('maxfiles', $options);
+ $this->assertArrayHasKey('context', $options);
+ $this->assertArrayHasKey('noclean', $options);
+ $this->assertArrayHasKey('trusttext', $options);
+ $this->assertSame($context, $options['context']);
+ }
+
+ public function test_response_removal_returns_37_entries(): void {
+ $this->resetAfterTest();
+ $options = form_options::response_removal();
+ $this->assertIsArray($options);
+ $this->assertCount(37, $options);
+ $this->assertArrayHasKey(0, $options);
+ }
+
+ public function test_js_module_returns_expected_keys(): void {
+ $module = form_options::js_module();
+ $this->assertSame('mod_questionnaire', $module['name']);
+ $this->assertSame('/mod/questionnaire/module.js', $module['fullpath']);
+ $this->assertIsArray($module['requires']);
+ $this->assertIsArray($module['strings']);
+ }
+}
diff --git a/tests/generator/lib.php b/tests/generator/lib.php
index d311f5894..a3621f004 100644
--- a/tests/generator/lib.php
+++ b/tests/generator/lib.php
@@ -18,11 +18,10 @@
use mod_questionnaire\generator\question_response,
mod_questionnaire\generator\question_response_rank,
- mod_questionnaire\question\question;
+ mod_questionnaire\local\question\question;
global $CFG;
-require_once($CFG->dirroot . '/mod/questionnaire/locallib.php');
-require_once($CFG->dirroot . '/mod/questionnaire/classes/question/question.php');
+require_once($CFG->dirroot . '/mod/questionnaire/classes/local/question/question.php');
/**
* The mod_questionnaire data generator.
@@ -49,7 +48,7 @@ class mod_questionnaire_generator extends testing_module_generator {
protected $responsecount = 0;
/**
- * @var questionnaire[]
+ * @var \mod_questionnaire\questionnaire[]
*/
protected $questionnaires = [];
@@ -76,7 +75,7 @@ public function questionnaires() {
* Create a questionnaire activity.
* @param array $record Will be changed in this function.
* @param array|null $options
- * @return questionnaire
+ * @return \mod_questionnaire\questionnaire
*/
public function create_instance($record = null, ?array $options = null) {
$record = (object)(array)$record;
@@ -84,8 +83,8 @@ public function create_instance($record = null, ?array $options = null) {
$defaultquestionnairesettings = [
'qtype' => 0,
'respondenttype' => 'fullname',
- 'resp_eligible' => 'all',
- 'resp_view' => 0,
+ 'respeligible' => 'all',
+ 'respview' => 0,
'opendate' => 0,
'closedate' => 0,
'resume' => 0,
@@ -105,9 +104,7 @@ public function create_instance($record = null, ?array $options = null) {
}
$instance = parent::create_instance($record, (array)$options);
- $cm = get_coursemodule_from_instance('questionnaire', $instance->id);
- $course = get_course($cm->course);
- $questionnaire = new \questionnaire($course, $cm, 0, $instance, false);
+ $questionnaire = \mod_questionnaire\questionnaire::from_instanceid($instance->id);
$this->questionnaires[$instance->id] = $questionnaire;
@@ -115,30 +112,30 @@ public function create_instance($record = null, ?array $options = null) {
}
/**
- * Create a survey instance with data from an existing questionnaire object.
- * @param questionnaire $questionnaire
- * @param array $record
- * @return bool|int
+ * Apply additional survey fields to an existing questionnaire's survey row.
+ *
+ * Only fields in survey::update_settings()'s allowlist may appear in $record.
+ *
+ * @param \mod_questionnaire\questionnaire $questionnaire
+ * @param array $record Map of survey field => value (e.g. ['realm' => 'public']).
+ * @return bool|int Survey id on success, false on validation failure.
*/
public function create_content($questionnaire, $record = []) {
- global $DB;
-
- $survey = $DB->get_record('questionnaire_survey', ['id' => $questionnaire->sid], '*', MUST_EXIST);
- foreach ($record as $name => $value) {
- $survey->{$name} = $value;
+ if (empty($record)) {
+ return $questionnaire->surveyid();
}
- return $questionnaire->survey_update($survey);
+ return $questionnaire->survey()->update_settings($record);
}
/**
* Function to create a question.
*
- * @param questionnaire $questionnaire
+ * @param \mod_questionnaire\questionnaire $questionnaire
* @param array|stdClass $record
* @param array|stdClass $data - accompanying data for question - e.g. choices
- * @return \mod_questionnaire\question\question the question object
+ * @return \mod_questionnaire\local\question\question the question object
*/
- public function create_question(questionnaire $questionnaire, $record = null, $data = null) {
+ public function create_question(\mod_questionnaire\questionnaire $questionnaire, $record = null, $data = null) {
global $DB;
// Increment the question count.
@@ -146,7 +143,7 @@ public function create_question(questionnaire $questionnaire, $record = null, $d
$record = (array)$record;
- $record['position'] = count($questionnaire->questions);
+ $record['position'] = count($questionnaire->questions());
if (!isset($record['surveyid'])) {
throw new coding_exception('surveyid must be present in phpunit_util::create_question() $record');
@@ -156,23 +153,23 @@ public function create_question(questionnaire $questionnaire, $record = null, $d
throw new coding_exception('name must be present in phpunit_util::create_question() $record');
}
- if (!isset($record['type_id'])) {
+ if (!isset($record['typeid'])) {
throw new coding_exception('typeid must be present in phpunit_util::create_question() $record');
}
if (!isset($record['content'])) {
- $record['content'] = 'Random ' . $this->type_str($record['type_id']) . ' ' . uniqid();
+ $record['content'] = 'Random ' . $this->type_str($record['typeid']) . ' ' . uniqid();
}
// Get question type.
- $typeid = $record['type_id'];
+ $typeid = $record['typeid'];
if ($typeid === QUESRATE && !isset($record['length'])) {
$record['length'] = 5;
}
if ($typeid !== QUESPAGEBREAK && $typeid !== QUESSECTIONTEXT) {
- $qtype = $DB->get_record('questionnaire_question_type', ['id' => $typeid]);
+ $qtype = $DB->get_record('questionnaire_question_type', ['typeid' => $typeid]);
if (!$qtype) {
throw new coding_exception('Could not find question type with id ' . $typeid);
}
@@ -185,7 +182,7 @@ public function create_question(questionnaire $questionnaire, $record = null, $d
// Add the question.
$record->id = $DB->insert_record('questionnaire_question', $record);
- $question = \mod_questionnaire\question\question::question_builder($record->type_id, $record->id, $record);
+ $question = \mod_questionnaire\local\question\question::question_builder($record->typeid, $record->id, $record);
// Add the question choices if required.
if ($typeid !== QUESPAGEBREAK && $typeid !== QUESSECTIONTEXT) {
@@ -207,54 +204,48 @@ public function create_question(questionnaire $questionnaire, $record = null, $d
* @param null|int $qtype
* @param array $questiondata
* @param null|array|stdClass $choicedata
- * @return questionnaire
+ * @return \mod_questionnaire\questionnaire
*/
public function create_test_questionnaire($course, $qtype = null, $questiondata = [], $choicedata = null) {
$questionnaire = $this->create_instance(['course' => $course->id]);
- $cm = get_coursemodule_from_instance('questionnaire', $questionnaire->id);
if ($qtype !== null) {
- $questiondata['type_id'] = $qtype;
- $questiondata['surveyid'] = $questionnaire->sid;
+ $questiondata['typeid'] = $qtype;
+ $questiondata['surveyid'] = $questionnaire->surveyid();
$questiondata['name'] = isset($questiondata['name']) ? $questiondata['name'] : 'Q1';
$questiondata['content'] = isset($questiondata['content']) ? $questiondata['content'] : 'Test content';
$this->create_question($questionnaire, $questiondata, $choicedata);
}
- $questionnaire = new \questionnaire($course, $cm, $questionnaire->id, null, true);
- return $questionnaire;
+ return \mod_questionnaire\questionnaire::from_instanceid($questionnaire->id());
}
/**
* Create a reponse to the supplied question.
- * @param questionnaire $questionnaire
+ * @param \mod_questionnaire\questionnaire $questionnaire
* @param question $question
* @param int|array $respval
* @param int $userid
* @param int $section
* @return false|mixed|stdClass
*/
- public function create_question_response($questionnaire, $question, $respval, $userid = 1, $section = 1) {
+ public function create_question_response(
+ \mod_questionnaire\questionnaire $questionnaire,
+ $question,
+ $respval,
+ $userid = 1,
+ $section = 1
+ ) {
global $DB;
+
$currentrid = 0;
if (!is_array($respval)) {
- $respval = ['q' . $question->id => $respval];
+ $respval = ['q' . $question->id() => $respval];
}
- $respdata = (object)(array_merge(['sec' => $section, 'rid' => $currentrid, 'a' => $questionnaire->id], $respval));
- $responseid = $questionnaire->response_insert($respdata, $userid);
- $this->response_commit($questionnaire, $responseid);
- return $DB->get_record('questionnaire_response', ['id' => $responseid]);
- }
+ $respdata = (object)(array_merge(['sec' => $section, 'rid' => $currentrid, 'a' => $questionnaire->id()], $respval));
- /**
- * Need to create a method to access a private questionnaire method.
- * TO DO - may not need this with above "TO DO".
- * @param questionnaire $questionnaire
- * @param int $responseid
- * @return mixed
- */
- private function response_commit($questionnaire, $responseid) {
- $method = new ReflectionMethod('questionnaire', 'response_commit');
- $method->setAccessible(true);
- return $method->invoke($questionnaire, $responseid);
+ $responses = new \mod_questionnaire\local\response\questionnaire_responses($questionnaire);
+ $responseid = $responses->response_insert($respdata, $userid);
+ $responses->response_commit($responseid);
+ return $DB->get_record('questionnaire_response', ['id' => $responseid]);
}
/**
@@ -321,7 +312,7 @@ protected function validate_question($typeid, $data) {
/**
* Add choices to question.
*
- * @param \mod_questionnaire\question\question $question
+ * @param \mod_questionnaire\local\question\question $question
* @param array $data
*/
protected function add_question_choices($question, $data) {
@@ -333,7 +324,7 @@ protected function add_question_choices($question, $data) {
];
}
$record = (object)[
- 'question_id' => $question->id,
+ 'questionid' => $question->id(),
'content' => $content->content,
'value' => $content->value,
];
@@ -448,14 +439,14 @@ public function type_name($qtypeid) {
/**
* Add the response choice.
- * @param \mod_questionnaire\responsetype\response\response $questionresponse
+ * @param \mod_questionnaire\local\response\response $questionresponse
* @param int $responseid
*/
protected function add_response_choice($questionresponse, $responseid) {
global $DB;
$question = $DB->get_record('questionnaire_question', ['id' => $questionresponse->questionid]);
- $qtype = intval($question->type_id);
+ $qtype = intval($question->typeid);
if (is_array($questionresponse->response)) {
foreach ($questionresponse->response as $choice) {
@@ -488,7 +479,7 @@ protected function add_response_choice($questionresponse, $responseid) {
// Lookup the choice id.
$comptext = $DB->sql_compare_text('content');
- $select = 'WHERE question_id = ? AND ' . $comptext . ' = ?';
+ $select = 'WHERE questionid = ? AND ' . $comptext . ' = ?';
$params = [intval($question->id), $choiceval];
$rs = $DB->get_records_sql("SELECT * FROM {questionnaire_quest_choice} $select", $params, 0, 1);
@@ -503,9 +494,9 @@ protected function add_response_choice($questionresponse, $responseid) {
$DB->insert_record(
'questionnaire_response_rank',
[
- 'response_id' => $responseid,
- 'question_id' => $questionresponse->questionid,
- 'choice_id' => $choiceid,
+ 'responseid' => $responseid,
+ 'questionid' => $questionresponse->questionid,
+ 'choiceid' => $choiceid,
'rankvalue' => $questionresponse->response->rankvalue,
]
);
@@ -518,9 +509,9 @@ protected function add_response_choice($questionresponse, $responseid) {
$DB->insert_record(
$instable,
[
- 'response_id' => $responseid,
- 'question_id' => $questionresponse->questionid,
- 'choice_id' => $choiceid,
+ 'responseid' => $responseid,
+ 'questionid' => $questionresponse->questionid,
+ 'choiceid' => $choiceid,
]
);
}
@@ -528,8 +519,8 @@ protected function add_response_choice($questionresponse, $responseid) {
$DB->insert_record(
'questionnaire_response_text',
[
- 'response_id' => $responseid,
- 'question_id' => $questionresponse->questionid,
+ 'responseid' => $responseid,
+ 'questionid' => $questionresponse->questionid,
'response' => $questionresponse->response,
]
);
@@ -612,7 +603,7 @@ public function assign_opts($number = 5) {
/**
* Generate a response.
* @param questionnaire $questionnaire
- * @param \mod_questionnaire\question\question[] $questions
+ * @param \mod_questionnaire\local\question\question[] $questions
* @param int $userid
* @param bool $complete
* @return stdClass
@@ -625,27 +616,27 @@ public function generate_response($questionnaire, $questions, $userid, $complete
$choices = array_values($question->choices);
}
- switch ($question->type_id) {
+ switch ($question->typeid()) {
case QUESTEXT:
- $responses[] = new question_response($question->id, 'Test answer');
+ $responses[] = new question_response($question->id(), 'Test answer');
break;
case QUESESSAY:
$resptext = 'Some header text Some paragraph text
';
- $responses[] = new question_response($question->id, $resptext);
+ $responses[] = new question_response($question->id(), $resptext);
break;
case QUESNUMERIC:
- $responses[] = new question_response($question->id, 83);
+ $responses[] = new question_response($question->id(), 83);
break;
case QUESDATE:
$date = mktime(0, 0, 0, 12, 28, 2017);
$dateformat = get_string('strfdate', 'questionnaire');
$datestr = userdate($date, $dateformat, '1', false);
- $responses[] = new question_response($question->id, $datestr);
+ $responses[] = new question_response($question->id(), $datestr);
break;
case QUESRADIO:
case QUESDROP:
$optidx = count($choices) - 1;
- $responses[] = new question_response($question->id, $choices[$optidx]);
+ $responses[] = new question_response($question->id(), $choices[$optidx]);
break;
case QUESCHECK:
$answers = [];
@@ -656,21 +647,21 @@ public function generate_response($questionnaire, $questions, $userid, $complete
$answers = array_unique($answers);
- $responses[] = new question_response($question->id, $answers);
+ $responses[] = new question_response($question->id(), $answers);
break;
case QUESRATE:
$answers = [];
for ($a = 0; $a < count($choices) - 1; $a++) {
$answers[] = new question_response_rank($choices[$a], (($a % 5) + 1));
}
- $responses[] = new question_response($question->id, $answers);
+ $responses[] = new question_response($question->id(), $answers);
break;
case QUESSLIDER:
- $responses[] = new question_response($question->id, 5);
+ $responses[] = new question_response($question->id(), 5);
break;
}
}
- return $this->create_response($responses, ['questionnaireid' => $questionnaire->id, 'userid' => $userid], $complete);
+ return $this->create_response($responses, ['questionnaireid' => $questionnaire->id(), 'userid' => $userid], $complete);
}
/**
@@ -746,9 +737,9 @@ public function create_and_fully_populate(
$qdg->create_question(
$questionnaire,
[
- 'surveyid' => $questionnaire->sid,
+ 'surveyid' => $questionnaire->surveyid(),
'name' => $qdg->type_name($questiontype),
- 'type_id' => QUESSECTIONTEXT,
+ 'typeid' => QUESSECTIONTEXT,
]
);
// Create questions.
@@ -760,9 +751,9 @@ public function create_and_fully_populate(
$questions[] = $qdg->create_question(
$questionnaire,
[
- 'surveyid' => $questionnaire->sid,
+ 'surveyid' => $questionnaire->surveyid(),
'name' => $qdg->type_name($questiontype) . ' ' . $qname++,
- 'type_id' => $questiontype,
+ 'typeid' => $questiontype,
],
$opts
);
@@ -771,9 +762,9 @@ public function create_and_fully_populate(
$qdg->create_question(
$questionnaire,
[
- 'surveyid' => $questionnaire->sid,
+ 'surveyid' => $questionnaire->surveyid(),
'name' => 'pagebreak ' . $qname++,
- 'type_id' => QUESPAGEBREAK,
+ 'typeid' => QUESPAGEBREAK,
]
);
}
diff --git a/tests/generator_test.php b/tests/generator_test.php
index 455230e88..822f3fe7d 100644
--- a/tests/generator_test.php
+++ b/tests/generator_test.php
@@ -55,18 +55,18 @@ public function test_create_instance(): void {
$questionnaire = $generator->create_instance(['course' => $course->id]);
$this->assertEquals(1, $DB->count_records('questionnaire'));
- $cm = get_coursemodule_from_instance('questionnaire', $questionnaire->id);
- $this->assertEquals($questionnaire->id, $cm->instance);
+ $cm = get_coursemodule_from_instance('questionnaire', $questionnaire->id());
+ $this->assertEquals($questionnaire->id(), $cm->instance);
$this->assertEquals('questionnaire', $cm->modname);
$this->assertEquals($course->id, $cm->course);
$context = \context_module::instance($cm->id);
- $this->assertEquals($questionnaire->cmid, $context->instanceid);
+ $this->assertEquals($questionnaire->coursemodule()->id, $context->instanceid);
- $survey = $DB->get_record('questionnaire_survey', ['id' => $questionnaire->sid]);
- $this->assertEquals($survey->id, $questionnaire->sid);
- $this->assertEquals($questionnaire->name, $survey->name);
- $this->assertEquals($questionnaire->name, $survey->title);
+ $survey = $DB->get_record('questionnaire_survey', ['id' => $questionnaire->surveyid()]);
+ $this->assertEquals($survey->id, $questionnaire->surveyid());
+ $this->assertEquals($questionnaire->name(), $survey->name);
+ $this->assertEquals($questionnaire->name(), $survey->title);
// Should test creating a public questionnaire, template questionnaire and creating one from a template.
@@ -90,20 +90,18 @@ public function test_create_content(): void {
$course = $this->getDataGenerator()->create_course();
$generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
$questionnaire = $generator->create_instance(['course' => $course->id]);
- $cm = get_coursemodule_from_instance('questionnaire', $questionnaire->id);
- $questionnaire = new \questionnaire($course, $cm, $questionnaire->id, null, false);
$newcontent = [
'title' => 'New title',
'email' => 'test@email.com',
'subtitle' => 'New subtitle',
'info' => 'New info',
- 'thanks_page' => 'http://thankurl.com',
- 'thank_head' => 'New thank header',
- 'thank_body' => 'New thank body',
+ 'thankspage' => 'http://thankurl.com',
+ 'thankhead' => 'New thank header',
+ 'thankbody' => 'New thank body',
];
$sid = $generator->create_content($questionnaire, $newcontent);
- $this->assertEquals($sid, $questionnaire->sid);
+ $this->assertEquals($sid, $questionnaire->surveyid());
$survey = $DB->get_record('questionnaire_survey', ['id' => $sid]);
foreach ($newcontent as $name => $value) {
$this->assertEquals($survey->{$name}, $value);
diff --git a/tests/gradebook_test.php b/tests/gradebook_test.php
new file mode 100644
index 000000000..b7072d334
--- /dev/null
+++ b/tests/gradebook_test.php
@@ -0,0 +1,202 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\gradebook.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire;
+
+/**
+ * Unit tests for mod_questionnaire\gradebook.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\gradebook
+ */
+final class gradebook_test extends \advanced_testcase {
+ /**
+ * Stand up a course + questionnaire instance and return both.
+ *
+ * @param int $grade Grade max for the questionnaire instance.
+ * @return array [course, questionnaire]
+ */
+ private function make_instance(int $grade = 100): array {
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $questionnaire = $generator->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id, 'grade' => $grade]);
+ return [$course, $questionnaire];
+ }
+
+ /**
+ * Insert a completed response row.
+ *
+ * @param int $questionnaireid
+ * @param int $userid
+ * @param int $grade
+ * @return int
+ */
+ private function insert_response(int $questionnaireid, int $userid, int $grade): int {
+ global $DB;
+ return $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $questionnaireid,
+ 'userid' => $userid,
+ 'submitted' => time(),
+ 'complete' => 'y',
+ 'grade' => $grade,
+ ]);
+ }
+
+ /**
+ * get_user_grades() returns rows keyed by response id with rawgrade/dategraded for one user.
+ */
+ public function test_get_user_grades_user_filter(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+ $generator = $this->getDataGenerator();
+
+ [, $questionnaire] = $this->make_instance(100);
+
+ $u1 = $generator->create_user();
+ $u2 = $generator->create_user();
+ $r1 = $this->insert_response($questionnaire->id(), $u1->id, 80);
+ $this->insert_response($questionnaire->id(), $u2->id, 50);
+
+ $rows = gradebook::get_user_grades($questionnaire, $u1->id);
+ $this->assertCount(1, $rows);
+ $row = reset($rows);
+ $this->assertEquals($u1->id, $row->userid);
+ $this->assertEquals(80, $row->rawgrade);
+ }
+
+ /**
+ * get_user_grades() with userid 0 returns rows for every user.
+ */
+ public function test_get_user_grades_all_users(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+ $generator = $this->getDataGenerator();
+
+ [, $questionnaire] = $this->make_instance(100);
+
+ $u1 = $generator->create_user();
+ $u2 = $generator->create_user();
+ $this->insert_response($questionnaire->id(), $u1->id, 80);
+ $this->insert_response($questionnaire->id(), $u2->id, 50);
+
+ $rows = gradebook::get_user_grades($questionnaire);
+ $this->assertCount(2, $rows);
+ }
+
+ /**
+ * get_user_grades() only counts complete responses.
+ */
+ public function test_get_user_grades_skips_incomplete(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+ $generator = $this->getDataGenerator();
+
+ [, $questionnaire] = $this->make_instance(100);
+ $user = $generator->create_user();
+ $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $questionnaire->id(),
+ 'userid' => $user->id,
+ 'submitted' => time(),
+ 'complete' => 'n',
+ 'grade' => 80,
+ ]);
+
+ $this->assertCount(0, gradebook::get_user_grades($questionnaire));
+ }
+
+ /**
+ * grade_item_update() creates a grade item record for the questionnaire.
+ */
+ public function test_grade_item_update_creates_grade_item(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [, $questionnaire] = $this->make_instance(100);
+
+ $this->assertSame(GRADE_UPDATE_OK, gradebook::grade_item_update($questionnaire));
+
+ $this->assertTrue($DB->record_exists('grade_items', [
+ 'itemmodule' => 'questionnaire',
+ 'iteminstance' => $questionnaire->id(),
+ ]));
+ }
+
+ /**
+ * grade_item_update() with grade = 0 deletes the grade item.
+ */
+ public function test_grade_item_update_with_zero_grade_deletes(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [, $questionnaire] = $this->make_instance(100);
+ // Create the item first.
+ gradebook::grade_item_update($questionnaire);
+ $this->assertTrue($DB->record_exists('grade_items', [
+ 'itemmodule' => 'questionnaire',
+ 'iteminstance' => $questionnaire->id(),
+ ]));
+
+ // Zero-grade instances should remove the grade item.
+ $DB->set_field('questionnaire', 'grade', 0, ['id' => $questionnaire->id()]);
+ $zerorec = $DB->get_record('questionnaire', ['id' => $questionnaire->id()]);
+ $zerorec->cmidnumber = '';
+ gradebook::grade_item_update($zerorec);
+
+ $this->assertFalse($DB->record_exists('grade_items', [
+ 'itemmodule' => 'questionnaire',
+ 'iteminstance' => $questionnaire->id(),
+ ]));
+ }
+
+ /**
+ * update_grades() pushes user grades to the gradebook for a specific questionnaire.
+ */
+ public function test_update_grades_pushes_user_grades(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+ $generator = $this->getDataGenerator();
+
+ [, $questionnaire] = $this->make_instance(100);
+ $user = $generator->create_user();
+ $this->insert_response($questionnaire->id(), $user->id, 80);
+
+ gradebook::update_grades($questionnaire, $user->id);
+
+ $itemid = $DB->get_field('grade_items', 'id', [
+ 'itemmodule' => 'questionnaire',
+ 'iteminstance' => $questionnaire->id(),
+ ]);
+ $this->assertNotEmpty($itemid);
+ $this->assertTrue($DB->record_exists('grade_grades', [
+ 'itemid' => $itemid,
+ 'userid' => $user->id,
+ ]));
+ }
+}
diff --git a/tests/instance_admin_test.php b/tests/instance_admin_test.php
new file mode 100644
index 000000000..a0965e7fa
--- /dev/null
+++ b/tests/instance_admin_test.php
@@ -0,0 +1,280 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\instance_admin.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire;
+
+/**
+ * Unit tests for mod_questionnaire\instance_admin.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\instance_admin
+ */
+final class instance_admin_test extends \advanced_testcase {
+ /**
+ * Build the formdata stdClass that mod_form normally produces for create.
+ *
+ * @param int $courseid
+ * @param string $name
+ * @return \stdClass
+ */
+ private function build_add_formdata(int $courseid, string $name = 'New survey'): \stdClass {
+ $placeholder = $this->getDataGenerator()->create_module('questionnaire', [
+ 'course' => $courseid,
+ 'name' => 'Placeholder for cm',
+ ]);
+ // We only use the placeholder to extract a valid coursemodule id.
+ $formdata = new \stdClass();
+ $formdata->coursemodule = $placeholder->coursemodule()->id;
+ $formdata->course = $courseid;
+ $formdata->name = $name;
+ $formdata->intro = '';
+ $formdata->introformat = FORMAT_HTML;
+ $formdata->qtype = 0;
+ $formdata->respondenttype = 'fullname';
+ $formdata->respeligible = 'all';
+ $formdata->respview = 0;
+ $formdata->notifications = 0;
+ $formdata->opendate = 0;
+ $formdata->closedate = 0;
+ $formdata->resume = 0;
+ $formdata->navigate = 0;
+ $formdata->grade = 0;
+ $formdata->sid = 0;
+ $formdata->create = 'new-0';
+ $formdata->autonum = 3;
+ $formdata->progressbar = 0;
+ $formdata->removeafter = 0;
+ $formdata->completionsubmit = 0;
+ return $formdata;
+ }
+
+ /**
+ * add_instance() creates a survey row, a questionnaire row, and links them.
+ */
+ public function test_add_instance_creates_survey_and_questionnaire(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $course = $this->getDataGenerator()->create_course();
+ $formdata = $this->build_add_formdata($course->id, 'My survey');
+
+ $id = instance_admin::add_instance($formdata);
+ $this->assertNotFalse($id);
+
+ $row = $DB->get_record('questionnaire', ['id' => $id], '*', MUST_EXIST);
+ $this->assertSame('My survey', $row->name);
+ $this->assertGreaterThan(0, (int) $row->sid);
+ $this->assertTrue($DB->record_exists('questionnaire_survey', ['id' => $row->sid]));
+ }
+
+ /**
+ * add_instance() with opendate + closedate set creates a calendar event for the instance.
+ */
+ public function test_add_instance_creates_calendar_event(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $course = $this->getDataGenerator()->create_course();
+ $formdata = $this->build_add_formdata($course->id, 'With dates');
+ $formdata->opendate = time() + 3600;
+ $formdata->closedate = time() + (2 * HOURSECS);
+
+ $id = instance_admin::add_instance($formdata);
+
+ $events = $DB->get_records('event', [
+ 'modulename' => 'questionnaire',
+ 'instance' => $id,
+ ]);
+ $this->assertNotEmpty($events);
+ }
+
+ /**
+ * update_instance() renames the questionnaire and syncs the survey realm.
+ */
+ public function test_update_instance_renames(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $course = $this->getDataGenerator()->create_course();
+ $questionnaire = $this->getDataGenerator()
+ ->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id, 'name' => 'Original']);
+
+ $data = new \stdClass();
+ $data->instance = $questionnaire->id();
+ $data->course = $course->id;
+ $data->coursemodule = $questionnaire->coursemodule()->id;
+ $data->sid = $questionnaire->surveyid();
+ $data->realm = 'private';
+ $data->name = 'Renamed';
+ $data->intro = '';
+ $data->introformat = FORMAT_HTML;
+ $data->qtype = 0;
+ $data->respondenttype = 'fullname';
+ $data->respeligible = 'all';
+ $data->respview = 0;
+ $data->notifications = 0;
+ $data->opendate = 0;
+ $data->closedate = 0;
+ $data->resume = 0;
+ $data->navigate = 0;
+ $data->grade = 0;
+ $data->completionsubmit = 0;
+ $data->autonum = 3;
+ $data->progressbar = 0;
+ $data->removeafter = 0;
+
+ $this->assertTrue(instance_admin::update_instance($data));
+
+ $this->assertSame('Renamed', $DB->get_field('questionnaire', 'name', ['id' => $questionnaire->id()]));
+ }
+
+ /**
+ * delete_instance() removes the row, its responses, and the survey content when owned by the course.
+ */
+ public function test_delete_instance_removes_owned_survey(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $course = $this->getDataGenerator()->create_course();
+ $questionnaire = $this->getDataGenerator()
+ ->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id]);
+
+ // Insert a stray response.
+ $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $questionnaire->id(),
+ 'userid' => 2,
+ 'submitted' => time(),
+ 'complete' => 'y',
+ 'grade' => 0,
+ ]);
+
+ $surveyid = $questionnaire->surveyid();
+ $this->assertTrue(instance_admin::delete_instance($questionnaire->id()));
+
+ $this->assertFalse($DB->record_exists('questionnaire', ['id' => $questionnaire->id()]));
+ $this->assertFalse($DB->record_exists('questionnaire_survey', ['id' => $surveyid]));
+ $this->assertEquals(0, $DB->count_records('questionnaire_response', ['questionnaireid' => $questionnaire->id()]));
+ }
+
+ /**
+ * delete_instance() returns false when the id does not match any row.
+ */
+ public function test_delete_instance_missing_returns_false(): void {
+ $this->resetAfterTest();
+ $this->assertFalse(instance_admin::delete_instance(99999));
+ }
+
+ /**
+ * set_events() replaces existing calendar events for the instance.
+ */
+ public function test_set_events_replaces_existing(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $course = $this->getDataGenerator()->create_course();
+ $questionnaire = $this->getDataGenerator()
+ ->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id]);
+
+ $data = new \stdClass();
+ $data->id = $questionnaire->id();
+ $data->course = $course->id;
+ $data->name = 'q';
+ $data->opendate = time() + 3600;
+ $data->closedate = time() + (2 * HOURSECS);
+ $data->visible = 1;
+
+ instance_admin::set_events($data);
+ $first = $DB->count_records('event', ['modulename' => 'questionnaire', 'instance' => $questionnaire->id()]);
+ $this->assertGreaterThan(0, $first);
+
+ // Calling again should not double the count — old events get deleted first.
+ instance_admin::set_events($data);
+ $second = $DB->count_records('event', ['modulename' => 'questionnaire', 'instance' => $questionnaire->id()]);
+ $this->assertSame($first, $second);
+ }
+
+ /**
+ * reset_userdata() deletes all responses for course questionnaires when reset is requested.
+ */
+ public function test_reset_userdata_deletes_responses(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $course = $this->getDataGenerator()->create_course();
+ $questionnaire = $this->getDataGenerator()
+ ->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id]);
+
+ $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $questionnaire->id(),
+ 'userid' => 2,
+ 'submitted' => time(),
+ 'complete' => 'y',
+ 'grade' => 0,
+ ]);
+
+ $data = (object)[
+ 'courseid' => $course->id,
+ 'reset_questionnaire' => 1,
+ ];
+ $status = instance_admin::reset_userdata($data);
+ $this->assertNotEmpty($status);
+ $this->assertEquals(0, $DB->count_records('questionnaire_response', ['questionnaireid' => $questionnaire->id()]));
+ }
+
+ /**
+ * reset_userdata() with the flag off does nothing and returns an empty status array.
+ */
+ public function test_reset_userdata_no_op_when_flag_off(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $course = $this->getDataGenerator()->create_course();
+ $questionnaire = $this->getDataGenerator()
+ ->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id]);
+ $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $questionnaire->id(),
+ 'userid' => 2,
+ 'submitted' => time(),
+ 'complete' => 'y',
+ 'grade' => 0,
+ ]);
+
+ $status = instance_admin::reset_userdata((object)['courseid' => $course->id]);
+ $this->assertSame([], $status);
+ $this->assertEquals(1, $DB->count_records('questionnaire_response', ['questionnaireid' => $questionnaire->id()]));
+ }
+}
diff --git a/tests/lib_test.php b/tests/lib_test.php
index 952c52a8e..89be1f94b 100644
--- a/tests/lib_test.php
+++ b/tests/lib_test.php
@@ -25,13 +25,13 @@
namespace mod_questionnaire;
-use mod_questionnaire\question\question;
+use mod_questionnaire\local\question\question;
defined('MOODLE_INTERNAL') || die();
global $CFG;
require_once($CFG->dirroot . '/mod/questionnaire/lib.php');
-require_once($CFG->dirroot . '/mod/questionnaire/classes/question/question.php');
+require_once($CFG->dirroot . '/mod/questionnaire/classes/local/question/question.php');
/**
* Unit tests for questionnaire_lib_testcase.
@@ -94,17 +94,17 @@ public function test_add_instance(): void {
$questdata->introformat = FORMAT_HTML;
$questdata->qtype = 1;
$questdata->respondenttype = 'anonymous';
- $questdata->resp_eligible = 'none';
- $questdata->resp_view = 2;
+ $questdata->respeligible = 'none';
+ $questdata->respview = 2;
$questdata->opendate = 99;
$questdata->closedate = 50;
$questdata->resume = 1;
$questdata->navigate = 1;
$questdata->grade = 100;
- $questdata->sid = 1;
$questdata->timemodified = 3;
$questdata->completionsubmit = 1;
$questdata->autonum = 1;
+ $questdata->create = 'new-0';
// Call add_instance with the data.
$this->assertTrue(questionnaire_add_instance($questdata) > 0);
@@ -127,9 +127,9 @@ public function test_update_instance(): void {
/** @var mod_questionnaire_generator $generator */
$generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
/** @var questionnaire $questionnaire */
- $questionnaire = $generator->create_instance(['course' => $course->id, 'sid' => 1]);
+ $questionnaire = $generator->create_instance(['course' => $course->id]);
- $qid = $questionnaire->id;
+ $qid = $questionnaire->id();
$this->assertTrue($qid > 0);
// Change all the default values.
@@ -137,17 +137,16 @@ public function test_update_instance(): void {
$qrow = $DB->get_record('questionnaire', ['id' => $qid]);
$qrow->qtype = 1;
$qrow->respondenttype = 'anonymous';
- $qrow->resp_eligible = 'none';
- $qrow->resp_view = 2;
+ $qrow->respeligible = 'none';
+ $qrow->respview = 2;
$qrow->opendate = 99;
$qrow->closedate = 50;
$qrow->resume = 1;
$qrow->navigate = 1;
$qrow->grade = 100;
- $qrow->timemodified = 3;
$qrow->completionsubmit = 1;
$qrow->autonum = 1;
- $qrow->coursemodule = $questionnaire->cm->id;
+ $qrow->coursemodule = $questionnaire->coursemodule()->id;
// Moodle update form passes "instance" instead of "id" to [mod]_update_instance.
$qrow->instance = $qid;
@@ -160,15 +159,14 @@ public function test_update_instance(): void {
$this->assertNotEmpty($questrecord);
$this->assertEquals($qrow->qtype, $questrecord->qtype);
$this->assertEquals($qrow->respondenttype, $questrecord->respondenttype);
- $this->assertEquals($qrow->resp_eligible, $questrecord->resp_eligible);
- $this->assertEquals($qrow->resp_view, $questrecord->resp_view);
+ $this->assertEquals($qrow->respeligible, $questrecord->respeligible);
+ $this->assertEquals($qrow->respview, $questrecord->respview);
$this->assertEquals($qrow->opendate, $questrecord->opendate);
$this->assertEquals($qrow->closedate, $questrecord->closedate);
$this->assertEquals($qrow->resume, $questrecord->resume);
$this->assertEquals($qrow->navigate, $questrecord->navigate);
$this->assertEquals($qrow->grade, $questrecord->grade);
$this->assertEquals($qrow->sid, $questrecord->sid);
- $this->assertEquals($qrow->timemodified, $questrecord->timemodified);
$this->assertEquals($qrow->completionsubmit, $questrecord->completionsubmit);
$this->assertEquals($qrow->autonum, $questrecord->autonum);
}
@@ -196,22 +194,22 @@ public function test_delete_instance(): void {
$generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
$questionnaire = $generator->create_test_questionnaire($course, QUESYESNO, $questiondata);
- $question = reset($questionnaire->questions);
+ $question = reset($questionnaire->questions());
// Add a response for the question.
$response = $generator->create_question_response($questionnaire, $question, 'y');
// Get records for database deletion confirmation.
- $survey = $DB->get_record('questionnaire_survey', ['id' => $questionnaire->sid]);
+ $survey = $DB->get_record('questionnaire_survey', ['id' => $questionnaire->surveyid()]);
// Now delete it all.
- $this->assertTrue(questionnaire_delete_instance($questionnaire->id));
- $this->assertEmpty($DB->get_record('questionnaire', ['id' => $questionnaire->id]));
- $this->assertEmpty($DB->get_record('questionnaire_survey', ['id' => $questionnaire->sid]));
+ $this->assertTrue(questionnaire_delete_instance($questionnaire->id()));
+ $this->assertEmpty($DB->get_record('questionnaire', ['id' => $questionnaire->id()]));
+ $this->assertEmpty($DB->get_record('questionnaire_survey', ['id' => $questionnaire->surveyid()]));
$this->assertEmpty($DB->get_records('questionnaire_question', ['surveyid' => $survey->id]));
- $this->assertEmpty($DB->get_records('questionnaire_response', ['questionnaireid' => $questionnaire->id]));
- $this->assertEmpty($DB->get_records('questionnaire_response_bool', ['response_id' => $response->id]));
- $this->assertEmpty($DB->get_records('event', ["modulename" => 'questionnaire', "instance" => $questionnaire->id]));
+ $this->assertEmpty($DB->get_records('questionnaire_response', ['questionnaireid' => $questionnaire->id()]));
+ $this->assertEmpty($DB->get_records('questionnaire_response_bool', ['responseid' => $response->id]));
+ $this->assertEmpty($DB->get_records('event', ["modulename" => 'questionnaire', "instance" => $questionnaire->id()]));
}
/**
@@ -237,7 +235,7 @@ public function test_questionnaire_user_outline(): void {
$this->assertEquals(get_string("noresponses", "questionnaire"), $outline->info);
// Test for a user with one response.
- $generator->create_question_response($questionnaire, reset($questionnaire->questions), 'y', $user->id);
+ $generator->create_question_response($questionnaire, reset($questionnaire->questions()), 'y', $user->id);
$outline = questionnaire_user_outline($course, $user, null, $questionnaire);
$this->assertEquals('1 ' . get_string("response", "questionnaire"), $outline->info);
}
@@ -338,8 +336,8 @@ public function test_questionnaire_grade_item_update(): void {
$course = $this->getDataGenerator()->create_course();
$generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
$questionnaire = $generator->create_test_questionnaire($course);
- $questionnaire->cmidnumber = $questionnaire->cm->idnumber;
- $questionnaire->courseid = $questionnaire->course->id;
+ $questionnaire->cmidnumber = $questionnaire->coursemodule()->idnumber;
+ $questionnaire->courseid = $questionnaire->course()->id;
$this->assertEquals(GRADE_UPDATE_OK, questionnaire_grade_item_update($questionnaire));
}
@@ -348,7 +346,7 @@ public function test_questionnaire_grade_item_update(): void {
*
* @return void
*
- * @covers \questionnaire_restore_deleted_question
+ * @covers \mod_questionnaire\questionnaire::restore_deleted_question
*/
public function test_questionnaire_restore_deleted_question(): void {
global $DB;
@@ -357,28 +355,28 @@ public function test_questionnaire_restore_deleted_question(): void {
$course = $this->getDataGenerator()->create_course();
$generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
$questionnaire = $generator->create_test_questionnaire($course);
- $sid = $questionnaire->sid;
+ $sid = $questionnaire->surveyid();
// Add three questions.
$q1 = $DB->insert_record('questionnaire_question', [
- 'surveyid' => $sid, 'type_id' => 1, 'position' => 1, 'deleted' => null, 'content' => 'Q1']);
+ 'surveyid' => $sid, 'typeid' => 1, 'position' => 1, 'deleted' => null, 'content' => 'Q1']);
$q2 = $DB->insert_record('questionnaire_question', [
- 'surveyid' => $sid, 'type_id' => 1, 'position' => 2, 'deleted' => null, 'content' => 'Q2']);
+ 'surveyid' => $sid, 'typeid' => 1, 'position' => 2, 'deleted' => null, 'content' => 'Q2']);
$q3 = $DB->insert_record('questionnaire_question', [
- 'surveyid' => $sid, 'type_id' => 1, 'position' => 3, 'deleted' => null, 'content' => 'Q3']);
+ 'surveyid' => $sid, 'typeid' => 1, 'position' => 3, 'deleted' => null, 'content' => 'Q3']);
// Delete Q2 and Q3.
$DB->set_field('questionnaire_question', 'deleted', 1234567890, ['id' => $q2]);
$DB->set_field('questionnaire_question', 'deleted', 1234567891, ['id' => $q3]);
// Restore Q2.
- questionnaire_restore_deleted_question($q2, $sid);
+ survey::restore_deleted_question($q2, $sid);
$restoredq2 = $DB->get_record('questionnaire_question', ['id' => $q2]);
$this->assertNull($restoredq2->deleted);
$this->assertEquals(2, $restoredq2->position); // Should be after Q1.
// Restore Q3.
- questionnaire_restore_deleted_question($q3, $sid);
+ survey::restore_deleted_question($q3, $sid);
$restoredq3 = $DB->get_record('questionnaire_question', ['id' => $q3]);
$this->assertNull($restoredq3->deleted);
$this->assertEquals(3, $restoredq3->position); // Should be after Q2.
diff --git a/tests/local/db/choice_record_test.php b/tests/local/db/choice_record_test.php
new file mode 100644
index 000000000..0435b37fa
--- /dev/null
+++ b/tests/local/db/choice_record_test.php
@@ -0,0 +1,100 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\local\db\choice_record.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire\local\db;
+
+/**
+ * Unit tests for mod_questionnaire\local\db\choice_record.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\local\db\choice_record
+ */
+final class choice_record_test extends \advanced_testcase {
+ /**
+ * Insert a choice row directly via $DB and return the new id.
+ *
+ * @param int $questionid
+ * @param string $content
+ * @return int
+ */
+ private function make_choice(int $questionid, string $content = 'option'): int {
+ global $DB;
+ return $DB->insert_record('questionnaire_quest_choice', (object)[
+ 'questionid' => $questionid,
+ 'content' => $content,
+ 'value' => null,
+ ]);
+ }
+
+ /**
+ * get_for_question() returns every choice for a question.
+ */
+ public function test_get_for_question_returns_choices(): void {
+ $this->resetAfterTest();
+ $qid = 7001;
+ $c1 = $this->make_choice($qid, 'a');
+ $c2 = $this->make_choice($qid, 'b');
+
+ $records = choice_record::get_for_question($qid);
+ $this->assertCount(2, $records);
+ $ids = array_map(fn($r) => $r->get('id'), $records);
+ $this->assertContains($c1, $ids);
+ $this->assertContains($c2, $ids);
+ }
+
+ /**
+ * get_for_question() returns an empty array when the question has no choices.
+ */
+ public function test_get_for_question_empty(): void {
+ $this->resetAfterTest();
+ $this->assertSame([], choice_record::get_for_question(99999));
+ }
+
+ /**
+ * delete_for_question() removes only rows belonging to the given question.
+ */
+ public function test_delete_for_question_scopes_to_question(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $qid = 7002;
+ $otherqid = 7003;
+ $this->make_choice($qid);
+ $this->make_choice($qid);
+ $this->make_choice($otherqid);
+
+ $this->assertTrue(choice_record::delete_for_question($qid));
+
+ $this->assertEquals(0, $DB->count_records('questionnaire_quest_choice', ['questionid' => $qid]));
+ $this->assertEquals(1, $DB->count_records('questionnaire_quest_choice', ['questionid' => $otherqid]));
+ }
+
+ /**
+ * delete_for_question() is a no-op when there are no choices for the question.
+ */
+ public function test_delete_for_question_no_op_when_empty(): void {
+ $this->resetAfterTest();
+ $this->assertTrue(choice_record::delete_for_question(99999));
+ }
+}
diff --git a/tests/local/db/dependency_record_test.php b/tests/local/db/dependency_record_test.php
new file mode 100644
index 000000000..70b27e3f3
--- /dev/null
+++ b/tests/local/db/dependency_record_test.php
@@ -0,0 +1,127 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\local\db\dependency_record.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire\local\db;
+
+/**
+ * Unit tests for mod_questionnaire\local\db\dependency_record.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\local\db\dependency_record
+ */
+final class dependency_record_test extends \advanced_testcase {
+ /**
+ * Insert a dependency row via $DB and return its id.
+ *
+ * @param int $surveyid
+ * @param int $questionid
+ * @param int $dependquestionid
+ * @return int
+ */
+ private function make_dep(int $surveyid, int $questionid, int $dependquestionid): int {
+ global $DB;
+ return $DB->insert_record('questionnaire_dependency', (object)[
+ 'questionid' => $questionid,
+ 'surveyid' => $surveyid,
+ 'dependquestionid' => $dependquestionid,
+ 'dependchoiceid' => 0,
+ 'dependlogic' => 1,
+ 'dependandor' => 'and',
+ ]);
+ }
+
+ /**
+ * get_for_question() returns every dependency rooted at the given question.
+ */
+ public function test_get_for_question(): void {
+ $this->resetAfterTest();
+ $sid = 80;
+ $qid = 81;
+ $this->make_dep($sid, $qid, 90);
+ $this->make_dep($sid, $qid, 91);
+ $this->make_dep($sid, 999, 90); // Unrelated question.
+
+ $records = dependency_record::get_for_question($qid);
+ $this->assertCount(2, $records);
+ }
+
+ /**
+ * get_for_survey() returns every dependency belonging to the survey.
+ */
+ public function test_get_for_survey(): void {
+ $this->resetAfterTest();
+ $sid = 82;
+ $othersid = 83;
+ $this->make_dep($sid, 100, 200);
+ $this->make_dep($sid, 101, 200);
+ $this->make_dep($othersid, 110, 210);
+
+ $records = dependency_record::get_for_survey($sid);
+ $this->assertCount(2, $records);
+ }
+
+ /**
+ * delete_for_survey() removes only the survey's dependencies.
+ */
+ public function test_delete_for_survey_scoped(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $sid = 84;
+ $othersid = 85;
+ $this->make_dep($sid, 100, 200);
+ $this->make_dep($sid, 101, 201);
+ $keep = $this->make_dep($othersid, 110, 210);
+
+ $this->assertTrue(dependency_record::delete_for_survey($sid));
+
+ $this->assertEquals(0, $DB->count_records('questionnaire_dependency', ['surveyid' => $sid]));
+ $this->assertTrue($DB->record_exists('questionnaire_dependency', ['id' => $keep]));
+ }
+
+ /**
+ * delete_for_question() removes dependencies on both sides of the relationship —
+ * those where the question depends on others, and those where others depend on it.
+ */
+ public function test_delete_for_question_removes_both_sides(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $sid = 86;
+ $qid = 300;
+ $other = 301;
+
+ // Qid depends on other.
+ $this->make_dep($sid, $qid, $other);
+ // Other depends on qid (qid is the depend target).
+ $this->make_dep($sid, $other, $qid);
+ // Unrelated.
+ $kept = $this->make_dep($sid, 999, 998);
+
+ $this->assertTrue(dependency_record::delete_for_question($qid));
+
+ $this->assertEquals(0, $DB->count_records('questionnaire_dependency', ['questionid' => $qid]));
+ $this->assertEquals(0, $DB->count_records('questionnaire_dependency', ['dependquestionid' => $qid]));
+ $this->assertTrue($DB->record_exists('questionnaire_dependency', ['id' => $kept]));
+ }
+}
diff --git a/tests/local/db/feedback_record_test.php b/tests/local/db/feedback_record_test.php
new file mode 100644
index 000000000..d0d419acd
--- /dev/null
+++ b/tests/local/db/feedback_record_test.php
@@ -0,0 +1,103 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\local\db\feedback_record.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire\local\db;
+
+/**
+ * Unit tests for mod_questionnaire\local\db\feedback_record.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\local\db\feedback_record
+ */
+final class feedback_record_test extends \advanced_testcase {
+ /**
+ * Insert a feedback row directly via $DB and return its id.
+ *
+ * @param int $sectionid
+ * @param float $minscore
+ * @param float $maxscore
+ * @return int
+ */
+ private function make_feedback(int $sectionid, float $minscore = 0.0, float $maxscore = 100.0): int {
+ global $DB;
+ return $DB->insert_record('questionnaire_feedback', (object)[
+ 'sectionid' => $sectionid,
+ 'feedbacklabel' => '',
+ 'feedbacktext' => '',
+ 'feedbacktextformat' => FORMAT_HTML,
+ 'minscore' => $minscore,
+ 'maxscore' => $maxscore,
+ ]);
+ }
+
+ /**
+ * get_for_section() returns every feedback row for the section.
+ */
+ public function test_get_for_section(): void {
+ $this->resetAfterTest();
+ $sid = 901;
+ $this->make_feedback($sid, 0, 50);
+ $this->make_feedback($sid, 50, 100);
+ $this->make_feedback(902, 0, 100); // Different section.
+
+ $this->assertCount(2, feedback_record::get_for_section($sid));
+ $this->assertCount(0, feedback_record::get_for_section(999));
+ }
+
+ /**
+ * get_for_section() honors the sort + order arguments.
+ */
+ public function test_get_for_section_sorted(): void {
+ $this->resetAfterTest();
+ $sid = 903;
+ $low = $this->make_feedback($sid, 0, 50);
+ $high = $this->make_feedback($sid, 75, 100);
+ $mid = $this->make_feedback($sid, 50, 75);
+
+ $sorted = array_values(feedback_record::get_for_section($sid, 'minscore', 'DESC'));
+ $this->assertCount(3, $sorted);
+ $this->assertSame($high, $sorted[0]->get('id'));
+ $this->assertSame($mid, $sorted[1]->get('id'));
+ $this->assertSame($low, $sorted[2]->get('id'));
+ }
+
+ /**
+ * delete_for_section() removes only feedback rows for the given section.
+ */
+ public function test_delete_for_section_scoped(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $target = 904;
+ $other = 905;
+ $this->make_feedback($target);
+ $this->make_feedback($target);
+ $keep = $this->make_feedback($other);
+
+ $this->assertTrue(feedback_record::delete_for_section($target));
+
+ $this->assertEquals(0, $DB->count_records('questionnaire_feedback', ['sectionid' => $target]));
+ $this->assertTrue($DB->record_exists('questionnaire_feedback', ['id' => $keep]));
+ }
+}
diff --git a/tests/local/db/feedback_section_record_test.php b/tests/local/db/feedback_section_record_test.php
new file mode 100644
index 000000000..232afcc2f
--- /dev/null
+++ b/tests/local/db/feedback_section_record_test.php
@@ -0,0 +1,120 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\local\db\feedback_section_record.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire\local\db;
+
+/**
+ * Unit tests for mod_questionnaire\local\db\feedback_section_record.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\local\db\feedback_section_record
+ */
+final class feedback_section_record_test extends \advanced_testcase {
+ /**
+ * Insert a feedback-section row directly via $DB and return its id.
+ *
+ * @param int $surveyid
+ * @param int $sectionnum
+ * @return int
+ */
+ private function make_section(int $surveyid, int $sectionnum): int {
+ global $DB;
+ return $DB->insert_record('questionnaire_fb_sections', (object)[
+ 'surveyid' => $surveyid,
+ 'section' => $sectionnum,
+ 'scorecalculation' => '',
+ 'sectionlabel' => 'L' . $sectionnum,
+ 'sectionheading' => '',
+ 'sectionheadingformat' => FORMAT_HTML,
+ ]);
+ }
+
+ /**
+ * get_for_survey() returns every feedback section for the survey.
+ */
+ public function test_get_for_survey(): void {
+ $this->resetAfterTest();
+ $sid = 401;
+ $this->make_section($sid, 1);
+ $this->make_section($sid, 2);
+ $this->make_section(402, 1); // Different survey.
+
+ $this->assertCount(2, feedback_section_record::get_for_survey($sid));
+ $this->assertCount(0, feedback_section_record::get_for_survey(999));
+ }
+
+ /**
+ * get_for_survey() honors the sort + order arguments.
+ */
+ public function test_get_for_survey_sorted(): void {
+ $this->resetAfterTest();
+ $sid = 403;
+ $third = $this->make_section($sid, 3);
+ $first = $this->make_section($sid, 1);
+ $second = $this->make_section($sid, 2);
+
+ $sorted = array_values(feedback_section_record::get_for_survey($sid, 'section'));
+ $this->assertCount(3, $sorted);
+ $this->assertSame($first, $sorted[0]->get('id'));
+ $this->assertSame($second, $sorted[1]->get('id'));
+ $this->assertSame($third, $sorted[2]->get('id'));
+ }
+
+ /**
+ * max_section_for_survey() returns the highest section number, or 0 if empty.
+ */
+ public function test_max_section_for_survey(): void {
+ $this->resetAfterTest();
+ $sid = 404;
+
+ $this->assertSame(0, feedback_section_record::max_section_for_survey($sid));
+
+ $this->make_section($sid, 1);
+ $this->make_section($sid, 5);
+ $this->make_section($sid, 3);
+
+ $this->assertSame(5, feedback_section_record::max_section_for_survey($sid));
+ // Other surveys are not considered.
+ $this->assertSame(0, feedback_section_record::max_section_for_survey(999));
+ }
+
+ /**
+ * delete_for_survey() removes only the survey's section rows.
+ */
+ public function test_delete_for_survey_scoped(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $sid = 405;
+ $other = 406;
+ $this->make_section($sid, 1);
+ $this->make_section($sid, 2);
+ $keep = $this->make_section($other, 1);
+
+ $this->assertTrue(feedback_section_record::delete_for_survey($sid));
+
+ $this->assertEquals(0, $DB->count_records('questionnaire_fb_sections', ['surveyid' => $sid]));
+ $this->assertTrue($DB->record_exists('questionnaire_fb_sections', ['id' => $keep]));
+ }
+}
diff --git a/tests/local/db/question_record_test.php b/tests/local/db/question_record_test.php
new file mode 100644
index 000000000..4e4ba8b45
--- /dev/null
+++ b/tests/local/db/question_record_test.php
@@ -0,0 +1,314 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\local\db\question_record.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire\local\db;
+
+use mod_questionnaire\local\question_type;
+
+/**
+ * Unit tests for mod_questionnaire\local\db\question_record.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\local\db\question_record
+ */
+final class question_record_test extends \advanced_testcase {
+ /**
+ * Insert a question row via $DB and return its id.
+ *
+ * @param int $surveyid
+ * @param int $position
+ * @param int $typeid
+ * @param int|null $deleted
+ * @return int
+ */
+ private function make_question(int $surveyid, int $position, int $typeid = 1, ?int $deleted = null): int {
+ global $DB;
+ return $DB->insert_record('questionnaire_question', (object)[
+ 'surveyid' => $surveyid,
+ 'name' => 'Q' . $position,
+ 'typeid' => $typeid,
+ 'length' => 0,
+ 'precise' => 0,
+ 'position' => $position,
+ 'content' => 'content ' . $position,
+ 'required' => 'n',
+ 'deleted' => $deleted,
+ ]);
+ }
+
+ /**
+ * get_active_for_survey() returns only non-deleted questions, ordered by position, keyed by id.
+ */
+ public function test_get_active_for_survey(): void {
+ $this->resetAfterTest();
+ $sid = 8001;
+ $third = $this->make_question($sid, 3);
+ $first = $this->make_question($sid, 1);
+ $second = $this->make_question($sid, 2);
+ $this->make_question($sid, 4, 1, time()); // Soft-deleted — excluded.
+
+ $records = question_record::get_active_for_survey($sid);
+ $this->assertCount(3, $records);
+
+ $ordered = array_values($records);
+ $this->assertSame($first, $ordered[0]->get('id'));
+ $this->assertSame($second, $ordered[1]->get('id'));
+ $this->assertSame($third, $ordered[2]->get('id'));
+ }
+
+ /**
+ * get_for_survey() returns every question for the survey, including soft-deleted ones.
+ */
+ public function test_get_for_survey_includes_deleted(): void {
+ $this->resetAfterTest();
+ $sid = 8002;
+ $this->make_question($sid, 1);
+ $this->make_question($sid, 2, 1, time()); // Soft-deleted.
+ $this->make_question(8003, 1); // Different survey.
+
+ $this->assertCount(2, question_record::get_for_survey($sid));
+ $this->assertCount(0, question_record::get_for_survey(99999));
+ }
+
+ /**
+ * get_for_type() returns questions of the given type, optionally filtered by survey.
+ */
+ public function test_get_for_type(): void {
+ $this->resetAfterTest();
+ $sida = 8004;
+ $sidb = 8005;
+ $this->make_question($sida, 1, question_type::QUESRATE);
+ $this->make_question($sida, 2, question_type::QUESRATE);
+ $this->make_question($sida, 3, question_type::QUESTEXT);
+ $this->make_question($sidb, 1, question_type::QUESRATE);
+
+ $this->assertCount(3, question_record::get_for_type(question_type::QUESRATE));
+ $this->assertCount(2, question_record::get_for_type(question_type::QUESRATE, $sida));
+ $this->assertCount(1, question_record::get_for_type(question_type::QUESRATE, $sidb));
+ $this->assertCount(0, question_record::get_for_type(question_type::QUESYESNO));
+ }
+
+ /**
+ * get_deleted_for_survey() returns soft-deleted questions, excluding pagebreaks,
+ * ordered by deletion time DESC.
+ */
+ public function test_get_deleted_for_survey(): void {
+ $this->resetAfterTest();
+ $sid = 8006;
+ $this->make_question($sid, 1); // Active — excluded.
+ $older = $this->make_question($sid, 2, 1, time() - 3600);
+ $newer = $this->make_question($sid, 3, 1, time());
+ $this->make_question($sid, 4, question_type::QUESPAGEBREAK, time()); // Pagebreak — excluded.
+
+ $records = question_record::get_deleted_for_survey($sid);
+ $this->assertCount(2, $records);
+ $ordered = array_values($records);
+ $this->assertSame($newer, $ordered[0]->get('id'));
+ $this->assertSame($older, $ordered[1]->get('id'));
+ }
+
+ /**
+ * get_soft_deleted() returns the row only when it's actually soft-deleted, otherwise null.
+ */
+ public function test_get_soft_deleted(): void {
+ $this->resetAfterTest();
+ $sid = 8007;
+ $active = $this->make_question($sid, 1);
+ $deleted = $this->make_question($sid, 2, 1, time());
+
+ $this->assertNull(question_record::get_soft_deleted($active, $sid));
+ $this->assertNull(question_record::get_soft_deleted($deleted, 99999)); // Wrong survey.
+
+ $found = question_record::get_soft_deleted($deleted, $sid);
+ $this->assertNotNull($found);
+ $this->assertSame($deleted, $found->get('id'));
+ }
+
+ /**
+ * max_active_position_for_survey() returns the highest position of active questions, or 0.
+ */
+ public function test_max_active_position_for_survey(): void {
+ $this->resetAfterTest();
+ $sid = 8008;
+
+ $this->assertSame(0, question_record::max_active_position_for_survey($sid));
+
+ $this->make_question($sid, 1);
+ $this->make_question($sid, 5);
+ $this->make_question($sid, 3);
+ $this->make_question($sid, 9, 1, time()); // Soft-deleted — excluded.
+
+ $this->assertSame(5, question_record::max_active_position_for_survey($sid));
+ $this->assertSame(0, question_record::max_active_position_for_survey(99999));
+ }
+
+ /**
+ * count_active_before_position() counts only matching-type, active questions strictly below the position.
+ */
+ public function test_count_active_before_position(): void {
+ $this->resetAfterTest();
+ $sid = 8108;
+ $pb = QUESPAGEBREAK;
+
+ $this->make_question($sid, 1, $pb);
+ $this->make_question($sid, 3, $pb);
+ $this->make_question($sid, 5, $pb);
+ $this->make_question($sid, 4, 1); // Wrong typeid — excluded.
+ $this->make_question($sid, 2, $pb, time()); // Soft-deleted — excluded.
+
+ $this->assertSame(2, question_record::count_active_before_position($sid, $pb, 5));
+ $this->assertSame(3, question_record::count_active_before_position($sid, $pb, 99));
+ $this->assertSame(0, question_record::count_active_before_position($sid, $pb, 1));
+ $this->assertSame(0, question_record::count_active_before_position(99999, $pb, 99));
+ }
+
+ /**
+ * update_position() sets the position field on the specified row.
+ */
+ public function test_update_position(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $sid = 8009;
+ $qid = $this->make_question($sid, 1);
+
+ $this->assertTrue(question_record::update_position($qid, 7));
+
+ $this->assertSame(7, (int) $DB->get_field('questionnaire_question', 'position', ['id' => $qid]));
+ }
+
+ /**
+ * soft_delete() stamps the deleted field with a current timestamp.
+ */
+ public function test_soft_delete(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $sid = 8010;
+ $qid = $this->make_question($sid, 1);
+
+ $before = time();
+ $this->assertTrue(question_record::soft_delete($qid));
+ $deleted = (int) $DB->get_field('questionnaire_question', 'deleted', ['id' => $qid]);
+
+ $this->assertGreaterThanOrEqual($before, $deleted);
+ }
+
+ /**
+ * get_active_after_position() returns active questions with greater positions, ordered ascending.
+ */
+ public function test_get_active_after_position(): void {
+ $this->resetAfterTest();
+ $sid = 8011;
+ $p1 = $this->make_question($sid, 1);
+ $p2 = $this->make_question($sid, 2);
+ $p3 = $this->make_question($sid, 3);
+ $this->make_question($sid, 4, 1, time()); // Soft-deleted — excluded.
+
+ $records = array_values(question_record::get_active_after_position($sid, 1));
+ $this->assertCount(2, $records);
+ $this->assertSame($p2, $records[0]->get('id'));
+ $this->assertSame($p3, $records[1]->get('id'));
+
+ $this->assertCount(0, question_record::get_active_after_position($sid, 10));
+ }
+
+ /**
+ * create_pagebreak() inserts a pagebreak row at the given position.
+ */
+ public function test_create_pagebreak(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $sid = 8012;
+ $rec = question_record::create_pagebreak($sid, 5);
+
+ $this->assertGreaterThan(0, $rec->get('id'));
+ $row = $DB->get_record('questionnaire_question', ['id' => $rec->get('id')]);
+ $this->assertEquals($sid, $row->surveyid);
+ $this->assertEquals(question_type::QUESPAGEBREAK, $row->typeid);
+ $this->assertEquals(5, $row->position);
+ $this->assertEquals('break', $row->content);
+ }
+
+ /**
+ * delete_for_survey() removes only the given survey's question rows.
+ */
+ public function test_delete_for_survey_scoped(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $sid = 8013;
+ $other = 8014;
+ $this->make_question($sid, 1);
+ $this->make_question($sid, 2);
+ $keep = $this->make_question($other, 1);
+
+ $this->assertTrue(question_record::delete_for_survey($sid));
+
+ $this->assertEquals(0, $DB->count_records('questionnaire_question', ['surveyid' => $sid]));
+ $this->assertTrue($DB->record_exists('questionnaire_question', ['id' => $keep]));
+ }
+
+ /**
+ * delete_soft_deleted() permanently removes a soft-deleted row, but only if it's soft-deleted.
+ */
+ public function test_delete_soft_deleted(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $sid = 8015;
+ $active = $this->make_question($sid, 1);
+ $deleted = $this->make_question($sid, 2, 1, time());
+
+ // Active rows are not removed.
+ $this->assertTrue(question_record::delete_soft_deleted($active, $sid));
+ $this->assertTrue($DB->record_exists('questionnaire_question', ['id' => $active]));
+
+ // Wrong survey: not removed.
+ $this->assertTrue(question_record::delete_soft_deleted($deleted, 99999));
+ $this->assertTrue($DB->record_exists('questionnaire_question', ['id' => $deleted]));
+
+ // Correctly scoped soft-deleted row is removed.
+ $this->assertTrue(question_record::delete_soft_deleted($deleted, $sid));
+ $this->assertFalse($DB->record_exists('questionnaire_question', ['id' => $deleted]));
+ }
+
+ /**
+ * delete_soft_deleted_pagebreaks_for_survey() removes only soft-deleted pagebreak rows.
+ */
+ public function test_delete_soft_deleted_pagebreaks_for_survey(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $sid = 8016;
+ $other = 8017;
+ $activepb = $this->make_question($sid, 1, question_type::QUESPAGEBREAK);
+ $deletedpb = $this->make_question($sid, 2, question_type::QUESPAGEBREAK, time());
+ $deletedquestion = $this->make_question($sid, 3, 1, time()); // Soft-deleted but not pagebreak.
+ $otherdeleted = $this->make_question($other, 1, question_type::QUESPAGEBREAK, time());
+
+ $this->assertTrue(question_record::delete_soft_deleted_pagebreaks_for_survey($sid));
+
+ $this->assertTrue($DB->record_exists('questionnaire_question', ['id' => $activepb]));
+ $this->assertFalse($DB->record_exists('questionnaire_question', ['id' => $deletedpb]));
+ $this->assertTrue($DB->record_exists('questionnaire_question', ['id' => $deletedquestion]));
+ $this->assertTrue($DB->record_exists('questionnaire_question', ['id' => $otherdeleted]));
+ }
+}
diff --git a/tests/local/db/question_type_record_test.php b/tests/local/db/question_type_record_test.php
new file mode 100644
index 000000000..8db3d2336
--- /dev/null
+++ b/tests/local/db/question_type_record_test.php
@@ -0,0 +1,77 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\local\db\question_type_record.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire\local\db;
+
+use mod_questionnaire\local\question_type;
+
+/**
+ * Unit tests for mod_questionnaire\local\db\question_type_record.
+ *
+ * The questionnaire_question_type table is populated at install time,
+ * so the test relies on the pre-seeded entries rather than inserting new ones.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\local\db\question_type_record
+ */
+final class question_type_record_test extends \advanced_testcase {
+ /**
+ * get_by_typeid() returns the installed record for a known typeid.
+ */
+ public function test_get_by_typeid_returns_known_type(): void {
+ $this->resetAfterTest();
+ $record = question_type_record::get_by_typeid(question_type::QUESTEXT);
+
+ $this->assertNotFalse($record);
+ $this->assertSame(question_type::QUESTEXT, (int) $record->get('typeid'));
+ }
+
+ /**
+ * get_by_typeid() returns false for an unknown typeid.
+ */
+ public function test_get_by_typeid_returns_false_for_unknown(): void {
+ $this->resetAfterTest();
+ $this->assertFalse(question_type_record::get_by_typeid(9999));
+ }
+
+ /**
+ * from_typeid() returns the installed record for a known typeid.
+ */
+ public function test_from_typeid_returns_known_type(): void {
+ $this->resetAfterTest();
+ $record = question_type_record::from_typeid(question_type::QUESYESNO);
+
+ $this->assertNotNull($record);
+ $this->assertSame(question_type::QUESYESNO, (int) $record->get('typeid'));
+ }
+
+ /**
+ * from_typeid() returns null for an unknown typeid.
+ */
+ public function test_from_typeid_returns_null_for_unknown(): void {
+ $this->resetAfterTest();
+ $this->assertNull(question_type_record::from_typeid(9999));
+ }
+}
diff --git a/tests/local/db/questionnaire_record_test.php b/tests/local/db/questionnaire_record_test.php
new file mode 100644
index 000000000..9d16a3d97
--- /dev/null
+++ b/tests/local/db/questionnaire_record_test.php
@@ -0,0 +1,120 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\local\db\questionnaire_record.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire\local\db;
+
+/**
+ * Unit tests for mod_questionnaire\local\db\questionnaire_record.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\local\db\questionnaire_record
+ */
+final class questionnaire_record_test extends \advanced_testcase {
+ /**
+ * Insert a questionnaire row via $DB and return its id.
+ *
+ * @param int $courseid
+ * @param int $sid
+ * @param string $name
+ * @return int
+ */
+ private function make_questionnaire(int $courseid, int $sid, string $name = 'Q'): int {
+ global $DB;
+ return $DB->insert_record('questionnaire', (object)[
+ 'course' => $courseid,
+ 'name' => $name,
+ 'intro' => '',
+ 'introformat' => FORMAT_HTML,
+ 'qtype' => 0,
+ 'respondenttype' => 'fullname',
+ 'respeligible' => 'all',
+ 'respview' => 0,
+ 'sid' => $sid,
+ 'timemodified' => time(),
+ ]);
+ }
+
+ /**
+ * get_for_survey() returns the first questionnaire pointing at the survey, or null.
+ */
+ public function test_get_for_survey(): void {
+ $this->resetAfterTest();
+ $sid = 7501;
+ $this->assertNull(questionnaire_record::get_for_survey($sid));
+
+ $qid = $this->make_questionnaire(1, $sid);
+ $found = questionnaire_record::get_for_survey($sid);
+ $this->assertNotNull($found);
+ $this->assertSame($qid, $found->get('id'));
+ }
+
+ /**
+ * get_for_survey_in_course() finds the questionnaire whose course owns the survey.
+ */
+ public function test_get_for_survey_in_course(): void {
+ $this->resetAfterTest();
+ $sid = 7502;
+ $course1 = 11;
+ $course2 = 22;
+
+ $q1 = $this->make_questionnaire($course1, $sid, 'Original');
+ $q2 = $this->make_questionnaire($course2, $sid, 'Copy');
+
+ $found = questionnaire_record::get_for_survey_in_course($sid, $course1);
+ $this->assertNotNull($found);
+ $this->assertSame($q1, $found->get('id'));
+
+ $found2 = questionnaire_record::get_for_survey_in_course($sid, $course2);
+ $this->assertSame($q2, $found2->get('id'));
+
+ $this->assertNull(questionnaire_record::get_for_survey_in_course($sid, 999));
+ }
+
+ /**
+ * create_from_formdata() creates a new questionnaire row from a stdClass.
+ */
+ public function test_create_from_formdata(): void {
+ global $DB;
+ $this->resetAfterTest();
+
+ $formdata = (object)[
+ 'course' => 5,
+ 'name' => 'Form created',
+ 'intro' => '',
+ 'introformat' => FORMAT_HTML,
+ 'qtype' => 0,
+ 'respondenttype' => 'fullname',
+ 'respeligible' => 'all',
+ 'respview' => 0,
+ 'sid' => 123,
+ 'timemodified' => time(),
+ ];
+ $record = questionnaire_record::create_from_formdata($formdata);
+
+ $this->assertGreaterThan(0, $record->get('id'));
+ $this->assertTrue($DB->record_exists('questionnaire', ['id' => $record->get('id')]));
+ $this->assertSame('Form created', $record->get('name'));
+ }
+}
diff --git a/tests/local/db/response_bool_record_test.php b/tests/local/db/response_bool_record_test.php
new file mode 100644
index 000000000..a59fd8b25
--- /dev/null
+++ b/tests/local/db/response_bool_record_test.php
@@ -0,0 +1,55 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\local\db\response_bool_record.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire\local\db;
+
+/**
+ * Unit tests for mod_questionnaire\local\db\response_bool_record.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\local\db\response_bool_record
+ */
+final class response_bool_record_test extends \advanced_testcase {
+ /**
+ * get_for_response() returns every yes/no answer for the response.
+ */
+ public function test_get_for_response(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $rid = 11001;
+ $DB->insert_record('questionnaire_response_bool', (object)[
+ 'responseid' => $rid, 'questionid' => 1, 'choiceid' => 'y',
+ ]);
+ $DB->insert_record('questionnaire_response_bool', (object)[
+ 'responseid' => $rid, 'questionid' => 2, 'choiceid' => 'n',
+ ]);
+ $DB->insert_record('questionnaire_response_bool', (object)[
+ 'responseid' => 11002, 'questionid' => 1, 'choiceid' => 'y',
+ ]);
+
+ $this->assertCount(2, response_bool_record::get_for_response($rid));
+ $this->assertCount(0, response_bool_record::get_for_response(99999));
+ }
+}
diff --git a/tests/local/db/response_date_record_test.php b/tests/local/db/response_date_record_test.php
new file mode 100644
index 000000000..553c80842
--- /dev/null
+++ b/tests/local/db/response_date_record_test.php
@@ -0,0 +1,55 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\local\db\response_date_record.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire\local\db;
+
+/**
+ * Unit tests for mod_questionnaire\local\db\response_date_record.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\local\db\response_date_record
+ */
+final class response_date_record_test extends \advanced_testcase {
+ /**
+ * get_for_response() returns every date answer for the response.
+ */
+ public function test_get_for_response(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $rid = 12001;
+ $DB->insert_record('questionnaire_response_date', (object)[
+ 'responseid' => $rid, 'questionid' => 1, 'response' => '2026-01-01',
+ ]);
+ $DB->insert_record('questionnaire_response_date', (object)[
+ 'responseid' => $rid, 'questionid' => 2, 'response' => '2026-02-02',
+ ]);
+ $DB->insert_record('questionnaire_response_date', (object)[
+ 'responseid' => 12002, 'questionid' => 1, 'response' => '2026-03-03',
+ ]);
+
+ $this->assertCount(2, response_date_record::get_for_response($rid));
+ $this->assertCount(0, response_date_record::get_for_response(99999));
+ }
+}
diff --git a/tests/local/db/response_file_record_test.php b/tests/local/db/response_file_record_test.php
new file mode 100644
index 000000000..5919b5603
--- /dev/null
+++ b/tests/local/db/response_file_record_test.php
@@ -0,0 +1,55 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\local\db\response_file_record.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire\local\db;
+
+/**
+ * Unit tests for mod_questionnaire\local\db\response_file_record.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\local\db\response_file_record
+ */
+final class response_file_record_test extends \advanced_testcase {
+ /**
+ * get_for_response() returns every file answer for the response.
+ */
+ public function test_get_for_response(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $rid = 13001;
+ $DB->insert_record('questionnaire_response_file', (object)[
+ 'responseid' => $rid, 'questionid' => 1, 'fileid' => 100,
+ ]);
+ $DB->insert_record('questionnaire_response_file', (object)[
+ 'responseid' => $rid, 'questionid' => 1, 'fileid' => 101,
+ ]);
+ $DB->insert_record('questionnaire_response_file', (object)[
+ 'responseid' => 13002, 'questionid' => 1, 'fileid' => 102,
+ ]);
+
+ $this->assertCount(2, response_file_record::get_for_response($rid));
+ $this->assertCount(0, response_file_record::get_for_response(99999));
+ }
+}
diff --git a/tests/local/db/response_multiple_record_test.php b/tests/local/db/response_multiple_record_test.php
new file mode 100644
index 000000000..85fecfc20
--- /dev/null
+++ b/tests/local/db/response_multiple_record_test.php
@@ -0,0 +1,55 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\local\db\response_multiple_record.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire\local\db;
+
+/**
+ * Unit tests for mod_questionnaire\local\db\response_multiple_record.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\local\db\response_multiple_record
+ */
+final class response_multiple_record_test extends \advanced_testcase {
+ /**
+ * get_for_response() returns every multiple-choice answer for the response.
+ */
+ public function test_get_for_response(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $rid = 14001;
+ $DB->insert_record('questionnaire_resp_multiple', (object)[
+ 'responseid' => $rid, 'questionid' => 1, 'choiceid' => 11,
+ ]);
+ $DB->insert_record('questionnaire_resp_multiple', (object)[
+ 'responseid' => $rid, 'questionid' => 1, 'choiceid' => 12,
+ ]);
+ $DB->insert_record('questionnaire_resp_multiple', (object)[
+ 'responseid' => 14002, 'questionid' => 1, 'choiceid' => 11,
+ ]);
+
+ $this->assertCount(2, response_multiple_record::get_for_response($rid));
+ $this->assertCount(0, response_multiple_record::get_for_response(99999));
+ }
+}
diff --git a/tests/local/db/response_other_record_test.php b/tests/local/db/response_other_record_test.php
new file mode 100644
index 000000000..dfcded188
--- /dev/null
+++ b/tests/local/db/response_other_record_test.php
@@ -0,0 +1,55 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\local\db\response_other_record.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire\local\db;
+
+/**
+ * Unit tests for mod_questionnaire\local\db\response_other_record.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\local\db\response_other_record
+ */
+final class response_other_record_test extends \advanced_testcase {
+ /**
+ * get_for_response() returns every "other" answer for the response.
+ */
+ public function test_get_for_response(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $rid = 15001;
+ $DB->insert_record('questionnaire_response_other', (object)[
+ 'responseid' => $rid, 'questionid' => 1, 'choiceid' => 5, 'response' => 'free text 1',
+ ]);
+ $DB->insert_record('questionnaire_response_other', (object)[
+ 'responseid' => $rid, 'questionid' => 2, 'choiceid' => 5, 'response' => 'free text 2',
+ ]);
+ $DB->insert_record('questionnaire_response_other', (object)[
+ 'responseid' => 15002, 'questionid' => 1, 'choiceid' => 5, 'response' => 'other',
+ ]);
+
+ $this->assertCount(2, response_other_record::get_for_response($rid));
+ $this->assertCount(0, response_other_record::get_for_response(99999));
+ }
+}
diff --git a/tests/local/db/response_rank_record_test.php b/tests/local/db/response_rank_record_test.php
new file mode 100644
index 000000000..769e2cf67
--- /dev/null
+++ b/tests/local/db/response_rank_record_test.php
@@ -0,0 +1,129 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\local\db\response_rank_record.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire\local\db;
+
+/**
+ * Unit tests for mod_questionnaire\local\db\response_rank_record.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\local\db\response_rank_record
+ */
+final class response_rank_record_test extends \advanced_testcase {
+ /**
+ * Insert a rank row via $DB and return its id.
+ *
+ * @param int $responseid
+ * @param int $questionid
+ * @param int $choiceid
+ * @param int $rankvalue
+ * @return int
+ */
+ private function make_rank(int $responseid, int $questionid, int $choiceid, int $rankvalue): int {
+ global $DB;
+ return $DB->insert_record('questionnaire_response_rank', (object)[
+ 'responseid' => $responseid,
+ 'questionid' => $questionid,
+ 'choiceid' => $choiceid,
+ 'rankvalue' => $rankvalue,
+ ]);
+ }
+
+ /**
+ * get_for_response() returns every rank row for the response.
+ */
+ public function test_get_for_response(): void {
+ $this->resetAfterTest();
+ $rid = 501;
+ $this->make_rank($rid, 1, 10, 2);
+ $this->make_rank($rid, 1, 11, 3);
+ $this->make_rank(502, 1, 10, 1); // Different response.
+
+ $this->assertCount(2, response_rank_record::get_for_response($rid));
+ }
+
+ /**
+ * get_for_question() returns every rank row for the question.
+ */
+ public function test_get_for_question(): void {
+ $this->resetAfterTest();
+ $qid = 600;
+ $this->make_rank(1, $qid, 1, 0);
+ $this->make_rank(2, $qid, 1, 1);
+ $this->make_rank(1, 601, 1, 0); // Different question.
+
+ $this->assertCount(2, response_rank_record::get_for_question($qid));
+ $this->assertCount(0, response_rank_record::get_for_question(99999));
+ }
+
+ /**
+ * increment_rankvalues() bumps every non-negative rankvalue by one across all rows.
+ */
+ public function test_increment_rankvalues_all_rows(): void {
+ global $DB;
+ $this->resetAfterTest();
+
+ $a = $this->make_rank(1, 1, 1, 0);
+ $b = $this->make_rank(1, 1, 2, 3);
+ $c = $this->make_rank(1, 1, 3, -1); // Sentinel; should not increment.
+
+ $this->assertTrue(response_rank_record::increment_rankvalues());
+
+ $this->assertSame(1, (int) $DB->get_field('questionnaire_response_rank', 'rankvalue', ['id' => $a]));
+ $this->assertSame(4, (int) $DB->get_field('questionnaire_response_rank', 'rankvalue', ['id' => $b]));
+ $this->assertSame(-1, (int) $DB->get_field('questionnaire_response_rank', 'rankvalue', ['id' => $c]));
+ }
+
+ /**
+ * increment_rankvalues() with a question-id filter only touches matching rows.
+ */
+ public function test_increment_rankvalues_filtered_by_question(): void {
+ global $DB;
+ $this->resetAfterTest();
+
+ $target = 700;
+ $other = 701;
+ $a = $this->make_rank(1, $target, 1, 2);
+ $b = $this->make_rank(2, $other, 1, 2);
+
+ $this->assertTrue(response_rank_record::increment_rankvalues([$target]));
+
+ $this->assertSame(3, (int) $DB->get_field('questionnaire_response_rank', 'rankvalue', ['id' => $a]));
+ $this->assertSame(2, (int) $DB->get_field('questionnaire_response_rank', 'rankvalue', ['id' => $b]));
+ }
+
+ /**
+ * increment_rankvalues() with an empty filter is a no-op and returns true.
+ */
+ public function test_increment_rankvalues_empty_filter_noop(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $a = $this->make_rank(1, 1, 1, 5);
+
+ $this->assertTrue(response_rank_record::increment_rankvalues([]));
+
+ $this->assertSame(5, (int) $DB->get_field('questionnaire_response_rank', 'rankvalue', ['id' => $a]));
+ }
+}
diff --git a/tests/local/db/response_record_test.php b/tests/local/db/response_record_test.php
new file mode 100644
index 000000000..45fce3a82
--- /dev/null
+++ b/tests/local/db/response_record_test.php
@@ -0,0 +1,313 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\local\db\response_record.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire\local\db;
+
+/**
+ * Unit tests for mod_questionnaire\local\db\response_record.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\local\db\response_record
+ */
+final class response_record_test extends \advanced_testcase {
+ /**
+ * Insert a questionnaire_response row via $DB and return its id.
+ *
+ * @param int $questionnaireid
+ * @param int $userid
+ * @param string $complete 'y' or 'n'.
+ * @param int|null $submitted
+ * @return int
+ */
+ private function make_response(int $questionnaireid, int $userid, string $complete = 'y', ?int $submitted = null): int {
+ global $DB;
+ return $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $questionnaireid,
+ 'userid' => $userid,
+ 'submitted' => $submitted ?? time(),
+ 'complete' => $complete,
+ 'grade' => 0,
+ ]);
+ }
+
+ /**
+ * Insert a questionnaire row pointing at a specific survey.
+ *
+ * @param int $courseid
+ * @param int $sid
+ * @return int
+ */
+ private function make_questionnaire(int $courseid, int $sid): int {
+ global $DB;
+ return $DB->insert_record('questionnaire', (object)[
+ 'course' => $courseid,
+ 'name' => 'Q',
+ 'intro' => '',
+ 'introformat' => FORMAT_HTML,
+ 'qtype' => 0,
+ 'respondenttype' => 'fullname',
+ 'respeligible' => 'all',
+ 'respview' => 0,
+ 'sid' => $sid,
+ 'timemodified' => time(),
+ ]);
+ }
+
+ /**
+ * Insert a survey row.
+ *
+ * @param int $courseid
+ * @param string $realm
+ * @param string $name
+ * @return int
+ */
+ private function make_survey(int $courseid, string $realm = 'private', string $name = 'S'): int {
+ global $DB;
+ return $DB->insert_record('questionnaire_survey', (object)[
+ 'name' => $name,
+ 'courseid' => $courseid,
+ 'realm' => $realm,
+ 'status' => 0,
+ 'title' => $name,
+ ]);
+ }
+
+ /**
+ * get_or_null() returns the record when it exists and null when it doesn't.
+ */
+ public function test_get_or_null(): void {
+ $this->resetAfterTest();
+ $rid = $this->make_response(8000, 1, 'y');
+
+ $record = response_record::get_or_null($rid);
+ $this->assertInstanceOf(response_record::class, $record);
+ $this->assertEquals($rid, $record->get('id'));
+ $this->assertEquals(8000, $record->get('questionnaireid'));
+
+ $this->assertNull(response_record::get_or_null(999999));
+ $this->assertNull(response_record::get_or_null(0));
+ }
+
+ /**
+ * get_course_fullname() returns the owning course's fullname for a complete response.
+ */
+ public function test_get_course_fullname(): void {
+ $this->resetAfterTest();
+ $course = $this->getDataGenerator()->create_course(['fullname' => 'Shared course']);
+ $sid = $this->make_survey((int)$course->id, 'public');
+ $qid = $this->make_questionnaire((int)$course->id, $sid);
+ $completerid = $this->make_response($qid, 1, 'y');
+ $incompleterid = $this->make_response($qid, 1, 'n');
+
+ $this->assertSame('Shared course', response_record::get_course_fullname($completerid));
+ $this->assertNull(response_record::get_course_fullname($incompleterid));
+ $this->assertNull(response_record::get_course_fullname(999999));
+ }
+
+ /**
+ * get_for_questionnaire() returns every response for the questionnaire.
+ */
+ public function test_get_for_questionnaire(): void {
+ $this->resetAfterTest();
+ $qid = 9001;
+ $this->make_response($qid, 1, 'y');
+ $this->make_response($qid, 2, 'n');
+ $this->make_response(9002, 1, 'y');
+
+ $this->assertCount(2, response_record::get_for_questionnaire($qid));
+ $this->assertCount(0, response_record::get_for_questionnaire(99999));
+ }
+
+ /**
+ * get_complete_for_user() returns only the user's complete responses.
+ */
+ public function test_get_complete_for_user(): void {
+ $this->resetAfterTest();
+ $qid = 9003;
+ $userid = 42;
+ $this->make_response($qid, $userid, 'y');
+ $this->make_response($qid, $userid, 'y');
+ $this->make_response($qid, $userid, 'n'); // Incomplete — excluded.
+ $this->make_response($qid, 43, 'y'); // Other user — excluded.
+
+ $this->assertCount(2, response_record::get_complete_for_user($qid, $userid));
+ }
+
+ /**
+ * user_has_complete_response() returns true only if a complete response exists.
+ */
+ public function test_user_has_complete_response(): void {
+ $this->resetAfterTest();
+ $qid = 9004;
+ $userid = 50;
+
+ $this->assertFalse(response_record::user_has_complete_response($qid, $userid));
+
+ $this->make_response($qid, $userid, 'n');
+ $this->assertFalse(response_record::user_has_complete_response($qid, $userid));
+
+ $this->make_response($qid, $userid, 'y');
+ $this->assertTrue(response_record::user_has_complete_response($qid, $userid));
+ }
+
+ /**
+ * user_has_saved_response() returns true only if an incomplete response exists.
+ */
+ public function test_user_has_saved_response(): void {
+ $this->resetAfterTest();
+ $qid = 9005;
+ $userid = 51;
+
+ $this->assertFalse(response_record::user_has_saved_response($qid, $userid));
+
+ $this->make_response($qid, $userid, 'y');
+ $this->assertFalse(response_record::user_has_saved_response($qid, $userid));
+
+ $this->make_response($qid, $userid, 'n');
+ $this->assertTrue(response_record::user_has_saved_response($qid, $userid));
+ }
+
+ /**
+ * get_latest_incomplete() returns the most recent incomplete response, or null.
+ */
+ public function test_get_latest_incomplete(): void {
+ $this->resetAfterTest();
+ $qid = 9006;
+ $userid = 52;
+
+ $this->assertNull(response_record::get_latest_incomplete($qid, $userid));
+
+ $older = $this->make_response($qid, $userid, 'n', time() - 3600);
+ $newer = $this->make_response($qid, $userid, 'n', time());
+ $this->make_response($qid, $userid, 'y'); // Complete — excluded.
+
+ $latest = response_record::get_latest_incomplete($qid, $userid);
+ $this->assertNotNull($latest);
+ $this->assertSame($newer, $latest->get('id'));
+ }
+
+ /**
+ * get_latest_complete_for_user() returns the most recent complete response, or null.
+ */
+ public function test_get_latest_complete_for_user(): void {
+ $this->resetAfterTest();
+ $qid = 9050;
+ $userid = 73;
+
+ $this->assertNull(response_record::get_latest_complete_for_user($qid, $userid));
+
+ $older = $this->make_response($qid, $userid, 'y', time() - 3600);
+ $newer = $this->make_response($qid, $userid, 'y', time());
+ $this->make_response($qid, $userid, 'n'); // Incomplete — excluded.
+ $this->make_response($qid, 74, 'y'); // Other user — excluded.
+
+ $latest = response_record::get_latest_complete_for_user($qid, $userid);
+ $this->assertNotNull($latest);
+ $this->assertSame($newer, $latest->get('id'));
+ }
+
+ /**
+ * count_complete_for_questionnaire() counts only complete responses scoped to the instance.
+ */
+ public function test_count_complete_for_questionnaire(): void {
+ $this->resetAfterTest();
+ $qid = 9007;
+ $this->make_response($qid, 1, 'y');
+ $this->make_response($qid, 2, 'y');
+ $this->make_response($qid, 3, 'n'); // Incomplete — excluded.
+ $this->make_response(9008, 1, 'y'); // Different questionnaire.
+
+ $this->assertSame(2, response_record::count_complete_for_questionnaire($qid));
+ }
+
+ /**
+ * count_complete_for_questionnaire() can restrict by user id.
+ */
+ public function test_count_complete_for_questionnaire_user_filter(): void {
+ $this->resetAfterTest();
+ $qid = 9009;
+ $this->make_response($qid, 1, 'y');
+ $this->make_response($qid, 1, 'y');
+ $this->make_response($qid, 2, 'y');
+
+ $this->assertSame(2, response_record::count_complete_for_questionnaire($qid, 1));
+ $this->assertSame(1, response_record::count_complete_for_questionnaire($qid, 2));
+ $this->assertSame(0, response_record::count_complete_for_questionnaire($qid, 99));
+ }
+
+ /**
+ * count_complete_for_questionnaire() can restrict by group membership.
+ */
+ public function test_count_complete_for_questionnaire_group_filter(): void {
+ global $DB;
+ $this->resetAfterTest();
+
+ $qid = 9010;
+ $this->make_response($qid, 1, 'y');
+ $this->make_response($qid, 2, 'y');
+ $this->make_response($qid, 3, 'y');
+
+ // Put users 1 and 2 in group 100 (raw insert — no need for a real course/group fixture).
+ $gid = 100;
+ $DB->insert_record('groups_members', (object)['groupid' => $gid, 'userid' => 1]);
+ $DB->insert_record('groups_members', (object)['groupid' => $gid, 'userid' => 2]);
+
+ $this->assertSame(2, response_record::count_complete_for_questionnaire($qid, false, $gid));
+ $this->assertSame(0, response_record::count_complete_for_questionnaire($qid, false, 999));
+ }
+
+ /**
+ * count_complete_for_public_survey() counts complete responses across every
+ * questionnaire instance pointing at the shared survey.
+ */
+ public function test_count_complete_for_public_survey(): void {
+ $this->resetAfterTest();
+ $sid = $this->make_survey(1, 'public');
+ $q1 = $this->make_questionnaire(11, $sid);
+ $q2 = $this->make_questionnaire(22, $sid);
+ $this->make_response($q1, 1, 'y');
+ $this->make_response($q1, 2, 'y');
+ $this->make_response($q2, 3, 'y');
+ $this->make_response($q1, 4, 'n'); // Incomplete — excluded.
+
+ $this->assertSame(3, response_record::count_complete_for_public_survey($sid));
+ }
+
+ /**
+ * count_complete_for_public_survey() can restrict by user id.
+ */
+ public function test_count_complete_for_public_survey_user_filter(): void {
+ $this->resetAfterTest();
+ $sid = $this->make_survey(1, 'public');
+ $q1 = $this->make_questionnaire(11, $sid);
+ $q2 = $this->make_questionnaire(22, $sid);
+ $this->make_response($q1, 1, 'y');
+ $this->make_response($q2, 1, 'y');
+ $this->make_response($q1, 2, 'y');
+
+ $this->assertSame(2, response_record::count_complete_for_public_survey($sid, 1));
+ $this->assertSame(1, response_record::count_complete_for_public_survey($sid, 2));
+ }
+}
diff --git a/tests/local/db/response_single_record_test.php b/tests/local/db/response_single_record_test.php
new file mode 100644
index 000000000..144275375
--- /dev/null
+++ b/tests/local/db/response_single_record_test.php
@@ -0,0 +1,55 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\local\db\response_single_record.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire\local\db;
+
+/**
+ * Unit tests for mod_questionnaire\local\db\response_single_record.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\local\db\response_single_record
+ */
+final class response_single_record_test extends \advanced_testcase {
+ /**
+ * get_for_response() returns every single-choice answer for the response.
+ */
+ public function test_get_for_response(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $rid = 16001;
+ $DB->insert_record('questionnaire_resp_single', (object)[
+ 'responseid' => $rid, 'questionid' => 1, 'choiceid' => 11,
+ ]);
+ $DB->insert_record('questionnaire_resp_single', (object)[
+ 'responseid' => $rid, 'questionid' => 2, 'choiceid' => 22,
+ ]);
+ $DB->insert_record('questionnaire_resp_single', (object)[
+ 'responseid' => 16002, 'questionid' => 1, 'choiceid' => 11,
+ ]);
+
+ $this->assertCount(2, response_single_record::get_for_response($rid));
+ $this->assertCount(0, response_single_record::get_for_response(99999));
+ }
+}
diff --git a/tests/local/db/response_text_record_test.php b/tests/local/db/response_text_record_test.php
new file mode 100644
index 000000000..0199987b0
--- /dev/null
+++ b/tests/local/db/response_text_record_test.php
@@ -0,0 +1,55 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\local\db\response_text_record.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire\local\db;
+
+/**
+ * Unit tests for mod_questionnaire\local\db\response_text_record.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\local\db\response_text_record
+ */
+final class response_text_record_test extends \advanced_testcase {
+ /**
+ * get_for_response() returns every text answer for the response.
+ */
+ public function test_get_for_response(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $rid = 17001;
+ $DB->insert_record('questionnaire_response_text', (object)[
+ 'responseid' => $rid, 'questionid' => 1, 'response' => 'answer 1',
+ ]);
+ $DB->insert_record('questionnaire_response_text', (object)[
+ 'responseid' => $rid, 'questionid' => 2, 'response' => 'answer 2',
+ ]);
+ $DB->insert_record('questionnaire_response_text', (object)[
+ 'responseid' => 17002, 'questionid' => 1, 'response' => 'other',
+ ]);
+
+ $this->assertCount(2, response_text_record::get_for_response($rid));
+ $this->assertCount(0, response_text_record::get_for_response(99999));
+ }
+}
diff --git a/tests/local/db/survey_record_test.php b/tests/local/db/survey_record_test.php
new file mode 100644
index 000000000..d974a9e1f
--- /dev/null
+++ b/tests/local/db/survey_record_test.php
@@ -0,0 +1,154 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\local\db\survey_record.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire\local\db;
+
+/**
+ * Unit tests for mod_questionnaire\local\db\survey_record.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\local\db\survey_record
+ */
+final class survey_record_test extends \advanced_testcase {
+ /**
+ * Insert a survey row via $DB and return its id.
+ *
+ * @param int $courseid
+ * @param string $name
+ * @param string $realm
+ * @return int
+ */
+ private function make_survey(int $courseid, string $name, string $realm = 'private'): int {
+ global $DB;
+ return $DB->insert_record('questionnaire_survey', (object)[
+ 'name' => $name,
+ 'courseid' => $courseid,
+ 'realm' => $realm,
+ 'status' => 0,
+ 'title' => $name,
+ ]);
+ }
+
+ /**
+ * Insert a questionnaire row that points to the given survey.
+ *
+ * @param int $courseid
+ * @param int $sid
+ * @return int
+ */
+ private function make_questionnaire(int $courseid, int $sid): int {
+ global $DB;
+ return $DB->insert_record('questionnaire', (object)[
+ 'course' => $courseid,
+ 'name' => 'Q' . $sid,
+ 'intro' => '',
+ 'introformat' => FORMAT_HTML,
+ 'qtype' => 0,
+ 'respondenttype' => 'fullname',
+ 'respeligible' => 'all',
+ 'respview' => 0,
+ 'sid' => $sid,
+ 'timemodified' => time(),
+ ]);
+ }
+
+ /**
+ * record_exists() reports presence of a survey row by id.
+ */
+ public function test_record_exists(): void {
+ $this->resetAfterTest();
+ $sid = $this->make_survey(1, 'Existing survey');
+
+ $this->assertTrue(survey_record::record_exists($sid));
+ $this->assertFalse(survey_record::record_exists(99999));
+ }
+
+ /**
+ * get_by_realm_in_course() returns surveys matching realm + course.
+ */
+ public function test_get_by_realm_in_course(): void {
+ $this->resetAfterTest();
+ $course = 11;
+ $this->make_survey($course, 'A', 'private');
+ $this->make_survey($course, 'B', 'private');
+ $this->make_survey($course, 'C', 'public');
+ $this->make_survey(99, 'D', 'private');
+
+ $this->assertCount(2, survey_record::get_by_realm_in_course('private', $course));
+ $this->assertCount(1, survey_record::get_by_realm_in_course('public', $course));
+ $this->assertCount(0, survey_record::get_by_realm_in_course('template', $course));
+ }
+
+ /**
+ * get_by_realm() returns surveys of the realm across all courses.
+ */
+ public function test_get_by_realm(): void {
+ $this->resetAfterTest();
+ $this->make_survey(1, 'A', 'public');
+ $this->make_survey(2, 'B', 'public');
+ $this->make_survey(3, 'C', 'template');
+
+ $this->assertCount(2, survey_record::get_by_realm('public'));
+ $this->assertCount(1, survey_record::get_by_realm('template'));
+ }
+
+ /**
+ * get_orphaned() returns surveys with no linked questionnaire row.
+ */
+ public function test_get_orphaned(): void {
+ $this->resetAfterTest();
+ $linked = $this->make_survey(1, 'linked');
+ $orphan1 = $this->make_survey(1, 'orphan1');
+ $orphan2 = $this->make_survey(1, 'orphan2');
+ $this->make_questionnaire(1, $linked);
+
+ $orphans = survey_record::get_orphaned();
+ $ids = array_map(fn($r) => $r->get('id'), $orphans);
+
+ $this->assertContains($orphan1, $ids);
+ $this->assertContains($orphan2, $ids);
+ $this->assertNotContains($linked, $ids);
+ }
+
+ /**
+ * create_from_sdata() inserts a row and returns the persistent.
+ */
+ public function test_create_from_sdata(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $sdata = (object)[
+ 'name' => 'Created via sdata',
+ 'courseid' => 7,
+ 'realm' => 'private',
+ 'status' => 0,
+ 'title' => 'Created via sdata',
+ ];
+ $record = survey_record::create_from_sdata($sdata);
+
+ $this->assertGreaterThan(0, $record->get('id'));
+ $this->assertTrue($DB->record_exists('questionnaire_survey', ['id' => $record->get('id')]));
+ $this->assertSame('Created via sdata', $record->get('name'));
+ }
+}
diff --git a/tests/local/feedback/section_test.php b/tests/local/feedback/section_test.php
new file mode 100644
index 000000000..4da776dc2
--- /dev/null
+++ b/tests/local/feedback/section_test.php
@@ -0,0 +1,242 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\local\feedback\section.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire\local\feedback;
+
+/**
+ * Unit tests for mod_questionnaire\local\feedback\section.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\local\feedback\section
+ */
+final class section_test extends \advanced_testcase {
+ /**
+ * Build a sample feedback-band data object suitable for sectionfeedback::new_sectionfeedback().
+ *
+ * @param int $sectionid
+ * @param float $min
+ * @param float $max
+ * @return \stdClass
+ */
+ private function band(int $sectionid, float $min, float $max): \stdClass {
+ return (object)[
+ 'sectionid' => $sectionid,
+ 'feedbacklabel' => 'L',
+ 'feedbacktext' => 'T',
+ 'feedbacktextformat' => FORMAT_HTML,
+ 'minscore' => $min,
+ 'maxscore' => $max,
+ ];
+ }
+
+ /**
+ * new_section() inserts a new feedback-section row and returns an instance with section = max + 1.
+ */
+ public function test_new_section_increments_section_number(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $sid = 5001;
+
+ $first = section::new_section($sid, 'First');
+ $this->assertGreaterThan(0, $first->id);
+ $this->assertSame(1, $first->section);
+ $this->assertSame('First', $first->sectionlabel);
+ $this->assertTrue($DB->record_exists('questionnaire_fb_sections', ['id' => $first->id]));
+
+ $second = section::new_section($sid, 'Second');
+ $this->assertSame(2, $second->section);
+ }
+
+ /**
+ * new_section() uses a default label when none is supplied.
+ */
+ public function test_new_section_default_label(): void {
+ $this->resetAfterTest();
+ $sid = 5002;
+ $section = section::new_section($sid);
+ $this->assertSame(get_string('feedbackdefaultlabel', 'questionnaire'), $section->sectionlabel);
+ }
+
+ /**
+ * decode_scorecalculation() returns an empty array for null/empty input.
+ */
+ public function test_decode_scorecalculation_empty(): void {
+ $this->assertSame([], section::decode_scorecalculation(null));
+ $this->assertSame([], section::decode_scorecalculation(''));
+ }
+
+ /**
+ * decode_scorecalculation() unserializes a valid score array.
+ */
+ public function test_decode_scorecalculation_valid(): void {
+ $encoded = serialize([10 => 1, 11 => 2]);
+ $this->assertSame([10 => 1, 11 => 2], section::decode_scorecalculation($encoded));
+ }
+
+ /**
+ * decode_scorecalculation() throws when an entry's score is non-numeric.
+ */
+ public function test_decode_scorecalculation_invalid(): void {
+ $this->expectException(\coding_exception::class);
+ section::decode_scorecalculation(serialize([10 => 'not-a-number']));
+ }
+
+ /**
+ * load_section() reads a section by id and attaches its feedback bands.
+ */
+ public function test_load_section_by_id(): void {
+ $this->resetAfterTest();
+ $sid = 5003;
+ $created = section::new_section($sid, 'lbl');
+
+ // Add two feedback bands.
+ sectionfeedback::new_sectionfeedback($this->band($created->id, 0, 50));
+ sectionfeedback::new_sectionfeedback($this->band($created->id, 50, 100));
+
+ $loaded = new section([], ['id' => $created->id]);
+ $this->assertSame($created->id, $loaded->id);
+ $this->assertSame($sid, $loaded->surveyid);
+ $this->assertCount(2, $loaded->sectionfeedback);
+ }
+
+ /**
+ * load_section() can find by surveyid + section number.
+ */
+ public function test_load_section_by_surveyid(): void {
+ $this->resetAfterTest();
+ $sid = 5004;
+ section::new_section($sid, 'first');
+ $second = section::new_section($sid, 'second');
+ sectionfeedback::new_sectionfeedback($this->band($second->id, 0, 100));
+
+ $loaded = new section([], ['surveyid' => $sid, 'sectionnum' => 2]);
+ $this->assertSame($second->id, $loaded->id);
+ $this->assertSame('second', $loaded->sectionlabel);
+ }
+
+ /**
+ * load_section() throws when nothing matches the supplied parameters.
+ */
+ public function test_load_section_missing_throws(): void {
+ $this->resetAfterTest();
+ $this->expectException(\invalid_parameter_exception::class);
+ new section([], ['id' => 99999]);
+ }
+
+ /**
+ * update() writes current in-memory state back to the row.
+ */
+ public function test_update_persists_changes(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $sid = 5005;
+ $section = section::new_section($sid);
+ $section->sectionlabel = 'renamed';
+ $section->update();
+
+ $row = $DB->get_record('questionnaire_fb_sections', ['id' => $section->id]);
+ $this->assertSame('renamed', $row->sectionlabel);
+ }
+
+ /**
+ * delete_sectionfeedback() removes all feedback bands for the section.
+ */
+ public function test_delete_sectionfeedback_removes_bands(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $sid = 5006;
+ $section = section::new_section($sid);
+ sectionfeedback::new_sectionfeedback($this->band($section->id, 0, 50));
+ sectionfeedback::new_sectionfeedback($this->band($section->id, 50, 100));
+
+ $this->assertEquals(2, $DB->count_records('questionnaire_feedback', ['sectionid' => $section->id]));
+ $section->delete_sectionfeedback();
+ $this->assertEquals(0, $DB->count_records('questionnaire_feedback', ['sectionid' => $section->id]));
+ $this->assertSame([], $section->sectionfeedback);
+ }
+
+ /**
+ * delete() removes the section row, its feedback bands, and resequences remaining sections.
+ */
+ public function test_delete_resequences(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $sid = 5007;
+ $s1 = section::new_section($sid);
+ $s2 = section::new_section($sid);
+ $s3 = section::new_section($sid);
+ sectionfeedback::new_sectionfeedback($this->band($s2->id, 0, 100));
+
+ // Delete the middle section.
+ $s2->delete();
+
+ $this->assertFalse($DB->record_exists('questionnaire_fb_sections', ['id' => $s2->id]));
+ $this->assertEquals(0, $DB->count_records('questionnaire_feedback', ['sectionid' => $s2->id]));
+
+ $remaining = $DB->get_records('questionnaire_fb_sections', ['surveyid' => $sid], 'section ASC');
+ $sections = array_map(fn($r) => (int) $r->section, array_values($remaining));
+ $this->assertSame([1, 2], $sections);
+ }
+
+ /**
+ * load_sectionfeedback() registers a new band on this section and inserts its row.
+ */
+ public function test_load_sectionfeedback_creates_new_band(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $sid = 5008;
+ $section = section::new_section($sid);
+
+ $data = (object)[
+ 'sectionid' => $section->id,
+ 'feedbacklabel' => 'L',
+ 'feedbacktext' => 'T',
+ 'feedbacktextformat' => FORMAT_HTML,
+ 'minscore' => 10,
+ 'maxscore' => 60,
+ ];
+ $newid = $section->load_sectionfeedback($data);
+
+ $this->assertGreaterThan(0, $newid);
+ $this->assertArrayHasKey($newid, $section->sectionfeedback);
+ $this->assertTrue($DB->record_exists('questionnaire_feedback', ['id' => $newid]));
+ }
+
+ /**
+ * set_new_scorecalculation() persists the encoded payload and keeps the in-memory state aligned.
+ */
+ public function test_set_new_scorecalculation_persists(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $sid = 5009;
+ $section = section::new_section($sid);
+
+ $section->set_new_scorecalculation([10 => 1, 11 => 2]);
+
+ $stored = $DB->get_field('questionnaire_fb_sections', 'scorecalculation', ['id' => $section->id]);
+ $this->assertSame([10 => 1, 11 => 2], unserialize($stored));
+ $this->assertSame([10 => 1, 11 => 2], $section->scorecalculation);
+ }
+}
diff --git a/tests/local/feedback/sectionfeedback_test.php b/tests/local/feedback/sectionfeedback_test.php
new file mode 100644
index 000000000..6b109a0aa
--- /dev/null
+++ b/tests/local/feedback/sectionfeedback_test.php
@@ -0,0 +1,147 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\local\feedback\sectionfeedback.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire\local\feedback;
+
+/**
+ * Unit tests for mod_questionnaire\local\feedback\sectionfeedback.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\local\feedback\sectionfeedback
+ */
+final class sectionfeedback_test extends \advanced_testcase {
+ /**
+ * Build a stdClass with the fields new_sectionfeedback expects.
+ *
+ * @param int $sectionid
+ * @param float $minscore
+ * @param float $maxscore
+ * @return \stdClass
+ */
+ private function sample_data(int $sectionid, float $minscore = 0.0, float $maxscore = 100.0): \stdClass {
+ return (object)[
+ 'sectionid' => $sectionid,
+ 'feedbacklabel' => 'label',
+ 'feedbacktext' => 'text',
+ 'feedbacktextformat' => FORMAT_HTML,
+ 'minscore' => $minscore,
+ 'maxscore' => $maxscore,
+ ];
+ }
+
+ /**
+ * The constructor with id = 0 leaves the object in its empty default state.
+ */
+ public function test_construct_empty(): void {
+ $sf = new sectionfeedback();
+ $this->assertSame(0, $sf->id);
+ $this->assertSame(0, $sf->sectionid);
+ }
+
+ /**
+ * Constructing with a stdClass record copies known fields without writing to the DB.
+ */
+ public function test_construct_with_record(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $countbefore = $DB->count_records('questionnaire_feedback');
+
+ $rec = (object)[
+ 'id' => 0,
+ 'sectionid' => 10,
+ 'feedbacklabel' => 'lbl',
+ 'feedbacktext' => 'body',
+ 'feedbacktextformat' => FORMAT_HTML,
+ 'minscore' => 25.0,
+ 'maxscore' => 75.0,
+ ];
+ $sf = new sectionfeedback(0, $rec);
+
+ $this->assertSame(10, $sf->sectionid);
+ $this->assertSame('lbl', $sf->feedbacklabel);
+ $this->assertSame('body', $sf->feedbacktext);
+ $this->assertEquals(25.0, $sf->minscore);
+ $this->assertEquals(75.0, $sf->maxscore);
+ $this->assertSame($countbefore, $DB->count_records('questionnaire_feedback'));
+ }
+
+ /**
+ * Constructing with an existing id loads the row from the database.
+ */
+ public function test_construct_loads_existing_id(): void {
+ $this->resetAfterTest();
+ $created = sectionfeedback::new_sectionfeedback($this->sample_data(20));
+
+ $loaded = new sectionfeedback($created->id);
+ $this->assertEquals($created->id, $loaded->id);
+ $this->assertEquals(20, $loaded->sectionid);
+ $this->assertSame('label', $loaded->feedbacklabel);
+ }
+
+ /**
+ * Constructing with a non-existent id throws.
+ */
+ public function test_construct_unknown_id_throws(): void {
+ $this->resetAfterTest();
+ $this->expectException(\invalid_parameter_exception::class);
+ new sectionfeedback(99999);
+ }
+
+ /**
+ * new_sectionfeedback() persists a new row and returns an instance with a real id.
+ */
+ public function test_new_sectionfeedback_persists(): void {
+ global $DB;
+ $this->resetAfterTest();
+
+ $sf = sectionfeedback::new_sectionfeedback($this->sample_data(30, 10.0, 90.0));
+
+ $this->assertGreaterThan(0, $sf->id);
+ $row = $DB->get_record('questionnaire_feedback', ['id' => $sf->id]);
+ $this->assertNotEmpty($row);
+ $this->assertEquals(30, $row->sectionid);
+ $this->assertEquals(10.0, $row->minscore);
+ $this->assertEquals(90.0, $row->maxscore);
+ }
+
+ /**
+ * update() writes current in-memory state back to the row.
+ */
+ public function test_update_persists_changes(): void {
+ global $DB;
+ $this->resetAfterTest();
+
+ $sf = sectionfeedback::new_sectionfeedback($this->sample_data(40, 0.0, 100.0));
+ $sf->minscore = 33.0;
+ $sf->maxscore = 66.0;
+ $sf->feedbacktext = 'updated text';
+ $sf->update();
+
+ $row = $DB->get_record('questionnaire_feedback', ['id' => $sf->id]);
+ $this->assertEquals(33.0, $row->minscore);
+ $this->assertEquals(66.0, $row->maxscore);
+ $this->assertSame('updated text', $row->feedbacktext);
+ }
+}
diff --git a/tests/local/response/response_test.php b/tests/local/response/response_test.php
new file mode 100644
index 000000000..a0dc9844d
--- /dev/null
+++ b/tests/local/response/response_test.php
@@ -0,0 +1,263 @@
+.
+
+namespace mod_questionnaire\local\response;
+
+use advanced_testcase;
+use mod_questionnaire\local\db\response_record;
+
+/**
+ * Unit tests for mod_questionnaire\local\response\response.
+ *
+ * @package mod_questionnaire
+ * @copyright 2025 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @covers \mod_questionnaire\local\response\response
+ */
+final class response_test extends advanced_testcase {
+ // Helpers.
+
+ /**
+ * Insert a raw questionnaire_response row and return its id.
+ *
+ * @param int $questionnaireid
+ * @param int $userid
+ * @param string $complete 'y' or 'n'
+ * @param int|null $submitted Unix timestamp; defaults to time().
+ * @return int
+ */
+ private function insert_response(
+ int $questionnaireid,
+ int $userid,
+ string $complete = 'n',
+ ?int $submitted = null
+ ): int {
+ global $DB;
+ return (int) $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $questionnaireid,
+ 'userid' => $userid,
+ 'submitted' => $submitted ?? time(),
+ 'complete' => $complete,
+ 'grade' => 0,
+ ]);
+ }
+
+ // Tests for response::create().
+
+ /**
+ * Test that create() inserts a header row and returns a response with the correct ids.
+ */
+ public function test_create_inserts_header_row(): void {
+ global $DB;
+ $this->resetAfterTest();
+
+ $r = response::create(101, 42);
+
+ $this->assertGreaterThan(0, $r->id());
+ $this->assertSame(101, $r->questionnaireid());
+ $this->assertSame(42, $r->userid());
+ $this->assertFalse($r->is_complete());
+ $this->assertTrue($DB->record_exists('questionnaire_response', ['id' => $r->id()]));
+ }
+
+ /**
+ * Test that create() sets submitted to approximately now.
+ */
+ public function test_create_sets_submitted_to_now(): void {
+ $this->resetAfterTest();
+
+ $before = time();
+ $r = response::create(101, 42);
+ $after = time();
+
+ $this->assertGreaterThanOrEqual($before, $r->submitted_at());
+ $this->assertLessThanOrEqual($after, $r->submitted_at());
+ }
+
+ // Tests for response::latest_incomplete().
+
+ /**
+ * Test that latest_incomplete() returns null when no incomplete response exists.
+ */
+ public function test_latest_incomplete_returns_null_when_none(): void {
+ $this->resetAfterTest();
+
+ $this->assertNull(response::latest_incomplete(999, 1));
+ }
+
+ /**
+ * Test that latest_incomplete() ignores complete responses.
+ */
+ public function test_latest_incomplete_ignores_complete_responses(): void {
+ $this->resetAfterTest();
+
+ $this->insert_response(202, 7, 'y');
+
+ $this->assertNull(response::latest_incomplete(202, 7));
+ }
+
+ /**
+ * Test that latest_incomplete() returns the incomplete response id.
+ */
+ public function test_latest_incomplete_returns_incomplete_response(): void {
+ $this->resetAfterTest();
+
+ $rid = $this->insert_response(303, 8, 'n');
+
+ $r = response::latest_incomplete(303, 8);
+
+ $this->assertNotNull($r);
+ $this->assertSame($rid, $r->id());
+ $this->assertSame(303, $r->questionnaireid());
+ $this->assertSame(8, $r->userid());
+ }
+
+ /**
+ * Test that latest_incomplete() returns the most recent when multiple exist.
+ */
+ public function test_latest_incomplete_returns_most_recent(): void {
+ $this->resetAfterTest();
+
+ $this->insert_response(404, 9, 'n', time() - 100);
+ $newer = $this->insert_response(404, 9, 'n', time() - 10);
+
+ $r = response::latest_incomplete(404, 9);
+
+ $this->assertSame($newer, $r->id());
+ }
+
+ /**
+ * Test that latest_incomplete() is scoped to the given questionnaire.
+ */
+ public function test_latest_incomplete_scoped_to_questionnaire(): void {
+ $this->resetAfterTest();
+
+ $this->insert_response(501, 10, 'n');
+
+ $this->assertNull(response::latest_incomplete(502, 10));
+ }
+
+ // Accessor tests.
+
+ /**
+ * Test that is_complete() returns false for an incomplete response.
+ */
+ public function test_is_complete_false_for_incomplete(): void {
+ $this->resetAfterTest();
+
+ $rid = $this->insert_response(601, 11, 'n');
+ $r = new response(new response_record($rid));
+
+ $this->assertFalse($r->is_complete());
+ }
+
+ /**
+ * Test that is_complete() returns true for a complete response.
+ */
+ public function test_is_complete_true_for_complete(): void {
+ $this->resetAfterTest();
+
+ $rid = $this->insert_response(601, 11, 'y');
+ $r = new response(new response_record($rid));
+
+ $this->assertTrue($r->is_complete());
+ }
+
+ // Tests for touch().
+
+ /**
+ * Test that touch() updates the submitted timestamp in the database.
+ */
+ public function test_touch_updates_submitted_timestamp(): void {
+ global $DB;
+ $this->resetAfterTest();
+
+ $rid = $this->insert_response(701, 12, 'n', time() - 3600);
+ $r = new response(new response_record($rid));
+
+ $before = time();
+ $r->touch();
+ $after = time();
+
+ $stored = (int) $DB->get_field('questionnaire_response', 'submitted', ['id' => $rid]);
+ $this->assertGreaterThanOrEqual($before, $stored);
+ $this->assertLessThanOrEqual($after, $stored);
+ }
+
+ // Tests for commit().
+
+ /**
+ * Test that commit() marks the response as complete in the database.
+ */
+ public function test_commit_marks_complete(): void {
+ global $DB;
+ $this->resetAfterTest();
+
+ $rid = $this->insert_response(801, 13, 'n');
+ $r = new response(new response_record($rid));
+ $r->commit();
+
+ $row = $DB->get_record('questionnaire_response', ['id' => $rid]);
+ $this->assertSame('y', $row->complete);
+ }
+
+ /**
+ * Test that commit() stores the provided grade.
+ */
+ public function test_commit_stores_grade(): void {
+ global $DB;
+ $this->resetAfterTest();
+
+ $rid = $this->insert_response(801, 13, 'n');
+ $r = new response(new response_record($rid));
+ $r->commit(5);
+
+ $this->assertSame('5', $DB->get_field('questionnaire_response', 'grade', ['id' => $rid]));
+ }
+
+ /**
+ * Test that commit() updates submitted to approximately now.
+ */
+ public function test_commit_updates_submitted(): void {
+ global $DB;
+ $this->resetAfterTest();
+
+ $rid = $this->insert_response(801, 13, 'n', time() - 3600);
+ $r = new response(new response_record($rid));
+
+ $before = time();
+ $r->commit();
+ $after = time();
+
+ $stored = (int) $DB->get_field('questionnaire_response', 'submitted', ['id' => $rid]);
+ $this->assertGreaterThanOrEqual($before, $stored);
+ $this->assertLessThanOrEqual($after, $stored);
+ }
+
+ /**
+ * Test that after commit() is_complete() returns true.
+ */
+ public function test_is_complete_true_after_commit(): void {
+ $this->resetAfterTest();
+
+ $rid = $this->insert_response(901, 14, 'n');
+ $r = new response(new response_record($rid));
+ $r->commit();
+
+ $this->assertTrue($r->is_complete());
+ }
+}
diff --git a/tests/local/response/responsetype_test.php b/tests/local/response/responsetype_test.php
new file mode 100644
index 000000000..c55f1574b
--- /dev/null
+++ b/tests/local/response/responsetype_test.php
@@ -0,0 +1,549 @@
+.
+
+/**
+ * Unit tests for the responsetype hierarchy under classes/local/response/.
+ *
+ * Covers the pure / state methods on the abstract base and each concrete
+ * subclass that can be exercised without a full questionnaire fixture.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire\local\response;
+
+/**
+ * Unit tests for the responsetype hierarchy.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\local\response\responsetype
+ * @covers \mod_questionnaire\local\response\boolean
+ * @covers \mod_questionnaire\local\response\text
+ * @covers \mod_questionnaire\local\response\date
+ * @covers \mod_questionnaire\local\response\file
+ * @covers \mod_questionnaire\local\response\single
+ * @covers \mod_questionnaire\local\response\multiple
+ * @covers \mod_questionnaire\local\response\rank
+ * @covers \mod_questionnaire\local\response\slider
+ * @covers \mod_questionnaire\local\response\numericaltext
+ */
+final class responsetype_test extends \advanced_testcase {
+ /**
+ * Build a minimal question stub with an id, suitable for instantiating a responsetype.
+ *
+ * @param int $id
+ * @param array $choices
+ * @return \mod_questionnaire\local\question\question
+ */
+ private function question_stub(int $id, array $choices = []): \mod_questionnaire\local\question\question {
+ $stub = new class extends \mod_questionnaire\local\question\question {
+ /** @var int Captured question id for the stub. */
+ public $stubid = 0;
+
+ /**
+ * Bypass the real constructor — the stub does not need DB-backed state.
+ */
+ public function __construct() {
+ }
+
+ /**
+ * Return the stub's captured id.
+ *
+ * @return int
+ */
+ public function id(): int {
+ return $this->stubid;
+ }
+
+ /**
+ * Help name placeholder.
+ *
+ * @return string
+ */
+ public function helpname(): string {
+ return 'stub';
+ }
+
+ /**
+ * Response table placeholder — not exercised by these tests.
+ *
+ * @return string
+ */
+ public function response_table() {
+ return '';
+ }
+
+ /**
+ * Responseclass placeholder — not exercised by these tests.
+ *
+ * @return string
+ */
+ protected function responseclass() {
+ return '';
+ }
+
+ /**
+ * Question display placeholder satisfying the abstract contract.
+ *
+ * @param mixed $response
+ * @param mixed $descendantsdata
+ * @param bool $blankquestionnaire
+ * @return string
+ */
+ protected function question_survey_display($response, $descendantsdata, $blankquestionnaire = false) {
+ return '';
+ }
+
+ /**
+ * Response display placeholder satisfying the abstract contract.
+ *
+ * @param mixed $response
+ * @return string
+ */
+ protected function response_survey_display($response) {
+ return '';
+ }
+ };
+ $stub->stubid = $id;
+ $stub->choices = $choices;
+ return $stub;
+ }
+
+ /**
+ * all_response_tables() lists every per-type answer table the plugin owns.
+ */
+ public function test_all_response_tables(): void {
+ $tables = responsetype::all_response_tables();
+ $this->assertContains('questionnaire_response_bool', $tables);
+ $this->assertContains('questionnaire_response_date', $tables);
+ $this->assertContains('questionnaire_response_text', $tables);
+ $this->assertContains('questionnaire_response_rank', $tables);
+ $this->assertContains('questionnaire_response_other', $tables);
+ $this->assertContains('questionnaire_resp_single', $tables);
+ $this->assertContains('questionnaire_resp_multiple', $tables);
+ }
+
+ /**
+ * Each subclass's static response_table() returns the expected table name.
+ */
+ public function test_response_table_per_subclass(): void {
+ $this->assertSame('questionnaire_response_bool', boolean::response_table());
+ $this->assertSame('questionnaire_response_text', text::response_table());
+ $this->assertSame('questionnaire_response_date', date::response_table());
+ $this->assertSame('questionnaire_response_file', file::response_table());
+ $this->assertSame('questionnaire_resp_single', single::response_table());
+ $this->assertSame('questionnaire_resp_multiple', multiple::response_table());
+ $this->assertSame('questionnaire_response_rank', rank::response_table());
+ // Slider and numericaltext inherit text's table.
+ $this->assertSame('questionnaire_response_text', slider::response_table());
+ $this->assertSame('questionnaire_response_text', numericaltext::response_table());
+ }
+
+ /**
+ * The base transform_choiceid() is an identity pass-through.
+ */
+ public function test_transform_choiceid_default_is_identity(): void {
+ $rt = new text($this->question_stub(1));
+ $this->assertSame(42, $rt->transform_choiceid(42));
+ $this->assertSame('foo', $rt->transform_choiceid('foo'));
+ }
+
+ /**
+ * boolean::transform_choiceid() maps 0 -> 'y' and any other value -> 'n'.
+ */
+ public function test_transform_choiceid_boolean_override(): void {
+ $rt = new boolean($this->question_stub(1));
+ $this->assertSame('y', $rt->transform_choiceid(0));
+ $this->assertSame('n', $rt->transform_choiceid(1));
+ $this->assertSame('n', $rt->transform_choiceid(99));
+ }
+
+ /**
+ * results_template() returns false on the base; subclasses that supply one return a string.
+ */
+ public function test_results_template(): void {
+ $base = new text($this->question_stub(1));
+ // The base default is false, but text overrides — verify each concrete returns expected.
+ $this->assertNotEmpty($base->results_template());
+
+ $bool = new boolean($this->question_stub(1));
+ $this->assertNotEmpty($bool->results_template());
+ $this->assertNotEmpty($bool->results_template(true));
+
+ $rank = new rank($this->question_stub(1));
+ $this->assertNotEmpty($rank->results_template());
+
+ $single = new single($this->question_stub(1));
+ $this->assertNotEmpty($single->results_template());
+ }
+
+ /**
+ * set_display_context() sets the protected state used by render-time methods.
+ */
+ public function test_set_display_context_state(): void {
+ $rt = new boolean($this->question_stub(1));
+ // Access via reflection — the fields are protected.
+ $rt->set_display_context(true, 'anonymous', 42);
+ $reflection = new \ReflectionObject($rt);
+
+ $canview = $reflection->getProperty('canviewsingleresponse');
+ $canview->setAccessible(true);
+ $this->assertTrue($canview->getValue($rt));
+
+ $type = $reflection->getProperty('displayrespondenttype');
+ $type->setAccessible(true);
+ $this->assertSame('anonymous', $type->getValue($rt));
+
+ $sid = $reflection->getProperty('displaysurveysid');
+ $sid->setAccessible(true);
+ $this->assertSame(42, $sid->getValue($rt));
+ }
+
+ /**
+ * boolean::answers_from_webform() turns 'y' / 'n' form input into one answer per question.
+ */
+ public function test_answers_from_webform_boolean(): void {
+ $question = $this->question_stub(7);
+ $data = (object)['rid' => 99, 'q7' => 'y'];
+ $answers = boolean::answers_from_webform($data, $question);
+ $this->assertCount(1, $answers);
+ $a = reset($answers);
+ $this->assertEquals(99, $a->responseid);
+ $this->assertEquals(7, $a->questionid);
+ $this->assertSame('y', $a->choiceid);
+ }
+
+ /**
+ * boolean::answers_from_webform() returns an empty array when the user did not answer.
+ */
+ public function test_answers_from_webform_boolean_empty(): void {
+ $question = $this->question_stub(7);
+ $data = (object)['rid' => 99]; // No q7 property.
+ $this->assertSame([], boolean::answers_from_webform($data, $question));
+ }
+
+ /**
+ * text::answers_from_webform() captures the free-form value when present.
+ */
+ public function test_answers_from_webform_text(): void {
+ $question = $this->question_stub(11);
+ $data = (object)['rid' => 50, 'q11' => 'a written answer'];
+ $answers = text::answers_from_webform($data, $question);
+ $this->assertCount(1, $answers);
+ $a = reset($answers);
+ $this->assertEquals(50, $a->responseid);
+ $this->assertEquals(11, $a->questionid);
+ $this->assertSame('a written answer', $a->value);
+ }
+
+ /**
+ * text::answers_from_webform() returns nothing for an empty string.
+ */
+ public function test_answers_from_webform_text_empty(): void {
+ $question = $this->question_stub(11);
+ $this->assertSame([], text::answers_from_webform((object)['rid' => 50, 'q11' => ''], $question));
+ }
+
+ /**
+ * Build a real course + questionnaire with one question of the given type, plus an empty
+ * parent response row. Returns [questionnaire, question, parent response id].
+ *
+ * @param int $qtype Question type constant (QUESYESNO, QUESTEXT, etc).
+ * @param array|null $choicedata Optional choice rows for choice-based question types.
+ * @return array
+ */
+ private function build_data_fixture(int $qtype, ?array $choicedata = null): array {
+ global $DB, $USER;
+
+ $course = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
+ $questionnaire = $generator->create_test_questionnaire(
+ $course,
+ $qtype,
+ ['content' => 'data fixture'],
+ $choicedata
+ );
+ $question = reset($questionnaire->questions());
+
+ // Use $USER->id so text::get_results' user join finds a row in its non-anonymous branch.
+ $rid = $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $questionnaire->id(),
+ 'userid' => $USER->id,
+ 'submitted' => time(),
+ 'complete' => 'n',
+ 'grade' => 0,
+ ]);
+ return [$questionnaire, $question, (int)$rid];
+ }
+
+ /**
+ * boolean::insert_response() writes a 'y' answer to questionnaire_response_bool.
+ */
+ public function test_boolean_insert_response_writes_record(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$questionnaire, $question, $rid] = $this->build_data_fixture(QUESYESNO);
+
+ $rt = new boolean($question);
+ $data = (object)['rid' => $rid, 'a' => $questionnaire->id(), 'q' . $question->id() => 'y'];
+ $insertedid = $rt->insert_response($data);
+
+ $this->assertNotFalse($insertedid);
+ $row = $DB->get_record('questionnaire_response_bool', ['id' => $insertedid]);
+ $this->assertEquals($rid, $row->responseid);
+ $this->assertEquals($question->id(), $row->questionid);
+ $this->assertSame('y', $row->choiceid);
+ }
+
+ /**
+ * boolean::get_results() returns one count per choice id.
+ */
+ public function test_boolean_get_results_counts_choices(): void {
+ global $DB, $USER;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$questionnaire, $question, $rid] = $this->build_data_fixture(QUESYESNO);
+ $rt = new boolean($question);
+
+ // Three responses: two 'y', one 'n', each in its own parent response row.
+ $rt->insert_response((object)['rid' => $rid, 'a' => $questionnaire->id(), 'q' . $question->id() => 'y']);
+ $rid2 = $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $questionnaire->id(), 'userid' => $USER->id,
+ 'submitted' => time(), 'complete' => 'n', 'grade' => 0,
+ ]);
+ $rt->insert_response((object)['rid' => $rid2, 'a' => $questionnaire->id(), 'q' . $question->id() => 'y']);
+ $rid3 = $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $questionnaire->id(), 'userid' => $USER->id,
+ 'submitted' => time(), 'complete' => 'n', 'grade' => 0,
+ ]);
+ $rt->insert_response((object)['rid' => $rid3, 'a' => $questionnaire->id(), 'q' . $question->id() => 'n']);
+
+ $results = $rt->get_results([$rid, $rid2, $rid3]);
+ $bychoice = [];
+ foreach ($results as $row) {
+ $bychoice[$row->choiceid] = (int)$row->num;
+ }
+ $this->assertSame(2, $bychoice['y'] ?? 0);
+ $this->assertSame(1, $bychoice['n'] ?? 0);
+ }
+
+ /**
+ * boolean::display_results() returns a templatable object derived from the counts.
+ */
+ public function test_boolean_display_results_returns_tags(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$questionnaire, $question, $rid] = $this->build_data_fixture(QUESYESNO);
+ $rt = new boolean($question);
+ $rt->insert_response((object)['rid' => $rid, 'a' => $questionnaire->id(), 'q' . $question->id() => 'y']);
+
+ $tags = $rt->display_results([$rid], '', false);
+ $this->assertIsObject($tags);
+ // Get_results_tags fills counts via $pagetags->counts; verify the structure renders something.
+ $this->assertNotEmpty(get_object_vars($tags));
+ }
+
+ /**
+ * text::insert_response() writes the clean text value to questionnaire_response_text.
+ */
+ public function test_text_insert_response_writes_value(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$questionnaire, $question, $rid] = $this->build_data_fixture(QUESTEXT);
+
+ $rt = new text($question);
+ $data = (object)[
+ 'rid' => $rid,
+ 'a' => $questionnaire->id(),
+ 'q' . $question->id() => 'free-form answer',
+ ];
+ $insertedid = $rt->insert_response($data);
+
+ $this->assertNotFalse($insertedid);
+ $row = $DB->get_record('questionnaire_response_text', ['id' => $insertedid]);
+ $this->assertEquals($rid, $row->responseid);
+ $this->assertEquals($question->id(), $row->questionid);
+ $this->assertSame('free-form answer', $row->response);
+ }
+
+ /**
+ * text::get_results() returns the inserted text answers joined with the parent response.
+ */
+ public function test_text_get_results_returns_value(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$questionnaire, $question, $rid] = $this->build_data_fixture(QUESTEXT);
+ $rt = new text($question);
+ $rt->insert_response((object)[
+ 'rid' => $rid,
+ 'a' => $questionnaire->id(),
+ 'q' . $question->id() => 'hello world',
+ ]);
+
+ $results = $rt->get_results([$rid]);
+ $this->assertCount(1, $results);
+ $row = reset($results);
+ $this->assertSame('hello world', $row->response);
+ }
+
+ /**
+ * date::insert_response() writes a YYYY-MM-DD value to questionnaire_response_date.
+ */
+ public function test_date_insert_response_writes_value(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$questionnaire, $question, $rid] = $this->build_data_fixture(QUESDATE);
+
+ $rt = new date($question);
+ $insertedid = $rt->insert_response((object)[
+ 'rid' => $rid,
+ 'a' => $questionnaire->id(),
+ 'q' . $question->id() => '2026-06-14',
+ ]);
+
+ $this->assertNotFalse($insertedid);
+ $row = $DB->get_record('questionnaire_response_date', ['id' => $insertedid]);
+ $this->assertEquals($rid, $row->responseid);
+ $this->assertEquals($question->id(), $row->questionid);
+ $this->assertSame('2026-06-14', $row->response);
+ }
+
+ /**
+ * date::insert_response() rejects badly-formatted input (returns false, writes nothing).
+ */
+ public function test_date_insert_response_rejects_bad_format(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$questionnaire, $question, $rid] = $this->build_data_fixture(QUESDATE);
+
+ $rt = new date($question);
+ $result = $rt->insert_response((object)[
+ 'rid' => $rid,
+ 'a' => $questionnaire->id(),
+ 'q' . $question->id() => 'not-a-date',
+ ]);
+
+ $this->assertFalse($result);
+ $this->assertSame(0, $DB->count_records('questionnaire_response_date', ['responseid' => $rid]));
+ }
+
+ /**
+ * date::get_results() returns the stored date rows for the given response ids.
+ */
+ public function test_date_get_results_returns_dates(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$questionnaire, $question, $rid] = $this->build_data_fixture(QUESDATE);
+ $rt = new date($question);
+ $rt->insert_response((object)[
+ 'rid' => $rid,
+ 'a' => $questionnaire->id(),
+ 'q' . $question->id() => '2026-06-14',
+ ]);
+
+ $results = $rt->get_results([$rid]);
+ $this->assertCount(1, $results);
+ $row = reset($results);
+ $this->assertSame('2026-06-14', $row->response);
+ }
+
+ /**
+ * single::insert_response() writes one questionnaire_resp_single row for the chosen choice id.
+ */
+ public function test_single_insert_response_writes_choice(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $choices = [
+ (object)['content' => 'One', 'value' => 1],
+ (object)['content' => 'Two', 'value' => 2],
+ (object)['content' => 'Three', 'value' => 3],
+ ];
+ [$questionnaire, $question, $rid] = $this->build_data_fixture(QUESRADIO, $choices);
+
+ // Pick the "Two" choice id from the question's loaded choices.
+ $twoid = 0;
+ foreach ($question->choices as $cid => $choice) {
+ if ($choice->content === 'Two') {
+ $twoid = $cid;
+ break;
+ }
+ }
+ $this->assertNotEmpty($twoid);
+
+ $rt = new single($question);
+ $insertedid = $rt->insert_response((object)[
+ 'rid' => $rid,
+ 'a' => $questionnaire->id(),
+ 'q' . $question->id() => $twoid,
+ ]);
+
+ $this->assertNotFalse($insertedid);
+ $row = $DB->get_record('questionnaire_resp_single', ['id' => $insertedid]);
+ $this->assertEquals($rid, $row->responseid);
+ $this->assertEquals($question->id(), $row->questionid);
+ $this->assertEquals($twoid, $row->choiceid);
+ }
+
+ /**
+ * single::get_results() joins the response and choice rows so each result carries the choice content.
+ */
+ public function test_single_get_results_returns_choice_content(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $choices = [
+ (object)['content' => 'One', 'value' => 1],
+ (object)['content' => 'Two', 'value' => 2],
+ ];
+ [$questionnaire, $question, $rid] = $this->build_data_fixture(QUESRADIO, $choices);
+
+ $twoid = 0;
+ foreach ($question->choices as $cid => $choice) {
+ if ($choice->content === 'Two') {
+ $twoid = $cid;
+ break;
+ }
+ }
+
+ $rt = new single($question);
+ $rt->insert_response((object)[
+ 'rid' => $rid,
+ 'a' => $questionnaire->id(),
+ 'q' . $question->id() => $twoid,
+ ]);
+
+ $results = $rt->get_results([$rid]);
+ $contents = array_map(fn($r) => $r->content ?? null, $results);
+ $this->assertContains('Two', $contents);
+ }
+}
diff --git a/tests/output/report_view_renderer_test.php b/tests/output/report_view_renderer_test.php
new file mode 100644
index 000000000..ff7268dda
--- /dev/null
+++ b/tests/output/report_view_renderer_test.php
@@ -0,0 +1,180 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\output\report_view_renderer.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire\output;
+
+use mod_questionnaire\questionnaire;
+
+/**
+ * Unit tests for mod_questionnaire\output\report_view_renderer.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\output\report_view_renderer
+ */
+final class report_view_renderer_test extends \advanced_testcase {
+ /**
+ * Initialise the SESSION->questionnaire bucket that real callers (preview.php, print.php)
+ * set up before invoking the renderer.
+ */
+ private function init_session(): void {
+ global $SESSION;
+ if (!isset($SESSION->questionnaire) || !is_object($SESSION->questionnaire)) {
+ $SESSION->questionnaire = new \stdClass();
+ }
+ }
+
+ /**
+ * Build a course + questionnaire with one yes/no question.
+ *
+ * @return array [questionnaire, student id]
+ */
+ private function build_fixture(): array {
+ global $DB;
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $plugin = $generator->get_plugin_generator('mod_questionnaire');
+ $instance = $plugin->create_test_questionnaire(
+ $course,
+ QUESYESNO,
+ ['content' => 'Yes or no?'],
+ []
+ );
+
+ $student = $generator->create_user();
+ $studentrole = $DB->get_record('role', ['shortname' => 'student'], '*', MUST_EXIST);
+ $generator->enrol_user($student->id, $course->id, $studentrole->id);
+
+ return [$instance, (int) $student->id];
+ }
+
+ /**
+ * Read the data backing a previewpage so tests can assert on the keys the renderer wrote.
+ *
+ * @param previewpage $page
+ * @return \stdClass
+ */
+ private function page_data(previewpage $page): \stdClass {
+ global $PAGE;
+ return $page->export_for_template($PAGE->get_renderer('mod_questionnaire'));
+ }
+
+ /**
+ * build_print_view() with rid = 0 populates the survey form skeleton on the page.
+ */
+ public function test_build_print_view_blank_renders_form(): void {
+ global $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$instance, ] = $this->build_fixture();
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $page = new previewpage();
+ $this->init_session();
+ (new report_view_renderer($renderer, $page))
+ ->build_print_view($instance, $instance->courseid(), '', 'preview', 0, true);
+
+ $data = $this->page_data($page);
+ $this->assertObjectHasProperty('formstart', $data);
+ $this->assertObjectHasProperty('questions', $data);
+ }
+
+ /**
+ * build_print_view() in preview mode (not blank) appends the preview-submit form end.
+ */
+ public function test_build_print_view_preview_adds_formend(): void {
+ global $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$instance, ] = $this->build_fixture();
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $page = new previewpage();
+ $this->init_session();
+ (new report_view_renderer($renderer, $page))
+ ->build_print_view($instance, $instance->courseid(), '', 'preview', 0, false);
+
+ $data = $this->page_data($page);
+ $this->assertObjectHasProperty('formend', $data);
+ }
+
+ /**
+ * build_print_view() writes the survey title via the shared header helper.
+ */
+ public function test_build_print_view_writes_title(): void {
+ global $DB, $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$instance, ] = $this->build_fixture();
+ $DB->set_field(
+ 'questionnaire_survey',
+ 'title',
+ 'Print Preview Title',
+ ['id' => $instance->surveyid()]
+ );
+ $instance = questionnaire::from_instanceid($instance->id());
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $page = new previewpage();
+ $this->init_session();
+ (new report_view_renderer($renderer, $page))
+ ->build_print_view($instance, $instance->courseid(), '', 'preview', 0, true);
+
+ $data = $this->page_data($page);
+ $this->assertObjectHasProperty('title', $data);
+ $this->assertStringContainsString('Print Preview Title', $data->title);
+ }
+
+ /**
+ * render_response() populates the responses key for an existing response.
+ */
+ public function test_render_response_populates_responses(): void {
+ global $DB, $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$instance, $studentid] = $this->build_fixture();
+ $rid = $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $instance->id(),
+ 'userid' => $studentid,
+ 'submitted' => time(),
+ 'complete' => 'y',
+ 'grade' => 0,
+ ]);
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $page = new previewpage();
+ $this->init_session();
+ (new report_view_renderer($renderer, $page))
+ ->render_response($instance, $rid, 'print');
+
+ // The 'responses' key is only present when there is at least one renderable question;
+ // even without a stored answer the YES/NO question renders an empty response row.
+ $data = $this->page_data($page);
+ $this->assertObjectHasProperty('responses', $data);
+ }
+}
diff --git a/tests/output/survey_view_renderer_test.php b/tests/output/survey_view_renderer_test.php
new file mode 100644
index 000000000..794cd66bb
--- /dev/null
+++ b/tests/output/survey_view_renderer_test.php
@@ -0,0 +1,514 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\output\survey_view_renderer.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire\output;
+
+use mod_questionnaire\questionnaire;
+
+/**
+ * Unit tests for mod_questionnaire\output\survey_view_renderer.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\output\survey_view_renderer
+ */
+final class survey_view_renderer_test extends \advanced_testcase {
+ /**
+ * Initialise the SESSION->questionnaire bucket that real callers (view.php, complete.php)
+ * set up before invoking the renderer.
+ */
+ private function init_session(): void {
+ global $SESSION;
+ if (!isset($SESSION->questionnaire) || !is_object($SESSION->questionnaire)) {
+ $SESSION->questionnaire = new \stdClass();
+ }
+ }
+
+ /**
+ * Build a course + questionnaire with one yes/no question and return both the
+ * domain object and the enrolled student id.
+ *
+ * @param string $realm Survey realm (defaults to 'private').
+ * @return array [questionnaire, student id]
+ */
+ private function build_fixture(string $realm = 'private'): array {
+ global $DB;
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $plugin = $generator->get_plugin_generator('mod_questionnaire');
+ $instance = $plugin->create_test_questionnaire(
+ $course,
+ QUESYESNO,
+ ['content' => 'Yes or no?'],
+ []
+ );
+
+ $student = $generator->create_user();
+ $studentrole = $DB->get_record('role', ['shortname' => 'student'], '*', MUST_EXIST);
+ $generator->enrol_user($student->id, $course->id, $studentrole->id);
+
+ return [$instance, (int) $student->id];
+ }
+
+ /**
+ * Expose the protected stdClass that backs the viewpage so tests can read back
+ * the keys the renderer added.
+ *
+ * @param viewpage $page
+ * @return \stdClass
+ */
+ private function page_data(viewpage $page): \stdClass {
+ global $PAGE;
+ return $page->export_for_template($PAGE->get_renderer('mod_questionnaire'));
+ }
+
+ /**
+ * build_view() writes an access-denied notification when access is blocked
+ * (template realm, current user is not the survey owner).
+ */
+ public function test_build_view_writes_access_denied(): void {
+ global $DB, $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$instance, $studentid] = $this->build_fixture();
+ // Flip the survey realm to template so user_access_messages reports "not viewable".
+ $DB->set_field(
+ 'questionnaire_survey',
+ 'realm',
+ 'template',
+ ['id' => $instance->surveyid()]
+ );
+ $instance = questionnaire::from_instanceid($instance->id());
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $page = new viewpage();
+ (new survey_view_renderer($renderer, $page))->build_view($instance, $studentid);
+
+ $data = $this->page_data($page);
+ $this->assertObjectHasProperty('notifications', $data);
+ $this->assertStringContainsString(
+ get_string('templatenotviewable', 'questionnaire'),
+ $data->notifications
+ );
+ $this->assertObjectNotHasProperty('formstart', $data);
+ }
+
+ /**
+ * build_view() falls through to build_survey_form when access is allowed, populating
+ * the standard form keys.
+ */
+ public function test_build_view_populates_survey_form_when_allowed(): void {
+ global $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$instance, $studentid] = $this->build_fixture();
+ $this->setUser($studentid);
+ $instance = questionnaire::from_instanceid($instance->id());
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $page = new viewpage();
+ $this->init_session();
+ (new survey_view_renderer($renderer, $page))->build_view($instance, $studentid);
+
+ $data = $this->page_data($page);
+ $this->assertObjectHasProperty('formstart', $data);
+ $this->assertObjectHasProperty('controlbuttons', $data);
+ $this->assertObjectHasProperty('formend', $data);
+ }
+
+ /**
+ * build_survey_form() returns null and populates formstart/controlbuttons/formend
+ * when questions exist.
+ */
+ public function test_build_survey_form_with_questions(): void {
+ global $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$instance, $studentid] = $this->build_fixture();
+ $this->setUser($studentid);
+ $instance = questionnaire::from_instanceid($instance->id());
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $page = new viewpage();
+ $this->init_session();
+ $result = (new survey_view_renderer($renderer, $page))
+ ->build_survey_form($instance, $studentid, $studentid);
+
+ $this->assertNull($result);
+ $data = $this->page_data($page);
+ $this->assertObjectHasProperty('formstart', $data);
+ $this->assertObjectHasProperty('controlbuttons', $data);
+ $this->assertObjectHasProperty('formend', $data);
+ }
+
+ /**
+ * build_survey_form() with the survey title set writes it to the page.
+ */
+ public function test_build_survey_form_writes_title(): void {
+ global $DB, $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$instance, $studentid] = $this->build_fixture();
+ $DB->set_field(
+ 'questionnaire_survey',
+ 'title',
+ 'My Survey Title',
+ ['id' => $instance->surveyid()]
+ );
+ $this->setUser($studentid);
+ $instance = questionnaire::from_instanceid($instance->id());
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $page = new viewpage();
+ $this->init_session();
+ (new survey_view_renderer($renderer, $page))
+ ->build_survey_form($instance, $studentid, $studentid);
+
+ $data = $this->page_data($page);
+ $this->assertObjectHasProperty('title', $data);
+ $this->assertStringContainsString('My Survey Title', $data->title);
+ }
+
+ /**
+ * handle_submit_action() short-circuits (returns null) when the user has already
+ * walked past the final page (formdata->end == 1).
+ */
+ public function test_handle_submit_action_short_circuits_when_past_end(): void {
+ global $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$instance, $studentid] = $this->build_fixture();
+ $this->setUser($studentid);
+ $instance = questionnaire::from_instanceid($instance->id());
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $page = new viewpage();
+ $this->init_session();
+
+ $svr = new survey_view_renderer($renderer, $page);
+ $formdata = (object)['sec' => 1, 'rid' => 0, 'end' => 1];
+ $method = new \ReflectionMethod($svr, 'handle_submit_action');
+ $method->setAccessible(true);
+
+ $this->assertNull($method->invoke($svr, $instance, $formdata, (int)$studentid));
+ }
+
+ /**
+ * handle_resume_action() persists the in-progress response and posts a
+ * "progress saved" notification to the page (delegating to goto_saved).
+ */
+ public function test_handle_resume_action_writes_savedprogress(): void {
+ global $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$instance, $studentid] = $this->build_fixture();
+ $this->setUser($studentid);
+ $instance = questionnaire::from_instanceid($instance->id());
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $page = new viewpage();
+ $this->init_session();
+
+ $svr = new survey_view_renderer($renderer, $page);
+ $formdata = (object)['sec' => 1, 'rid' => 0];
+ $method = new \ReflectionMethod($svr, 'handle_resume_action');
+ $method->setAccessible(true);
+ $method->invoke($svr, $instance, $formdata, (int)$studentid);
+
+ $data = $this->page_data($page);
+ $this->assertObjectHasProperty('notifications', $data);
+ $this->assertStringContainsString('progress has been saved', $data->notifications);
+ $this->assertNotEmpty($formdata->rid);
+ }
+
+ /**
+ * handle_next_action() advances formdata->sec to the next section on success.
+ */
+ public function test_handle_next_action_advances_to_next_section(): void {
+ global $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$instance, $studentid] = $this->build_fixture();
+ $this->setUser($studentid);
+ $instance = questionnaire::from_instanceid($instance->id());
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $page = new viewpage();
+ $this->init_session();
+
+ $svr = new survey_view_renderer($renderer, $page);
+ $formdata = (object)['sec' => 1, 'rid' => 0, 'next' => 'Next'];
+ $method = new \ReflectionMethod($svr, 'handle_next_action');
+ $method->setAccessible(true);
+ $msg = $method->invoke($svr, $instance, $formdata, (int)$studentid, 1);
+
+ $this->assertSame('', $msg);
+ $this->assertSame(2, $formdata->sec);
+ }
+
+ /**
+ * handle_submit_action() returns the validation error and refreshes formdata->rid
+ * when the user tries to submit a page with a required question left blank.
+ */
+ public function test_handle_submit_action_returns_error_on_missing_required(): void {
+ global $DB, $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$instance, $studentid] = $this->build_fixture();
+ // Mark the only question on the survey as required so check_format flags it as missing.
+ $qid = $DB->get_field('questionnaire_question', 'id', ['surveyid' => $instance->surveyid()]);
+ $DB->set_field('questionnaire_question', 'required', 'y', ['id' => $qid]);
+ $this->setUser($studentid);
+ $instance = questionnaire::from_instanceid($instance->id());
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $page = new viewpage();
+ $this->init_session();
+
+ $svr = new survey_view_renderer($renderer, $page);
+ $formdata = (object)['sec' => 1, 'rid' => 0, 'submit' => 'Submit Survey'];
+ $method = new \ReflectionMethod($svr, 'handle_submit_action');
+ $method->setAccessible(true);
+ $msg = $method->invoke($svr, $instance, $formdata, (int)$studentid);
+
+ $this->assertNotEmpty($msg);
+ $this->assertNotEmpty($formdata->rid);
+ }
+
+ /**
+ * handle_next_action() returns the validation error, clears formdata->next, and
+ * refreshes formdata->rid when the user tries to advance past a required question.
+ */
+ public function test_handle_next_action_returns_error_on_missing_required(): void {
+ global $DB, $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$instance, $studentid] = $this->build_fixture();
+ $qid = $DB->get_field('questionnaire_question', 'id', ['surveyid' => $instance->surveyid()]);
+ $DB->set_field('questionnaire_question', 'required', 'y', ['id' => $qid]);
+ $this->setUser($studentid);
+ $instance = questionnaire::from_instanceid($instance->id());
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $page = new viewpage();
+ $this->init_session();
+
+ $svr = new survey_view_renderer($renderer, $page);
+ $formdata = (object)['sec' => 1, 'rid' => 0, 'next' => 'Next'];
+ $method = new \ReflectionMethod($svr, 'handle_next_action');
+ $method->setAccessible(true);
+ $msg = $method->invoke($svr, $instance, $formdata, (int)$studentid, 1);
+
+ $this->assertNotEmpty($msg);
+ $this->assertSame('', $formdata->next);
+ $this->assertNotEmpty($formdata->rid);
+ }
+
+ /**
+ * handle_prev_action() returns a wrong-format error, clears formdata->prev,
+ * and refreshes formdata->rid when the current page contains an invalid date.
+ *
+ * Prev only checks format (not missing-required), so we use a date question
+ * with a non-date value to trigger response_valid() == false.
+ */
+ public function test_handle_prev_action_returns_error_on_invalid_format(): void {
+ global $DB, $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $plugin = $generator->get_plugin_generator('mod_questionnaire');
+ $instance = $plugin->create_test_questionnaire(
+ $course,
+ QUESDATE,
+ ['content' => 'When?'],
+ []
+ );
+ $student = $generator->create_user();
+ $studentrole = $DB->get_record('role', ['shortname' => 'student'], '*', MUST_EXIST);
+ $generator->enrol_user($student->id, $course->id, $studentrole->id);
+ $this->setUser($student->id);
+ $instance = questionnaire::from_instanceid($instance->id());
+
+ $qid = $DB->get_field('questionnaire_question', 'id', ['surveyid' => $instance->surveyid()]);
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $page = new viewpage();
+ $this->init_session();
+
+ $svr = new survey_view_renderer($renderer, $page);
+ $formdata = (object)['sec' => 1, 'rid' => 0, 'prev' => 'Prev', 'q' . $qid => 'not-a-date'];
+ $method = new \ReflectionMethod($svr, 'handle_prev_action');
+ $method->setAccessible(true);
+ $msg = $method->invoke($svr, $instance, $formdata, (int)$student->id);
+
+ $this->assertNotEmpty($msg);
+ $this->assertSame('', $formdata->prev);
+ $this->assertNotEmpty($formdata->rid);
+ }
+
+ /**
+ * handle_prev_action() walks back from the past-end summary by decrementing
+ * sec and clearing SESSION->end before validating the current page.
+ */
+ public function test_handle_prev_action_walks_back_from_past_end(): void {
+ global $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$instance, $studentid] = $this->build_fixture();
+ $this->setUser($studentid);
+ $instance = questionnaire::from_instanceid($instance->id());
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $page = new viewpage();
+ $this->init_session();
+
+ $svr = new survey_view_renderer($renderer, $page);
+ // After the user walked past the last section (sec=2 + end=1), pressing Prev should land them on sec=1
+ // with the end flag cleared.
+ $formdata = (object)['sec' => 2, 'rid' => 0, 'prev' => 'Prev', 'end' => 1];
+ $method = new \ReflectionMethod($svr, 'handle_prev_action');
+ $method->setAccessible(true);
+ $method->invoke($svr, $instance, $formdata, (int)$studentid);
+
+ $this->assertSame(0, $formdata->end);
+ }
+
+ /**
+ * print_survey_end() writes a "page X of Y" footer when auto-numbering is on and
+ * there is more than one section.
+ */
+ public function test_print_survey_end_writes_pageinfo(): void {
+ global $DB, $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$instance, ] = $this->build_fixture();
+ // The autonum bit 2 (decimal 2 or 3) turns on page auto-numbering.
+ $DB->set_field('questionnaire', 'autonum', 3, ['id' => $instance->id()]);
+ $instance = questionnaire::from_instanceid($instance->id());
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $page = new viewpage();
+ (new survey_view_renderer($renderer, $page))->print_survey_end($instance, 1, 3);
+
+ $data = $this->page_data($page);
+ $this->assertObjectHasProperty('pageinfo', $data);
+ $this->assertStringContainsString('1', $data->pageinfo);
+ }
+
+ /**
+ * print_survey_end() is a no-op when there is only one section.
+ */
+ public function test_print_survey_end_skips_single_section(): void {
+ global $DB, $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$instance, ] = $this->build_fixture();
+ $DB->set_field('questionnaire', 'autonum', 3, ['id' => $instance->id()]);
+ $instance = questionnaire::from_instanceid($instance->id());
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $page = new viewpage();
+ (new survey_view_renderer($renderer, $page))->print_survey_end($instance, 1, 1);
+
+ $data = $this->page_data($page);
+ $this->assertObjectNotHasProperty('pageinfo', $data);
+ }
+
+ /**
+ * print_survey_end() is a no-op when auto-numbering is disabled.
+ */
+ public function test_print_survey_end_skips_when_autonum_off(): void {
+ global $DB, $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$instance, ] = $this->build_fixture();
+ $DB->set_field('questionnaire', 'autonum', 0, ['id' => $instance->id()]);
+ $instance = questionnaire::from_instanceid($instance->id());
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $page = new viewpage();
+ (new survey_view_renderer($renderer, $page))->print_survey_end($instance, 1, 5);
+
+ $data = $this->page_data($page);
+ $this->assertObjectNotHasProperty('pageinfo', $data);
+ }
+
+ /**
+ * goto_saved() adds a save-progress notification and a back-to-course homelink.
+ */
+ public function test_goto_saved_writes_savedprogress_notification(): void {
+ global $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$instance, $studentid] = $this->build_fixture();
+ $this->setUser($studentid);
+ $instance = questionnaire::from_instanceid($instance->id());
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $page = new viewpage();
+ (new survey_view_renderer($renderer, $page))->goto_saved($instance);
+
+ $data = $this->page_data($page);
+ $this->assertObjectHasProperty('notifications', $data);
+ $this->assertStringContainsString('progress has been saved', $data->notifications);
+ $this->assertObjectHasProperty('respondentinfo', $data);
+ }
+
+ /**
+ * goto_thankyou() writes the thank-you title and a continue button when no thanks URL is set.
+ */
+ public function test_goto_thankyou_writes_title_and_continue(): void {
+ global $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$instance, $studentid] = $this->build_fixture();
+ $this->setUser($studentid);
+ $instance = questionnaire::from_instanceid($instance->id());
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $page = new viewpage();
+ (new survey_view_renderer($renderer, $page))->goto_thankyou($instance);
+
+ $data = $this->page_data($page);
+ $this->assertObjectHasProperty('title', $data);
+ $this->assertObjectHasProperty('continue', $data);
+ }
+}
diff --git a/tests/output/tabs_test.php b/tests/output/tabs_test.php
new file mode 100644
index 000000000..fd68aa3d1
--- /dev/null
+++ b/tests/output/tabs_test.php
@@ -0,0 +1,189 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\output\tabs.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire\output;
+
+use mod_questionnaire\questionnaire;
+
+/**
+ * Unit tests for mod_questionnaire\output\tabs.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\output\tabs
+ */
+final class tabs_test extends \advanced_testcase {
+ /**
+ * Build a course + questionnaire with one yes/no question.
+ *
+ * @return questionnaire
+ */
+ private function build_questionnaire(): questionnaire {
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ return $generator->get_plugin_generator('mod_questionnaire')->create_test_questionnaire(
+ $course,
+ QUESYESNO,
+ ['content' => 'Yes or no?'],
+ []
+ );
+ }
+
+ /**
+ * Seed a complete student response so the staff "All responses" tab path is reachable.
+ *
+ * @param questionnaire $questionnaire
+ * @return void
+ */
+ private function seed_complete_response(questionnaire $questionnaire): void {
+ $generator = $this->getDataGenerator();
+ $student = $generator->create_user();
+ $generator->enrol_user($student->id, $questionnaire->course()->id, 'student');
+ $generator->get_plugin_generator('mod_questionnaire')->generate_response(
+ $questionnaire,
+ $questionnaire->questions(),
+ (int) $student->id,
+ true
+ );
+ $this->setAdminUser();
+ }
+
+ /**
+ * Render the tabs into a fresh feedbackpage and return its tabsarea HTML.
+ *
+ * @param questionnaire $questionnaire
+ * @param string $currenttab
+ * @param int|null $currentgroupid
+ * @param int|null $rid
+ * @return string
+ */
+ private function render_tabsarea(
+ questionnaire $questionnaire,
+ string $currenttab,
+ ?int $currentgroupid = null,
+ ?int $rid = null,
+ ): string {
+ global $PAGE;
+ $page = new feedbackpage();
+ (new tabs($questionnaire, $currenttab, $currentgroupid, $rid))->render($page);
+ $data = $page->export_for_template($PAGE->get_renderer('mod_questionnaire'));
+ return (string) ($data->tabsarea ?? '');
+ }
+
+ /**
+ * Owner with full caps sees the settings + questions + feedback + preview row.
+ * Uses an inactive currenttab so every management tab renders with a clickable href.
+ */
+ public function test_owner_admin_sees_management_tabs(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+ $questionnaire = $this->build_questionnaire();
+
+ $html = $this->render_tabsarea($questionnaire, 'inactive-tab');
+
+ $this->assertStringContainsString('qsettings.php', $html);
+ $this->assertStringContainsString('questions.php', $html);
+ $this->assertStringContainsString('feedback.php', $html);
+ $this->assertStringContainsString('preview.php', $html);
+ }
+
+ /**
+ * On the 'vall' tab with a complete response present, the all-responses sub-row appears.
+ * The vrespsummary sub-tab is clickable on this currenttab and includes byresponse=1.
+ */
+ public function test_vall_subrow_visible_when_responses_present(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+ $questionnaire = $this->build_questionnaire();
+ $this->seed_complete_response($questionnaire);
+
+ $html = $this->render_tabsarea($questionnaire, 'vall');
+
+ // The vall sub-row introduces the "View by response" sub-tab (vrespsummary).
+ $this->assertStringContainsString('byresponse=1', $html);
+ $this->assertStringContainsString('action=vresp', $html);
+ }
+
+ /**
+ * On the 'individualresp' tab the deleteresp sub-tab becomes a clickable link
+ * carrying the supplied rid.
+ */
+ public function test_deleteresp_tab_includes_rid(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+ $questionnaire = $this->build_questionnaire();
+ $this->seed_complete_response($questionnaire);
+
+ $html = $this->render_tabsarea($questionnaire, 'individualresp', 0, 4242);
+
+ $this->assertStringContainsString('rid=4242', $html);
+ }
+
+ /**
+ * The currentgroupid parameter feeds into the All-responses sub-row href group= param.
+ */
+ public function test_currentgroupid_threads_into_subrow_links(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+ $questionnaire = $this->build_questionnaire();
+ $this->seed_complete_response($questionnaire);
+
+ $html = $this->render_tabsarea($questionnaire, 'valldefault', 77);
+
+ $this->assertStringContainsString('group=77', $html);
+ }
+
+ /**
+ * Unknown tab name still renders the management row without errors.
+ */
+ public function test_unknown_tab_renders_main_row_only(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+ $questionnaire = $this->build_questionnaire();
+
+ $html = $this->render_tabsarea($questionnaire, 'no-such-tab');
+
+ // No sub-row indicators (order_default appears only on the vall sub-row).
+ $this->assertStringNotContainsString('order_default', $html);
+ // Main row still renders something for settings.
+ $this->assertStringContainsString('qsettings.php', $html);
+ }
+
+ /**
+ * Student without manage caps does NOT see the staff management row.
+ */
+ public function test_student_without_responses_sees_no_tabsarea(): void {
+ $this->resetAfterTest();
+ $questionnaire = $this->build_questionnaire();
+
+ $student = $this->getDataGenerator()->create_user();
+ $this->getDataGenerator()->enrol_user($student->id, $questionnaire->course()->id, 'student');
+ $this->setUser($student);
+
+ $html = $this->render_tabsarea($questionnaire, 'view');
+
+ // No row to print (count(row) <= 1 short-circuits).
+ $this->assertSame('', $html);
+ }
+}
diff --git a/tests/privacy_provider_test.php b/tests/privacy_provider_test.php
index b4aa58840..21da4e4ae 100644
--- a/tests/privacy_provider_test.php
+++ b/tests/privacy_provider_test.php
@@ -61,7 +61,7 @@ public function test_get_contexts_for_userid(): void {
$user = $DB->get_record('user', ['firstname' => 'Testy']);
$questionnaires = $qdg->questionnaires();
$questionnaire = current($questionnaires);
- [$course, $cm] = get_course_and_cm_from_instance($questionnaire->id, 'questionnaire', $questionnaire->course);
+ [$course, $cm] = get_course_and_cm_from_instance($questionnaire->id(), 'questionnaire', $questionnaire->courseid());
$contextlist = provider::get_contexts_for_userid($user->id);
// Check that we only get back one context.
@@ -87,7 +87,7 @@ public function test_get_users_in_context(): void {
$user = $DB->get_record('user', ['firstname' => 'Testy']);
$questionnaires = $qdg->questionnaires();
$questionnaire = current($questionnaires);
- [$course, $cm] = get_course_and_cm_from_instance($questionnaire->id, 'questionnaire', $questionnaire->course);
+ [$course, $cm] = get_course_and_cm_from_instance($questionnaire->id(), 'questionnaire', $questionnaire->courseid());
$cmcontext = \context_module::instance($cm->id);
$userlist = new \core_privacy\local\request\userlist($cmcontext, 'mod_questionnaire');
@@ -120,7 +120,7 @@ public function test_export_user_data(): void {
$user = $DB->get_record('user', ['firstname' => 'Testy']);
$questionnaires = $qdg->questionnaires();
$questionnaire = current($questionnaires);
- [$course, $cm] = get_course_and_cm_from_instance($questionnaire->id, 'questionnaire', $questionnaire->course);
+ [$course, $cm] = get_course_and_cm_from_instance($questionnaire->id(), 'questionnaire', $questionnaire->courseid());
$cmcontext = \context_module::instance($cm->id);
$writer = \core_privacy\local\request\writer::with_context($cmcontext);
@@ -130,8 +130,8 @@ public function test_export_user_data(): void {
provider::export_user_data($approvedlist);
$data = $writer->get_data([]);
- $this->assertStringContainsString($questionnaire->name, strip_tags($data->name));
- $this->assertEquals($questionnaire->intro, strip_tags($data->intro));
+ $this->assertStringContainsString($questionnaire->name(), strip_tags($data->name));
+ $this->assertEquals($questionnaire->intro(), strip_tags($data->intro));
$this->assertNotEmpty($data->responses[0]['questions']);
$this->assertEquals('1. Text Box 1000', $data->responses[0]['questions'][1]->questionname);
$this->assertEquals('Test answer', $data->responses[0]['questions'][1]->answers[0]);
@@ -157,7 +157,7 @@ public function test_delete_data_for_all_users_in_context(): void {
$user = $DB->get_record('user', ['username' => 'username1']);
$questionnaires = $qdg->questionnaires();
$questionnaire = current($questionnaires);
- [$course, $cm] = get_course_and_cm_from_instance($questionnaire->id, 'questionnaire', $questionnaire->course);
+ [$course, $cm] = get_course_and_cm_from_instance($questionnaire->id(), 'questionnaire', $questionnaire->courseid());
$cmcontext = \context_module::instance($cm->id);
// Get all accounts. There should be two.
@@ -183,7 +183,7 @@ public function test_delete_data_for_user(): void {
$user = $DB->get_record('user', ['username' => 'username1']);
$questionnaires = $qdg->questionnaires();
$questionnaire = current($questionnaires);
- [$course, $cm] = get_course_and_cm_from_instance($questionnaire->id, 'questionnaire', $questionnaire->course);
+ [$course, $cm] = get_course_and_cm_from_instance($questionnaire->id(), 'questionnaire', $questionnaire->courseid());
$cmcontext = \context_module::instance($cm->id);
// Get all accounts. There should be two.
@@ -215,7 +215,7 @@ public function test_delete_data_for_users(): void {
$user3 = $DB->get_record('user', ['username' => 'username3']);
$questionnaires = $qdg->questionnaires();
$questionnaire = current($questionnaires);
- [$course, $cm] = get_course_and_cm_from_instance($questionnaire->id, 'questionnaire', $questionnaire->course);
+ [$course, $cm] = get_course_and_cm_from_instance($questionnaire->id(), 'questionnaire', $questionnaire->courseid());
$cmcontext = \context_module::instance($cm->id);
$approveduserlist = new \core_privacy\local\request\approved_userlist($cmcontext, 'questionnaire', [$user->id, $user3->id]);
diff --git a/tests/question_navigator_test.php b/tests/question_navigator_test.php
new file mode 100644
index 000000000..aee65d057
--- /dev/null
+++ b/tests/question_navigator_test.php
@@ -0,0 +1,349 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\local\question_navigator.
+ *
+ * All tests use in-memory stubs (no DB) via survey_testable and anonymous
+ * question stubs — the same pattern used in questionnaire_test.php.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire;
+
+use mod_questionnaire\local\db\survey_record;
+use mod_questionnaire\local\question_navigator;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+require_once($CFG->dirroot . '/mod/questionnaire/tests/survey_testable.php');
+
+/**
+ * Unit tests for question_navigator.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\local\question_navigator
+ */
+final class question_navigator_test extends \advanced_testcase {
+ // Helpers.
+
+ /**
+ * Build an in-memory survey_record with sensible defaults.
+ *
+ * @param array $fields
+ * @return survey_record
+ */
+ private function make_survey_record(array $fields = []): survey_record {
+ return new survey_record(0, (object)array_merge([
+ 'id' => 1,
+ 'name' => 'Test survey',
+ 'courseid' => 1,
+ 'realm' => 'private',
+ 'status' => 0,
+ 'title' => '',
+ 'email' => null,
+ 'subtitle' => null,
+ 'info' => null,
+ 'theme' => null,
+ 'thankspage' => null,
+ 'thankhead' => null,
+ 'thankbody' => null,
+ 'feedbacksections' => 0,
+ 'feedbacknotes' => null,
+ 'feedbackscores' => 0,
+ 'charttype' => null,
+ ], $fields));
+ }
+
+ /**
+ * Build a survey_testable with injected questions.
+ *
+ * @param array $questions Keyed by question id.
+ * @param array $questionsbysec Keyed by 1-based section number.
+ * @return survey_testable
+ */
+ private function make_survey(array $questions = [], array $questionsbysec = []): survey_testable {
+ $survey = new survey_testable($this->make_survey_record());
+ $survey->set_questions($questions);
+ $survey->set_questions_by_sec($questionsbysec);
+ return $survey;
+ }
+
+ /**
+ * Build a question_navigator from a survey and a skip-logic flag.
+ *
+ * @param survey_testable $survey
+ * @param bool $skiplogicenabled
+ * @return question_navigator
+ */
+ private function make_navigator(survey_testable $survey, bool $skiplogicenabled = false): question_navigator {
+ return new question_navigator($survey, $skiplogicenabled);
+ }
+
+ /**
+ * Build an anonymous question stub with the given id and dependency list.
+ *
+ * The stub satisfies the interface expected by question_navigator:
+ * has_dependencies(), id(), dependency_fulfilled().
+ *
+ * @param int $id
+ * @param array $dependencies
+ * @return object
+ */
+ private function make_stub_question(int $id, array $dependencies): object {
+ return new class ($id, $dependencies) {
+ /** @var int */
+ public int $id;
+ /** @var array */
+ public array $dependencies;
+ /** @var int */
+ public int $position = 0;
+ /** @var string */
+ public string $name = '';
+ /** @var string */
+ public string $content = '';
+ /** @var int */
+ public int $typeid = 0;
+
+ /**
+ * Constructor.
+ * @param int $id
+ * @param array $dependencies
+ */
+ public function __construct(int $id, array $dependencies) {
+ $this->id = $id;
+ $this->dependencies = $dependencies;
+ }
+
+ /**
+ * True if dependencies are non-empty.
+ * @return bool
+ */
+ public function has_dependencies(): bool {
+ return !empty($this->dependencies);
+ }
+
+ /**
+ * Return the question id.
+ * @return int
+ */
+ public function id(): int {
+ return $this->id;
+ }
+
+ /**
+ * Always fulfilled when no dependencies are set (used in navigation tests).
+ * @param mixed $rid
+ * @param mixed $questions
+ * @return bool
+ */
+ public function dependency_fulfilled($rid, $questions): bool {
+ return !$this->has_dependencies();
+ }
+ };
+ }
+
+ // Tests for has_dependencies().
+
+ /**
+ * Asserts has_dependencies() returns false when skip-logic is disabled.
+ *
+ * @covers \mod_questionnaire\local\question_navigator::has_dependencies
+ */
+ public function test_has_dependencies_false_when_skiplogic_disabled(): void {
+ $dep = (object)['dependquestionid' => 2, 'dependchoiceid' => 1, 'dependlogic' => 1, 'dependandor' => 'and'];
+ $survey = $this->make_survey([
+ 1 => $this->make_stub_question(1, []),
+ 2 => $this->make_stub_question(2, [99 => $dep]),
+ ]);
+ $nav = $this->make_navigator($survey, false);
+ $this->assertFalse($nav->has_dependencies());
+ }
+
+ /**
+ * Asserts has_dependencies() returns false when skip-logic is on but no question has deps.
+ *
+ * @covers \mod_questionnaire\local\question_navigator::has_dependencies
+ */
+ public function test_has_dependencies_false_when_no_question_has_deps(): void {
+ $survey = $this->make_survey([
+ 1 => $this->make_stub_question(1, []),
+ 2 => $this->make_stub_question(2, []),
+ ]);
+ $nav = $this->make_navigator($survey, true);
+ $this->assertFalse($nav->has_dependencies());
+ }
+
+ /**
+ * Asserts has_dependencies() returns true when skip-logic is on and a question has a dep.
+ *
+ * @covers \mod_questionnaire\local\question_navigator::has_dependencies
+ */
+ public function test_has_dependencies_true_when_question_has_dep(): void {
+ $dep = (object)['dependquestionid' => 1, 'dependchoiceid' => 1, 'dependlogic' => 1, 'dependandor' => 'and'];
+ $survey = $this->make_survey([
+ 1 => $this->make_stub_question(1, []),
+ 2 => $this->make_stub_question(2, [99 => $dep]),
+ ]);
+ $nav = $this->make_navigator($survey, true);
+ $this->assertTrue($nav->has_dependencies());
+ }
+
+ // Tests for get_dependants().
+
+ /**
+ * Asserts get_dependants() returns an empty array when no questions depend on the given question.
+ *
+ * @covers \mod_questionnaire\local\question_navigator::get_dependants
+ */
+ public function test_get_dependants_returns_empty_when_none(): void {
+ $survey = $this->make_survey([
+ 1 => $this->make_stub_question(1, []),
+ 2 => $this->make_stub_question(2, []),
+ ]);
+ $nav = $this->make_navigator($survey);
+ $this->assertSame([], $nav->get_dependants(1));
+ }
+
+ /**
+ * Asserts get_dependants() returns IDs of questions that depend on the given question.
+ *
+ * @covers \mod_questionnaire\local\question_navigator::get_dependants
+ */
+ public function test_get_dependants_returns_dependent_ids(): void {
+ $dep = (object)['dependquestionid' => 1, 'dependchoiceid' => 1, 'dependlogic' => 1, 'dependandor' => 'and'];
+ $survey = $this->make_survey([
+ 1 => $this->make_stub_question(1, []),
+ 2 => $this->make_stub_question(2, [10 => $dep]),
+ 3 => $this->make_stub_question(3, []),
+ ]);
+ $nav = $this->make_navigator($survey);
+ $this->assertSame([2], $nav->get_dependants(1));
+ }
+
+ /**
+ * Asserts get_dependants() returns multiple IDs when several questions depend on the same parent.
+ *
+ * @covers \mod_questionnaire\local\question_navigator::get_dependants
+ */
+ public function test_get_dependants_returns_multiple_dependants(): void {
+ $dep1 = (object)['dependquestionid' => 1, 'dependchoiceid' => 1, 'dependlogic' => 1, 'dependandor' => 'and'];
+ $dep2 = (object)['dependquestionid' => 1, 'dependchoiceid' => 2, 'dependlogic' => 1, 'dependandor' => 'and'];
+ $survey = $this->make_survey([
+ 1 => $this->make_stub_question(1, []),
+ 2 => $this->make_stub_question(2, [10 => $dep1]),
+ 3 => $this->make_stub_question(3, [11 => $dep2]),
+ ]);
+ $nav = $this->make_navigator($survey);
+ $result = $nav->get_dependants(1);
+ sort($result);
+ $this->assertSame([2, 3], $result);
+ }
+
+ // Tests for get_dependants_and_choices().
+
+ /**
+ * Asserts get_dependants_and_choices() returns an empty array when no dependencies exist.
+ *
+ * @covers \mod_questionnaire\local\question_navigator::get_dependants_and_choices
+ */
+ public function test_get_dependants_and_choices_empty_when_none(): void {
+ $survey = $this->make_survey([
+ 1 => $this->make_stub_question(1, []),
+ 2 => $this->make_stub_question(2, []),
+ ]);
+ $nav = $this->make_navigator($survey);
+ $this->assertSame([], $nav->get_dependants_and_choices());
+ }
+
+ /**
+ * Asserts get_dependants_and_choices() returns the correct parent→child map.
+ *
+ * @covers \mod_questionnaire\local\question_navigator::get_dependants_and_choices
+ */
+ public function test_get_dependants_and_choices_returns_map(): void {
+ $dep = (object)['dependquestionid' => 1, 'dependchoiceid' => 5, 'dependlogic' => 1, 'dependandor' => 'and'];
+ $survey = $this->make_survey([
+ 1 => $this->make_stub_question(1, []),
+ 2 => $this->make_stub_question(2, [10 => $dep]),
+ ]);
+ $nav = $this->make_navigator($survey);
+ $result = $nav->get_dependants_and_choices();
+ $this->assertArrayHasKey(1, $result);
+ $this->assertArrayHasKey(2, $result[1]);
+ $this->assertEquals(5, $result[1][2][0]->choiceid);
+ $this->assertEquals(1, $result[1][2][0]->logic);
+ $this->assertEquals('and', $result[1][2][0]->andor);
+ }
+
+ // Tests for the eligible_questions_on_page, next_page and prev_page navigation methods.
+
+ /**
+ * Asserts eligible_questions_on_page() returns true for a question with no dependencies.
+ *
+ * @covers \mod_questionnaire\local\question_navigator::eligible_questions_on_page
+ */
+ public function test_eligible_questions_on_page_with_no_deps(): void {
+ $stub = $this->make_stub_question(1, []);
+ $survey = $this->make_survey([1 => $stub], [1 => [$stub]]);
+ $nav = $this->make_navigator($survey, false);
+ $this->assertTrue($nav->eligible_questions_on_page(1, 0));
+ }
+
+ /**
+ * Asserts next_page() increments section when there are no dependencies.
+ *
+ * @covers \mod_questionnaire\local\question_navigator::next_page
+ */
+ public function test_next_page_no_dependencies(): void {
+ $stub1 = $this->make_stub_question(1, []);
+ $stub2 = $this->make_stub_question(2, []);
+ $stub3 = $this->make_stub_question(3, []);
+ $survey = $this->make_survey(
+ [1 => $stub1, 2 => $stub2, 3 => $stub3],
+ [1 => [$stub1], 2 => [$stub2], 3 => [$stub3]]
+ );
+ $nav = $this->make_navigator($survey, false);
+ $this->assertEquals(2, $nav->next_page(1, 0));
+ $this->assertEquals(3, $nav->next_page(2, 0));
+ // Past the last section — returns the (invalid) incremented number, not false,
+ // because the skip-loop only runs when has_dependencies() is true.
+ $this->assertEquals(4, $nav->next_page(3, 0));
+ }
+
+ /**
+ * Asserts prev_page() decrements section when there are no dependencies.
+ *
+ * @covers \mod_questionnaire\local\question_navigator::prev_page
+ */
+ public function test_prev_page_no_dependencies(): void {
+ $stub1 = $this->make_stub_question(1, []);
+ $stub2 = $this->make_stub_question(2, []);
+ $survey = $this->make_survey(
+ [1 => $stub1, 2 => $stub2],
+ [1 => [$stub1], 2 => [$stub2]]
+ );
+ $nav = $this->make_navigator($survey, false);
+ $this->assertEquals(1, $nav->prev_page(2, 0));
+ // Section 1 → decrements to 0 → returns false.
+ $this->assertFalse($nav->prev_page(1, 0));
+ }
+}
diff --git a/tests/question_type_test.php b/tests/question_type_test.php
new file mode 100644
index 000000000..926664e20
--- /dev/null
+++ b/tests/question_type_test.php
@@ -0,0 +1,205 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\local\question_type.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire;
+
+use mod_questionnaire\local\question_type;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+
+/**
+ * Unit tests for mod_questionnaire\local\question_type.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\local\question_type
+ */
+final class question_type_test extends \advanced_testcase {
+ // Tests for qtypename().
+
+ /**
+ * Asserts qtypename() returns the correct short name for the yes/no type.
+ *
+ * @covers \mod_questionnaire\local\question_type::qtypename
+ */
+ public function test_qtypename_returns_yesno_for_type_1(): void {
+ $this->assertEquals('yesno', question_type::qtypename(question_type::QUESYESNO));
+ }
+
+ /**
+ * Asserts qtypename() returns the correct short name for the essay type.
+ *
+ * @covers \mod_questionnaire\local\question_type::qtypename
+ */
+ public function test_qtypename_returns_essay_for_essay_type(): void {
+ $this->assertEquals('essay', question_type::qtypename(question_type::QUESESSAY));
+ }
+
+ /**
+ * Asserts qtypename() returns an empty string for an unknown type id.
+ *
+ * @covers \mod_questionnaire\local\question_type::qtypename
+ */
+ public function test_qtypename_returns_empty_string_for_unknown_type(): void {
+ $this->assertSame('', question_type::qtypename(999));
+ }
+
+ /**
+ * Asserts qtypename() returns an empty string for QUESCHOOSE which is a UI placeholder.
+ *
+ * @covers \mod_questionnaire\local\question_type::qtypename
+ */
+ public function test_qtypename_returns_empty_string_for_choose_type(): void {
+ $this->assertSame('', question_type::qtypename(question_type::QUESCHOOSE));
+ }
+
+ // Tests for qtypenames().
+
+ /**
+ * Asserts qtypenames() returns an array.
+ *
+ * @covers \mod_questionnaire\local\question_type::qtypenames
+ */
+ public function test_qtypenames_returns_array(): void {
+ $this->assertIsArray(question_type::qtypenames());
+ }
+
+ /**
+ * Asserts qtypenames() contains entries for all standard question types.
+ *
+ * @covers \mod_questionnaire\local\question_type::qtypenames
+ */
+ public function test_qtypenames_contains_all_standard_types(): void {
+ $names = question_type::qtypenames();
+ $this->assertArrayHasKey(question_type::QUESYESNO, $names);
+ $this->assertArrayHasKey(question_type::QUESTEXT, $names);
+ $this->assertArrayHasKey(question_type::QUESESSAY, $names);
+ $this->assertArrayHasKey(question_type::QUESRADIO, $names);
+ $this->assertArrayHasKey(question_type::QUESCHECK, $names);
+ $this->assertArrayHasKey(question_type::QUESDROP, $names);
+ $this->assertArrayHasKey(question_type::QUESRATE, $names);
+ $this->assertArrayHasKey(question_type::QUESDATE, $names);
+ $this->assertArrayHasKey(question_type::QUESNUMERIC, $names);
+ $this->assertArrayHasKey(question_type::QUESSLIDER, $names);
+ $this->assertArrayHasKey(question_type::QUESFILE, $names);
+ $this->assertArrayHasKey(question_type::QUESPAGEBREAK, $names);
+ $this->assertArrayHasKey(question_type::QUESSECTIONTEXT, $names);
+ }
+
+ /**
+ * Asserts qtypenames() does not include QUESCHOOSE which is a UI placeholder with no stored type.
+ *
+ * @covers \mod_questionnaire\local\question_type::qtypenames
+ */
+ public function test_qtypenames_does_not_include_choose_type(): void {
+ $this->assertArrayNotHasKey(question_type::QUESCHOOSE, question_type::qtypenames());
+ }
+
+ // Tests for display_name().
+
+ /**
+ * Asserts display_name() returns a non-empty string for every known question type.
+ *
+ * @covers \mod_questionnaire\local\question_type::display_name
+ */
+ public function test_display_name_returns_non_empty_string_for_each_known_type(): void {
+ $this->resetAfterTest();
+ $types = [
+ question_type::QUESYESNO,
+ question_type::QUESTEXT,
+ question_type::QUESESSAY,
+ question_type::QUESRADIO,
+ question_type::QUESCHECK,
+ question_type::QUESDROP,
+ question_type::QUESRATE,
+ question_type::QUESDATE,
+ question_type::QUESNUMERIC,
+ question_type::QUESSLIDER,
+ question_type::QUESFILE,
+ question_type::QUESSECTIONTEXT,
+ question_type::QUESPAGEBREAK,
+ ];
+ foreach ($types as $typeid) {
+ $name = question_type::display_name($typeid);
+ $this->assertNotEmpty($name, "display_name($typeid) should not be empty");
+ $this->assertIsString($name);
+ }
+ }
+
+ /**
+ * Asserts display_name() returns an empty string for an unknown type id.
+ *
+ * @covers \mod_questionnaire\local\question_type::display_name
+ */
+ public function test_display_name_returns_empty_string_for_unknown_type(): void {
+ $this->assertSame('', question_type::display_name(999));
+ }
+
+ /**
+ * Asserts display_name() returns an empty string for QUESCHOOSE which has no display name.
+ *
+ * @covers \mod_questionnaire\local\question_type::display_name
+ */
+ public function test_display_name_returns_empty_string_for_choose_type(): void {
+ $this->assertSame('', question_type::display_name(question_type::QUESCHOOSE));
+ }
+
+ // Tests for from_typeid().
+
+ /**
+ * Asserts from_typeid() returns a question_type instance for a known type.
+ *
+ * @covers \mod_questionnaire\local\question_type::from_typeid
+ */
+ public function test_from_typeid_returns_question_type_for_yesno(): void {
+ $this->resetAfterTest();
+ $qt = question_type::from_typeid(question_type::QUESYESNO);
+ $this->assertNotNull($qt);
+ $this->assertInstanceOf(question_type::class, $qt);
+ }
+
+ /**
+ * Asserts from_typeid() returns null when the type id does not exist in the database.
+ *
+ * @covers \mod_questionnaire\local\question_type::from_typeid
+ */
+ public function test_from_typeid_returns_null_for_invalid_typeid(): void {
+ $this->resetAfterTest();
+ $this->assertNull(question_type::from_typeid(999));
+ }
+
+ /**
+ * Asserts from_typeid() returns the same instance on repeated calls due to per-request caching.
+ *
+ * @covers \mod_questionnaire\local\question_type::from_typeid
+ */
+ public function test_from_typeid_returns_same_instance_on_repeat_call(): void {
+ $this->resetAfterTest();
+ $first = question_type::from_typeid(question_type::QUESTEXT);
+ $second = question_type::from_typeid(question_type::QUESTEXT);
+ $this->assertSame($first, $second);
+ }
+}
diff --git a/tests/questionnaire_responses_test.php b/tests/questionnaire_responses_test.php
new file mode 100644
index 000000000..31d971aac
--- /dev/null
+++ b/tests/questionnaire_responses_test.php
@@ -0,0 +1,580 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\local\response\questionnaire_responses static methods.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire;
+
+use mod_questionnaire\local\question_type;
+use mod_questionnaire\local\response\questionnaire_responses;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+
+/**
+ * Unit tests for mod_questionnaire\local\response\questionnaire_responses static methods.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\local\response\questionnaire_responses
+ */
+final class questionnaire_responses_test extends \advanced_testcase {
+ // Tests for count_for_question().
+
+ /**
+ * Asserts count_for_question() returns zero for the QUESSECTIONTEXT type without any DB query.
+ *
+ * @covers \mod_questionnaire\local\response\questionnaire_responses::count_for_question
+ */
+ public function test_count_for_question_returns_zero_for_sectiontext(): void {
+ $this->assertEquals(0, questionnaire_responses::count_for_question(99, question_type::QUESSECTIONTEXT));
+ }
+
+ /**
+ * Asserts count_for_question() returns zero when no response records exist for the question.
+ *
+ * @covers \mod_questionnaire\local\response\questionnaire_responses::count_for_question
+ */
+ public function test_count_for_question_returns_zero_when_no_records(): void {
+ $this->resetAfterTest();
+ // Use a question id that has never had responses.
+ $this->assertEquals(0, questionnaire_responses::count_for_question(99999, question_type::QUESYESNO));
+ }
+
+ /**
+ * Asserts count_for_question() returns the correct count after inserting response records.
+ *
+ * @covers \mod_questionnaire\local\response\questionnaire_responses::count_for_question
+ */
+ public function test_count_for_question_returns_correct_count(): void {
+ global $DB;
+ $this->resetAfterTest();
+
+ // Insert two yes/no response records for the same question id.
+ $qid = 12301;
+ $DB->insert_record('questionnaire_response_bool', (object)['questionid' => $qid, 'responseid' => 1, 'choice' => 'y']);
+ $DB->insert_record('questionnaire_response_bool', (object)['questionid' => $qid, 'responseid' => 2, 'choice' => 'n']);
+
+ $this->assertEquals(2, questionnaire_responses::count_for_question($qid, question_type::QUESYESNO));
+ }
+
+ /**
+ * Asserts count_for_question() only counts records for the specified question id.
+ *
+ * @covers \mod_questionnaire\local\response\questionnaire_responses::count_for_question
+ */
+ public function test_count_for_question_counts_only_matching_questionid(): void {
+ global $DB;
+ $this->resetAfterTest();
+
+ $qid = 12302;
+ $otherid = 12303;
+ $DB->insert_record('questionnaire_response_bool', (object)['questionid' => $qid, 'responseid' => 1, 'choice' => 'y']);
+ $DB->insert_record('questionnaire_response_bool', (object)['questionid' => $otherid, 'responseid' => 2, 'choice' => 'n']);
+
+ $this->assertEquals(1, questionnaire_responses::count_for_question($qid, question_type::QUESYESNO));
+ }
+
+ /**
+ * Asserts count_for_question() returns zero for an unknown type id with no response table.
+ *
+ * @covers \mod_questionnaire\local\response\questionnaire_responses::count_for_question
+ */
+ public function test_count_for_question_returns_zero_for_unknown_type(): void {
+ $this->resetAfterTest();
+ $this->assertEquals(0, questionnaire_responses::count_for_question(1, 999));
+ }
+
+ // Tests for delete_old_responses().
+
+ /**
+ * Asserts delete_old_responses() deletes responses older than the questionnaire's retention period.
+ *
+ * @covers \mod_questionnaire\local\response\questionnaire_responses::delete_old_responses
+ */
+ public function test_delete_old_responses_removes_expired_responses(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $questionnaire = $this->getDataGenerator()
+ ->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id]);
+
+ // Set removeafter to 1 hour.
+ $onehoursecs = HOURSECS;
+ $DB->set_field('questionnaire', 'removeafter', $onehoursecs, ['id' => $questionnaire->id()]);
+
+ // Insert a response submitted 2 hours ago (expired).
+ $expiredid = $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $questionnaire->id(),
+ 'userid' => 2,
+ 'submitted' => time() - (2 * HOURSECS),
+ 'complete' => 'y',
+ 'grade' => 0,
+ ]);
+
+ questionnaire_responses::delete_old_responses();
+
+ $this->assertFalse($DB->record_exists('questionnaire_response', ['id' => $expiredid]));
+ }
+
+ /**
+ * Asserts delete_old_responses() leaves responses that are still within the retention period.
+ *
+ * @covers \mod_questionnaire\local\response\questionnaire_responses::delete_old_responses
+ */
+ public function test_delete_old_responses_keeps_recent_responses(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $questionnaire = $this->getDataGenerator()
+ ->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id]);
+
+ // Set removeafter to 1 day.
+ $DB->set_field('questionnaire', 'removeafter', DAYSECS, ['id' => $questionnaire->id()]);
+
+ // Insert a response submitted 1 hour ago (still within 1 day retention).
+ $recentid = $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $questionnaire->id(),
+ 'userid' => 2,
+ 'submitted' => time() - HOURSECS,
+ 'complete' => 'y',
+ 'grade' => 0,
+ ]);
+
+ questionnaire_responses::delete_old_responses();
+
+ $this->assertTrue($DB->record_exists('questionnaire_response', ['id' => $recentid]));
+ }
+
+ /**
+ * Asserts delete_old_responses() leaves responses when removeafter is zero (disabled).
+ *
+ * @covers \mod_questionnaire\local\response\questionnaire_responses::delete_old_responses
+ */
+ public function test_delete_old_responses_ignores_when_removeafter_is_zero(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $questionnaire = $this->getDataGenerator()
+ ->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id]);
+
+ // Explicitly set removeafter to 0 (disabled).
+ $DB->set_field('questionnaire', 'removeafter', 0, ['id' => $questionnaire->id()]);
+
+ // Insert a very old response.
+ $oldid = $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $questionnaire->id(),
+ 'userid' => 2,
+ 'submitted' => time() - (365 * DAYSECS),
+ 'complete' => 'y',
+ 'grade' => 0,
+ ]);
+
+ questionnaire_responses::delete_old_responses();
+
+ // With removeafter=0 the WHERE clause filters it out; the response must survive.
+ $this->assertTrue($DB->record_exists('questionnaire_response', ['id' => $oldid]));
+ }
+
+ /**
+ * Asserts delete_old_responses() also removes answer rows from all response detail tables.
+ *
+ * @covers \mod_questionnaire\local\response\questionnaire_responses::delete_old_responses
+ */
+ public function test_delete_old_responses_removes_answer_rows(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $questionnaire = $this->getDataGenerator()
+ ->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id]);
+
+ $DB->set_field('questionnaire', 'removeafter', HOURSECS, ['id' => $questionnaire->id()]);
+
+ $expiredrid = $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $questionnaire->id(),
+ 'userid' => 2,
+ 'submitted' => time() - (2 * HOURSECS),
+ 'complete' => 'y',
+ 'grade' => 0,
+ ]);
+
+ // Insert an answer row in questionnaire_response_bool referencing the expired response.
+ $DB->insert_record('questionnaire_response_bool', (object)[
+ 'questionid' => 1, 'responseid' => $expiredrid, 'choice' => 'y',
+ ]);
+
+ questionnaire_responses::delete_old_responses();
+
+ $this->assertFalse(
+ $DB->record_exists('questionnaire_response_bool', ['responseid' => $expiredrid]),
+ 'Answer rows in response_bool should be deleted with the expired response.'
+ );
+ }
+
+ // Tests for get_incomplete_users().
+
+ /**
+ * Asserts get_incomplete_users() returns false when no users are enrolled.
+ *
+ * @covers \mod_questionnaire\local\response\questionnaire_responses::get_incomplete_users
+ */
+ public function test_get_incomplete_users_returns_false_when_no_enrolled_users(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $course = $this->getDataGenerator()->create_course();
+ $questionnaire = $this->getDataGenerator()
+ ->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id]);
+
+ $cm = get_coursemodule_from_instance('questionnaire', $questionnaire->id(), $course->id, false, MUST_EXIST);
+
+ // No students enrolled; get_enrolled_users() returns empty → false.
+ $result = questionnaire_responses::get_incomplete_users($cm, $questionnaire->surveyid());
+ $this->assertFalse($result);
+ }
+
+ /**
+ * Asserts get_incomplete_users() returns enrolled users who have not completed the questionnaire.
+ *
+ * @covers \mod_questionnaire\local\response\questionnaire_responses::get_incomplete_users
+ */
+ public function test_get_incomplete_users_returns_users_without_completion(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $questionnaire = $generator
+ ->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id]);
+
+ $student1 = $generator->create_user();
+ $student2 = $generator->create_user();
+ $studentrole = $DB->get_record('role', ['shortname' => 'student'], '*', MUST_EXIST);
+ $generator->enrol_user($student1->id, $course->id, $studentrole->id);
+ $generator->enrol_user($student2->id, $course->id, $studentrole->id);
+
+ $cm = get_coursemodule_from_instance('questionnaire', $questionnaire->id(), $course->id, false, MUST_EXIST);
+ $result = questionnaire_responses::get_incomplete_users($cm, $questionnaire->surveyid());
+
+ // Normalise to integers to avoid driver-specific string/int key differences.
+ $intresult = is_array($result) ? array_map('intval', $result) : [];
+ $this->assertNotEmpty($intresult, 'Enrolled students should appear as incomplete users.');
+ $this->assertContains((int)$student1->id, $intresult);
+ $this->assertContains((int)$student2->id, $intresult);
+ }
+
+ /**
+ * Asserts get_incomplete_users() excludes users who have submitted a complete response.
+ *
+ * @covers \mod_questionnaire\local\response\questionnaire_responses::get_incomplete_users
+ */
+ public function test_get_incomplete_users_excludes_completers(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $questionnaire = $generator
+ ->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id]);
+
+ $student1 = $generator->create_user();
+ $student2 = $generator->create_user();
+ $studentrole = $DB->get_record('role', ['shortname' => 'student'], '*', MUST_EXIST);
+ $generator->enrol_user($student1->id, $course->id, $studentrole->id);
+ $generator->enrol_user($student2->id, $course->id, $studentrole->id);
+
+ // Student1 submits a complete response.
+ $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $questionnaire->id(),
+ 'userid' => $student1->id,
+ 'submitted' => time(),
+ 'complete' => 'y',
+ 'grade' => 0,
+ ]);
+
+ $cm = get_coursemodule_from_instance('questionnaire', $questionnaire->id(), $course->id, false, MUST_EXIST);
+ $result = questionnaire_responses::get_incomplete_users($cm, $questionnaire->surveyid());
+
+ $intresult = is_array($result) ? array_map('intval', $result) : [];
+ $this->assertNotContains((int)$student1->id, $intresult);
+ $this->assertContains((int)$student2->id, $intresult);
+ }
+
+ /**
+ * Asserts get_incomplete_users() supports paging via startpage and pagecount parameters.
+ *
+ * The internal early-return path (no completions yet) skips paging, so a completed
+ * response must exist before the paging slice can be exercised.
+ *
+ * @covers \mod_questionnaire\local\response\questionnaire_responses::get_incomplete_users
+ */
+ public function test_get_incomplete_users_supports_paging(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $questionnaire = $generator
+ ->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id]);
+
+ $studentrole = $DB->get_record('role', ['shortname' => 'student'], '*', MUST_EXIST);
+ $students = [];
+ for ($i = 0; $i < 5; $i++) {
+ $student = $generator->create_user();
+ $generator->enrol_user($student->id, $course->id, $studentrole->id);
+ $students[] = $student;
+ }
+
+ // One student completes — triggers the completion-check path that applies paging.
+ $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $questionnaire->id(),
+ 'userid' => $students[0]->id,
+ 'submitted' => time(),
+ 'complete' => 'y',
+ 'grade' => 0,
+ ]);
+
+ // 4 remaining students are incomplete. Page by 2 gives two non-overlapping pages.
+ $cm = get_coursemodule_from_instance('questionnaire', $questionnaire->id(), $course->id, false, MUST_EXIST);
+ $page0 = questionnaire_responses::get_incomplete_users($cm, $questionnaire->surveyid(), false, '', 0, 2);
+ $page1 = questionnaire_responses::get_incomplete_users($cm, $questionnaire->surveyid(), false, '', 2, 2);
+
+ $this->assertIsArray($page0);
+ $this->assertCount(2, $page0);
+ $this->assertIsArray($page1);
+ $this->assertCount(2, $page1);
+ // No overlap between pages.
+ $this->assertEmpty(array_intersect($page0, $page1));
+ }
+
+ // Tests for count_distinct_responders().
+
+ /**
+ * Asserts count_distinct_responders() counts each user once regardless of how many responses they have.
+ *
+ * @covers \mod_questionnaire\local\response\questionnaire_responses::count_distinct_responders
+ */
+ public function test_count_distinct_responders_counts_unique_users(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $questionnaire = $generator->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id]);
+
+ $u1 = $generator->create_user();
+ $u2 = $generator->create_user();
+ $u3 = $generator->create_user();
+
+ // User u1 has two responses; should still count once.
+ $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $questionnaire->id(),
+ 'userid' => $u1->id, 'submitted' => time(), 'complete' => 'y', 'grade' => 0,
+ ]);
+ $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $questionnaire->id(),
+ 'userid' => $u1->id, 'submitted' => time(), 'complete' => 'n', 'grade' => 0,
+ ]);
+ $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $questionnaire->id(),
+ 'userid' => $u2->id, 'submitted' => time(), 'complete' => 'y', 'grade' => 0,
+ ]);
+ $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $questionnaire->id(),
+ 'userid' => $u3->id, 'submitted' => time(), 'complete' => 'y', 'grade' => 0,
+ ]);
+
+ $this->assertSame(3, $questionnaire->responses()->count_distinct_responders());
+ }
+
+ /**
+ * Asserts count_distinct_responders() restricts the count to members of the given groups.
+ *
+ * @covers \mod_questionnaire\local\response\questionnaire_responses::count_distinct_responders
+ */
+ public function test_count_distinct_responders_respects_group_filter(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $questionnaire = $generator->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id]);
+
+ $u1 = $generator->create_user();
+ $u2 = $generator->create_user();
+ $u3 = $generator->create_user();
+
+ foreach ([$u1, $u2, $u3] as $u) {
+ $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $questionnaire->id(),
+ 'userid' => $u->id, 'submitted' => time(), 'complete' => 'y', 'grade' => 0,
+ ]);
+ }
+
+ $group = $generator->create_group(['courseid' => $course->id]);
+ $DB->insert_record('groups_members', (object)['groupid' => $group->id, 'userid' => $u1->id]);
+ $DB->insert_record('groups_members', (object)['groupid' => $group->id, 'userid' => $u2->id]);
+
+ $this->assertSame(2, $questionnaire->responses()->count_distinct_responders([$group->id]));
+ $this->assertSame(3, $questionnaire->responses()->count_distinct_responders());
+ }
+
+ /**
+ * Asserts count_distinct_responders() returns zero when no responses exist.
+ *
+ * @covers \mod_questionnaire\local\response\questionnaire_responses::count_distinct_responders
+ */
+ public function test_count_distinct_responders_returns_zero_when_empty(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $questionnaire = $generator->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id]);
+
+ $this->assertSame(0, $questionnaire->responses()->count_distinct_responders());
+ }
+
+ // Tests for response_select_max_sec().
+
+ /**
+ * Build a fixture with a Q1, pagebreak, Q2, pagebreak, Q3 layout at explicit positions 1..5.
+ * Inserts questions directly via $DB so positions are deterministic for section-math tests.
+ *
+ * @return array [questionnaire, [q1id, q2id, q3id]]
+ */
+ private function build_three_section_questionnaire(): array {
+ global $DB;
+ $this->setAdminUser();
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $questionnaire = $generator->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id]);
+ $sid = $questionnaire->surveyid();
+
+ $mkrow = function (int $surveyid, int $position, int $typeid, string $name) use ($DB): int {
+ return $DB->insert_record('questionnaire_question', (object)[
+ 'surveyid' => $surveyid,
+ 'name' => $name,
+ 'typeid' => $typeid,
+ 'length' => 0,
+ 'precise' => 0,
+ 'position' => $position,
+ 'content' => $name . ' content',
+ 'required' => 'n',
+ 'deleted' => null,
+ ]);
+ };
+
+ $q1id = $mkrow($sid, 1, QUESYESNO, 'Q1');
+ $mkrow($sid, 2, QUESPAGEBREAK, 'PB1');
+ $q2id = $mkrow($sid, 3, QUESYESNO, 'Q2');
+ $mkrow($sid, 4, QUESPAGEBREAK, 'PB2');
+ $q3id = $mkrow($sid, 5, QUESYESNO, 'Q3');
+
+ // Reload so questions_by_section_all is correct for the new layout.
+ $questionnaire = \mod_questionnaire\questionnaire::from_instanceid($questionnaire->id());
+ return [$questionnaire, [$q1id, $q2id, $q3id]];
+ }
+
+ /**
+ * Insert a yes/no answer row tying a response to a question.
+ *
+ * @param int $responseid
+ * @param int $questionid
+ * @return void
+ */
+ private function insert_bool_answer(int $responseid, int $questionid): void {
+ global $DB;
+ $DB->insert_record('questionnaire_response_bool', (object)[
+ 'responseid' => $responseid,
+ 'questionid' => $questionid,
+ 'choiceid' => 'y',
+ ]);
+ }
+
+ /**
+ * Asserts response_select_max_sec() returns 1 when the response has no answers.
+ *
+ * @covers \mod_questionnaire\local\response\questionnaire_responses::response_select_max_sec
+ */
+ public function test_response_select_max_sec_returns_one_when_no_answers(): void {
+ $this->resetAfterTest();
+ [$questionnaire] = $this->build_three_section_questionnaire();
+ $student = $this->getDataGenerator()->create_user();
+
+ $response = \mod_questionnaire\local\response\response::create($questionnaire->id(), (int)$student->id);
+ $this->assertSame(1, $questionnaire->responses()->response_select_max_sec($response->id()));
+ }
+
+ /**
+ * Asserts response_select_max_sec() returns the section number containing the highest answered question.
+ *
+ * @covers \mod_questionnaire\local\response\questionnaire_responses::response_select_max_sec
+ */
+ public function test_response_select_max_sec_reflects_last_answered_section(): void {
+ $this->resetAfterTest();
+ [$questionnaire, $qids] = $this->build_three_section_questionnaire();
+ $student = $this->getDataGenerator()->create_user();
+
+ $r1 = \mod_questionnaire\local\response\response::create($questionnaire->id(), (int)$student->id);
+ $this->insert_bool_answer($r1->id(), $qids[0]);
+ $this->assertSame(1, $questionnaire->responses()->response_select_max_sec($r1->id()));
+
+ $r2 = \mod_questionnaire\local\response\response::create($questionnaire->id(), (int)$student->id);
+ $this->insert_bool_answer($r2->id(), $qids[1]);
+ $this->assertSame(2, $questionnaire->responses()->response_select_max_sec($r2->id()));
+
+ $r3 = \mod_questionnaire\local\response\response::create($questionnaire->id(), (int)$student->id);
+ $this->insert_bool_answer($r3->id(), $qids[2]);
+ $this->assertSame(3, $questionnaire->responses()->response_select_max_sec($r3->id()));
+ }
+}
diff --git a/tests/questionnaire_test.php b/tests/questionnaire_test.php
new file mode 100644
index 000000000..16a6c35fe
--- /dev/null
+++ b/tests/questionnaire_test.php
@@ -0,0 +1,710 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\questionnaire.
+ *
+ * The testable subclass bypasses the constructor (which requires a real course module)
+ * so that pure business logic can be tested without full Moodle fixture setup.
+ *
+ * Tests that require capabilities or a real context are marked TODO.
+ *
+ * @package mod_questionnaire
+ * @copyright 2025 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire;
+
+use mod_questionnaire\local\db\questionnaire_record;
+use mod_questionnaire\local\db\survey_record;
+use mod_questionnaire\local\response\questionnaire_responses;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+require_once($CFG->dirroot . '/mod/questionnaire/lib.php');
+require_once($CFG->dirroot . '/mod/questionnaire/tests/questionnaire_testable.php');
+
+/**
+ * Unit tests for mod_questionnaire\questionnaire.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\questionnaire
+ */
+final class questionnaire_test extends \advanced_testcase {
+ // Helpers.
+
+ /**
+ * Build a questionnaire_record persistent populated from an in-memory object
+ * (no DB read). Pass $fields to override any default.
+ *
+ * @param array $fields
+ * @return questionnaire_record
+ */
+ private function make_module_record(array $fields = []): questionnaire_record {
+ return new questionnaire_record(0, (object)array_merge([
+ 'id' => 1,
+ 'course' => 1,
+ 'name' => 'Test questionnaire',
+ 'intro' => '',
+ 'introformat' => FORMAT_HTML,
+ 'qtype' => questionnaire::QTYPE_UNLIMITED,
+ 'respondenttype' => 'fullname',
+ 'respeligible' => 'all',
+ 'respview' => questionnaire::RESPVIEW_NEVER,
+ 'notifications' => 0,
+ 'opendate' => 0,
+ 'closedate' => 0,
+ 'resume' => 0,
+ 'navigate' => 0,
+ 'grade' => 0,
+ 'sid' => 1,
+ 'timemodified' => 0,
+ 'completionsubmit' => 0,
+ 'autonum' => 3,
+ 'progressbar' => 0,
+ 'removeafter' => 0,
+ ], $fields));
+ }
+
+ /**
+ * Build a survey_record persistent from an in-memory object (no DB read).
+ *
+ * @param array $fields
+ * @return survey_record
+ */
+ private function make_survey_record(array $fields = []): survey_record {
+ return new survey_record(0, (object)array_merge([
+ 'id' => 1,
+ 'name' => 'Test survey',
+ 'courseid' => 1,
+ 'realm' => 'private',
+ 'status' => 0,
+ 'title' => '',
+ 'email' => null,
+ 'subtitle' => null,
+ 'info' => null,
+ 'theme' => null,
+ 'thankspage' => null,
+ 'thankhead' => null,
+ 'thankbody' => null,
+ 'feedbacksections' => 0,
+ 'feedbacknotes' => null,
+ 'feedbackscores' => 0,
+ 'charttype' => null,
+ ], $fields));
+ }
+
+ /**
+ * Return a questionnaire_testable with optional field overrides.
+ *
+ * @param array $modulefields Overrides for questionnaire_record.
+ * @param array $surveyfields Overrides for survey_record.
+ * @return questionnaire_testable
+ */
+ private function make_questionnaire(array $modulefields = [], array $surveyfields = []): questionnaire_testable {
+ if (!array_key_exists('id', $surveyfields)) {
+ $surveyfields['id'] = $modulefields['sid'] ?? 1;
+ }
+ return new questionnaire_testable(
+ $this->make_module_record($modulefields),
+ $this->make_survey_record($surveyfields)
+ );
+ }
+
+ // Tests for is_active().
+
+ /**
+ * Asserts is_active() returns true when a survey is linked.
+ *
+ * @covers \mod_questionnaire\questionnaire::is_active
+ */
+ public function test_is_active_when_survey_linked(): void {
+ $this->assertTrue($this->make_questionnaire(['sid' => 5])->is_active());
+ }
+
+ /**
+ * Asserts is_active() returns false when no survey is linked.
+ *
+ * @covers \mod_questionnaire\questionnaire::is_active
+ */
+ public function test_is_active_when_no_survey(): void {
+ $this->assertFalse($this->make_questionnaire(['sid' => 0])->is_active());
+ }
+
+ // Tests for is_open().
+
+ /**
+ * Asserts is_open() returns true when no open date is set.
+ *
+ * @covers \mod_questionnaire\questionnaire::is_open
+ */
+ public function test_is_open_with_no_date(): void {
+ $this->assertTrue($this->make_questionnaire(['opendate' => 0])->is_open());
+ }
+
+ /**
+ * Asserts is_open() returns true when the open date is in the past.
+ *
+ * @covers \mod_questionnaire\questionnaire::is_open
+ */
+ public function test_is_open_with_past_open_date(): void {
+ $this->assertTrue($this->make_questionnaire(['opendate' => time() - 3600])->is_open());
+ }
+
+ /**
+ * Asserts is_open() returns false when the open date is in the future.
+ *
+ * @covers \mod_questionnaire\questionnaire::is_open
+ */
+ public function test_is_not_open_with_future_open_date(): void {
+ $this->assertFalse($this->make_questionnaire(['opendate' => time() + 3600])->is_open());
+ }
+
+ // Tests for is_closed().
+
+ /**
+ * Asserts is_closed() returns false when no close date is set.
+ *
+ * @covers \mod_questionnaire\questionnaire::is_closed
+ */
+ public function test_is_not_closed_with_no_date(): void {
+ $this->assertFalse($this->make_questionnaire(['closedate' => 0])->is_closed());
+ }
+
+ /**
+ * Asserts is_closed() returns true when the close date is in the past.
+ *
+ * @covers \mod_questionnaire\questionnaire::is_closed
+ */
+ public function test_is_closed_with_past_close_date(): void {
+ $this->assertTrue($this->make_questionnaire(['closedate' => time() - 3600])->is_closed());
+ }
+
+ /**
+ * Asserts is_closed() returns false when the close date is in the future.
+ *
+ * @covers \mod_questionnaire\questionnaire::is_closed
+ */
+ public function test_is_not_closed_with_future_close_date(): void {
+ $this->assertFalse($this->make_questionnaire(['closedate' => time() + 3600])->is_closed());
+ }
+
+ // Tests for is_anonymous().
+
+ /**
+ * Asserts is_anonymous() returns true when respondent type is anonymous.
+ *
+ * @covers \mod_questionnaire\questionnaire::is_anonymous
+ */
+ public function test_is_anonymous(): void {
+ $this->assertTrue($this->make_questionnaire(['respondenttype' => 'anonymous'])->is_anonymous());
+ }
+
+ /**
+ * Asserts is_anonymous() returns false when respondent type is fullname.
+ *
+ * @covers \mod_questionnaire\questionnaire::is_anonymous
+ */
+ public function test_is_not_anonymous(): void {
+ $this->assertFalse($this->make_questionnaire(['respondenttype' => 'fullname'])->is_anonymous());
+ }
+
+ // Tests for the survey_is_public and survey_is_template state methods.
+
+ /**
+ * Asserts survey_is_public() returns correct value based on realm.
+ *
+ * @covers \mod_questionnaire\questionnaire::survey_is_public
+ */
+ public function test_survey_is_public(): void {
+ $this->assertTrue($this->make_questionnaire([], ['realm' => 'public'])->survey_is_public());
+ $this->assertFalse($this->make_questionnaire([], ['realm' => 'private'])->survey_is_public());
+ $this->assertFalse($this->make_questionnaire([], ['realm' => 'template'])->survey_is_public());
+ }
+
+ /**
+ * Asserts survey_is_template() returns correct value based on realm.
+ *
+ * @covers \mod_questionnaire\questionnaire::survey_is_template
+ */
+ public function test_survey_is_template(): void {
+ $this->assertTrue($this->make_questionnaire([], ['realm' => 'template'])->survey_is_template());
+ $this->assertFalse($this->make_questionnaire([], ['realm' => 'public'])->survey_is_template());
+ $this->assertFalse($this->make_questionnaire([], ['realm' => 'private'])->survey_is_template());
+ }
+
+ // Tests for the survey_is_public_master and is_survey_owner state methods.
+
+ /**
+ * Asserts survey_is_public_master() returns true when courses match.
+ *
+ * @covers \mod_questionnaire\questionnaire::survey_is_public_master
+ */
+ public function test_survey_is_public_master_when_owning_course(): void {
+ $q = $this->make_questionnaire(['course' => 10], ['realm' => 'public', 'courseid' => 10]);
+ $this->assertTrue($q->survey_is_public_master());
+ }
+
+ /**
+ * Asserts survey_is_public_master() returns false when courses differ.
+ *
+ * @covers \mod_questionnaire\questionnaire::survey_is_public_master
+ */
+ public function test_survey_is_not_public_master_when_different_course(): void {
+ $q = $this->make_questionnaire(['course' => 10], ['realm' => 'public', 'courseid' => 99]);
+ $this->assertFalse($q->survey_is_public_master());
+ }
+
+ /**
+ * Asserts survey_is_public_master() returns false when survey is private.
+ *
+ * @covers \mod_questionnaire\questionnaire::survey_is_public_master
+ */
+ public function test_survey_is_not_public_master_when_private(): void {
+ $q = $this->make_questionnaire(['course' => 10], ['realm' => 'private', 'courseid' => 10]);
+ $this->assertFalse($q->survey_is_public_master());
+ }
+
+ /**
+ * Asserts is_survey_owner() returns true when questionnaire and survey share course.
+ *
+ * @covers \mod_questionnaire\questionnaire::is_survey_owner
+ */
+ public function test_is_survey_owner_when_same_course(): void {
+ $q = $this->make_questionnaire(['course' => 10], ['courseid' => 10]);
+ $this->assertTrue($q->is_survey_owner());
+ }
+
+ /**
+ * Asserts is_survey_owner() returns false when questionnaire and survey are in different courses.
+ *
+ * @covers \mod_questionnaire\questionnaire::is_survey_owner
+ */
+ public function test_is_not_survey_owner_when_different_course(): void {
+ $q = $this->make_questionnaire(['course' => 10], ['courseid' => 99]);
+ $this->assertFalse($q->is_survey_owner());
+ }
+
+ // Tests for user_has_saved_response().
+
+ /**
+ * Asserts user_has_saved_response() returns false when no saved response exists.
+ *
+ * @covers \mod_questionnaire\questionnaire::user_has_saved_response
+ */
+ public function test_user_has_no_saved_response(): void {
+ $this->resetAfterTest();
+ $q = $this->make_questionnaire(['id' => 99991]);
+ $this->assertFalse($q->user_has_saved_response(1));
+ }
+
+ /**
+ * Asserts user_has_saved_response() returns true when an incomplete response exists.
+ *
+ * @covers \mod_questionnaire\questionnaire::user_has_saved_response
+ */
+ public function test_user_has_saved_response(): void {
+ global $DB;
+ $this->resetAfterTest();
+
+ $qid = 99992;
+ $q = $this->make_questionnaire(['id' => $qid]);
+ $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $qid, 'userid' => 1,
+ 'submitted' => time(), 'complete' => 'n', 'grade' => 0,
+ ]);
+
+ $this->assertTrue($q->user_has_saved_response(1));
+ }
+
+ /**
+ * Complete responses do not count as "saved" (incomplete) responses.
+ * @covers \mod_questionnaire\questionnaire::user_has_saved_response
+ */
+ public function test_complete_response_is_not_saved_response(): void {
+ global $DB;
+ $this->resetAfterTest();
+
+ $qid = 99993;
+ $q = $this->make_questionnaire(['id' => $qid]);
+ $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $qid, 'userid' => 1,
+ 'submitted' => time(), 'complete' => 'y', 'grade' => 0,
+ ]);
+
+ $this->assertFalse($q->user_has_saved_response(1));
+ }
+
+ // Tests for user_access_messages() — cases that don't reach capability checks.
+
+ /**
+ * Asserts user_access_messages() returns the template-not-viewable string for template surveys.
+ *
+ * @covers \mod_questionnaire\questionnaire::user_access_messages
+ */
+ public function test_user_access_messages_template_not_viewable(): void {
+ $q = $this->make_questionnaire(['sid' => 5], ['realm' => 'template']);
+ $this->assertStringContainsString(
+ get_string('templatenotviewable', 'questionnaire'),
+ $q->user_access_messages()
+ );
+ }
+
+ /**
+ * Asserts user_access_messages() includes the open date when the questionnaire is not yet open.
+ *
+ * @covers \mod_questionnaire\questionnaire::user_access_messages
+ */
+ public function test_user_access_messages_not_open_yet(): void {
+ $opendate = time() + 7200;
+ $q = $this->make_questionnaire(['sid' => 5, 'opendate' => $opendate]);
+ $msg = $q->user_access_messages();
+ $this->assertNotNull($msg);
+ $this->assertStringContainsString(userdate($opendate), $msg);
+ }
+
+ /**
+ * Asserts user_access_messages() includes the close date when the questionnaire is closed.
+ *
+ * @covers \mod_questionnaire\questionnaire::user_access_messages
+ */
+ public function test_user_access_messages_closed(): void {
+ $closedate = time() - 3600;
+ $q = $this->make_questionnaire(['sid' => 5, 'closedate' => $closedate]);
+ $msg = $q->user_access_messages();
+ $this->assertNotNull($msg);
+ $this->assertStringContainsString(userdate($closedate), $msg);
+ }
+
+ // Tests for the navigate and pages_autonumbered accessors.
+
+ /**
+ * Asserts navigate() returns the raw integer from the module record.
+ *
+ * @covers \mod_questionnaire\questionnaire::navigate
+ */
+ public function test_navigate_returns_field_value(): void {
+ $this->assertEquals(0, $this->make_questionnaire(['navigate' => 0])->navigate());
+ $this->assertEquals(1, $this->make_questionnaire(['navigate' => 1])->navigate());
+ }
+
+ /**
+ * Asserts pages_autonumbered() returns true only for autonum values 2 and 3.
+ *
+ * @covers \mod_questionnaire\questionnaire::pages_autonumbered
+ */
+ public function test_pages_autonumbered(): void {
+ $this->assertFalse($this->make_questionnaire(['autonum' => 0])->pages_autonumbered());
+ $this->assertFalse($this->make_questionnaire(['autonum' => 1])->pages_autonumbered());
+ $this->assertTrue($this->make_questionnaire(['autonum' => 2])->pages_autonumbered());
+ $this->assertTrue($this->make_questionnaire(['autonum' => 3])->pages_autonumbered());
+ }
+
+ // Tests for responses().
+
+ /**
+ * Asserts responses() returns a questionnaire_responses instance.
+ *
+ * @covers \mod_questionnaire\questionnaire::responses
+ */
+ public function test_responses_returns_correct_type(): void {
+ $this->assertInstanceOf(questionnaire_responses::class, $this->make_questionnaire()->responses());
+ }
+
+ // Tests for get_responses().
+
+ /**
+ * Asserts get_responses() returns an empty array when no responses exist.
+ *
+ * @covers \mod_questionnaire\questionnaire::get_responses
+ */
+ public function test_get_responses_empty_when_none(): void {
+ $this->resetAfterTest();
+ $this->assertSame([], $this->make_questionnaire(['id' => 77771])->get_responses());
+ }
+
+ /**
+ * Asserts get_responses() returns all responses for the questionnaire.
+ *
+ * @covers \mod_questionnaire\questionnaire::get_responses
+ */
+ public function test_get_responses_returns_records(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $qid = 77772;
+ $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $qid, 'userid' => 1,
+ 'submitted' => time(), 'complete' => 'y', 'grade' => 0,
+ ]);
+ $this->assertCount(1, $this->make_questionnaire(['id' => $qid])->get_responses());
+ }
+
+ /**
+ * Asserts get_responses() filters by userid when one is specified.
+ *
+ * @covers \mod_questionnaire\questionnaire::get_responses
+ */
+ public function test_get_responses_filtered_by_userid(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $qid = 77773;
+ $q = $this->make_questionnaire(['id' => $qid]);
+ $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $qid, 'userid' => 1,
+ 'submitted' => time(), 'complete' => 'y', 'grade' => 0,
+ ]);
+ $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $qid, 'userid' => 2,
+ 'submitted' => time(), 'complete' => 'y', 'grade' => 0,
+ ]);
+ $this->assertCount(1, $q->get_responses(1));
+ $this->assertCount(1, $q->get_responses(2));
+ $this->assertCount(2, $q->get_responses(false));
+ }
+
+ // Tests for get_latest_responseid().
+
+ /**
+ * Asserts get_latest_responseid() returns 0 when no responses exist.
+ *
+ * @covers \mod_questionnaire\questionnaire::get_latest_responseid
+ */
+ public function test_get_latest_responseid_returns_zero_when_none(): void {
+ $this->resetAfterTest();
+ $this->assertSame(0, $this->make_questionnaire(['id' => 66661])->get_latest_responseid(1));
+ }
+
+ /**
+ * Asserts get_latest_responseid() returns the id of the user's incomplete response.
+ *
+ * @covers \mod_questionnaire\questionnaire::get_latest_responseid
+ */
+ public function test_get_latest_responseid_returns_id_of_incomplete(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $qid = 66662;
+ $rid = $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $qid, 'userid' => 1,
+ 'submitted' => time(), 'complete' => 'n', 'grade' => 0,
+ ]);
+ $this->assertSame((int)$rid, $this->make_questionnaire(['id' => $qid])->get_latest_responseid(1));
+ }
+
+ /**
+ * Asserts get_latest_responseid() returns 0 when only complete responses exist.
+ *
+ * @covers \mod_questionnaire\questionnaire::get_latest_responseid
+ */
+ public function test_get_latest_responseid_ignores_complete_responses(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $qid = 66663;
+ $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $qid, 'userid' => 1,
+ 'submitted' => time(), 'complete' => 'y', 'grade' => 0,
+ ]);
+ $this->assertSame(0, $this->make_questionnaire(['id' => $qid])->get_latest_responseid(1));
+ }
+
+ /**
+ * Asserts get_latest_responseid() returns the most recently submitted incomplete response.
+ *
+ * @covers \mod_questionnaire\questionnaire::get_latest_responseid
+ */
+ public function test_get_latest_responseid_returns_most_recent(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $qid = 66664;
+ $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $qid, 'userid' => 1,
+ 'submitted' => time() - 7200, 'complete' => 'n', 'grade' => 0,
+ ]);
+ $latestid = $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $qid, 'userid' => 1,
+ 'submitted' => time() - 3600, 'complete' => 'n', 'grade' => 0,
+ ]);
+ $this->assertSame((int)$latestid, $this->make_questionnaire(['id' => $qid])->get_latest_responseid(1));
+ }
+
+ /*
+ * TODO: tests for get_notifiable_users().
+ *
+ * get_notifiable_users() requires get_enrolled_users() and groups_get_activity_groupmode(),
+ * which need a real course module and context. These tests should be added once the
+ * generator creates instances through the full add_instance pathway.
+ */
+
+ // Tests for get_all_file_areas().
+
+ /**
+ * Asserts get_all_file_areas() returns the basic area keys when no feedback sections exist.
+ *
+ * @covers \mod_questionnaire\questionnaire::get_all_file_areas
+ */
+ public function test_get_all_file_areas_basic(): void {
+ $this->resetAfterTest();
+ $sid = 1;
+ $q = $this->make_questionnaire([], ['id' => $sid]);
+ $stub = $this->make_stub_question(10, []);
+ $q->set_questions([10 => $stub]);
+ $areas = $q->get_all_file_areas();
+ $this->assertSame($sid, $areas['info']);
+ $this->assertSame($sid, $areas['thankbody']);
+ $this->assertSame($sid, $areas['feedbacknotes']);
+ $this->assertContains(10, $areas['question']);
+ $this->assertArrayNotHasKey('sectionheading', $areas);
+ $this->assertArrayNotHasKey('feedback', $areas);
+ }
+
+ /**
+ * Asserts get_all_file_areas() includes sectionheading and feedback areas when fb_sections exist.
+ *
+ * @covers \mod_questionnaire\questionnaire::get_all_file_areas
+ */
+ public function test_get_all_file_areas_with_feedback_sections(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $sid = 12345;
+ $q = $this->make_questionnaire([], ['id' => $sid]);
+ $stub = $this->make_stub_question(10, []);
+ $q->set_questions([10 => $stub]);
+
+ $sectionid = $DB->insert_record('questionnaire_fb_sections', (object)[
+ 'surveyid' => $sid, 'section' => 1, 'scorecalculation' => null,
+ 'sectionlabel' => 'S1', 'sectionheading' => '', 'sectionheadingformat' => FORMAT_HTML,
+ ]);
+ $feedbackid = $DB->insert_record('questionnaire_feedback', (object)[
+ 'sectionid' => $sectionid, 'feedbacklabel' => '', 'feedbacktext' => '',
+ 'feedbacktextformat' => FORMAT_HTML, 'minscore' => 0, 'maxscore' => 100,
+ ]);
+
+ $areas = $q->get_all_file_areas();
+ $this->assertArrayHasKey('sectionheading', $areas);
+ $this->assertContains((int)$sectionid, $areas['sectionheading']);
+ $this->assertArrayHasKey('feedback', $areas);
+ $this->assertContains((int)$feedbackid, $areas['feedback']);
+ }
+
+ // Helpers for dependency tests.
+
+ /**
+ * Create a minimal question stub with the given id and dependencies array.
+ *
+ * Uses an anonymous class to avoid instantiating the real question hierarchy
+ * (which requires a DB-backed record).
+ *
+ * @param int $id
+ * @param array $dependencies Keyed dependency stdClass objects (dependquestionid etc.)
+ * @return object
+ */
+ private function make_stub_question(int $id, array $dependencies): object {
+ return new class ($id, $dependencies) {
+ /** @var int */
+ public int $id;
+ /** @var array */
+ public array $dependencies;
+ /** @var int */
+ public int $position = 0;
+ /** @var string */
+ public string $name = '';
+ /** @var string */
+ public string $content = '';
+ /** @var int */
+ public int $typeid = 0;
+
+ /**
+ * Constructor.
+ * @param int $id
+ * @param array $dependencies
+ */
+ public function __construct(int $id, array $dependencies) {
+ $this->id = $id;
+ $this->dependencies = $dependencies;
+ }
+
+ /**
+ * True if dependencies are non-empty.
+ * @return bool
+ */
+ public function has_dependencies(): bool {
+ return !empty($this->dependencies);
+ }
+
+ /**
+ * Return the question id.
+ * @return int
+ */
+ public function id(): int {
+ return $this->id;
+ }
+
+ /**
+ * Always fulfilled when no dependencies are set (used in navigation tests).
+ * @param mixed $rid
+ * @param mixed $questions
+ * @return bool
+ */
+ public function dependency_fulfilled($rid, $questions): bool {
+ return !$this->has_dependencies();
+ }
+ };
+ }
+
+ // Tests for the default_page_count, confirm_delete_param and restore_param behavior helpers.
+
+ /**
+ * Asserts default_page_count() returns the expected default value of 20.
+ *
+ * @covers \mod_questionnaire\questionnaire::default_page_count
+ */
+ public function test_default_page_count_returns_twenty(): void {
+ $this->assertEquals(20, questionnaire::default_page_count());
+ }
+
+ /**
+ * Asserts confirm_delete_param() returns the expected URL parameter string.
+ *
+ * @covers \mod_questionnaire\questionnaire::confirm_delete_param
+ */
+ public function test_confirm_delete_param_returns_expected_string(): void {
+ $this->assertEquals(questionnaire::CONFIRM_DELETE_PERMANENTLY, questionnaire::confirm_delete_param());
+ }
+
+ /**
+ * Asserts restore_param() returns the expected URL parameter string.
+ *
+ * @covers \mod_questionnaire\questionnaire::restore_param
+ */
+ public function test_restore_param_returns_expected_string(): void {
+ $this->assertEquals(questionnaire::RESTORE_PARAM, questionnaire::restore_param());
+ }
+
+ // Tests for question_deletion_duration().
+
+ /**
+ * Asserts question_deletion_duration() returns the value from plugin config.
+ *
+ * @covers \mod_questionnaire\questionnaire::question_deletion_duration
+ */
+ public function test_question_deletion_duration_returns_configured_value(): void {
+ $this->resetAfterTest();
+ set_config('duration', 7 * DAYSECS, 'questionnaire_questiondeletion');
+ $this->assertEquals(7 * DAYSECS, survey::question_deletion_duration());
+ }
+}
diff --git a/tests/questionnaire_testable.php b/tests/questionnaire_testable.php
new file mode 100644
index 000000000..3b3eb00de
--- /dev/null
+++ b/tests/questionnaire_testable.php
@@ -0,0 +1,63 @@
+.
+
+namespace mod_questionnaire;
+
+use mod_questionnaire\local\db\questionnaire_record;
+use mod_questionnaire\local\db\survey_record;
+
+/**
+ * Testable subclass of questionnaire that bypasses the real constructor.
+ *
+ * Allows injecting questionnaire_record and survey_record directly so
+ * business-logic methods can be unit tested without a real course module.
+ *
+ * @package mod_questionnaire
+ * @copyright 2025 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class questionnaire_testable extends questionnaire {
+ /**
+ * Construct with injected records, bypassing the real questionnaire constructor.
+ *
+ * @param questionnaire_record $modulerecord
+ * @param survey_record $surveyrecord
+ */
+ public function __construct(questionnaire_record $modulerecord, survey_record $surveyrecord) {
+ require_once(__DIR__ . '/survey_testable.php');
+ $this->modulerecord = $modulerecord;
+ $this->survey = new survey_testable($surveyrecord);
+ }
+
+ /**
+ * Inject question objects for unit tests (bypasses DB loading).
+ *
+ * @param array $questions Keyed by question id.
+ */
+ public function set_questions(array $questions): void {
+ $this->survey->set_questions($questions);
+ }
+
+ /**
+ * Inject the questions-by-section map for unit tests.
+ *
+ * @param array $questionsbysec Array of question object arrays, keyed by 1-based section number.
+ */
+ public function set_questions_by_sec(array $questionsbysec): void {
+ $this->survey->set_questions_by_sec($questionsbysec);
+ }
+}
diff --git a/tests/questiontypes_test.php b/tests/questiontypes_test.php
index 6f23fa120..e2c8defa0 100644
--- a/tests/questiontypes_test.php
+++ b/tests/questiontypes_test.php
@@ -25,13 +25,12 @@
namespace mod_questionnaire;
-use mod_questionnaire\question\question;
+use mod_questionnaire\local\question\question;
defined('MOODLE_INTERNAL') || die();
global $CFG;
-require_once($CFG->dirroot . '/mod/questionnaire/locallib.php');
-require_once($CFG->dirroot . '/mod/questionnaire/classes/question/question.php');
+require_once($CFG->dirroot . '/mod/questionnaire/classes/local/question/question.php');
/**
* Unit tests for questionnaire_questiontypes_testcase.
@@ -48,7 +47,7 @@ final class questiontypes_test extends \advanced_testcase {
public function test_create_question_checkbox(): void {
$this->create_test_question_with_choices(
QUESCHECK,
- '\\mod_questionnaire\\question\\check',
+ '\\mod_questionnaire\\local\\question\\check',
['content' => 'Check one']
);
}
@@ -61,7 +60,7 @@ public function test_create_question_checkbox(): void {
* @covers \mod_questionnaire\questiontypes_test::create_test_question
*/
public function test_create_question_date(): void {
- $this->create_test_question(QUESDATE, '\\mod_questionnaire\\question\\date', ['content' => 'Enter a date']);
+ $this->create_test_question(QUESDATE, '\\mod_questionnaire\\local\\question\\date', ['content' => 'Enter a date']);
}
/**
@@ -72,7 +71,11 @@ public function test_create_question_date(): void {
* @covers \mod_questionnaire\questiontypes_test::create_test_question
*/
public function test_create_question_dropdown(): void {
- $this->create_test_question_with_choices(QUESDROP, '\\mod_questionnaire\\question\\drop', ['content' => 'Select one']);
+ $this->create_test_question_with_choices(
+ QUESDROP,
+ '\\mod_questionnaire\\local\\question\\drop',
+ ['content' => 'Select one']
+ );
}
/**
@@ -88,7 +91,7 @@ public function test_create_question_essay(): void {
'length' => 0,
'precise' => 5,
];
- $this->create_test_question(QUESESSAY, '\\mod_questionnaire\\question\\essay', $questiondata);
+ $this->create_test_question(QUESESSAY, '\\mod_questionnaire\\local\\question\\essay', $questiondata);
}
/**
@@ -101,7 +104,7 @@ public function test_create_question_essay(): void {
public function test_create_question_sectiontext(): void {
$this->create_test_question(
QUESSECTIONTEXT,
- '\\mod_questionnaire\\question\\sectiontext',
+ '\\mod_questionnaire\\local\\question\\sectiontext',
['name' => null, 'content' => 'This a section label.']
);
}
@@ -119,7 +122,7 @@ public function test_create_question_numeric(): void {
'length' => 10,
'precise' => 0,
];
- $this->create_test_question(QUESNUMERIC, '\\mod_questionnaire\\question\\numerical', $questiondata);
+ $this->create_test_question(QUESNUMERIC, '\\mod_questionnaire\\local\\question\\numerical', $questiondata);
}
/**
@@ -130,7 +133,11 @@ public function test_create_question_numeric(): void {
* @covers \mod_questionnaire\questiontypes_test::create_test_question
*/
public function test_create_question_radiobuttons(): void {
- $this->create_test_question_with_choices(QUESRADIO, '\\mod_questionnaire\\question\\radio', ['content' => 'Choose one']);
+ $this->create_test_question_with_choices(
+ QUESRADIO,
+ '\\mod_questionnaire\\local\\question\\radio',
+ ['content' => 'Choose one']
+ );
}
/**
@@ -141,7 +148,11 @@ public function test_create_question_radiobuttons(): void {
* @covers \mod_questionnaire\questiontypes_test::create_test_question
*/
public function test_create_question_ratescale(): void {
- $this->create_test_question_with_choices(QUESRATE, '\\mod_questionnaire\\question\\rate', ['content' => 'Rate these']);
+ $this->create_test_question_with_choices(
+ QUESRATE,
+ '\\mod_questionnaire\\local\\question\\rate',
+ ['content' => 'Rate these']
+ );
}
/**
@@ -157,7 +168,7 @@ public function test_create_question_textbox(): void {
'length' => 20,
'precise' => 25,
];
- $this->create_test_question(QUESTEXT, '\\mod_questionnaire\\question\\text', $questiondata);
+ $this->create_test_question(QUESTEXT, '\\mod_questionnaire\\local\\question\\text', $questiondata);
}
/**
@@ -169,7 +180,7 @@ public function test_create_question_textbox(): void {
*/
public function test_create_question_slider(): void {
$questiondata = ['content' => 'Enter a number'];
- $this->create_test_question(QUESSLIDER, '\\mod_questionnaire\\question\\slider', $questiondata);
+ $this->create_test_question(QUESSLIDER, '\\mod_questionnaire\\local\\question\\slider', $questiondata);
}
/**
@@ -180,7 +191,7 @@ public function test_create_question_slider(): void {
* @covers \mod_questionnaire\questiontypes_test::create_test_question
*/
public function test_create_question_yesno(): void {
- $this->create_test_question(QUESYESNO, '\\mod_questionnaire\\question\\yesno', ['content' => 'Enter yes or no']);
+ $this->create_test_question(QUESYESNO, '\\mod_questionnaire\\local\\question\\yesno', ['content' => 'Enter yes or no']);
}
@@ -201,20 +212,19 @@ private function create_test_question($qtype, $questionclass, $questiondata = []
$course = $this->getDataGenerator()->create_course();
$generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
$questionnaire = $generator->create_instance(['course' => $course->id]);
- $cm = get_coursemodule_from_instance('questionnaire', $questionnaire->id);
- $questiondata['type_id'] = $qtype;
- $questiondata['surveyid'] = $questionnaire->sid;
+ $questiondata['typeid'] = $qtype;
+ $questiondata['surveyid'] = $questionnaire->surveyid();
$questiondata['name'] = isset($questiondata['name']) ? $questiondata['name'] : 'Q1';
$questiondata['content'] = isset($questiondata['content']) ? $questiondata['content'] : 'Test content';
$question = $generator->create_question($questionnaire, $questiondata, $choicedata);
$this->assertInstanceOf($questionclass, $question);
- $this->assertTrue($question->id > 0);
+ $this->assertTrue($question->id() > 0);
// Question object retrieved from the database should have correct data.
- $this->assertEquals($question->type_id, $qtype);
+ $this->assertEquals($question->typeid(), $qtype);
foreach ($questiondata as $property => $value) {
- $this->assertEquals($question->$property, $value);
+ $this->assertEquals($question->$property(), $value);
}
if ($question->has_choices()) {
$this->assertEquals('array', gettype($question->choices));
@@ -229,13 +239,14 @@ private function create_test_question($qtype, $questionclass, $questiondata = []
}
// Questionnaire object should now have question record(s).
- $questionnaire = new \questionnaire($course, $cm, $questionnaire->id, null, true);
- $this->assertTrue($DB->record_exists('questionnaire_question', ['id' => $question->id]));
- $this->assertEquals('array', gettype($questionnaire->questions));
- $this->assertTrue(array_key_exists($question->id, $questionnaire->questions));
- $this->assertEquals(1, count($questionnaire->questions));
- if ($questionnaire->questions[$question->id]->has_choices()) {
- $this->assertEquals(count($choicedata), count($questionnaire->questions[$question->id]->choices));
+ $questionnaire = \mod_questionnaire\questionnaire::from_instanceid($questionnaire->id());
+ $this->assertTrue($DB->record_exists('questionnaire_question', ['id' => $question->id()]));
+ $questions = $questionnaire->questions();
+ $this->assertEquals('array', gettype($questions));
+ $this->assertTrue(array_key_exists($question->id(), $questions));
+ $this->assertEquals(1, count($questions));
+ if ($questions[$question->id()]->has_choices()) {
+ $this->assertEquals(count($choicedata), count($questions[$question->id()]->choices));
}
}
diff --git a/tests/report_actions_test.php b/tests/report_actions_test.php
new file mode 100644
index 000000000..052d0ef5b
--- /dev/null
+++ b/tests/report_actions_test.php
@@ -0,0 +1,163 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\report_actions.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire;
+
+/**
+ * Unit tests for mod_questionnaire\report_actions.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\report_actions
+ */
+final class report_actions_test extends \advanced_testcase {
+ /**
+ * delete_response removes the response record and fires response_deleted.
+ */
+ public function test_delete_response_removes_record_and_redirects(): void {
+ global $DB, $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $course = $this->getDataGenerator()->create_course();
+ $questionnaire = $this->getDataGenerator()
+ ->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id]);
+ $PAGE->set_context($questionnaire->context());
+
+ $rid = $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $questionnaire->id(),
+ 'userid' => 2,
+ 'submitted' => time(),
+ 'complete' => 'y',
+ 'grade' => 0,
+ ]);
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $sink = $this->redirectEvents();
+ try {
+ (new report_actions($questionnaire, $renderer))->delete_response($rid);
+ $this->fail('redirect() should have terminated the call');
+ } catch (\moodle_exception $e) {
+ // Under PHPUnit, redirect() throws; the response should still have been deleted first.
+ $this->assertFalse($DB->record_exists('questionnaire_response', ['id' => $rid]));
+ }
+
+ $events = array_filter(
+ $sink->get_events(),
+ fn($e) => $e instanceof \mod_questionnaire\event\response_deleted
+ );
+ $this->assertCount(1, $events);
+ }
+
+ /**
+ * delete_response throws invalidresponserecord when the rid does not exist.
+ */
+ public function test_delete_response_throws_for_missing_rid(): void {
+ global $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $course = $this->getDataGenerator()->create_course();
+ $questionnaire = $this->getDataGenerator()
+ ->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id]);
+ $PAGE->set_context($questionnaire->context());
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $this->expectException(\moodle_exception::class);
+ $this->expectExceptionMessageMatches('/invalidresponserecord|Invalid response record/i');
+ (new report_actions($questionnaire, $renderer))->delete_response(99999999);
+ }
+
+ /**
+ * delete_all_responses removes every passed response and fires all_responses_deleted.
+ */
+ public function test_delete_all_responses_removes_records_and_redirects(): void {
+ global $DB, $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $course = $this->getDataGenerator()->create_course();
+ $questionnaire = $this->getDataGenerator()
+ ->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id]);
+ $PAGE->set_context($questionnaire->context());
+
+ $ridone = $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $questionnaire->id(),
+ 'userid' => 2,
+ 'submitted' => time(),
+ 'complete' => 'y',
+ 'grade' => 0,
+ ]);
+ $ridtwo = $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $questionnaire->id(),
+ 'userid' => 3,
+ 'submitted' => time(),
+ 'complete' => 'y',
+ 'grade' => 0,
+ ]);
+
+ $resps = $questionnaire->get_responses();
+ $this->assertCount(2, $resps);
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $sink = $this->redirectEvents();
+ try {
+ (new report_actions($questionnaire, $renderer))
+ ->delete_all_responses(0, 0, $resps);
+ $this->fail('redirect() should have terminated the call');
+ } catch (\moodle_exception $e) {
+ $this->assertFalse($DB->record_exists('questionnaire_response', ['id' => $ridone]));
+ $this->assertFalse($DB->record_exists('questionnaire_response', ['id' => $ridtwo]));
+ }
+
+ $events = array_filter(
+ $sink->get_events(),
+ fn($e) => $e instanceof \mod_questionnaire\event\all_responses_deleted
+ );
+ $this->assertCount(1, $events);
+ }
+
+ /**
+ * delete_all_responses throws couldnotdelresp when there are no responses to delete.
+ */
+ public function test_delete_all_responses_throws_when_empty(): void {
+ global $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $course = $this->getDataGenerator()->create_course();
+ $questionnaire = $this->getDataGenerator()
+ ->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id]);
+ $PAGE->set_context($questionnaire->context());
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $this->expectException(\moodle_exception::class);
+ (new report_actions($questionnaire, $renderer))
+ ->delete_all_responses(0, 0, []);
+ }
+}
diff --git a/tests/report_downloader_test.php b/tests/report_downloader_test.php
new file mode 100644
index 000000000..c263e01a2
--- /dev/null
+++ b/tests/report_downloader_test.php
@@ -0,0 +1,110 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\report_downloader.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire;
+
+use mod_questionnaire\output\reportpage;
+
+/**
+ * Unit tests for mod_questionnaire\report_downloader.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\report_downloader
+ */
+final class report_downloader_test extends \advanced_testcase {
+ /**
+ * show_download_options enforces the downloadresponses capability.
+ */
+ public function test_show_download_options_requires_capability(): void {
+ global $PAGE;
+ $this->resetAfterTest();
+
+ $course = $this->getDataGenerator()->create_course();
+ $questionnaire = $this->getDataGenerator()
+ ->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id]);
+ $PAGE->set_context($questionnaire->context());
+
+ // A freshly-created student has no downloadresponses cap.
+ $student = $this->getDataGenerator()->create_and_enrol($course, 'student');
+ $this->setUser($student);
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $this->expectException(\required_capability_exception::class);
+ (new report_downloader($questionnaire, $renderer))
+ ->show_download_options(new reportpage(), 0, 0, [], 0);
+ }
+
+ /**
+ * download_responses enforces the downloadresponses capability.
+ */
+ public function test_download_responses_requires_capability(): void {
+ global $PAGE;
+ $this->resetAfterTest();
+
+ $course = $this->getDataGenerator()->create_course();
+ $questionnaire = $this->getDataGenerator()
+ ->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id]);
+ $PAGE->set_context($questionnaire->context());
+
+ $student = $this->getDataGenerator()->create_and_enrol($course, 'student');
+ $this->setUser($student);
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $this->expectException(\required_capability_exception::class);
+ (new report_downloader($questionnaire, $renderer))
+ ->download_responses(new reportpage(), 0, 0);
+ }
+
+ /**
+ * download_responses redirects to dwnpg when "email report" is selected but no
+ * recipients are specified (allowemailreporting off, no roles, no extras).
+ */
+ public function test_download_responses_redirects_when_no_emails(): void {
+ global $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ $qdg = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
+ $qdg->create_and_fully_populate(1, 1, 1, 1);
+ $questionnaires = $qdg->questionnaires();
+ $questionnaire = reset($questionnaires);
+ $PAGE->set_context($questionnaire->context());
+
+ // Force the email branch with no recipients and no allowemailreporting config.
+ $_POST['emailreport'] = 'send';
+ set_config('allowemailreporting', 0, 'questionnaire');
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $this->expectException(\moodle_exception::class);
+ try {
+ (new report_downloader($questionnaire, $renderer))
+ ->download_responses(new reportpage(), 0, 0);
+ } finally {
+ unset($_POST['emailreport']);
+ }
+ }
+}
diff --git a/tests/report_viewer_test.php b/tests/report_viewer_test.php
new file mode 100644
index 000000000..d008e10ac
--- /dev/null
+++ b/tests/report_viewer_test.php
@@ -0,0 +1,161 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\report_viewer.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire;
+
+use mod_questionnaire\output\reportpage;
+
+/**
+ * Unit tests for mod_questionnaire\report_viewer.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\report_viewer
+ */
+final class report_viewer_test extends \advanced_testcase {
+ /**
+ * Build a course + plain questionnaire and return both the domain object
+ * and a moodle_url pointing at the report page.
+ *
+ * @return array [questionnaire, moodle_url]
+ */
+ private function setup_fixture(): array {
+ global $PAGE;
+ $course = $this->getDataGenerator()->create_course();
+ $questionnaire = $this->getDataGenerator()
+ ->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id]);
+ $PAGE->set_context($questionnaire->context());
+ $url = new \moodle_url('/mod/questionnaire/report.php');
+
+ return [$questionnaire, $url];
+ }
+
+ /**
+ * Initialise the SESSION->questionnaire bucket that callers (report.php) set
+ * up before invoking the controller. Call this AFTER setUser() — switching
+ * users resets the session.
+ */
+ private function init_session(): void {
+ global $SESSION;
+ if (!isset($SESSION->questionnaire) || !is_object($SESSION->questionnaire)) {
+ $SESSION->questionnaire = new \stdClass();
+ }
+ }
+
+ /**
+ * Default response-status map used by the report.php caller (mirrors what the
+ * production entry script supplies).
+ *
+ * @return array
+ */
+ private function default_responsestatus(): array {
+ return [
+ 'y' => get_string('fullsubmissions', 'questionnaire'),
+ '0' => get_string('allresponses', 'questionnaire'),
+ 'n' => get_string('responsesnotsubmitted', 'questionnaire'),
+ ];
+ }
+
+ /**
+ * view_all_responses() throws nopermissions when the user has neither
+ * readallresponses nor readallresponseanytime.
+ */
+ public function test_view_all_responses_requires_capability(): void {
+ global $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$questionnaire, $url] = $this->setup_fixture();
+
+ // Use an unenrolled user — no role assignments means no caps.
+ $user = $this->getDataGenerator()->create_user();
+ $this->setUser($user);
+ $this->init_session();
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $this->expectException(\moodle_exception::class);
+ $this->expectExceptionMessageMatches('/permission|nopermissions/i');
+ ob_start();
+ try {
+ (new report_viewer($questionnaire, $renderer))->view_all_responses(
+ new reportpage(),
+ 'vall',
+ 'html',
+ $url,
+ 0,
+ 0,
+ [],
+ [],
+ 'default',
+ '0',
+ $this->default_responsestatus(),
+ false
+ );
+ } finally {
+ ob_end_clean();
+ }
+ }
+
+ /**
+ * view_individual_response() throws surveyowner when the survey is owned by
+ * a different course than the questionnaire instance.
+ */
+ public function test_view_individual_response_throws_when_survey_not_owned_by_course(): void {
+ global $DB, $PAGE;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$questionnaire, $url] = $this->setup_fixture();
+ $this->init_session();
+
+ // Point the survey at a different course so owning_courseid() != questionnaire->course->id.
+ $othercourse = $this->getDataGenerator()->create_course();
+ $DB->set_field(
+ 'questionnaire_survey',
+ 'courseid',
+ $othercourse->id,
+ ['id' => $questionnaire->surveyid()]
+ );
+ $questionnaire = questionnaire::from_instanceid($questionnaire->id());
+
+ $renderer = $PAGE->get_renderer('mod_questionnaire');
+ $this->expectException(\moodle_exception::class);
+ $this->expectExceptionMessageMatches('/owner|surveyowner/i');
+ (new report_viewer($questionnaire, $renderer))->view_individual_response(
+ new reportpage(),
+ 'html',
+ $url,
+ 0,
+ 0,
+ [],
+ false,
+ false,
+ false,
+ false,
+ '0',
+ $this->default_responsestatus()
+ );
+ }
+}
diff --git a/tests/responsetypes_test.php b/tests/responsetypes_test.php
index 88995ff70..dcb3dbd0b 100644
--- a/tests/responsetypes_test.php
+++ b/tests/responsetypes_test.php
@@ -25,15 +25,14 @@
namespace mod_questionnaire;
-use mod_questionnaire\question\question;
+use mod_questionnaire\local\question\question;
defined('MOODLE_INTERNAL') || die();
global $CFG;
-require_once($CFG->dirroot . '/mod/questionnaire/locallib.php');
require_once($CFG->dirroot . '/mod/questionnaire/tests/generator_test.php');
require_once($CFG->dirroot . '/mod/questionnaire/tests/questiontypes_test.php');
-require_once($CFG->dirroot . '/mod/questionnaire/classes/question/question.php');
+require_once($CFG->dirroot . '/mod/questionnaire/classes/local/question/question.php');
/**
* Unit tests for questionnaire_responsetypes_testcase.
@@ -46,7 +45,7 @@ final class responsetypes_test extends \advanced_testcase {
* @return void
* @throws dml_exception
*
- * @covers \mod_questionnaire\question\yesno
+ * @covers \mod_questionnaire\local\question\yesno
*/
public function test_create_response_boolean(): void {
global $DB;
@@ -60,18 +59,18 @@ public function test_create_response_boolean(): void {
$course = $this->getDataGenerator()->create_course();
$generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
$questionnaire = $generator->create_test_questionnaire($course, QUESYESNO, ['content' => 'Enter yes or no']);
- $question = reset($questionnaire->questions);
+ $question = reset($questionnaire->questions());
$response = $generator->create_question_response($questionnaire, $question, 'y', $userid);
// Test the responses for this questionnaire.
- $this->response_tests($questionnaire->id, $response->id, $userid);
+ $this->response_tests($questionnaire->id(), $response->id, $userid);
// Retrieve the specific boolean response.
- $booleanresponses = $DB->get_records('questionnaire_response_bool', ['response_id' => $response->id]);
+ $booleanresponses = $DB->get_records('questionnaire_response_bool', ['responseid' => $response->id]);
$this->assertEquals(1, count($booleanresponses));
$booleanresponse = reset($booleanresponses);
- $this->assertEquals($question->id, $booleanresponse->question_id);
- $this->assertEquals('y', $booleanresponse->choice_id);
+ $this->assertEquals($question->id(), $booleanresponse->questionid);
+ $this->assertEquals('y', $booleanresponse->choiceid);
}
/**
@@ -80,7 +79,7 @@ public function test_create_response_boolean(): void {
* @return void
* @throws dml_exception
*
- * @covers \mod_questionnaire\question\essay
+ * @covers \mod_questionnaire\local\question\essay
*/
public function test_create_response_text(): void {
global $DB;
@@ -95,17 +94,17 @@ public function test_create_response_text(): void {
$generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
$questiondata = ['content' => 'Enter some text', 'length' => 0, 'precise' => 5];
$questionnaire = $generator->create_test_questionnaire($course, QUESESSAY, $questiondata);
- $question = reset($questionnaire->questions);
+ $question = reset($questionnaire->questions());
$response = $generator->create_question_response($questionnaire, $question, 'This is my essay.', $userid);
// Test the responses for this questionnaire.
- $this->response_tests($questionnaire->id, $response->id, $userid);
+ $this->response_tests($questionnaire->id(), $response->id, $userid);
// Retrieve the specific text response.
- $textresponses = $DB->get_records('questionnaire_response_text', ['response_id' => $response->id]);
+ $textresponses = $DB->get_records('questionnaire_response_text', ['responseid' => $response->id]);
$this->assertEquals(1, count($textresponses));
$textresponse = reset($textresponses);
- $this->assertEquals($question->id, $textresponse->question_id);
+ $this->assertEquals($question->id(), $textresponse->questionid);
$this->assertEquals('This is my essay.', $textresponse->response);
}
@@ -115,7 +114,7 @@ public function test_create_response_text(): void {
* @return void
* @throws dml_exception
*
- * @covers \mod_questionnaire\question\slider
+ * @covers \mod_questionnaire\local\question\slider
*/
public function test_create_response_slider(): void {
global $DB;
@@ -130,17 +129,17 @@ public function test_create_response_slider(): void {
$generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
$questiondata = ['content' => 'Enter some text'];
$questionnaire = $generator->create_test_questionnaire($course, QUESSLIDER, $questiondata);
- $question = reset($questionnaire->questions);
+ $question = reset($questionnaire->questions());
$response = $generator->create_question_response($questionnaire, $question, 5, $userid);
// Test the responses for this questionnaire.
- $this->response_tests($questionnaire->id, $response->id, $userid);
+ $this->response_tests($questionnaire->id(), $response->id, $userid);
// Retrieve the specific text response.
- $textresponses = $DB->get_records('questionnaire_response_text', ['response_id' => $response->id]);
+ $textresponses = $DB->get_records('questionnaire_response_text', ['responseid' => $response->id]);
$this->assertEquals(1, count($textresponses));
$textresponse = reset($textresponses);
- $this->assertEquals($question->id, $textresponse->question_id);
+ $this->assertEquals($question->id(), $textresponse->questionid);
$this->assertEquals(5, $textresponse->response);
}
@@ -150,7 +149,7 @@ public function test_create_response_slider(): void {
* @return void
* @throws dml_exception
*
- * @covers \mod_questionnaire\question\date
+ * @covers \mod_questionnaire\local\question\date
*/
public function test_create_response_date(): void {
global $DB;
@@ -164,18 +163,18 @@ public function test_create_response_date(): void {
$course = $this->getDataGenerator()->create_course();
$generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
$questionnaire = $generator->create_test_questionnaire($course, QUESDATE, ['content' => 'Enter a date']);
- $question = reset($questionnaire->questions);
+ $question = reset($questionnaire->questions());
// Date format is configured per site. This won't work unless it matches the configured format.
$response = $generator->create_question_response($questionnaire, $question, '2015-01-27', $userid);
// Test the responses for this questionnaire.
- $this->response_tests($questionnaire->id, $response->id, $userid);
+ $this->response_tests($questionnaire->id(), $response->id, $userid);
// Retrieve the specific date response.
- $dateresponses = $DB->get_records('questionnaire_response_date', ['response_id' => $response->id]);
+ $dateresponses = $DB->get_records('questionnaire_response_date', ['responseid' => $response->id]);
$this->assertEquals(1, count($dateresponses));
$dateresponse = reset($dateresponses);
- $this->assertEquals($question->id, $dateresponse->question_id);
+ $this->assertEquals($question->id(), $dateresponse->questionid);
// The date is always stored in the database in the same way.
$this->assertEquals('2015-01-27', $dateresponse->response);
}
@@ -186,7 +185,7 @@ public function test_create_response_date(): void {
* @return void
* @throws dml_exception
*
- * @covers \mod_questionnaire\question\radio
+ * @covers \mod_questionnaire\local\question\radio
*/
public function test_create_response_single(): void {
global $DB;
@@ -208,7 +207,7 @@ public function test_create_response_single(): void {
$questionnaire = $generator->create_test_questionnaire($course, QUESRADIO, ['content' => 'Select one'], $choicedata);
// Create a response using one of the choices.
- $question = reset($questionnaire->questions);
+ $question = reset($questionnaire->questions());
$val = 'unknown';
foreach ($question->choices as $cid => $choice) {
if ($choice->content == 'Two') {
@@ -218,14 +217,14 @@ public function test_create_response_single(): void {
$response = $generator->create_question_response($questionnaire, $question, $val, $userid);
// Test the responses for this questionnaire.
- $this->response_tests($questionnaire->id, $response->id, $userid);
+ $this->response_tests($questionnaire->id(), $response->id, $userid);
// Retrieve the specific single response.
- $singresponses = $DB->get_records('questionnaire_resp_single', ['response_id' => $response->id]);
+ $singresponses = $DB->get_records('questionnaire_resp_single', ['responseid' => $response->id]);
$this->assertEquals(1, count($singresponses));
$singresponse = reset($singresponses);
- $this->assertEquals($question->id, $singresponse->question_id);
- $this->assertEquals($val, $singresponse->choice_id);
+ $this->assertEquals($question->id(), $singresponse->questionid);
+ $this->assertEquals($val, $singresponse->choiceid);
// Create another response using the '!other' choice.
foreach ($question->choices as $cid => $choice) {
@@ -233,29 +232,29 @@ public function test_create_response_single(): void {
$val = $cid;
}
}
- $vals = ['q' . $question->id => $val,
- 'q' . $question->id . \mod_questionnaire\question\choice::id_other_choice_name($val) => 'Forty-four'];
+ $vals = ['q' . $question->id() => $val,
+ 'q' . $question->id() . \mod_questionnaire\local\question\choice::id_other_choice_name($val) => 'Forty-four'];
$userid = 2;
$response = $generator->create_question_response($questionnaire, $question, $vals, $userid);
// Test the responses for this questionnaire.
- $this->response_tests($questionnaire->id, $response->id, $userid, 1, 2);
+ $this->response_tests($questionnaire->id(), $response->id, $userid, 1, 2);
// Retrieve the specific single response.
- $singresponses = $DB->get_records('questionnaire_resp_single', ['response_id' => $response->id]);
+ $singresponses = $DB->get_records('questionnaire_resp_single', ['responseid' => $response->id]);
$this->assertEquals(1, count($singresponses));
$singresponse = reset($singresponses);
- $this->assertEquals($question->id, $singresponse->question_id);
- $this->assertEquals($val, $singresponse->choice_id);
+ $this->assertEquals($question->id(), $singresponse->questionid);
+ $this->assertEquals($val, $singresponse->choiceid);
// Retrieve the 'other' response data.
$otherresponses = $DB->get_records(
'questionnaire_response_other',
- ['response_id' => $response->id, 'question_id' => $question->id]
+ ['responseid' => $response->id, 'questionid' => $question->id()]
);
$this->assertEquals(1, count($otherresponses));
$otherresponse = reset($otherresponses);
- $this->assertEquals($val, $otherresponse->choice_id);
+ $this->assertEquals($val, $otherresponse->choiceid);
$this->assertEquals('Forty-four', $otherresponse->response);
}
@@ -265,7 +264,7 @@ public function test_create_response_single(): void {
* @return void
* @throws dml_exception
*
- * @covers \mod_questionnaire\question\rate
+ * @covers \mod_questionnaire\local\question\rate
*/
public function test_create_response_multiple(): void {
global $DB;
@@ -286,41 +285,41 @@ public function test_create_response_multiple(): void {
];
$questionnaire = $generator->create_test_questionnaire($course, QUESCHECK, ['content' => 'Select any'], $choicedata);
- $question = reset($questionnaire->questions);
+ $question = reset($questionnaire->questions());
$val = [];
foreach ($question->choices as $cid => $choice) {
if (($choice->content == 'Two') || ($choice->content == 'Three')) {
$val[$cid] = $cid;
} else if ($choice->content == '!other=Another number') {
$val[$cid] = $cid;
- $val[\mod_questionnaire\question\choice::id_other_choice_name($cid)] = 'Forty-four';
+ $val[\mod_questionnaire\local\question\choice::id_other_choice_name($cid)] = 'Forty-four';
$ocid = $cid;
}
}
- $vals = ['q' . $question->id => $val];
+ $vals = ['q' . $question->id() => $val];
$response = $generator->create_question_response($questionnaire, $question, $vals, $userid);
// Test the responses for this questionnaire.
- $this->response_tests($questionnaire->id, $response->id, $userid);
+ $this->response_tests($questionnaire->id(), $response->id, $userid);
// Retrieve the specific multiples responses.
- $multresponses = $DB->get_records('questionnaire_resp_multiple', ['response_id' => $response->id]);
+ $multresponses = $DB->get_records('questionnaire_resp_multiple', ['responseid' => $response->id]);
$this->assertEquals(3, count($multresponses));
$multresponse = reset($multresponses);
- $this->assertEquals($question->id, $multresponse->question_id);
- $this->assertEquals(reset($val), $multresponse->choice_id);
+ $this->assertEquals($question->id(), $multresponse->questionid);
+ $this->assertEquals(reset($val), $multresponse->choiceid);
$multresponse = next($multresponses);
- $this->assertEquals($question->id, $multresponse->question_id);
- $this->assertEquals(next($val), $multresponse->choice_id);
+ $this->assertEquals($question->id(), $multresponse->questionid);
+ $this->assertEquals(next($val), $multresponse->choiceid);
// Retrieve the specific other response.
$otherresponses = $DB->get_records(
'questionnaire_response_other',
- ['response_id' => $response->id, 'question_id' => $question->id]
+ ['responseid' => $response->id, 'questionid' => $question->id()]
);
$this->assertEquals(1, count($otherresponses));
$otherresponse = reset($otherresponses);
- $this->assertEquals($ocid, $otherresponse->choice_id);
+ $this->assertEquals($ocid, $otherresponse->choiceid);
$this->assertEquals('Forty-four', $otherresponse->response);
}
@@ -330,7 +329,7 @@ public function test_create_response_multiple(): void {
* @return void
* @throws dml_exception
*
- * @covers \mod_questionnaire\question\rate
+ * @covers \mod_questionnaire\local\question\rate
*/
public function test_create_response_rank(): void {
global $DB;
@@ -352,24 +351,24 @@ public function test_create_response_rank(): void {
$questionnaire = $generator->create_test_questionnaire($course, QUESRATE, $questiondata, $choicedata);
// Create a response for each choice.
- $question = reset($questionnaire->questions);
+ $question = reset($questionnaire->questions());
$vals = [];
$i = 1;
foreach ($question->choices as $cid => $choice) {
$vals[$cid] = $i;
- $vals['q' . $question->id . '_' . $cid] = $i++;
+ $vals['q' . $question->id() . '_' . $cid] = $i++;
}
$response = $generator->create_question_response($questionnaire, $question, $vals, $userid);
// Test the responses for this questionnaire.
- $this->response_tests($questionnaire->id, $response->id, $userid);
+ $this->response_tests($questionnaire->id(), $response->id, $userid);
// Retrieve the specific rank response.
- $multresponses = $DB->get_records('questionnaire_response_rank', ['response_id' => $response->id]);
+ $multresponses = $DB->get_records('questionnaire_response_rank', ['responseid' => $response->id]);
$this->assertEquals(3, count($multresponses));
foreach ($multresponses as $multresponse) {
- $this->assertEquals($question->id, $multresponse->question_id);
- $this->assertEquals($vals[$multresponse->choice_id], $multresponse->rankvalue);
+ $this->assertEquals($question->id(), $multresponse->questionid);
+ $this->assertEquals($vals[$multresponse->choiceid], $multresponse->rankvalue);
}
}
@@ -389,17 +388,14 @@ public function create_test_questionnaire($qtype, $questiondata = [], $choicedat
$course = $this->getDataGenerator()->create_course();
$generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
$questionnaire = $generator->create_instance(['course' => $course->id]);
- $cm = get_coursemodule_from_instance('questionnaire', $questionnaire->id);
- $questiondata['type_id'] = $qtype;
- $questiondata['surveyid'] = $questionnaire->sid;
+ $questiondata['typeid'] = $qtype;
+ $questiondata['surveyid'] = $questionnaire->surveyid();
$questiondata['name'] = isset($questiondata['name']) ? $questiondata['name'] : 'Q1';
$questiondata['content'] = isset($questiondata['content']) ? $questiondata['content'] : 'Test content';
$generator->create_question($questionnaire, $questiondata, $choicedata);
- $questionnaire = new \questionnaire($course, $cm, $questionnaire->id, null, true);
-
- return $questionnaire;
+ return \mod_questionnaire\questionnaire::from_instanceid($questionnaire->id());
}
/**
@@ -434,7 +430,7 @@ private function response_tests(
/**
* Tests that an old boolean response is deleted correctly.
*
- * @covers \mod_questionnaire\responsetype\boolean
+ * @covers \mod_questionnaire\local\response\boolean
*/
public function test_create_old_response_boolean(): void {
global $DB;
@@ -449,22 +445,22 @@ public function test_create_old_response_boolean(): void {
$generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
// Add a questionnaire that will delete old responses after one month.
$questionnaire1 = $generator->create_test_questionnaire($course, QUESYESNO, ['content' => 'Enter yes or no']);
- $question1 = reset($questionnaire1->questions);
+ $question1 = reset($questionnaire1->questions());
$response1 = $generator->create_question_response($questionnaire1, $question1, 'y', $userid);
$questionnaire2 = $generator->create_test_questionnaire($course, QUESYESNO, ['content' => 'Enter yes or no']);
- $question2 = reset($questionnaire2->questions);
+ $question2 = reset($questionnaire2->questions());
$response2 = $generator->create_question_response($questionnaire2, $question2, 'y', $userid);
- $this->response_tests($questionnaire1->id, $response1->id, $userid);
- $this->response_tests($questionnaire2->id, $response2->id, $userid);
+ $this->response_tests($questionnaire1->id(), $response1->id, $userid);
+ $this->response_tests($questionnaire2->id(), $response2->id, $userid);
// Set the removeafterfield for questionnaires.
$newquestionairre1 = new \stdClass();
- $newquestionairre1->id = $questionnaire1->id;
+ $newquestionairre1->id = $questionnaire1->id();
$newquestionairre1->removeafter = 2592000;
$newquestionairre2 = new \stdClass();
- $newquestionairre2->id = $questionnaire2->id;
+ $newquestionairre2->id = $questionnaire2->id();
$newquestionairre2->removeafter = 2592000;
$DB->update_record('questionnaire', $newquestionairre1);
$DB->update_record('questionnaire', $newquestionairre2);
@@ -476,13 +472,13 @@ public function test_create_old_response_boolean(): void {
$booleanresponses2->submitted = $booleanresponses2->submitted - 2592000 - 86400;
$DB->update_record('questionnaire_response', $booleanresponses1);
$DB->update_record('questionnaire_response', $booleanresponses2);
- questionnaire_delete_old_responses();
+ \mod_questionnaire\local\response\questionnaire_responses::delete_old_responses();
$responseresult1 = $DB->record_exists('questionnaire_response', ['id' => $response1->id]);
$responseresult2 = $DB->record_exists('questionnaire_response', ['id' => $response2->id]);
$this->assertEmpty($responseresult1);
$this->assertEmpty($responseresult2);
- $boolresponseresult1 = $DB->record_exists('questionnaire_response_bool', ['response_id' => $response1->id]);
- $boolresponseresult2 = $DB->record_exists('questionnaire_response_bool', ['response_id' => $response2->id]);
+ $boolresponseresult1 = $DB->record_exists('questionnaire_response_bool', ['responseid' => $response1->id]);
+ $boolresponseresult2 = $DB->record_exists('questionnaire_response_bool', ['responseid' => $response2->id]);
$this->assertEmpty($boolresponseresult1);
$this->assertEmpty($boolresponseresult2);
}
diff --git a/tests/save_mobile_data_test.php b/tests/save_mobile_data_test.php
new file mode 100644
index 000000000..646d1d21b
--- /dev/null
+++ b/tests/save_mobile_data_test.php
@@ -0,0 +1,247 @@
+.
+
+/**
+ * Unit tests for questionnaire::save_mobile_data().
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+
+/**
+ * Tests for questionnaire::save_mobile_data().
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\questionnaire::save_mobile_data
+ */
+final class save_mobile_data_test extends \advanced_testcase {
+ // Helpers.
+
+ /**
+ * Create a course, questionnaire instance, and one optional-text question.
+ * Returns [$questionnaire, $userid].
+ *
+ * The pagebreak requires at least two questions before it (position >= 2) so that
+ * load_questions() does not treat it as a leading break and skip it. We therefore
+ * add Q1 + Q2 on page 1, then a pagebreak, then Q3 on page 2.
+ *
+ * @param bool $addpagebreak Also add a page break + a third text question (for nav tests).
+ * @param bool $required Make the first text question required.
+ * @return array [$questionnaire, $userid]
+ */
+ private function make_fixture(bool $addpagebreak = false, bool $required = false): array {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ global $DB;
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $qgen = $generator->get_plugin_generator('mod_questionnaire');
+ $questionnaire = $qgen->create_instance(['course' => $course->id]);
+
+ $surveyid = $questionnaire->surveyid();
+ $qgen->create_question($questionnaire, [
+ 'surveyid' => $surveyid,
+ 'name' => 'Q1',
+ 'typeid' => QUESTEXT,
+ 'content' => 'Enter some text',
+ 'required' => $required ? 'y' : 'n',
+ ]);
+
+ if ($addpagebreak) {
+ // Two questions on page 1 push the pagebreak to position >= 2, which is
+ // required for load_questions() to recognise it as a real section break.
+ $qgen->create_question($questionnaire, [
+ 'surveyid' => $surveyid,
+ 'name' => 'Q2',
+ 'typeid' => QUESTEXT,
+ 'content' => 'Enter more text',
+ 'required' => 'n',
+ ]);
+ $qgen->create_question($questionnaire, [
+ 'surveyid' => $surveyid,
+ 'name' => 'break1',
+ 'typeid' => QUESPAGEBREAK,
+ 'content' => '',
+ ]);
+ $qgen->create_question($questionnaire, [
+ 'surveyid' => $surveyid,
+ 'name' => 'Q3',
+ 'typeid' => QUESTEXT,
+ 'content' => 'Enter final text',
+ 'required' => 'n',
+ ]);
+ }
+
+ $user = $generator->create_user();
+ $studentrole = $DB->get_record('role', ['shortname' => 'student'], '*', MUST_EXIST);
+ $generator->enrol_user($user->id, $course->id, $studentrole->id);
+
+ // Reload so questions_by_section is populated.
+ $questionnaire = questionnaire::from_instanceid($questionnaire->id());
+
+ return [$questionnaire, $user->id];
+ }
+
+ // Tests for action = '' (plain save).
+
+ /**
+ * A plain save with no action inserts a response record and returns an empty array.
+ *
+ * @covers \mod_questionnaire\questionnaire::save_mobile_data
+ */
+ public function test_plain_save_inserts_response(): void {
+ global $DB;
+ [$questionnaire, $userid] = $this->make_fixture();
+
+ $result = $questionnaire->save_mobile_data($userid, 1, 0, 0, 0, '', []);
+
+ $this->assertIsArray($result);
+ $this->assertArrayNotHasKey('warnings', $result);
+ $this->assertTrue(
+ $DB->record_exists('questionnaire_response', ['questionnaireid' => $questionnaire->id(), 'userid' => $userid])
+ );
+ }
+
+ /**
+ * When completed=1 (reviewing), a plain save must NOT insert a new response.
+ *
+ * @covers \mod_questionnaire\questionnaire::save_mobile_data
+ */
+ public function test_plain_save_skips_insert_when_completed(): void {
+ global $DB;
+ [$questionnaire, $userid] = $this->make_fixture();
+
+ $result = $questionnaire->save_mobile_data($userid, 1, 1, 0, 0, '', []);
+
+ $this->assertIsArray($result);
+ $this->assertArrayNotHasKey('warnings', $result);
+ $this->assertFalse(
+ $DB->record_exists('questionnaire_response', ['questionnaireid' => $questionnaire->id(), 'userid' => $userid])
+ );
+ }
+
+ /**
+ * A required question with no answer returns warnings and a response object; no DB record is created.
+ *
+ * @covers \mod_questionnaire\questionnaire::save_mobile_data
+ */
+ public function test_plain_save_returns_warnings_for_missing_required(): void {
+ global $DB;
+ [$questionnaire, $userid] = $this->make_fixture(false, true); // Required question.
+
+ $result = $questionnaire->save_mobile_data($userid, 1, 0, 0, 0, '', []);
+
+ $this->assertArrayHasKey('warnings', $result);
+ $this->assertNotEmpty($result['warnings']);
+ $this->assertArrayHasKey('response', $result);
+ $this->assertFalse(
+ $DB->record_exists('questionnaire_response', ['questionnaireid' => $questionnaire->id(), 'userid' => $userid])
+ );
+ }
+
+ // Tests for submit=1.
+
+ /**
+ * When submit=1 and there are no warnings, the response is committed (complete='y').
+ *
+ * @covers \mod_questionnaire\questionnaire::save_mobile_data
+ */
+ public function test_submit_commits_response(): void {
+ global $DB;
+ [$questionnaire, $userid] = $this->make_fixture();
+
+ $questionnaire->save_mobile_data($userid, 1, 0, 0, 1, '', []);
+
+ $record = $DB->get_record(
+ 'questionnaire_response',
+ ['questionnaireid' => $questionnaire->id(), 'userid' => $userid],
+ 'complete',
+ MUST_EXIST
+ );
+ $this->assertEquals('y', $record->complete);
+ }
+
+ /**
+ * When submit=1 but there are warnings (required question unanswered), the response is NOT committed.
+ *
+ * @covers \mod_questionnaire\questionnaire::save_mobile_data
+ */
+ public function test_submit_skipped_when_warnings_present(): void {
+ global $DB;
+ [$questionnaire, $userid] = $this->make_fixture(false, true); // Required question.
+
+ $questionnaire->save_mobile_data($userid, 1, 0, 0, 1, '', []);
+
+ $this->assertFalse(
+ $DB->record_exists('questionnaire_response', ['questionnaireid' => $questionnaire->id(), 'userid' => $userid])
+ );
+ }
+
+ // Tests for action = 'nextpage'.
+
+ /**
+ * nextpage action on a two-page questionnaire returns nextpagenum = 2.
+ *
+ * @covers \mod_questionnaire\questionnaire::save_mobile_data
+ */
+ public function test_nextpage_returns_next_section_number(): void {
+ [$questionnaire, $userid] = $this->make_fixture(true); // Two-page questionnaire.
+
+ $result = $questionnaire->save_mobile_data($userid, 1, 0, 0, 0, 'nextpage', []);
+
+ $this->assertArrayHasKey('nextpagenum', $result);
+ $this->assertEquals(2, $result['nextpagenum']);
+ }
+
+ // Tests for action = 'previouspage'.
+
+ /**
+ * previouspage action from page 2 returns nextpagenum = 1.
+ *
+ * @covers \mod_questionnaire\questionnaire::save_mobile_data
+ */
+ public function test_previouspage_returns_previous_section_number(): void {
+ [$questionnaire, $userid] = $this->make_fixture(true); // Two-page questionnaire.
+
+ $result = $questionnaire->save_mobile_data($userid, 2, 0, 0, 0, 'previouspage', []);
+
+ $this->assertArrayHasKey('nextpagenum', $result);
+ $this->assertEquals(1, $result['nextpagenum']);
+ }
+
+ /**
+ * previouspage action from page 1 returns nextpagenum = false (no previous page).
+ *
+ * @covers \mod_questionnaire\questionnaire::save_mobile_data
+ */
+ public function test_previouspage_returns_false_on_first_page(): void {
+ [$questionnaire, $userid] = $this->make_fixture(true);
+
+ $result = $questionnaire->save_mobile_data($userid, 1, 0, 0, 0, 'previouspage', []);
+
+ $this->assertArrayHasKey('nextpagenum', $result);
+ $this->assertFalse($result['nextpagenum']);
+ }
+}
diff --git a/tests/submission_controller_test.php b/tests/submission_controller_test.php
new file mode 100644
index 000000000..75dedb845
--- /dev/null
+++ b/tests/submission_controller_test.php
@@ -0,0 +1,195 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\submission_controller.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire;
+
+use mod_questionnaire\local\db\questionnaire_record;
+use mod_questionnaire\local\db\survey_record;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+require_once($CFG->dirroot . '/mod/questionnaire/tests/questionnaire_testable.php');
+
+/**
+ * Unit tests for mod_questionnaire\submission_controller.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\submission_controller
+ */
+final class submission_controller_test extends \advanced_testcase {
+ /**
+ * Build a questionnaire_record persistent populated from an in-memory object.
+ *
+ * @param array $fields
+ * @return questionnaire_record
+ */
+ private function make_module_record(array $fields = []): questionnaire_record {
+ return new questionnaire_record(0, (object)array_merge([
+ 'id' => 1,
+ 'course' => 1,
+ 'name' => 'Test questionnaire',
+ 'intro' => '',
+ 'introformat' => FORMAT_HTML,
+ 'qtype' => questionnaire::QTYPE_UNLIMITED,
+ 'respondenttype' => 'fullname',
+ 'respeligible' => 'all',
+ 'respview' => questionnaire::RESPVIEW_NEVER,
+ 'notifications' => 0,
+ 'opendate' => 0,
+ 'closedate' => 0,
+ 'resume' => 0,
+ 'navigate' => 0,
+ 'grade' => 0,
+ 'sid' => 1,
+ 'timemodified' => 0,
+ 'completionsubmit' => 0,
+ 'autonum' => 3,
+ 'progressbar' => 0,
+ 'removeafter' => 0,
+ ], $fields));
+ }
+
+ /**
+ * Build a survey_record persistent from an in-memory object.
+ *
+ * @param array $fields
+ * @return survey_record
+ */
+ private function make_survey_record(array $fields = []): survey_record {
+ return new survey_record(0, (object)array_merge([
+ 'id' => 1,
+ 'name' => 'Test survey',
+ 'courseid' => 1,
+ 'realm' => 'private',
+ 'status' => 0,
+ 'title' => 'Title',
+ 'email' => null,
+ 'subtitle' => null,
+ 'info' => null,
+ 'theme' => null,
+ 'thankspage' => null,
+ 'thankhead' => null,
+ 'thankbody' => null,
+ 'feedbacksections' => 0,
+ 'feedbacknotes' => null,
+ 'feedbackscores' => 0,
+ 'charttype' => null,
+ ], $fields));
+ }
+
+ /**
+ * Build a questionnaire_testable wrapping fresh module/survey records.
+ *
+ * @param array $modulefields
+ * @param array $surveyfields
+ * @return questionnaire_testable
+ */
+ private function make_questionnaire(array $modulefields = [], array $surveyfields = []): questionnaire_testable {
+ if (!array_key_exists('id', $surveyfields)) {
+ $surveyfields['id'] = $modulefields['sid'] ?? 1;
+ }
+ return new questionnaire_testable(
+ $this->make_module_record($modulefields),
+ $this->make_survey_record($surveyfields)
+ );
+ }
+
+ // Tests for existing_response_action().
+
+ /**
+ * Asserts existing_response_action() inserts a new DB record when rid is 0.
+ */
+ public function test_existing_response_action_inserts_when_rid_zero(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $qid = 55561;
+ $q = $this->make_questionnaire(['id' => $qid]);
+ $q->set_questions_by_sec([1 => []]);
+ $newrid = $q->submission()->existing_response_action((object)['rid' => 0, 'sec' => 1], 1);
+ $this->assertGreaterThan(0, $newrid);
+ $this->assertTrue($DB->record_exists('questionnaire_response', ['id' => $newrid, 'questionnaireid' => $qid]));
+ }
+
+ /**
+ * Asserts existing_response_action() updates the submitted time on an existing record.
+ */
+ public function test_existing_response_action_updates_existing_record(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $qid = 55562;
+ $q = $this->make_questionnaire(['id' => $qid]);
+ $q->set_questions_by_sec([1 => []]);
+ $originaltime = time() - 3600;
+ $rid = $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $qid, 'userid' => 1,
+ 'submitted' => $originaltime, 'complete' => 'n', 'grade' => 0,
+ ]);
+ $returnedrid = $q->submission()->existing_response_action((object)['rid' => $rid, 'sec' => 1], 1);
+ $this->assertSame((int)$rid, (int)$returnedrid);
+ $this->assertGreaterThan($originaltime, $DB->get_field('questionnaire_response', 'submitted', ['id' => $rid]));
+ }
+
+ // Tests for next_page_action().
+
+ /**
+ * Asserts next_page_action() returns the next section number when the response is valid.
+ */
+ public function test_next_page_action_returns_next_section_when_valid(): void {
+ $this->resetAfterTest();
+ // With no questions, response_check_format returns '' so the action proceeds.
+ $q = $this->make_questionnaire(['id' => 44451, 'navigate' => 0]);
+ $q->set_questions_by_sec([1 => []]);
+ $result = $q->submission()->next_page_action((object)['rid' => 0, 'sec' => 1], 1);
+ // With no dependencies, next_page(1, 0) increments to 2.
+ $this->assertSame(2, $result);
+ }
+
+ // Tests for previous_page_action().
+
+ /**
+ * Asserts previous_page_action() saves the response and returns the previous section number.
+ */
+ public function test_previous_page_action_returns_previous_section(): void {
+ $this->resetAfterTest();
+ $q = $this->make_questionnaire(['id' => 44452, 'navigate' => 0]);
+ $q->set_questions_by_sec([1 => [], 2 => []]);
+ $result = $q->submission()->previous_page_action((object)['rid' => 0, 'sec' => 2], 1);
+ // With no dependencies, prev_page(2, 0) returns 1.
+ $this->assertSame(1, $result);
+ }
+
+ /**
+ * Asserts previous_page_action() returns false when already on the first section.
+ */
+ public function test_previous_page_action_returns_false_on_first_section(): void {
+ $this->resetAfterTest();
+ $q = $this->make_questionnaire(['id' => 44453, 'navigate' => 0]);
+ $q->set_questions_by_sec([1 => []]);
+ $result = $q->submission()->previous_page_action((object)['rid' => 0, 'sec' => 1], 1);
+ // Prev_page(1, 0) decrements to 0, which returns false.
+ $this->assertFalse($result);
+ }
+}
diff --git a/tests/submission_notifier_test.php b/tests/submission_notifier_test.php
new file mode 100644
index 000000000..4303f33ca
--- /dev/null
+++ b/tests/submission_notifier_test.php
@@ -0,0 +1,207 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\submission_notifier.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire;
+
+/**
+ * Unit tests for mod_questionnaire\submission_notifier.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\submission_notifier
+ */
+final class submission_notifier_test extends \advanced_testcase {
+ /**
+ * Create a course, a questionnaire instance, and an enrolled student. Return both the
+ * questionnaire domain object and the student so callers can wire up further state.
+ *
+ * @param array $instanceopts Extra options to pass to create_instance().
+ * @return array [questionnaire, student]
+ */
+ private function setup_with_student(array $instanceopts = []): array {
+ global $DB;
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $instance = $generator->get_plugin_generator('mod_questionnaire')
+ ->create_instance(array_merge(['course' => $course->id], $instanceopts));
+
+ $student = $generator->create_user();
+ $studentrole = $DB->get_record('role', ['shortname' => 'student'], '*', MUST_EXIST);
+ $generator->enrol_user($student->id, $course->id, $studentrole->id);
+
+ return [$instance, $student];
+ }
+
+ /**
+ * Insert a complete response and return its id.
+ *
+ * @param int $questionnaireid
+ * @param int $userid
+ * @return int
+ */
+ private function insert_response(int $questionnaireid, int $userid): int {
+ global $DB;
+ return $DB->insert_record('questionnaire_response', (object)[
+ 'questionnaireid' => $questionnaireid,
+ 'userid' => $userid,
+ 'submitted' => time(),
+ 'complete' => 'y',
+ 'grade' => 0,
+ ]);
+ }
+
+ /**
+ * get_notifiable_users() returns every enrolled user with the capability except the submitter.
+ */
+ public function test_get_notifiable_users_excludes_submitter(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+ $generator = $this->getDataGenerator();
+
+ [$questionnaire, $student] = $this->setup_with_student();
+ // Enrol a teacher who will receive notifications.
+ $teacher = $generator->create_user();
+ $teacherrole = $generator->create_role();
+ assign_capability(
+ 'mod/questionnaire:submissionnotification',
+ CAP_ALLOW,
+ $teacherrole,
+ $questionnaire->context()->id
+ );
+ $generator->role_assign($teacherrole, $teacher->id, $questionnaire->context()->id);
+ $generator->enrol_user($teacher->id, $questionnaire->courseid());
+
+ $notifier = new submission_notifier($questionnaire);
+ $users = $notifier->get_notifiable_users($student->id);
+
+ $this->assertArrayHasKey($teacher->id, $users);
+ $this->assertArrayNotHasKey($student->id, $users);
+ }
+
+ /**
+ * get_notifiable_users() returns an empty array when nobody has the notification capability.
+ */
+ public function test_get_notifiable_users_empty_when_nobody_capable(): void {
+ $this->resetAfterTest();
+ [$questionnaire, $student] = $this->setup_with_student();
+ // The student does not have mod/questionnaire:submissionnotification by default.
+
+ $notifier = new submission_notifier($questionnaire);
+ $this->assertSame([], $notifier->get_notifiable_users($student->id));
+ }
+
+ /**
+ * notify() does nothing when the survey has no email recipient and notifications are off.
+ */
+ public function test_notify_noop_with_no_recipients(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$questionnaire, $student] = $this->setup_with_student();
+ $rid = $this->insert_response($questionnaire->id(), $student->id);
+
+ $emailsink = $this->redirectEmails();
+ $messagesink = $this->redirectMessages();
+
+ $notifier = new submission_notifier($questionnaire);
+ $this->assertTrue($notifier->notify($rid));
+
+ $this->assertCount(0, $emailsink->get_messages());
+ $this->assertCount(0, $messagesink->get_messages());
+ $emailsink->close();
+ $messagesink->close();
+ }
+
+ /**
+ * notify() sends an email to every address in the survey's configured recipient list.
+ */
+ public function test_notify_sends_email_to_survey_recipients(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ [$questionnaire, $student] = $this->setup_with_student();
+ // Add an email recipient list to the survey row.
+ $DB->set_field(
+ 'questionnaire_survey',
+ 'email',
+ 'first@example.com,second@example.com',
+ ['id' => $questionnaire->surveyid()]
+ );
+
+ $rid = $this->insert_response($questionnaire->id(), $student->id);
+
+ $emailsink = $this->redirectEmails();
+
+ // Reload the questionnaire so the survey object picks up the email.
+ $reloaded = questionnaire::from_instanceid($questionnaire->id());
+ (new submission_notifier($reloaded))->notify($rid);
+
+ $emails = $emailsink->get_messages();
+ $this->assertCount(2, $emails);
+ $addresses = array_map(fn($m) => $m->to, $emails);
+ $this->assertContains('first@example.com', $addresses);
+ $this->assertContains('second@example.com', $addresses);
+ $emailsink->close();
+ }
+
+ /**
+ * notify() dispatches a Moodle message to capable users when notifications are enabled.
+ */
+ public function test_notify_sends_messages_when_notifications_enabled(): void {
+ global $DB;
+ $this->resetAfterTest();
+ $generator = $this->getDataGenerator();
+
+ [$questionnaire, $student] = $this->setup_with_student();
+ // Enable notifications mode 1 (subject-only message).
+ $DB->set_field('questionnaire', 'notifications', 1, ['id' => $questionnaire->id()]);
+
+ // Enrol a teacher with the notification capability.
+ $teacher = $generator->create_user();
+ $teacherrole = $generator->create_role();
+ assign_capability(
+ 'mod/questionnaire:submissionnotification',
+ CAP_ALLOW,
+ $teacherrole,
+ $questionnaire->context()->id
+ );
+ $generator->role_assign($teacherrole, $teacher->id, $questionnaire->context()->id);
+ $generator->enrol_user($teacher->id, $questionnaire->courseid());
+
+ $rid = $this->insert_response($questionnaire->id(), $student->id);
+
+ // The notifier reads $USER->id as the submitter.
+ $this->setUser($student);
+ $messagesink = $this->redirectMessages();
+
+ $reloaded = questionnaire::from_instanceid($questionnaire->id());
+ (new submission_notifier($reloaded))->notify($rid);
+
+ $messages = $messagesink->get_messages();
+ $this->assertCount(1, $messages);
+ $this->assertEquals($teacher->id, $messages[0]->useridto);
+ $messagesink->close();
+ }
+}
diff --git a/tests/survey_settings_controller_test.php b/tests/survey_settings_controller_test.php
new file mode 100644
index 000000000..83364866d
--- /dev/null
+++ b/tests/survey_settings_controller_test.php
@@ -0,0 +1,126 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\survey_settings_controller.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire;
+
+/**
+ * Unit tests for mod_questionnaire\survey_settings_controller.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\survey_settings_controller
+ */
+final class survey_settings_controller_test extends \advanced_testcase {
+ /**
+ * Build a course + questionnaire fixture.
+ *
+ * @return questionnaire
+ */
+ private function setup_questionnaire(): questionnaire {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+ $course = $this->getDataGenerator()->create_course();
+ return $this->getDataGenerator()
+ ->get_plugin_generator('mod_questionnaire')
+ ->create_instance(['course' => $course->id]);
+ }
+
+ /**
+ * Build the minimal formdata stdClass that the qsettings form returns from get_data().
+ *
+ * @param questionnaire $questionnaire
+ * @param array $overrides
+ * @return \stdClass
+ */
+ private function formdata(questionnaire $questionnaire, array $overrides = []): \stdClass {
+ $defaults = [
+ 'name' => $questionnaire->survey()->name(),
+ 'realm' => $questionnaire->survey()->realm(),
+ 'title' => $questionnaire->survey()->title(),
+ 'subtitle' => 'Sub',
+ 'info' => ['itemid' => 0, 'format' => FORMAT_HTML, 'text' => 'About this survey'],
+ 'thankspage' => 'https://example.org/done',
+ 'thankhead' => 'Thanks!',
+ 'thankbody' => ['itemid' => 0, 'format' => FORMAT_HTML, 'text' => 'Bye'],
+ 'email' => 'alerts@example.org',
+ 'courseid' => $questionnaire->course()->id,
+ ];
+ return (object) array_merge($defaults, $overrides);
+ }
+
+ /**
+ * Asserts save() persists each settings field onto the survey row.
+ */
+ public function test_save_persists_form_fields(): void {
+ global $DB;
+
+ $questionnaire = $this->setup_questionnaire();
+ $result = (new survey_settings_controller($questionnaire))->save($this->formdata($questionnaire, [
+ 'subtitle' => 'New subtitle',
+ 'thankhead' => 'New thank head',
+ 'email' => 'sup@example.org',
+ ]));
+
+ $this->assertSame($questionnaire->surveyid(), $result);
+ $row = $DB->get_record('questionnaire_survey', ['id' => $questionnaire->surveyid()]);
+ $this->assertEquals('New subtitle', $row->subtitle);
+ $this->assertEquals('New thank head', $row->thankhead);
+ $this->assertEquals('sup@example.org', $row->email);
+ $this->assertStringContainsString('About this survey', $row->info);
+ $this->assertStringContainsString('Bye', $row->thankbody);
+ }
+
+ /**
+ * Asserts save() throws when underlying update rejects (e.g. duplicate name).
+ */
+ public function test_save_throws_when_update_rejected(): void {
+ $questionnaire = $this->setup_questionnaire();
+
+ // Empty title is rejected by survey::update_settings().
+ $this->expectException(\moodle_exception::class);
+ (new survey_settings_controller($questionnaire))->save($this->formdata($questionnaire, [
+ 'title' => '',
+ ]));
+ }
+
+ /**
+ * Asserts save() leaves the survey row id untouched even when the form would otherwise
+ * carry a misleading 'id' value. Hardened against the historical feedback.php bug.
+ */
+ public function test_save_does_not_corrupt_survey_id(): void {
+ global $DB;
+
+ $questionnaire = $this->setup_questionnaire();
+ $surveyid = $questionnaire->surveyid();
+
+ $formdata = $this->formdata($questionnaire);
+ // Smuggle a stray id like the legacy form payload used to. survey_settings_controller
+ // builds an explicit allowlist, so this must be ignored.
+ $formdata->id = 999999;
+
+ (new survey_settings_controller($questionnaire))->save($formdata);
+
+ $this->assertTrue($DB->record_exists('questionnaire_survey', ['id' => $surveyid]));
+ }
+}
diff --git a/tests/survey_test.php b/tests/survey_test.php
new file mode 100644
index 000000000..0e6654d91
--- /dev/null
+++ b/tests/survey_test.php
@@ -0,0 +1,822 @@
+.
+
+/**
+ * Unit tests for mod_questionnaire\survey.
+ *
+ * Pure business-logic tests use survey_testable (no DB). Tests that require
+ * a real survey record use the DB with resetAfterTest.
+ *
+ * @package mod_questionnaire
+ * @copyright 2026 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_questionnaire;
+
+use mod_questionnaire\local\db\survey_record;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+require_once($CFG->dirroot . '/mod/questionnaire/tests/survey_testable.php');
+
+/**
+ * Unit tests for mod_questionnaire\survey.
+ *
+ * @group mod_questionnaire
+ * @covers \mod_questionnaire\survey
+ */
+final class survey_test extends \advanced_testcase {
+ // Helpers.
+
+ /**
+ * Build an in-memory survey_record with sensible defaults, optionally overriding fields.
+ *
+ * @param array $fields
+ * @return survey_record
+ */
+ private function make_survey_record(array $fields = []): survey_record {
+ return new survey_record(0, (object) array_merge([
+ 'id' => 1,
+ 'name' => 'Test survey',
+ 'courseid' => 1,
+ 'realm' => 'private',
+ 'status' => 0,
+ 'title' => 'My title',
+ 'email' => null,
+ 'subtitle' => null,
+ 'info' => null,
+ 'theme' => null,
+ 'thankspage' => null,
+ 'thankhead' => null,
+ 'thankbody' => null,
+ 'feedbacksections' => 0,
+ 'feedbacknotes' => null,
+ 'feedbackscores' => 0,
+ 'charttype' => null,
+ ], $fields));
+ }
+
+ /**
+ * Build a survey_testable with optional field overrides.
+ *
+ * @param array $fields
+ * @return survey_testable
+ */
+ private function make_survey(array $fields = []): survey_testable {
+ return new survey_testable($this->make_survey_record($fields));
+ }
+
+ /**
+ * Build a minimal stub question with a required() accessor for has_required() tests.
+ *
+ * @param bool $required
+ * @return object
+ */
+ private function make_required_stub(bool $required): object {
+ return new class ($required) {
+ /** @var bool */
+ private bool $req;
+ /**
+ * Constructor.
+ *
+ * @param bool $required
+ */
+ public function __construct(bool $required) {
+ $this->req = $required;
+ }
+ /**
+ * Required flag accessor.
+ *
+ * @return bool
+ */
+ public function required(): bool {
+ return $this->req;
+ }
+ };
+ }
+
+ /**
+ * Build a minimal stub question for position-helper tests.
+ *
+ * @param int $id Question id.
+ * @param int $position Question position (1-based).
+ * @param array $dependencies Array of dependency stdClass objects with dependquestionid.
+ * @return object
+ */
+ private function make_stub_question(int $id, int $position, array $dependencies = []): object {
+ return new class ($id, $position, $dependencies) {
+ /** @var int */
+ public int $qid;
+ /** @var array */
+ public array $dependencies;
+ /** @var int */
+ private int $pos;
+
+ /**
+ * Constructor.
+ *
+ * @param int $id
+ * @param int $position
+ * @param array $dependencies
+ */
+ public function __construct(int $id, int $position, array $dependencies) {
+ $this->qid = $id;
+ $this->pos = $position;
+ $this->dependencies = $dependencies;
+ }
+
+ /**
+ * Return the question id.
+ *
+ * @return int
+ */
+ public function id(): int {
+ return $this->qid;
+ }
+
+ /**
+ * Return the question position.
+ *
+ * @return int
+ */
+ public function position(): int {
+ return $this->pos;
+ }
+ };
+ }
+
+ // Tests for accessor methods (no DB).
+
+ /**
+ * Asserts title() returns the value from the survey record.
+ *
+ * @covers \mod_questionnaire\survey::title
+ */
+ public function test_title_returns_value_from_record(): void {
+ $this->assertEquals('My title', $this->make_survey(['title' => 'My title'])->title());
+ }
+
+ /**
+ * Asserts subtitle() returns an empty string when the record value is null.
+ *
+ * @covers \mod_questionnaire\survey::subtitle
+ */
+ public function test_subtitle_returns_empty_string_when_null(): void {
+ $this->assertSame('', $this->make_survey(['subtitle' => null])->subtitle());
+ }
+
+ /**
+ * Asserts subtitle() returns the stored value when set.
+ *
+ * @covers \mod_questionnaire\survey::subtitle
+ */
+ public function test_subtitle_returns_value_when_set(): void {
+ $this->assertEquals('Sub', $this->make_survey(['subtitle' => 'Sub'])->subtitle());
+ }
+
+ /**
+ * Asserts info() returns an empty string when the record value is null.
+ *
+ * @covers \mod_questionnaire\survey::info
+ */
+ public function test_info_returns_empty_string_when_null(): void {
+ $this->assertSame('', $this->make_survey(['info' => null])->info());
+ }
+
+ /**
+ * Asserts realm() returns the stored realm string.
+ *
+ * @covers \mod_questionnaire\survey::realm
+ */
+ public function test_realm_returns_private_by_default(): void {
+ $this->assertEquals('private', $this->make_survey()->realm());
+ }
+
+ /**
+ * Asserts owning_courseid() returns the course id from the record.
+ *
+ * @covers \mod_questionnaire\survey::owning_courseid
+ */
+ public function test_owning_courseid_returns_course_id(): void {
+ $this->assertEquals(42, $this->make_survey(['courseid' => 42])->owning_courseid());
+ }
+
+ /**
+ * Asserts thankspage() returns an empty string when the record value is null.
+ *
+ * @covers \mod_questionnaire\survey::thankspage
+ */
+ public function test_thankspage_returns_empty_when_null(): void {
+ $this->assertSame('', $this->make_survey(['thankspage' => null])->thankspage());
+ }
+
+ /**
+ * Asserts thankhead() returns the stored value when set.
+ *
+ * @covers \mod_questionnaire\survey::thankhead
+ */
+ public function test_thankhead_returns_value_when_set(): void {
+ $this->assertEquals('Thank you!', $this->make_survey(['thankhead' => 'Thank you!'])->thankhead());
+ }
+
+ /**
+ * Asserts thankbody() returns an empty string when the record value is null.
+ *
+ * @covers \mod_questionnaire\survey::thankbody
+ */
+ public function test_thankbody_returns_empty_when_null(): void {
+ $this->assertSame('', $this->make_survey(['thankbody' => null])->thankbody());
+ }
+
+ /**
+ * Asserts email() returns an empty string when the record value is null.
+ *
+ * @covers \mod_questionnaire\survey::email
+ */
+ public function test_email_returns_empty_when_null(): void {
+ $this->assertSame('', $this->make_survey(['email' => null])->email());
+ }
+
+ /**
+ * Asserts email() returns the stored address when set.
+ *
+ * @covers \mod_questionnaire\survey::email
+ */
+ public function test_email_returns_value_when_set(): void {
+ $this->assertEquals('a@b.com', $this->make_survey(['email' => 'a@b.com'])->email());
+ }
+
+ /**
+ * Asserts feedbacknotes() returns an empty string when the record value is null.
+ *
+ * @covers \mod_questionnaire\survey::feedbacknotes
+ */
+ public function test_feedbacknotes_returns_empty_when_null(): void {
+ $this->assertSame('', $this->make_survey(['feedbacknotes' => null])->feedbacknotes());
+ }
+
+ /**
+ * Asserts feedbacksections() returns 0 when no feedback sections are configured.
+ *
+ * @covers \mod_questionnaire\survey::feedbacksections
+ */
+ public function test_feedbacksections_returns_zero_by_default(): void {
+ $this->assertSame(0, $this->make_survey()->feedbacksections());
+ }
+
+ /**
+ * Asserts feedbacksections() returns the configured count.
+ *
+ * @covers \mod_questionnaire\survey::feedbacksections
+ */
+ public function test_feedbacksections_returns_configured_value(): void {
+ $this->assertEquals(3, $this->make_survey(['feedbacksections' => 3])->feedbacksections());
+ }
+
+ /**
+ * Asserts charttype() returns an empty string when the record value is null.
+ *
+ * @covers \mod_questionnaire\survey::charttype
+ */
+ public function test_charttype_returns_empty_when_null(): void {
+ $this->assertSame('', $this->make_survey(['charttype' => null])->charttype());
+ }
+
+ // Tests for boolean state methods.
+
+ /**
+ * Asserts is_public() returns false for a private-realm survey.
+ *
+ * @covers \mod_questionnaire\survey::is_public
+ */
+ public function test_is_public_false_when_private(): void {
+ $this->assertFalse($this->make_survey(['realm' => 'private'])->is_public());
+ }
+
+ /**
+ * Asserts is_public() returns true for a public-realm survey.
+ *
+ * @covers \mod_questionnaire\survey::is_public
+ */
+ public function test_is_public_true_when_public(): void {
+ $this->assertTrue($this->make_survey(['realm' => 'public'])->is_public());
+ }
+
+ /**
+ * Asserts is_template() returns false for a private-realm survey.
+ *
+ * @covers \mod_questionnaire\survey::is_template
+ */
+ public function test_is_template_false_when_private(): void {
+ $this->assertFalse($this->make_survey(['realm' => 'private'])->is_template());
+ }
+
+ /**
+ * Asserts is_template() returns true for a template-realm survey.
+ *
+ * @covers \mod_questionnaire\survey::is_template
+ */
+ public function test_is_template_true_when_template(): void {
+ $this->assertTrue($this->make_survey(['realm' => 'template'])->is_template());
+ }
+
+ /**
+ * Asserts is_public_master() returns true when public and the course id matches.
+ *
+ * @covers \mod_questionnaire\survey::is_public_master
+ */
+ public function test_is_public_master_true_when_public_and_owning_course(): void {
+ $survey = $this->make_survey(['realm' => 'public', 'courseid' => 5]);
+ $this->assertTrue($survey->is_public_master(5));
+ }
+
+ /**
+ * Asserts is_public_master() returns false when the survey is private.
+ *
+ * @covers \mod_questionnaire\survey::is_public_master
+ */
+ public function test_is_public_master_false_when_private(): void {
+ $survey = $this->make_survey(['realm' => 'private', 'courseid' => 5]);
+ $this->assertFalse($survey->is_public_master(5));
+ }
+
+ /**
+ * Asserts is_public_master() returns false when the course id does not match.
+ *
+ * @covers \mod_questionnaire\survey::is_public_master
+ */
+ public function test_is_public_master_false_when_different_course(): void {
+ $survey = $this->make_survey(['realm' => 'public', 'courseid' => 5]);
+ $this->assertFalse($survey->is_public_master(99));
+ }
+
+ /**
+ * Asserts is_owned_by_course() returns true when the course id matches.
+ *
+ * @covers \mod_questionnaire\survey::is_owned_by_course
+ */
+ public function test_is_owned_by_course_true_when_same(): void {
+ $this->assertTrue($this->make_survey(['courseid' => 7])->is_owned_by_course(7));
+ }
+
+ /**
+ * Asserts is_owned_by_course() returns false when the course id does not match.
+ *
+ * @covers \mod_questionnaire\survey::is_owned_by_course
+ */
+ public function test_is_owned_by_course_false_when_different(): void {
+ $this->assertFalse($this->make_survey(['courseid' => 7])->is_owned_by_course(8));
+ }
+
+ // Tests for to_stdclass().
+
+ /**
+ * Asserts to_stdclass() returns a stdClass with the expected field values.
+ *
+ * @covers \mod_questionnaire\survey::to_stdclass
+ */
+ public function test_to_stdclass_contains_expected_fields(): void {
+ $obj = $this->make_survey(['title' => 'T', 'realm' => 'public'])->to_stdclass();
+ $this->assertInstanceOf(\stdClass::class, $obj);
+ $this->assertEquals('T', $obj->title);
+ $this->assertEquals('public', $obj->realm);
+ }
+
+ // Tests for static position helpers (pure, no DB).
+
+ /**
+ * Asserts get_parent_positions() returns an empty array when no questions have dependencies.
+ *
+ * @covers \mod_questionnaire\survey::get_parent_positions
+ */
+ public function test_get_parent_positions_empty_when_no_deps(): void {
+ $questions = [
+ 1 => $this->make_stub_question(1, 1),
+ 2 => $this->make_stub_question(2, 2),
+ ];
+ $this->assertSame([], survey::get_parent_positions($questions));
+ }
+
+ /**
+ * Asserts get_parent_positions() maps child id to parent position.
+ *
+ * @covers \mod_questionnaire\survey::get_parent_positions
+ */
+ public function test_get_parent_positions_returns_parent_position(): void {
+ $dep = (object)['dependquestionid' => 1, 'dependchoiceid' => 1, 'dependlogic' => 1];
+ $questions = [
+ 1 => $this->make_stub_question(1, 5),
+ 2 => $this->make_stub_question(2, 10, [$dep]),
+ ];
+ $result = survey::get_parent_positions($questions);
+ $this->assertArrayHasKey(2, $result);
+ $this->assertEquals(5, $result[2]);
+ }
+
+ /**
+ * Asserts get_parent_positions() uses the highest parent position when a child has multiple parents.
+ *
+ * @covers \mod_questionnaire\survey::get_parent_positions
+ */
+ public function test_get_parent_positions_highest_parent_wins(): void {
+ $dep1 = (object)['dependquestionid' => 1, 'dependchoiceid' => 1, 'dependlogic' => 1];
+ $dep2 = (object)['dependquestionid' => 2, 'dependchoiceid' => 1, 'dependlogic' => 1];
+ $questions = [
+ 1 => $this->make_stub_question(1, 3),
+ 2 => $this->make_stub_question(2, 7),
+ 3 => $this->make_stub_question(3, 10, [$dep1, $dep2]),
+ ];
+ $result = survey::get_parent_positions($questions);
+ $this->assertEquals(7, $result[3]);
+ }
+
+ /**
+ * Asserts get_child_positions() returns an empty array when no questions have dependencies.
+ *
+ * @covers \mod_questionnaire\survey::get_child_positions
+ */
+ public function test_get_child_positions_empty_when_no_deps(): void {
+ $questions = [
+ 1 => $this->make_stub_question(1, 1),
+ 2 => $this->make_stub_question(2, 2),
+ ];
+ $this->assertSame([], survey::get_child_positions($questions));
+ }
+
+ /**
+ * Asserts get_child_positions() maps parent id to child position.
+ *
+ * @covers \mod_questionnaire\survey::get_child_positions
+ */
+ public function test_get_child_positions_returns_child_position(): void {
+ $dep = (object)['dependquestionid' => 1, 'dependchoiceid' => 1, 'dependlogic' => 1];
+ $questions = [
+ 1 => $this->make_stub_question(1, 5),
+ 2 => $this->make_stub_question(2, 10, [$dep]),
+ ];
+ $result = survey::get_child_positions($questions);
+ $this->assertArrayHasKey(1, $result);
+ $this->assertEquals(10, $result[1]);
+ }
+
+ /**
+ * Asserts get_child_positions() uses the lowest child position when a parent has multiple children.
+ *
+ * @covers \mod_questionnaire\survey::get_child_positions
+ */
+ public function test_get_child_positions_lowest_child_wins(): void {
+ $dep = (object)['dependquestionid' => 1, 'dependchoiceid' => 1, 'dependlogic' => 1];
+ $questions = [
+ 1 => $this->make_stub_question(1, 2),
+ 2 => $this->make_stub_question(2, 5, [$dep]),
+ 3 => $this->make_stub_question(3, 3, [$dep]),
+ ];
+ $result = survey::get_child_positions($questions);
+ $this->assertEquals(3, $result[1]);
+ }
+
+ // DB-backed tests.
+
+ /**
+ * Asserts from_sid() returns a zero-id survey when the given sid does not exist.
+ *
+ * @covers \mod_questionnaire\survey::from_sid
+ */
+ public function test_from_sid_returns_empty_survey_for_nonexistent_sid(): void {
+ $survey = survey::from_sid(0);
+ $this->assertEquals(0, $survey->id());
+ }
+
+ /**
+ * Asserts from_sid() returns a populated survey for a real survey id.
+ *
+ * @covers \mod_questionnaire\survey::from_sid
+ */
+ public function test_from_sid_returns_survey_for_real_sid(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+ $course = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
+ $questionnaire = $generator->create_instance(['course' => $course->id]);
+
+ $sid = $questionnaire->surveyid();
+ $this->assertGreaterThan(0, $sid);
+
+ $survey = survey::from_sid($sid);
+ $this->assertEquals($sid, $survey->id());
+ }
+
+ /**
+ * Asserts delete_pagebreaks() removes soft-deleted pagebreak rows while leaving other rows intact.
+ *
+ * @covers \mod_questionnaire\survey::delete_pagebreaks
+ */
+ public function test_delete_pagebreaks_removes_deleted_pagebreak_questions(): void {
+ global $DB;
+
+ $this->resetAfterTest();
+ $this->setAdminUser();
+ $course = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
+ $questionnaire = $generator->create_instance(['course' => $course->id]);
+ $sid = $questionnaire->surveyid();
+
+ // Insert a soft-deleted pagebreak question.
+ $pbid = $DB->insert_record('questionnaire_question', [
+ 'surveyid' => $sid,
+ 'typeid' => QUESPAGEBREAK,
+ 'position' => 1,
+ 'deleted' => time(),
+ 'content' => '',
+ ]);
+
+ // Insert a non-deleted regular question that must not be removed.
+ $regularid = $DB->insert_record('questionnaire_question', [
+ 'surveyid' => $sid,
+ 'typeid' => QUESYESNO,
+ 'position' => 2,
+ 'deleted' => null,
+ 'content' => 'Q?',
+ ]);
+
+ survey::delete_pagebreaks($sid);
+
+ $this->assertFalse($DB->record_exists('questionnaire_question', ['id' => $pbid]));
+ $this->assertTrue($DB->record_exists('questionnaire_question', ['id' => $regularid]));
+ }
+
+ // Tests for survey listing methods.
+
+ /**
+ * Asserts get_private_questionnaires() returns an entry keyed "private-{sid}" for a private survey.
+ *
+ * @covers \mod_questionnaire\survey::get_private_questionnaires
+ */
+ public function test_get_private_questionnaires_returns_entry_for_course_survey(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+ $course = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
+ $questionnaire = $generator->create_instance(['course' => $course->id]);
+ $sid = $questionnaire->surveyid();
+
+ $result = survey::get_private_questionnaires($course->id);
+
+ $this->assertArrayHasKey('private-' . $sid, $result);
+ $this->assertNotEmpty($result['private-' . $sid]);
+ }
+
+ /**
+ * Asserts get_public_questionnaires() includes other-course public surveys and excludes the current course's own.
+ *
+ * @covers \mod_questionnaire\survey::get_public_questionnaires
+ */
+ public function test_get_public_questionnaires_excludes_current_course(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+ $course1 = $this->getDataGenerator()->create_course();
+ $course2 = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
+
+ $q1 = $generator->create_instance(['course' => $course1->id]);
+ $generator->create_content($q1, ['realm' => 'public']);
+ $sid1 = $q1->surveyid();
+
+ $q2 = $generator->create_instance(['course' => $course2->id]);
+ $generator->create_content($q2, ['realm' => 'public']);
+ $sid2 = $q2->surveyid();
+
+ $result = survey::get_public_questionnaires($course1->id);
+
+ $this->assertArrayNotHasKey('public-' . $sid1, $result);
+ $this->assertArrayHasKey('public-' . $sid2, $result);
+ }
+
+ /**
+ * Asserts get_template_questionnaires() returns an entry keyed "template-{sid}" for a template survey.
+ *
+ * @covers \mod_questionnaire\survey::get_template_questionnaires
+ */
+ public function test_get_template_questionnaires_returns_template_survey(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+ $course = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
+
+ $questionnaire = $generator->create_instance(['course' => $course->id]);
+ $generator->create_content($questionnaire, ['realm' => 'template']);
+ $sid = $questionnaire->surveyid();
+
+ $result = survey::get_template_questionnaires($course->id);
+
+ $this->assertArrayHasKey('template-' . $sid, $result);
+ $this->assertNotEmpty($result['template-' . $sid]);
+ }
+
+ // Tests covering the update_settings allowlist persistence path.
+
+ /**
+ * Asserts update_settings() persists each allowlisted field onto the survey row.
+ *
+ * @covers \mod_questionnaire\survey::update_settings
+ */
+ public function test_update_settings_persists_allowlisted_fields(): void {
+ global $DB;
+
+ $this->resetAfterTest();
+ $this->setAdminUser();
+ $course = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
+ $questionnaire = $generator->create_instance(['course' => $course->id]);
+ $sid = $questionnaire->surveyid();
+
+ $survey = survey::from_sid($sid);
+ $result = $survey->update_settings([
+ 'feedbacksections' => 2,
+ 'feedbackscores' => 1,
+ 'feedbacknotes' => 'Notes body',
+ 'charttype' => 'bipolar',
+ ]);
+
+ $this->assertSame($sid, $result);
+ $row = $DB->get_record('questionnaire_survey', ['id' => $sid]);
+ $this->assertEquals(2, $row->feedbacksections);
+ $this->assertEquals(1, $row->feedbackscores);
+ $this->assertEquals('Notes body', $row->feedbacknotes);
+ $this->assertEquals('bipolar', $row->charttype);
+ }
+
+ /**
+ * Asserts update_settings() rejects unknown / non-allowlisted fields.
+ *
+ * @covers \mod_questionnaire\survey::update_settings
+ */
+ public function test_update_settings_rejects_unknown_field(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+ $course = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
+ $questionnaire = $generator->create_instance(['course' => $course->id]);
+
+ $survey = survey::from_sid($questionnaire->surveyid());
+
+ $this->expectException(\coding_exception::class);
+ $survey->update_settings(['id' => 999]);
+ }
+
+ /**
+ * Asserts update_settings() rejects a field that is not in the persistent's properties
+ * (e.g. someone passing a form-only key like 'sid').
+ *
+ * @covers \mod_questionnaire\survey::update_settings
+ */
+ public function test_update_settings_rejects_form_metadata_field(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+ $course = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
+ $questionnaire = $generator->create_instance(['course' => $course->id]);
+
+ $survey = survey::from_sid($questionnaire->surveyid());
+
+ $this->expectException(\coding_exception::class);
+ $survey->update_settings(['sid' => $questionnaire->surveyid()]);
+ }
+
+ /**
+ * Asserts update_settings() returns false when a present 'name' / 'title' / 'realm' is empty.
+ *
+ * @covers \mod_questionnaire\survey::update_settings
+ */
+ public function test_update_settings_returns_false_for_empty_required_field(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+ $course = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
+ $questionnaire = $generator->create_instance(['course' => $course->id]);
+
+ $survey = survey::from_sid($questionnaire->surveyid());
+ $this->assertFalse($survey->update_settings(['name' => '']));
+ $this->assertFalse($survey->update_settings(['title' => '']));
+ $this->assertFalse($survey->update_settings(['realm' => '']));
+ }
+
+ /**
+ * Asserts update_settings() returns false when renaming to a value that collides with another survey.
+ *
+ * @covers \mod_questionnaire\survey::update_settings
+ */
+ public function test_update_settings_returns_false_for_duplicate_name(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+ $course = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
+ $q1 = $generator->create_instance(['course' => $course->id]);
+ $q2 = $generator->create_instance(['course' => $course->id]);
+
+ $survey1 = survey::from_sid($q1->surveyid());
+ $survey2 = survey::from_sid($q2->surveyid());
+
+ $survey1->update_settings(['name' => 'shared-name']);
+ $this->assertFalse($survey2->update_settings(['name' => 'shared-name']));
+ }
+
+ /**
+ * Asserts update_settings() does NOT silently mutate fields that were not supplied
+ * (only the named keys are written).
+ *
+ * @covers \mod_questionnaire\survey::update_settings
+ */
+ public function test_update_settings_does_not_touch_unsupplied_fields(): void {
+ global $DB;
+
+ $this->resetAfterTest();
+ $this->setAdminUser();
+ $course = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
+ $questionnaire = $generator->create_instance(['course' => $course->id]);
+ $sid = $questionnaire->surveyid();
+ $originaltitle = $DB->get_field('questionnaire_survey', 'title', ['id' => $sid]);
+
+ survey::from_sid($sid)->update_settings(['feedbacksections' => 3]);
+
+ $this->assertEquals($originaltitle, $DB->get_field('questionnaire_survey', 'title', ['id' => $sid]));
+ $this->assertEquals(3, $DB->get_field('questionnaire_survey', 'feedbacksections', ['id' => $sid]));
+ }
+
+ // Tests for has_required() (pure, no DB).
+
+ /**
+ * Asserts has_required() returns false when there are no questions.
+ *
+ * @covers \mod_questionnaire\survey::has_required
+ */
+ public function test_has_required_false_when_no_questions(): void {
+ $this->assertFalse($this->make_survey()->has_required());
+ $this->assertFalse($this->make_survey()->has_required(2));
+ }
+
+ /**
+ * Asserts has_required() returns true across all sections when any question is required.
+ *
+ * @covers \mod_questionnaire\survey::has_required
+ */
+ public function test_has_required_true_across_all_sections(): void {
+ $survey = $this->make_survey();
+ $survey->set_questions([
+ 1 => $this->make_required_stub(false),
+ 2 => $this->make_required_stub(true),
+ ]);
+ $this->assertTrue($survey->has_required());
+ }
+
+ /**
+ * Asserts has_required() returns false across all sections when no question is required.
+ *
+ * @covers \mod_questionnaire\survey::has_required
+ */
+ public function test_has_required_false_across_all_sections(): void {
+ $survey = $this->make_survey();
+ $survey->set_questions([
+ 1 => $this->make_required_stub(false),
+ 2 => $this->make_required_stub(false),
+ ]);
+ $this->assertFalse($survey->has_required());
+ }
+
+ /**
+ * Asserts has_required() scoped to a section only inspects that section.
+ *
+ * @covers \mod_questionnaire\survey::has_required
+ */
+ public function test_has_required_per_section(): void {
+ $survey = $this->make_survey();
+ $survey->set_questions_by_sec([
+ 1 => [$this->make_required_stub(false)],
+ 2 => [$this->make_required_stub(true)],
+ ]);
+ $survey->set_questions([
+ 1 => $this->make_required_stub(false),
+ 2 => $this->make_required_stub(true),
+ ]);
+ $this->assertFalse($survey->has_required(1));
+ $this->assertTrue($survey->has_required(2));
+ $this->assertFalse($survey->has_required(99));
+ }
+}
diff --git a/tests/survey_testable.php b/tests/survey_testable.php
new file mode 100644
index 000000000..b4a8fdcf1
--- /dev/null
+++ b/tests/survey_testable.php
@@ -0,0 +1,62 @@
+.
+
+namespace mod_questionnaire;
+
+use mod_questionnaire\local\db\survey_record;
+
+/**
+ * Testable subclass of survey that bypasses the real constructor.
+ *
+ * Allows injecting a survey_record and question arrays directly so
+ * business-logic methods can be unit tested without a real course module.
+ *
+ * @package mod_questionnaire
+ * @copyright 2025 Mike Churchward (mike.churchward@poetopensource.org)
+ * @author Mike Churchward
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class survey_testable extends survey {
+ /**
+ * Construct with injected record, bypassing the real survey constructor.
+ *
+ * @param survey_record $surveyrecord
+ */
+ public function __construct(survey_record $surveyrecord) {
+ $this->surveyrecord = $surveyrecord;
+ $this->context = null;
+ $this->questions = [];
+ $this->questionsbysec = [];
+ }
+
+ /**
+ * Inject question objects for unit tests (bypasses DB loading).
+ *
+ * @param array $questions Keyed by question id.
+ */
+ public function set_questions(array $questions): void {
+ $this->questions = $questions;
+ }
+
+ /**
+ * Inject the questions-by-section map for unit tests.
+ *
+ * @param array $questionsbysec Array of question object arrays, keyed by 1-based section number.
+ */
+ public function set_questions_by_sec(array $questionsbysec): void {
+ $this->questionsbysec = $questionsbysec;
+ }
+}
diff --git a/version.php b/version.php
index 0d5163bdd..99a4e753a 100644
--- a/version.php
+++ b/version.php
@@ -25,10 +25,10 @@
defined('MOODLE_INTERNAL') || die();
-$plugin->version = 2025041402;
+$plugin->version = 2026050100.01;
$plugin->requires = 2025041400.00; // Moodle 5.0 and up.
$plugin->component = 'mod_questionnaire';
-$plugin->release = '5.0.3 (Build - 2026052200)';
-$plugin->maturity = MATURITY_STABLE;
+$plugin->release = '5.2.0 (Build - 2026041400)';
+$plugin->maturity = MATURITY_ALPHA;
diff --git a/view.php b/view.php
index 687ef0cb6..d4578e145 100644
--- a/view.php
+++ b/view.php
@@ -25,146 +25,141 @@
*/
require_once("../../config.php");
-require_once($CFG->dirroot . '/mod/questionnaire/locallib.php');
require_once($CFG->libdir . '/completionlib.php');
-require_once($CFG->dirroot . '/mod/questionnaire/questionnaire.class.php');
+
+use mod_questionnaire\questionnaire;
+use mod_questionnaire\output\viewpage;
if (!isset($SESSION->questionnaire)) {
$SESSION->questionnaire = new stdClass();
}
-$SESSION->questionnaire->current_tab = 'view';
-
-$id = optional_param('id', null, PARAM_INT); // Course Module ID.
-$a = optional_param('a', null, PARAM_INT); // Or questionnaire ID.
+$cmid = optional_param('id', null, PARAM_INT); // Course Module ID.
+$qid = optional_param('a', null, PARAM_INT); // Or questionnaire ID.
$sid = optional_param('sid', null, PARAM_INT); // Survey id.
-
-[$cm, $course, $questionnaire] = questionnaire_get_standard_page_items($id, $a);
+if (!empty($cmid)) {
+ $questionnaire = questionnaire::from_cmid($cmid);
+} else {
+ $questionnaire = questionnaire::from_instanceid($qid);
+}
// Check login and get context.
-require_course_login($course, true, $cm);
-$context = context_module::instance($cm->id);
+require_course_login($questionnaire->courseid(), true, $questionnaire->coursemodule());
$url = new moodle_url($CFG->wwwroot . '/mod/questionnaire/view.php');
-if (isset($id)) {
- $url->param('id', $id);
+if (isset($cmid)) {
+ $url->param('id', $cmid);
} else {
- $url->param('a', $a);
+ $url->param('a', $qid);
}
if (isset($sid)) {
$url->param('sid', $sid);
}
+// Log this course module view.
+$anonymous = $questionnaire->is_anonymous();
+$event = \mod_questionnaire\event\course_module_viewed::create(
+ [
+ 'objectid' => $questionnaire->id(),
+ 'anonymous' => $anonymous,
+ 'context' => $questionnaire->context(),
+ ]
+);
+$event->trigger();
+
$PAGE->set_url($url);
-$PAGE->set_context($context);
-$questionnaire = new questionnaire($course, $cm, 0, $questionnaire);
-// Add renderer and page objects to the questionnaire object for display use.
-$questionnaire->add_renderer($PAGE->get_renderer('mod_questionnaire'));
-$questionnaire->add_page(new \mod_questionnaire\output\viewpage());
+$PAGE->set_context($questionnaire->context());
+$PAGE->set_title(format_string($questionnaire->name()));
+$PAGE->set_heading(format_string($questionnaire->course()->fullname));
-$PAGE->set_title(format_string($questionnaire->name));
-$PAGE->set_heading(format_string($course->fullname));
+$renderer = $PAGE->get_renderer('mod_questionnaire');
+$page = new viewpage();
-echo $questionnaire->renderer->header();
// No need to print out intro or name in Moodle 4 and above.
-
-$cm = $questionnaire->cm;
+$cm = $questionnaire->coursemodule();
$currentgroupid = groups_get_activity_group($cm);
if (!groups_is_member($currentgroupid, $USER->id)) {
$currentgroupid = 0;
}
$message = $questionnaire->user_access_messages($USER->id);
-if ($message !== false) {
- $questionnaire->page->add_to_page('message', $message);
-} else if ($questionnaire->user_can_take($USER->id)) {
- if ($questionnaire->questions) { // Sanity check.
+if ($message !== null) {
+ $page->add_to_page('message', $message);
+} else if ($questionnaire->capabilities()->user_can_take($USER->id)) {
+ if ($questionnaire->questions()) { // Sanity check.
if (!$questionnaire->user_has_saved_response($USER->id)) {
- $questionnaire->page->add_to_page(
+ $page->add_to_page(
'complete',
'' . get_string('answerquestions', 'questionnaire') . ' '
);
} else {
$resumesurvey = get_string('resumesurvey', 'questionnaire');
- $questionnaire->page->add_to_page(
+ $page->add_to_page(
'complete',
'' . $resumesurvey . ' '
);
}
} else {
- $questionnaire->page->add_to_page('message', get_string('noneinuse', 'questionnaire'));
+ $page->add_to_page('message', get_string('noneinuse', 'questionnaire'));
}
}
-if ($questionnaire->capabilities->editquestions && !$questionnaire->questions && $questionnaire->is_active()) {
- $questionnaire->page->add_to_page(
+if ($questionnaire->capabilities()->can_edit_questions() && !$questionnaire->questions() && $questionnaire->is_active()) {
+ $page->add_to_page(
'complete',
'' .
+ 'id=' . $questionnaire->coursemodule()->id) . '" class="btn btn-primary">' .
get_string('addquestions', 'questionnaire') . ' '
);
}
// Time zone message (if required).
-if (!$message && $questionnaire->is_open() && !$questionnaire->is_closed()) {
+if ($message === null && $questionnaire->is_open() && !$questionnaire->is_closed()) {
$info = $questionnaire->view_information();
- $questionnaire->page->add_to_page('info', $questionnaire->access_messages($info));
+ $page->add_to_page('info', $questionnaire->access_messages($info));
}
if (isguestuser()) {
$guestno = html_writer::tag('p', get_string('noteligible', 'questionnaire'));
$liketologin = html_writer::tag('p', get_string('liketologin'));
- $questionnaire->page->add_to_page(
+ $page->add_to_page(
'guestuser',
- $questionnaire->renderer->confirm($guestno . "\n\n" . $liketologin . "\n", get_login_url(), get_local_referer(false))
+ $renderer->confirm($guestno . "\n\n" . $liketologin . "\n", get_login_url(), get_local_referer(false))
);
}
-// Log this course module view.
-// Needed for the event logging.
-$context = context_module::instance($questionnaire->cm->id);
-$anonymous = $questionnaire->respondenttype == 'anonymous';
-
-$event = \mod_questionnaire\event\course_module_viewed::create(
- [
- 'objectid' => $questionnaire->id,
- 'anonymous' => $anonymous,
- 'context' => $context,
- ]
-);
-$event->trigger();
-
$usernumresp = $questionnaire->count_submissions($USER->id);
-if ($questionnaire->capabilities->readownresponses && ($usernumresp > 0)) {
- $argstr = 'instance=' . $questionnaire->id . '&user=' . $USER->id;
+if ($questionnaire->capabilities()->can_read_own_responses() && ($usernumresp > 0)) {
+ $argstr = 'instance=' . $questionnaire->id() . '&user=' . $USER->id;
if ($usernumresp > 1) {
$titletext = get_string('viewyourresponses', 'questionnaire', $usernumresp);
} else {
$titletext = get_string('yourresponse', 'questionnaire');
$argstr .= '&byresponse=1&action=vresp';
}
- $questionnaire->page->add_to_page(
+ $page->add_to_page(
'yourresponse',
'' . $titletext . ' '
);
}
-if ($questionnaire->can_view_all_responses($usernumresp)) {
- $argstr = 'instance=' . $questionnaire->id . '&group=' . $currentgroupid;
- $questionnaire->page->add_to_page(
+if ($questionnaire->capabilities()->can_view_all_responses($usernumresp)) {
+ $argstr = 'instance=' . $questionnaire->id() . '&group=' . $currentgroupid;
+ $page->add_to_page(
'allresponses',
'' . get_string('viewallresponses', 'questionnaire') . ' '
);
}
-echo $questionnaire->renderer->render($questionnaire->page);
-echo $questionnaire->renderer->footer();
+echo $renderer->header();
+echo $renderer->render($page);
+echo $renderer->footer();