tags
+ // around it, as that is done anyway during generation of the PDF.
$qa = $quba->get_question_attempt($slot);
+ if ($this->options->source === 'html') {
+ $formattingoptions = [
+ 'trusted' => true,
+ 'filter' => false,
+ 'para' => false,
+ ];
+
+ $responsehtml = format_text(
+ strval($qa->get_last_qt_var('answer', '')),
+ $qa->get_last_qt_var('answerformat', FORMAT_PLAIN),
+ $formattingoptions
+ );
+
+ $questionhtml = format_text(
+ $questiondefinition->questiontext,
+ $questiondefinition->questiontextformat,
+ $formattingoptions
+ );
+
+ $details[$questionfolder]['responsetext'] = $responsehtml;
+ $details[$questionfolder]['questiontext'] = $questionhtml;
+ }
+
+ // Finally, fetch attachments, if there are.
$details[$questionfolder]['attachments'] = $qa->get_last_qt_files('attachments', $quba->get_owning_context()->id);
}
return $details;
@@ -335,30 +374,56 @@ protected function process_and_download(): void {
$errors = 0;
// Iterate over every attempt and every question.
- foreach ($this->attempts as $attemptid => $attemptpath) {
+ foreach ($this->attempts as $attemptid => $attemptdata) {
$questions = $this->get_details_for_attempt($attemptid);
foreach ($questions as $questionpath => $questiondetails) {
// Depending on the user's choice, the files will either be grouped by attempt or by question.
if ($this->options->groupby === 'byattempt') {
- $path = $attemptpath . '/' . $questionpath;
+ $path = $attemptdata['path'] . '/' . $questionpath;
+ } else {
+ $path = $questionpath . '/' . $attemptdata['path'];
+ }
+
+ // Build the full name according to user setting.
+ if ($this->options->nameordering === 'firstlast') {
+ $fullname = $attemptdata['firstname'] . ' ' . $attemptdata['lastname'];
} else {
- $path = $questionpath . '/' . $attemptpath;
+ $fullname = $attemptdata['lastname'] . ' ' . $attemptdata['firstname'];
}
try {
- if ($this->options->questiontext) {
- $zipwriter->add_file_from_string($path . '/' . 'questiontext.txt', $questiondetails['questiontext']);
- $emptyarchive = false;
+ if ($this->options->fileformat === 'pdf') {
+ $zipwriter->add_file_from_string(
+ $path . '/' . 'response.pdf',
+
+ $this->generate_pdf(
+ $questiondetails['responsetext'],
+ get_string('response', 'quiz_essaydownload'),
+ $fullname,
+ $fullname
+ )
+ );
+ } else {
+ $zipwriter->add_file_from_string($path . '/' . 'response.txt', $questiondetails['responsetext']);
}
- if ($this->options->responsetext) {
- $zipwriter->add_file_from_string($path . '/' . 'response.txt', $questiondetails['responsetext']);
- $emptyarchive = false;
+ $emptyarchive = false;
+
+ // Only include question text if instructed to do so.
+ if ($this->options->questiontext) {
+ if ($this->options->fileformat === 'pdf') {
+ $zipwriter->add_file_from_string($path . '/' . 'questiontext.pdf', $this->generate_pdf(
+ $questiondetails['questiontext'],
+ get_string('questiontext', 'question'),
+ get_string('presentedto', 'quiz_essaydownload', $fullname)
+ ));
+ } else {
+ $zipwriter->add_file_from_string($path . '/' . 'questiontext.txt', $questiondetails['questiontext']);
+ }
}
- if (!empty($questiondetails['attachments']) && $this->options->attachments) {
- $emptyarchive = false;
+ if ($this->options->attachments && !empty($questiondetails['attachments'])) {
foreach ($questiondetails['attachments'] as $file) {
$zipwriter->add_file_from_stored_file($path . '/attachments/' . $file->get_filename(), $file);
}
@@ -392,7 +457,7 @@ protected function process_and_download(): void {
* @param string $type the notification type, e. g. 'error' or 'info' or 'warn'
* @return void
*/
- protected function notification(string $message, string $type = 'error') {
+ protected function notification(string $message, string $type = 'error'): void {
global $OUTPUT;
// Printing the standard header. We'll set $hasquestions and $hasstudents to true here,
@@ -421,4 +486,59 @@ protected static function clean_filename(string $filename): string {
return clean_filename(str_replace(' ', '_', $filename));
}
+ /**
+ * Generate a PDF file from a given HTML code.
+ *
+ * @param string $text HTML code to be typeset
+ * @param string $header upper line of the header, printed in bold face
+ * @param string $subheader lower line of the header
+ * @param string $author author name to be stored in the document information field
+ * @return string PDF code
+ */
+ protected function generate_pdf(string $text, string $header = '', string $subheader = '', string $author = ''): string {
+ // The text might contain \xC2\xA0 for a unicode NON-BREAK SPACE character. This can confuse TCPDF, so we
+ // rather remove it here.
+ $text = str_replace("\xc2\xa0", " ", $text);
+
+ $doc = new pdf('P', 'mm', $this->options->pageformat);
+
+ $doc->SetCreator('quiz_essaydownload plugin for Moodle LMS');
+ $doc->SetAuthor($author);
+ $doc->SetTitle('');
+ $doc->SetKeywords('');
+ $doc->SetSubject('');
+
+ // The configured top margin is used for the distance between the page's top border and the start of the header.
+ $doc->setHeaderMargin($this->options->margintop);
+
+ // In order for the document's text to be reasonably separated from the header (and its rule), we add some space
+ // relative to linespacing and font size.
+ $doc->SetMargins(
+ $this->options->marginleft,
+ $this->options->margintop + $this->options->linespacing * $this->options->fontsize,
+ $this->options->marginright
+ );
+ $doc->setPrintFooter(false);
+
+ if ($this->options->font === 'serif') {
+ $fontname = 'freeserif';
+ } else if ($this->options->font === 'mono') {
+ $fontname = 'freemono';
+ } else {
+ $fontname = 'freesans';
+ }
+ $doc->SetFont($fontname, '', $this->options->fontsize);
+ $doc->setHeaderFont([$fontname, '', $this->options->fontsize]);
+
+ $doc->setHeaderData('', 0, $header, $subheader);
+ $doc->setFooterData();
+ $doc->SetAutoPageBreak(true, $this->options->marginbottom);
+
+ $doc->AddPage();
+ $linespacebase = 1.25;
+ $doc->writeHTML('
' . $text . '
');
+
+ return $doc->Output('', 'S');
+ }
+
}
diff --git a/tests/behat/form.feature b/tests/behat/form.feature
new file mode 100644
index 0000000..2310b3e
--- /dev/null
+++ b/tests/behat/form.feature
@@ -0,0 +1,63 @@
+@quiz @quiz_essaydownload @javascript
+Feature: Validation and display of the form
+
+ Background:
+ Given the following "courses" exist:
+ | fullname | shortname | category |
+ | Course 1 | C1 | 0 |
+ And the following "users" exist:
+ | username | firstname | lastname |
+ | teacher1 | T1 | Teacher1 |
+ | student1 | S1 | Student1 |
+ And the following "course enrolments" exist:
+ | user | course | role |
+ | teacher1 | C1 | editingteacher |
+ | student1 | C1 | student |
+ And the following "question categories" exist:
+ | contextlevel | reference | name |
+ | Course | C1 | Test questions |
+ And the following "activities" exist:
+ | activity | name | intro | course | groupmode |
+ | quiz | Quiz 1 | Quiz 1 description | C1 | 1 |
+ And the following "questions" exist:
+ | questioncategory | qtype | name | questiontext |
+ | Test questions | essay | Q1 | First question |
+ And quiz "Quiz 1" contains the following questions:
+ | question | page | maxmark |
+ | Q1 | 1 | 1.0 |
+ And user "student1" has attempted "Quiz 1" with responses:
+ | slot | response |
+ | 1 | The first student's answer. |
+
+ Scenario: Invalid form values should trigger an error message
+ When I am on the "Quiz 1" "quiz_essaydownload > essaydownload report" page logged in as "teacher1"
+ And I set the field "marginleft" to "100"
+ And I press "Download"
+ And I wait until the page is ready
+ Then I should see "All page margins must be integers between 0 and 80."
+ When I set the following fields to these values:
+ | marginleft | 20 |
+ | marginright | -1 |
+ And I press "Download"
+ And I wait until the page is ready
+ Then I should see "All page margins must be integers between 0 and 80."
+ When I set the following fields to these values:
+ | marginleft | 20 |
+ | marginright | 20 |
+ | fontsize | 5 |
+ And I press "Download"
+ And I wait until the page is ready
+ Then I should see "Font size should be an integer between 6 and 50."
+
+ Scenario: PDF specific fields should be disabled if output set to TXT
+ When I am on the "Quiz 1" "quiz_essaydownload > essaydownload report" page logged in as "teacher1"
+ When I set the field "fileformat" to "txt"
+ Then the "source" "select" should be disabled
+ And the "page" "select" should be disabled
+ And the "marginleft" "field" should be disabled
+ And the "marginright" "field" should be disabled
+ And the "margintop" "field" should be disabled
+ And the "marginbottom" "field" should be disabled
+ And the "linespacing" "select" should be disabled
+ And the "font" "select" should be disabled
+ And the "fontsize" "field" should be disabled
diff --git a/tests/report_test.php b/tests/report_test.php
index 62558b6..71ebc97 100644
--- a/tests/report_test.php
+++ b/tests/report_test.php
@@ -127,7 +127,7 @@ public function test_long_names_being_shortened(): void {
$student = \phpunit_util::get_data_generator()->create_user(
[
'firstname' => 'ExtremelyLongFirstNameForThisVerySpecificPerson',
- 'lastname' => 'OneThingIsSureThisLastNameIsNotGoingToEndVerySoon'
+ 'lastname' => 'OneThingIsSureThisLastNameIsNotGoingToEndVerySoon',
]
);
\phpunit_util::get_data_generator()->enrol_user($student->id, $course->id, 'student');
@@ -154,12 +154,14 @@ public function test_long_names_being_shortened(): void {
self::assertCount(1, $fetchedattempts);
$i = 0;
- foreach ($fetchedattempts as $fetchedid => $fetchedname) {
+ foreach ($fetchedattempts as $fetchedid => $fetcheddata) {
// The attempt is stored in a somewhat obscure way.
$attemptobj = $attempt[2]->get_attempt();
$id = $attemptobj->id;
self::assertEquals($id, $fetchedid);
+ self::assertEquals($student->firstname, $fetcheddata['firstname']);
+ self::assertEquals($student->lastname, $fetcheddata['lastname']);
$firstname = clean_filename(str_replace(' ', '_', substr($student->firstname, 0, 40)));
$lastname = clean_filename(str_replace(' ', '_', substr($student->lastname, 0, 40)));
@@ -169,9 +171,14 @@ public function test_long_names_being_shortened(): void {
// We will not compare the minutes and seconds, because there might be a small difference and
// we don't really care. If the timestamp is correct up to the hours, we can safely assume the
// conversion worked.
- self::assertStringStartsWith(substr($name, 0, -4), $fetchedname);
+ self::assertStringStartsWith(substr($name, 0, -4), $fetcheddata['path']);
$i++;
}
+
+ // Fetch details for first attempt and test whether the prefix ist Q_1 instead of Question_1.
+ $details = $report->get_details_for_attempt(array_keys($fetchedattempts)[0]);
+ self::assertCount(1, $details);
+ self::assertStringStartsWith('Q_1_-_', array_keys($details)[0]);
}
public function test_custom_name_order(): void {
@@ -211,12 +218,14 @@ public function test_custom_name_order(): void {
self::assertCount(1, $fetchedattempts);
$i = 0;
- foreach ($fetchedattempts as $fetchedid => $fetchedname) {
+ foreach ($fetchedattempts as $fetchedid => $fetcheddata) {
// The attempt is stored in a somewhat obscure way.
$attemptobj = $attempt[2]->get_attempt();
$id = $attemptobj->id;
self::assertEquals($id, $fetchedid);
+ self::assertEquals($student->firstname, $fetcheddata['firstname']);
+ self::assertEquals($student->lastname, $fetcheddata['lastname']);
$firstname = clean_filename(str_replace(' ', '_', $student->firstname));
$lastname = clean_filename(str_replace(' ', '_', $student->lastname));
@@ -226,7 +235,7 @@ public function test_custom_name_order(): void {
// We will not compare the minutes and seconds, because there might be a small difference and
// we don't really care. If the timestamp is correct up to the hours, we can safely assume the
// conversion worked.
- self::assertStringStartsWith(substr($name, 0, -4), $fetchedname);
+ self::assertStringStartsWith(substr($name, 0, -4), $fetcheddata['path']);
$i++;
}
}
@@ -259,12 +268,14 @@ public function test_get_attempts_and_names_without_groups(): void {
self::assertCount(count($students), $fetchedattempts);
$i = 0;
- foreach ($fetchedattempts as $fetchedid => $fetchedname) {
+ foreach ($fetchedattempts as $fetchedid => $fetcheddata) {
// The attempt is stored in a somewhat obscure way.
$attemptobj = $attempts[$i][2]->get_attempt();
$id = $attemptobj->id;
self::assertEquals($id, $fetchedid);
+ self::assertEquals($students[$i]->firstname, $fetcheddata['firstname']);
+ self::assertEquals($students[$i]->lastname, $fetcheddata['lastname']);
$firstname = clean_filename(str_replace(' ', '_', $students[$i]->firstname));
$lastname = clean_filename(str_replace(' ', '_', $students[$i]->lastname));
@@ -274,7 +285,7 @@ public function test_get_attempts_and_names_without_groups(): void {
// We will not compare the minutes and seconds, because there might be a small difference and
// we don't really care. If the timestamp is correct up to the hours, we can safely assume the
// conversion worked.
- self::assertStringStartsWith(substr($name, 0, -4), $fetchedname);
+ self::assertStringStartsWith(substr($name, 0, -4), $fetcheddata['path']);
$i++;
}
}
@@ -327,6 +338,8 @@ public function test_get_attempts_and_names_with_separated_groups(): void {
self::assertEquals($id, array_keys($fetchedattempts)[0]);
// Comparing to the second student.
+ self::assertEquals($students[1]->firstname, $fetchedattempts[$id]['firstname']);
+ self::assertEquals($students[1]->lastname, $fetchedattempts[$id]['lastname']);
$firstname = clean_filename(str_replace(' ', '_', $students[1]->firstname));
$lastname = clean_filename(str_replace(' ', '_', $students[1]->lastname));
$name = $lastname . '_' . $firstname . '_' . $id . '_' . date('Ymd_His', $attemptobj->timefinish);
@@ -334,7 +347,7 @@ public function test_get_attempts_and_names_with_separated_groups(): void {
// We will not compare the minutes and seconds, because there might be a small difference and
// we don't really care. If the timestamp is correct up to the hours, we can safely assume the
// conversion worked.
- self::assertStringStartsWith(substr($name, 0, -4), reset($fetchedattempts));
+ self::assertStringStartsWith(substr($name, 0, -4), $fetchedattempts[$id]['path']);
// Now, add one more student to group 1 and refetch. We'll just check the count.
$generator->create_group_member(['groupid' => $group1->id, 'userid' => $students[0]->id]);
@@ -396,7 +409,7 @@ public function test_get_details_for_attempt_with_single_essay_question(): void
$quiz = $this->create_test_quiz($course);
quiz_essaydownload_test_helper::add_essay_question($questiongenerator, $quiz, [
'name' => 'My Question Title / Test',
- 'questiontext' => ['text' => '
Go write your stuff!
', 'format' => FORMAT_HTML],
+ 'questiontext' => ['text' => 'Go write your stuff!', 'format' => FORMAT_PLAIN],
]);
// Add a student and start an attempt.
@@ -406,7 +419,7 @@ public function test_get_details_for_attempt_with_single_essay_question(): void
// Submit a response and finish the attempt.
$timenow = time();
- $tosubmit = [1 => ['answer' => '
Here we go.
', 'answerformat' => FORMAT_HTML]];
+ $tosubmit = [1 => ['answer' => 'Here we go.', 'answerformat' => FORMAT_PLAIN]];
$attemptobj->process_submitted_actions($timenow, false, $tosubmit);
$attemptobj->process_finish($timenow, false);
@@ -453,7 +466,7 @@ public function test_get_details_for_attempt_with_two_essay_questions(): void {
foreach ($questionsandanswers as $data) {
quiz_essaydownload_test_helper::add_essay_question($questiongenerator, $quiz, [
'name' => $data['name'],
- 'questiontext' => ['text' => "{$data['text']}", 'format' => FORMAT_HTML],
+ 'questiontext' => ['text' => $data['text'], 'format' => FORMAT_PLAIN],
]);
}
@@ -465,8 +478,8 @@ public function test_get_details_for_attempt_with_two_essay_questions(): void {
// Submit a response and finish the attempt.
$timenow = time();
$tosubmit = [
- 1 => ['answer' => "
{$questionsandanswers[1]['response']}
", 'answerformat' => FORMAT_HTML],
- 2 => ['answer' => "
{$questionsandanswers[2]['response']}
", 'answerformat' => FORMAT_HTML],
+ 1 => ['answer' => $questionsandanswers[1]['response'], 'answerformat' => FORMAT_PLAIN],
+ 2 => ['answer' => $questionsandanswers[2]['response'], 'answerformat' => FORMAT_PLAIN],
];
$attemptobj->process_submitted_actions($timenow, false, $tosubmit);
$attemptobj->process_finish($timenow, false);
@@ -511,7 +524,7 @@ public function test_get_details_for_attempt_with_one_essay_and_two_other_questi
$this->add_two_regular_questions($questiongenerator, $quiz);
quiz_essaydownload_test_helper::add_essay_question($questiongenerator, $quiz, [
'name' => 'My Question Title / Test',
- 'questiontext' => ['text' => '
Go write your stuff!
', 'format' => FORMAT_HTML],
+ 'questiontext' => ['text' => 'Go write your stuff!', 'format' => FORMAT_PLAIN],
]);
// Add a student and start an attempt.
@@ -525,7 +538,7 @@ public function test_get_details_for_attempt_with_one_essay_and_two_other_questi
$tosubmit = [
1 => ['answer' => 'frog'],
2 => ['answer' => '3.14'],
- 3 => ['answer' => '
Here we go.
', 'answerformat' => FORMAT_HTML],
+ 3 => ['answer' => 'Here we go.', 'answerformat' => FORMAT_PLAIN],
];
$attemptobj->process_submitted_actions($timenow, false, $tosubmit);
$attemptobj->process_finish($timenow, false);
@@ -619,7 +632,7 @@ public function test_get_details_for_attempt_with_random_essay_question(): void
// resolve to a shortanswer question.
$timenow = time();
$tosubmit = [
- 1 => ['answer' => '
Foo Bar Quak.
', 'answerformat' => FORMAT_HTML],
+ 1 => ['answer' => 'Foo Bar Quak.', 'answerformat' => FORMAT_PLAIN],
];
$attemptobj->process_submitted_actions($timenow, false, $tosubmit);
$attemptobj->process_finish($timenow, false);
@@ -657,7 +670,7 @@ public function test_get_details_for_attempt_with_text_and_attachment(): void {
$quiz = $this->create_test_quiz($course);
quiz_essaydownload_test_helper::add_essay_question($questiongenerator, $quiz, [
'name' => 'My Question Title / Test',
- 'questiontext' => ['text' => '
Go write your stuff!
', 'format' => FORMAT_HTML],
+ 'questiontext' => ['text' => 'Go write your stuff!', 'format' => FORMAT_PLAIN],
'responseformat' => 'editorfilepicker',
'attachments' => 2,
]);
@@ -675,8 +688,8 @@ public function test_get_details_for_attempt_with_text_and_attachment(): void {
quiz_essaydownload_test_helper::save_file_to_draft_area($usercontextid, $attachementsdraftid, 'greeting.txt', 'Foobar');
$timenow = time();
$tosubmit = [1 => [
- 'answer' => '
Foo.
',
- 'answerformat' => FORMAT_HTML,
+ 'answer' => 'Foo.',
+ 'answerformat' => FORMAT_PLAIN,
'answer:itemid' => 1,
'attachments' => $attachementsdraftid,
]];
@@ -694,8 +707,8 @@ public function test_get_details_for_attempt_with_text_and_attachment(): void {
// Submit a response and finish the attempt.
$timenow = time();
$tosubmit = [1 => [
- 'answer' => '
Here we go.
',
- 'answerformat' => FORMAT_HTML,
+ 'answer' => 'Here we go.',
+ 'answerformat' => FORMAT_PLAIN,
'answer:itemid' => 1,
'attachments' => $attachementsdraftid,
]];
@@ -707,6 +720,14 @@ public function test_get_details_for_attempt_with_text_and_attachment(): void {
list($currentgroup, $allstudentjoins, $groupstudentjoins, $allowedjoins) =
$report->init('essaydownload', 'quiz_essaydownload_form', $quiz, $cm, $course);
+ // Use reflection to force text source to plain (i. e. summary).
+ $reflectedreport = new \ReflectionClass($report);
+ $reflectedoptions = $reflectedreport->getProperty('options');
+ $reflectedoptions->setAccessible(true);
+ $options = new quiz_essaydownload_options('essaydownload', $quiz, $cm, $course);
+ $options->source = 'plain';
+ $reflectedoptions->setValue($report, $options);
+
// Fetch the attemp using the report's API.
$fetchedattempts = $report->get_attempts_and_names($groupstudentjoins);
self::assertCount(1, $fetchedattempts);
@@ -746,7 +767,7 @@ public function test_get_details_for_attempt_with_unanswered_question(): void {
$quiz = $this->create_test_quiz($course);
quiz_essaydownload_test_helper::add_essay_question($questiongenerator, $quiz, [
'name' => 'My Question Title / Test',
- 'questiontext' => ['text' => '
Go write your stuff!
', 'format' => FORMAT_HTML],
+ 'questiontext' => ['text' => 'Go write your stuff!', 'format' => FORMAT_PLAIN],
]);
// Add a student and start an attempt.
@@ -756,7 +777,7 @@ public function test_get_details_for_attempt_with_unanswered_question(): void {
// Finish the attempt without submitting an answer.
$timenow = time();
- $tosubmit = [1 => ['answer' => '', 'answerformat' => FORMAT_HTML]];
+ $tosubmit = [1 => ['answer' => '', 'answerformat' => FORMAT_PLAIN]];
$attemptobj->process_submitted_actions($timenow, false, $tosubmit);
$attemptobj->process_finish($timenow, false);
@@ -786,4 +807,214 @@ public function test_get_details_for_attempt_with_unanswered_question(): void {
self::assertEmpty($detail['attachments']);
}
}
+
+ public function test_pdf_from_summary_when_input_is_html(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ // Create a course and a quiz with an essay question.
+ $generator = $this->getDataGenerator();
+ $questiongenerator = $this->getDataGenerator()->get_plugin_generator('core_question');
+ $course = $generator->create_course();
+ $quiz = $this->create_test_quiz($course);
+ quiz_essaydownload_test_helper::add_essay_question($questiongenerator, $quiz, [
+ 'name' => 'My Question Title / Test',
+ 'questiontext' => ['text' => '
Go write your stuff!
', 'format' => FORMAT_HTML],
+ ]);
+
+ // Add a student and start an attempt.
+ $student = $generator->create_user();
+ $generator->enrol_user($student->id, $course->id, 'student');
+ list($quizobj, $quba, $attemptobj) = quiz_essaydownload_test_helper::start_attempt_at_quiz($quiz, $student);
+
+ // Submit a response and finish the attempt.
+ $timenow = time();
+ $tosubmit = [1 => ['answer' => '
Here we go.
', 'answerformat' => FORMAT_HTML]];
+ $attemptobj->process_submitted_actions($timenow, false, $tosubmit);
+ $attemptobj->process_finish($timenow, false);
+
+ $cm = get_coursemodule_from_id('quiz', $quiz->cmid);
+ $report = new quiz_essaydownload_report();
+ list($currentgroup, $allstudentjoins, $groupstudentjoins, $allowedjoins) =
+ $report->init('essaydownload', 'quiz_essaydownload_form', $quiz, $cm, $course);
+
+ // Use reflection to force options.
+ $reflectedreport = new \ReflectionClass($report);
+ $reflectedoptions = $reflectedreport->getProperty('options');
+ $reflectedoptions->setAccessible(true);
+ $options = new quiz_essaydownload_options('essaydownload', $quiz, $cm, $course);
+ $options->source = 'plain';
+ $reflectedoptions->setValue($report, $options);
+
+ // Fetch the attemp using the report's API.
+ $fetchedattempts = $report->get_attempts_and_names($groupstudentjoins);
+ self::assertCount(1, $fetchedattempts);
+
+ // Fetch the details.
+ $details = $report->get_details_for_attempt(array_keys($fetchedattempts)[0]);
+
+ // We expect the result to be an array with one element. The data should match the
+ // second response.
+ self::assertCount(1, $details);
+ foreach ($details as $label => $detail) {
+ self::assertEquals('Question_1_-_My_Question_Title__Test', $label);
+ self::assertEquals('Go write YOUR stuff!', trim($detail['questiontext']));
+ self::assertStringStartsWith('Here WE go.', $detail['responsetext']);
+ self::assertCount(0, $detail['attachments']);
+ }
+ }
+
+ public function test_pdf_from_html_when_input_is_html(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ // Create a course and a quiz with an essay question.
+ $generator = $this->getDataGenerator();
+ $questiongenerator = $this->getDataGenerator()->get_plugin_generator('core_question');
+ $course = $generator->create_course();
+ $quiz = $this->create_test_quiz($course);
+ quiz_essaydownload_test_helper::add_essay_question($questiongenerator, $quiz, [
+ 'name' => 'My Question Title / Test',
+ 'questiontext' => ['text' => '
Go write your stuff!
', 'format' => FORMAT_HTML],
+ ]);
+
+ // Add a student and start an attempt.
+ $student = $generator->create_user();
+ $generator->enrol_user($student->id, $course->id, 'student');
+ list($quizobj, $quba, $attemptobj) = quiz_essaydownload_test_helper::start_attempt_at_quiz($quiz, $student);
+
+ // Submit a response and finish the attempt.
+ $timenow = time();
+ $tosubmit = [1 => ['answer' => '
Here we go.
', 'answerformat' => FORMAT_HTML]];
+ $attemptobj->process_submitted_actions($timenow, false, $tosubmit);
+ $attemptobj->process_finish($timenow, false);
+
+ $cm = get_coursemodule_from_id('quiz', $quiz->cmid);
+ $report = new quiz_essaydownload_report();
+ list($currentgroup, $allstudentjoins, $groupstudentjoins, $allowedjoins) =
+ $report->init('essaydownload', 'quiz_essaydownload_form', $quiz, $cm, $course);
+
+ // Fetch the attemp using the report's API.
+ $fetchedattempts = $report->get_attempts_and_names($groupstudentjoins);
+ self::assertCount(1, $fetchedattempts);
+
+ // Fetch the details.
+ $details = $report->get_details_for_attempt(array_keys($fetchedattempts)[0]);
+
+ // We expect the result to be an array with one element. The data should match the
+ // second response.
+ self::assertCount(1, $details);
+ foreach ($details as $label => $detail) {
+ self::assertEquals('Question_1_-_My_Question_Title__Test', $label);
+ self::assertEquals('
Go write your stuff!
', trim($detail['questiontext']));
+ self::assertStringStartsWith('
Here we go.
', $detail['responsetext']);
+ self::assertCount(0, $detail['attachments']);
+ }
+ }
+
+ public function test_pdf_from_html_when_input_is_plaintext_with_newlines(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ // Create a course and a quiz with an essay question.
+ $generator = $this->getDataGenerator();
+ $questiongenerator = $this->getDataGenerator()->get_plugin_generator('core_question');
+ $course = $generator->create_course();
+ $quiz = $this->create_test_quiz($course);
+ quiz_essaydownload_test_helper::add_essay_question($questiongenerator, $quiz, [
+ 'name' => 'My Question Title / Test',
+ 'questiontext' => ['text' => '
Go write your stuff!
', 'format' => FORMAT_HTML],
+ ]);
+
+ // Add a student and start an attempt.
+ $student = $generator->create_user();
+ $generator->enrol_user($student->id, $course->id, 'student');
+ list($quizobj, $quba, $attemptobj) = quiz_essaydownload_test_helper::start_attempt_at_quiz($quiz, $student);
+
+ // Submit a response and finish the attempt.
+ $timenow = time();
+ $tosubmit = [1 => ['answer' => "Here\nwe\ngo.", 'answerformat' => FORMAT_PLAIN]];
+ $attemptobj->process_submitted_actions($timenow, false, $tosubmit);
+ $attemptobj->process_finish($timenow, false);
+
+ $cm = get_coursemodule_from_id('quiz', $quiz->cmid);
+ $report = new quiz_essaydownload_report();
+ list($currentgroup, $allstudentjoins, $groupstudentjoins, $allowedjoins) =
+ $report->init('essaydownload', 'quiz_essaydownload_form', $quiz, $cm, $course);
+
+ // Fetch the attemp using the report's API.
+ $fetchedattempts = $report->get_attempts_and_names($groupstudentjoins);
+ self::assertCount(1, $fetchedattempts);
+
+ // Fetch the details.
+ $details = $report->get_details_for_attempt(array_keys($fetchedattempts)[0]);
+
+ // We expect the result to be an array with one element. The data should match the
+ // second response.
+ self::assertCount(1, $details);
+ foreach ($details as $label => $detail) {
+ self::assertEquals('Question_1_-_My_Question_Title__Test', $label);
+ self::assertEquals('
Go write your stuff!
', trim($detail['questiontext']));
+ self::assertStringStartsWith("Here
\nwe
\ngo.", $detail['responsetext']);
+ self::assertCount(0, $detail['attachments']);
+ }
+ }
+
+ public function test_txt_when_input_is_html(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+
+ // Create a course and a quiz with an essay question.
+ $generator = $this->getDataGenerator();
+ $questiongenerator = $this->getDataGenerator()->get_plugin_generator('core_question');
+ $course = $generator->create_course();
+ $quiz = $this->create_test_quiz($course);
+ quiz_essaydownload_test_helper::add_essay_question($questiongenerator, $quiz, [
+ 'name' => 'My Question Title / Test',
+ 'questiontext' => ['text' => '
Go write your stuff!
', 'format' => FORMAT_HTML],
+ ]);
+
+ // Add a student and start an attempt.
+ $student = $generator->create_user();
+ $generator->enrol_user($student->id, $course->id, 'student');
+ list($quizobj, $quba, $attemptobj) = quiz_essaydownload_test_helper::start_attempt_at_quiz($quiz, $student);
+
+ // Submit a response and finish the attempt.
+ $timenow = time();
+ $tosubmit = [1 => ['answer' => '
Here we go.
', 'answerformat' => FORMAT_HTML]];
+ $attemptobj->process_submitted_actions($timenow, false, $tosubmit);
+ $attemptobj->process_finish($timenow, false);
+
+ $cm = get_coursemodule_from_id('quiz', $quiz->cmid);
+ $report = new quiz_essaydownload_report();
+ list($currentgroup, $allstudentjoins, $groupstudentjoins, $allowedjoins) =
+ $report->init('essaydownload', 'quiz_essaydownload_form', $quiz, $cm, $course);
+
+ // Use reflection to force options.
+ $reflectedreport = new \ReflectionClass($report);
+ $reflectedoptions = $reflectedreport->getProperty('options');
+ $reflectedoptions->setAccessible(true);
+ $options = new quiz_essaydownload_options('essaydownload', $quiz, $cm, $course);
+ $options->fileformat = 'txt';
+ $options->source = 'plain';
+ $reflectedoptions->setValue($report, $options);
+
+ // Fetch the attemp using the report's API.
+ $fetchedattempts = $report->get_attempts_and_names($groupstudentjoins);
+ self::assertCount(1, $fetchedattempts);
+
+ // Fetch the details.
+ $details = $report->get_details_for_attempt(array_keys($fetchedattempts)[0]);
+
+ // We expect the result to be an array with one element. The data should match the
+ // second response.
+ self::assertCount(1, $details);
+ foreach ($details as $label => $detail) {
+ self::assertEquals('Question_1_-_My_Question_Title__Test', $label);
+ self::assertEquals('Go write YOUR stuff!', trim($detail['questiontext']));
+ self::assertStringStartsWith('Here WE go.', $detail['responsetext']);
+ self::assertCount(0, $detail['attachments']);
+ }
+ }
+
}