MDL-52879 quiz editing: allow removal of the last question in a quiz
[moodle.git] / mod / quiz / classes / output / edit_renderer.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Renderer outputting the quiz editing UI.
19  *
20  * @package mod_quiz
21  * @copyright 2013 The Open University.
22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace mod_quiz\output;
26 defined('MOODLE_INTERNAL') || die();
28 use \mod_quiz\structure;
29 use \html_writer;
31 /**
32  * Renderer outputting the quiz editing UI.
33  *
34  * @copyright 2013 The Open University.
35  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  * @since Moodle 2.7
37  */
38 class edit_renderer extends \plugin_renderer_base {
40     /**
41      * Render the edit page
42      *
43      * @param \quiz $quizobj object containing all the quiz settings information.
44      * @param structure $structure object containing the structure of the quiz.
45      * @param \question_edit_contexts $contexts the relevant question bank contexts.
46      * @param \moodle_url $pageurl the canonical URL of this page.
47      * @param array $pagevars the variables from {@link question_edit_setup()}.
48      * @return string HTML to output.
49      */
50     public function edit_page(\quiz $quizobj, structure $structure,
51             \question_edit_contexts $contexts, \moodle_url $pageurl, array $pagevars) {
52         $output = '';
54         // Page title.
55         $output .= $this->heading_with_help(get_string('editingquizx', 'quiz',
56                 format_string($quizobj->get_quiz_name())), 'editingquiz', 'quiz', '',
57                 get_string('basicideasofquiz', 'quiz'), 2);
59         // Information at the top.
60         $output .= $this->quiz_state_warnings($structure);
61         $output .= $this->quiz_information($structure);
62         $output .= $this->maximum_grade_input($structure, $pageurl);
63         $output .= $this->repaginate_button($structure, $pageurl);
64         $output .= $this->total_marks($quizobj->get_quiz());
66         // Show the questions organised into sections and pages.
67         $output .= $this->start_section_list($structure);
69         foreach ($structure->get_sections() as $section) {
70             $output .= $this->start_section($structure, $section);
71             $output .= $this->questions_in_section($structure, $section, $contexts, $pagevars, $pageurl);
73             if ($structure->is_last_section($section)) {
74                 $output .= \html_writer::start_div('last-add-menu');
75                 $output .= html_writer::tag('span', $this->add_menu_actions($structure, 0,
76                         $pageurl, $contexts, $pagevars), array('class' => 'add-menu-outer'));
77                 $output .= \html_writer::end_div();
78             }
80             $output .= $this->end_section();
81         }
83         $output .= $this->end_section_list();
85         // Initialise the JavaScript.
86         $this->initialise_editing_javascript($structure, $contexts, $pagevars, $pageurl);
88         // Include the contents of any other popups required.
89         if ($structure->can_be_edited()) {
90             $popups = '';
92             $popups .= $this->question_bank_loading();
93             $this->page->requires->yui_module('moodle-mod_quiz-quizquestionbank',
94                     'M.mod_quiz.quizquestionbank.init',
95                     array('class' => 'questionbank', 'cmid' => $structure->get_cmid()));
97             $popups .= $this->random_question_form($pageurl, $contexts, $pagevars);
98             $this->page->requires->yui_module('moodle-mod_quiz-randomquestion',
99                     'M.mod_quiz.randomquestion.init');
101             $output .= html_writer::div($popups, 'mod_quiz_edit_forms');
103             // Include the question chooser.
104             $output .= $this->question_chooser();
105             $this->page->requires->yui_module('moodle-mod_quiz-questionchooser', 'M.mod_quiz.init_questionchooser');
106         }
108         return $output;
109     }
111     /**
112      * Render any warnings that might be required about the state of the quiz,
113      * e.g. if it has been attempted, or if the shuffle questions option is
114      * turned on.
115      *
116      * @param structure $structure the quiz structure.
117      * @return string HTML to output.
118      */
119     public function quiz_state_warnings(structure $structure) {
120         $warnings = $structure->get_edit_page_warnings();
122         if (empty($warnings)) {
123             return '';
124         }
126         $output = array();
127         foreach ($warnings as $warning) {
128             $output[] = \html_writer::tag('p', $warning);
129         }
130         return $this->box(implode("\n", $output), 'statusdisplay');
131     }
133     /**
134      * Render the status bar.
135      *
136      * @param structure $structure the quiz structure.
137      * @return string HTML to output.
138      */
139     public function quiz_information(structure $structure) {
140         list($currentstatus, $explanation) = $structure->get_dates_summary();
142         $output = html_writer::span(
143                     get_string('numquestionsx', 'quiz', $structure->get_question_count()),
144                     'numberofquestions') . ' | ' .
145                 html_writer::span($currentstatus, 'quizopeningstatus',
146                     array('title' => $explanation));
148         return html_writer::div($output, 'statusbar');
149     }
151     /**
152      * Render the form for setting a quiz' overall grade
153      *
154      * @param structure $structure the quiz structure.
155      * @param \moodle_url $pageurl the canonical URL of this page.
156      * @return string HTML to output.
157      */
158     public function maximum_grade_input($structure, \moodle_url $pageurl) {
159         $output = '';
160         $output .= html_writer::start_div('maxgrade');
161         $output .= html_writer::start_tag('form', array('method' => 'post', 'action' => 'edit.php',
162                 'class' => 'quizsavegradesform'));
163         $output .= html_writer::start_tag('fieldset', array('class' => 'invisiblefieldset'));
164         $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'sesskey', 'value' => sesskey()));
165         $output .= html_writer::input_hidden_params($pageurl);
166         $a = html_writer::empty_tag('input', array('type' => 'text', 'id' => 'inputmaxgrade',
167                 'name' => 'maxgrade', 'size' => ($structure->get_decimal_places_for_grades() + 2),
168                 'value' => $structure->formatted_quiz_grade()));
169         $output .= html_writer::tag('label', get_string('maximumgradex', '', $a),
170                 array('for' => 'inputmaxgrade'));
171         $output .= html_writer::empty_tag('input', array('type' => 'submit',
172                 'name' => 'savechanges', 'value' => get_string('save', 'quiz')));
173         $output .= html_writer::end_tag('fieldset');
174         $output .= html_writer::end_tag('form');
175         $output .= html_writer::end_tag('div');
176         return $output;
177     }
179     /**
180      * Return the repaginate button
181      * @param structure $structure the structure of the quiz being edited.
182      * @param \moodle_url $pageurl the canonical URL of this page.
183      * @return string HTML to output.
184      */
185     protected function repaginate_button(structure $structure, \moodle_url $pageurl) {
187         $header = html_writer::tag('span', get_string('repaginatecommand', 'quiz'), array('class' => 'repaginatecommand'));
188         $form = $this->repaginate_form($structure, $pageurl);
189         $containeroptions = array(
190                 'class'  => 'rpcontainerclass',
191                 'cmid'   => $structure->get_cmid(),
192                 'header' => $header,
193                 'form'   => $form,
194         );
196         $buttonoptions = array(
197             'type'  => 'submit',
198             'name'  => 'repaginate',
199             'id'    => 'repaginatecommand',
200             'value' => get_string('repaginatecommand', 'quiz'),
201         );
202         if (!$structure->can_be_repaginated()) {
203             $buttonoptions['disabled'] = 'disabled';
204         } else {
205             $this->page->requires->yui_module('moodle-mod_quiz-repaginate', 'M.mod_quiz.repaginate.init');
206         }
208         return html_writer::tag('div',
209                 html_writer::empty_tag('input', $buttonoptions), $containeroptions);
210     }
212     /**
213      * Return the repaginate form
214      * @param structure $structure the structure of the quiz being edited.
215      * @param \moodle_url $pageurl the canonical URL of this page.
216      * @return string HTML to output.
217      */
218     protected function repaginate_form(structure $structure, \moodle_url $pageurl) {
219         $perpage = array();
220         $perpage[0] = get_string('allinone', 'quiz');
221         for ($i = 1; $i <= 50; ++$i) {
222             $perpage[$i] = $i;
223         }
225         $hiddenurl = clone($pageurl);
226         $hiddenurl->param('sesskey', sesskey());
228         $select = html_writer::select($perpage, 'questionsperpage',
229                 $structure->get_questions_per_page(), false);
231         $buttonattributes = array('type' => 'submit', 'name' => 'repaginate', 'value' => get_string('go'));
233         $formcontent = html_writer::tag('form', html_writer::div(
234                     html_writer::input_hidden_params($hiddenurl) .
235                     get_string('repaginate', 'quiz', $select) .
236                     html_writer::empty_tag('input', $buttonattributes)
237                 ), array('action' => 'edit.php', 'method' => 'post'));
239         return html_writer::div($formcontent, '', array('id' => 'repaginatedialog'));
240     }
242     /**
243      * Render the total marks available for the quiz.
244      *
245      * @param \stdClass $quiz the quiz settings from the database.
246      * @return string HTML to output.
247      */
248     public function total_marks($quiz) {
249         $totalmark = html_writer::span(quiz_format_grade($quiz, $quiz->sumgrades), 'mod_quiz_summarks');
250         return html_writer::tag('span',
251                 get_string('totalmarksx', 'quiz', $totalmark),
252                 array('class' => 'totalpoints'));
253     }
255     /**
256      * Generate the starting container html for the start of a list of sections
257      * @param structure $structure the structure of the quiz being edited.
258      * @return string HTML to output.
259      */
260     protected function start_section_list(structure $structure) {
261         $class = 'slots';
262         if ($structure->get_section_count() == 1) {
263             $class .= ' only-one-section';
264         }
265         return html_writer::start_tag('ul', array('class' => $class));
266     }
268     /**
269      * Generate the closing container html for the end of a list of sections
270      * @return string HTML to output.
271      */
272     protected function end_section_list() {
273         return html_writer::end_tag('ul');
274     }
276     /**
277      * Display the start of a section, before the questions.
278      *
279      * @param structure $structure the structure of the quiz being edited.
280      * @param \stdClass $section The quiz_section entry from DB
281      * @return string HTML to output.
282      */
283     protected function start_section($structure, $section) {
285         $output = '';
287         $sectionstyle = '';
288         if ($structure->is_only_one_slot_in_section($section)) {
289             $sectionstyle = ' only-has-one-slot';
290         }
292         $output .= html_writer::start_tag('li', array('id' => 'section-'.$section->id,
293             'class' => 'section main clearfix'.$sectionstyle, 'role' => 'region',
294             'aria-label' => $section->heading));
296         $output .= html_writer::start_div('content');
298         $output .= html_writer::start_div('section-heading');
300         $headingtext = $this->heading(html_writer::span(
301                 html_writer::span($section->heading, 'instancesection'), 'sectioninstance'), 3);
303         if (!$structure->can_be_edited()) {
304             $editsectionheadingicon = '';
305         } else {
306             $editsectionheadingicon = html_writer::link(new \moodle_url('#'),
307                 $this->pix_icon('t/editstring', get_string('sectionheadingedit', 'quiz', $section->heading),
308                         'moodle', array('class' => 'editicon visibleifjs')),
309                         array('class' => 'editing_section', 'data-action' => 'edit_section_title'));
310         }
311         $output .= html_writer::div($headingtext . $editsectionheadingicon, 'instancesectioncontainer');
313         if (!$structure->is_first_section($section) && $structure->can_be_edited()) {
314             $output .= $this->section_remove_icon($section);
315         }
316         $output .= $this->section_shuffle_questions($structure, $section);
318         $output .= html_writer::end_div($output, 'section-heading');
320         return $output;
321     }
323     /**
324      * Display a checkbox for shuffling question within a section.
325      *
326      * @param structure $structure object containing the structure of the quiz.
327      * @param \stdClass $section data from the quiz_section table.
328      * @return string HTML to output.
329      */
330     public function section_shuffle_questions(structure $structure, $section) {
331         $checkboxattributes = array(
332             'type' => 'checkbox',
333             'id' => 'shuffle-' . $section->id,
334             'value' => 1,
335             'data-action' => 'shuffle_questions',
336             'class' => 'cm-edit-action',
337         );
339         if (!$structure->can_be_edited()) {
340             $checkboxattributes['disabled'] = 'disabled';
341         }
342         if ($section->shufflequestions) {
343             $checkboxattributes['checked'] = 'checked';
344         }
346         if ($structure->is_first_section($section)) {
347             $help = $this->help_icon('shufflequestions', 'quiz');
348         } else {
349             $help = '';
350         }
352         $progressspan = html_writer::span('', 'shuffle-progress');
353         $checkbox = html_writer::empty_tag('input', $checkboxattributes);
354         $label = html_writer::label(get_string('shufflequestions', 'quiz') . ' ' . $help,
355                 $checkboxattributes['id'], false);
356         return html_writer::span($progressspan . $checkbox . $label,
357                 'instanceshufflequestions', array('data-action' => 'shuffle_questions'));
358     }
360     /**
361      * Display the end of a section, after the questions.
362      *
363      * @return string HTML to output.
364      */
365     protected function end_section() {
366         $output = html_writer::end_tag('div');
367         $output .= html_writer::end_tag('li');
369         return $output;
370     }
372     /**
373      * Render an icon to remove a section from the quiz.
374      *
375      * @param object $section the section to be removed.
376      * @return string HTML to output.
377      */
378     public function section_remove_icon($section) {
379         $title = get_string('sectionheadingremove', 'quiz', $section->heading);
380         $url = new \moodle_url('/mod/quiz/edit.php',
381                 array('sesskey' => sesskey(), 'removesection' => '1', 'sectionid' => $section->id));
382         $image = $this->pix_icon('t/delete', $title);
383         return $this->action_link($url, $image, null, array(
384                 'class' => 'cm-edit-action editing_delete', 'data-action' => 'deletesection'));
385     }
387     /**
388      * Renders HTML to display the questions in a section of the quiz.
389      *
390      * This function calls {@link core_course_renderer::quiz_section_question()}
391      *
392      * @param structure $structure object containing the structure of the quiz.
393      * @param \stdClass $section information about the section.
394      * @param \question_edit_contexts $contexts the relevant question bank contexts.
395      * @param array $pagevars the variables from {@link \question_edit_setup()}.
396      * @param \moodle_url $pageurl the canonical URL of this page.
397      * @return string HTML to output.
398      */
399     public function questions_in_section(structure $structure, $section,
400             $contexts, $pagevars, $pageurl) {
402         $output = '';
403         foreach ($structure->get_slots_in_section($section->id) as $slot) {
404             $output .= $this->question_row($structure, $slot, $contexts, $pagevars, $pageurl);
405         }
406         return html_writer::tag('ul', $output, array('class' => 'section img-text'));
407     }
409     /**
410      * Displays one question with the surrounding controls.
411      *
412      * @param structure $structure object containing the structure of the quiz.
413      * @param int $slot which slot we are outputting.
414      * @param \question_edit_contexts $contexts the relevant question bank contexts.
415      * @param array $pagevars the variables from {@link \question_edit_setup()}.
416      * @param \moodle_url $pageurl the canonical URL of this page.
417      * @return string HTML to output.
418      */
419     public function question_row(structure $structure, $slot, $contexts, $pagevars, $pageurl) {
420         $output = '';
422         $output .= $this->page_row($structure, $slot, $contexts, $pagevars, $pageurl);
424         // Page split/join icon.
425         $joinhtml = '';
426         if ($structure->can_be_edited() && !$structure->is_last_slot_in_quiz($slot) &&
427                                             !$structure->is_last_slot_in_section($slot)) {
428             $joinhtml = $this->page_split_join_button($structure, $slot);
429         }
430         // Question HTML.
431         $questionhtml = $this->question($structure, $slot, $pageurl);
432         $qtype = $structure->get_question_type_for_slot($slot);
433         $questionclasses = 'activity ' . $qtype . ' qtype_' . $qtype . ' slot';
435         $output .= html_writer::tag('li', $questionhtml . $joinhtml,
436                 array('class' => $questionclasses, 'id' => 'slot-' . $structure->get_slot_id_for_slot($slot),
437                         'data-canfinish' => $structure->can_finish_during_the_attempt($slot)));
439         return $output;
440     }
442     /**
443      * Displays one question with the surrounding controls.
444      *
445      * @param structure $structure object containing the structure of the quiz.
446      * @param int $slot the first slot on the page we are outputting.
447      * @param \question_edit_contexts $contexts the relevant question bank contexts.
448      * @param array $pagevars the variables from {@link \question_edit_setup()}.
449      * @param \moodle_url $pageurl the canonical URL of this page.
450      * @return string HTML to output.
451      */
452     public function page_row(structure $structure, $slot, $contexts, $pagevars, $pageurl) {
453         $output = '';
455         $pagenumber = $structure->get_page_number_for_slot($slot);
457         // Put page in a heading for accessibility and styling.
458         $page = $this->heading(get_string('page') . ' ' . $pagenumber, 4);
460         if ($structure->is_first_slot_on_page($slot)) {
461             // Add the add-menu at the page level.
462             $addmenu = html_writer::tag('span', $this->add_menu_actions($structure,
463                     $pagenumber, $pageurl, $contexts, $pagevars),
464                     array('class' => 'add-menu-outer'));
466             $addquestionform = $this->add_question_form($structure,
467                     $pagenumber, $pageurl, $pagevars);
469             $output .= html_writer::tag('li', $page . $addmenu . $addquestionform,
470                     array('class' => 'pagenumber activity yui3-dd-drop page', 'id' => 'page-' . $pagenumber));
471         }
473         return $output;
474     }
476     /**
477      * Returns the add menu that is output once per page.
478      * @param structure $structure object containing the structure of the quiz.
479      * @param int $page the page number that this menu will add to.
480      * @param \moodle_url $pageurl the canonical URL of this page.
481      * @param \question_edit_contexts $contexts the relevant question bank contexts.
482      * @param array $pagevars the variables from {@link \question_edit_setup()}.
483      * @return string HTML to output.
484      */
485     public function add_menu_actions(structure $structure, $page, \moodle_url $pageurl,
486             \question_edit_contexts $contexts, array $pagevars) {
488         $actions = $this->edit_menu_actions($structure, $page, $pageurl, $pagevars);
489         if (empty($actions)) {
490             return '';
491         }
492         $menu = new \action_menu();
493         $menu->set_alignment(\action_menu::TR, \action_menu::TR);
494         $menu->set_constraint('.mod-quiz-edit-content');
495         $trigger = html_writer::tag('span', get_string('add', 'quiz'), array('class' => 'add-menu'));
496         $menu->set_menu_trigger($trigger);
497         // The menu appears within an absolutely positioned element causing width problems.
498         // Make sure no-wrap is set so that we don't get a squashed menu.
499         $menu->set_nowrap_on_items(true);
501         // Disable the link if quiz has attempts.
502         if (!$structure->can_be_edited()) {
503             return $this->render($menu);
504         }
506         foreach ($actions as $action) {
507             if ($action instanceof \action_menu_link) {
508                 $action->add_class('add-menu');
509             }
510             $menu->add($action);
511         }
512         $menu->attributes['class'] .= ' page-add-actions commands';
514         // Prioritise the menu ahead of all other actions.
515         $menu->prioritise = true;
517         return $this->render($menu);
518     }
520     /**
521      * Returns the list of actions to go in the add menu.
522      * @param structure $structure object containing the structure of the quiz.
523      * @param int $page the page number that this menu will add to.
524      * @param \moodle_url $pageurl the canonical URL of this page.
525      * @param array $pagevars the variables from {@link \question_edit_setup()}.
526      * @return array the actions.
527      */
528     public function edit_menu_actions(structure $structure, $page,
529             \moodle_url $pageurl, array $pagevars) {
530         $questioncategoryid = question_get_category_id_from_pagevars($pagevars);
531         static $str;
532         if (!isset($str)) {
533             $str = get_strings(array('addasection', 'addaquestion', 'addarandomquestion',
534                     'addarandomselectedquestion', 'questionbank'), 'quiz');
535         }
537         // Get section, page, slotnumber and maxmark.
538         $actions = array();
540         // Add a new section to the add_menu if possible. This is always added to the HTML
541         // then hidden with CSS when no needed, so that as things are re-ordered, etc. with
542         // Ajax it can be relevaled again when necessary.
543         $params = array('cmid' => $structure->get_cmid(), 'addsectionatpage' => $page);
545         $actions['addasection'] = new \action_menu_link_secondary(
546                 new \moodle_url($pageurl, $params),
547                 new \pix_icon('t/add', $str->addasection, 'moodle', array('class' => 'iconsmall', 'title' => '')),
548                 $str->addasection, array('class' => 'cm-edit-action addasection', 'data-action' => 'addasection')
549         );
551         // Add a new question to the quiz.
552         $returnurl = new \moodle_url($pageurl, array('addonpage' => $page));
553         $params = array('returnurl' => $returnurl->out_as_local_url(false),
554                 'cmid' => $structure->get_cmid(), 'category' => $questioncategoryid,
555                 'addonpage' => $page, 'appendqnumstring' => 'addquestion');
557         $actions['addaquestion'] = new \action_menu_link_secondary(
558             new \moodle_url('/question/addquestion.php', $params),
559             new \pix_icon('t/add', $str->addaquestion, 'moodle', array('class' => 'iconsmall', 'title' => '')),
560             $str->addaquestion, array('class' => 'cm-edit-action addquestion', 'data-action' => 'addquestion')
561         );
563         // Call question bank.
564         $icon = new \pix_icon('t/add', $str->questionbank, 'moodle', array('class' => 'iconsmall', 'title' => ''));
565         if ($page) {
566             $title = get_string('addquestionfrombanktopage', 'quiz', $page);
567         } else {
568             $title = get_string('addquestionfrombankatend', 'quiz');
569         }
570         $attributes = array('class' => 'cm-edit-action questionbank',
571                 'data-header' => $title, 'data-action' => 'questionbank', 'data-addonpage' => $page);
572         $actions['questionbank'] = new \action_menu_link_secondary($pageurl, $icon, $str->questionbank, $attributes);
574         // Add a random question.
575         $returnurl = new \moodle_url('/mod/quiz/edit.php', array('cmid' => $structure->get_cmid(), 'data-addonpage' => $page));
576         $params = array('returnurl' => $returnurl, 'cmid' => $structure->get_cmid(), 'appendqnumstring' => 'addarandomquestion');
577         $url = new \moodle_url('/mod/quiz/addrandom.php', $params);
578         $icon = new \pix_icon('t/add', $str->addarandomquestion, 'moodle', array('class' => 'iconsmall', 'title' => ''));
579         $attributes = array('class' => 'cm-edit-action addarandomquestion', 'data-action' => 'addarandomquestion');
580         if ($page) {
581             $title = get_string('addrandomquestiontopage', 'quiz', $page);
582         } else {
583             $title = get_string('addrandomquestionatend', 'quiz');
584         }
585         $attributes = array_merge(array('data-header' => $title, 'data-addonpage' => $page), $attributes);
586         $actions['addarandomquestion'] = new \action_menu_link_secondary($url, $icon, $str->addarandomquestion, $attributes);
588         return $actions;
589     }
591     /**
592      * Render the form that contains the data for adding a new question to the quiz.
593      *
594      * @param structure $structure object containing the structure of the quiz.
595      * @param int $page the page number that this menu will add to.
596      * @param \moodle_url $pageurl the canonical URL of this page.
597      * @param array $pagevars the variables from {@link \question_edit_setup()}.
598      * @return string HTML to output.
599      */
600     protected function add_question_form(structure $structure, $page, \moodle_url $pageurl, array $pagevars) {
602         $questioncategoryid = question_get_category_id_from_pagevars($pagevars);
604         $output = html_writer::tag('input', null,
605                 array('type' => 'hidden', 'name' => 'returnurl',
606                         'value' => $pageurl->out_as_local_url(false, array('addonpage' => $page))));
607         $output .= html_writer::tag('input', null,
608                 array('type' => 'hidden', 'name' => 'cmid', 'value' => $structure->get_cmid()));
609         $output .= html_writer::tag('input', null,
610                 array('type' => 'hidden', 'name' => 'appendqnumstring', 'value' => 'addquestion'));
611         $output .= html_writer::tag('input', null,
612                 array('type' => 'hidden', 'name' => 'category', 'value' => $questioncategoryid));
614         return html_writer::tag('form', html_writer::div($output),
615                 array('class' => 'addnewquestion', 'method' => 'post',
616                         'action' => new \moodle_url('/question/addquestion.php')));
617     }
619     /**
620      * Display a question.
621      *
622      * @param structure $structure object containing the structure of the quiz.
623      * @param int $slot the first slot on the page we are outputting.
624      * @param \moodle_url $pageurl the canonical URL of this page.
625      * @return string HTML to output.
626      */
627     public function question(structure $structure, $slot, \moodle_url $pageurl) {
628         $output = '';
629         $output .= html_writer::start_tag('div');
631         if ($structure->can_be_edited()) {
632             $output .= $this->question_move_icon($structure, $slot);
633         }
635         $output .= html_writer::start_div('mod-indent-outer');
636         $output .= $this->question_number($structure->get_displayed_number_for_slot($slot));
638         // This div is used to indent the content.
639         $output .= html_writer::div('', 'mod-indent');
641         // Display the link to the question (or do nothing if question has no url).
642         if ($structure->get_question_type_for_slot($slot) == 'random') {
643             $questionname = $this->random_question($structure, $slot, $pageurl);
644         } else {
645             $questionname = $this->question_name($structure, $slot, $pageurl);
646         }
648         // Start the div for the activity title, excluding the edit icons.
649         $output .= html_writer::start_div('activityinstance');
650         $output .= $questionname;
652         // Closing the tag which contains everything but edit icons. Content part of the module should not be part of this.
653         $output .= html_writer::end_tag('div'); // .activityinstance.
655         // Action icons.
656         $questionicons = '';
657         $questionicons .= $this->question_preview_icon($structure->get_quiz(), $structure->get_question_in_slot($slot));
658         if ($structure->can_be_edited()) {
659             $questionicons .= $this->question_remove_icon($structure, $slot, $pageurl);
660         }
661         $questionicons .= $this->marked_out_of_field($structure, $slot);
662         $output .= html_writer::span($questionicons, 'actions'); // Required to add js spinner icon.
663         if ($structure->can_be_edited()) {
664             $output .= $this->question_dependency_icon($structure, $slot);
665         }
667         // End of indentation div.
668         $output .= html_writer::end_tag('div');
669         $output .= html_writer::end_tag('div');
671         return $output;
672     }
674     /**
675      * Render the move icon.
676      *
677      * @param structure $structure object containing the structure of the quiz.
678      * @param int $slot the first slot on the page we are outputting.
679      * @return string The markup for the move action.
680      */
681     public function question_move_icon(structure $structure, $slot) {
682         return html_writer::link(new \moodle_url('#'),
683             $this->pix_icon('i/dragdrop', get_string('move'), 'moodle', array('class' => 'iconsmall', 'title' => '')),
684             array('class' => 'editing_move', 'data-action' => 'move')
685         );
686     }
688     /**
689      * Output the question number.
690      * @param string $number The number, or 'i'.
691      * @return string HTML to output.
692      */
693     public function question_number($number) {
694         if (is_numeric($number)) {
695             $number = html_writer::span(get_string('question'), 'accesshide') . ' ' . $number;
696         }
697         return html_writer::tag('span', $number, array('class' => 'slotnumber'));
698     }
700     /**
701      * Render the preview icon.
702      *
703      * @param \stdClass $quiz the quiz settings from the database.
704      * @param \stdClass $question data from the question and quiz_slots tables.
705      * @param bool $label if true, show the preview question label after the icon
706      * @return string HTML to output.
707      */
708     public function question_preview_icon($quiz, $question, $label = null) {
709         $url = quiz_question_preview_url($quiz, $question);
711         // Do we want a label?
712         $strpreviewlabel = '';
713         if ($label) {
714             $strpreviewlabel = ' ' . get_string('preview', 'quiz');
715         }
717         // Build the icon.
718         $strpreviewquestion = get_string('previewquestion', 'quiz');
719         $image = $this->pix_icon('t/preview', $strpreviewquestion);
721         $action = new \popup_action('click', $url, 'questionpreview',
722                                         question_preview_popup_params());
724         return $this->action_link($url, $image . $strpreviewlabel, $action,
725                 array('title' => $strpreviewquestion, 'class' => 'preview'));
726     }
728     /**
729      * Render an icon to remove a question from the quiz.
730      *
731      * @param structure $structure object containing the structure of the quiz.
732      * @param int $slot the first slot on the page we are outputting.
733      * @param \moodle_url $pageurl the canonical URL of the edit page.
734      * @return string HTML to output.
735      */
736     public function question_remove_icon(structure $structure, $slot, $pageurl) {
737         $url = new \moodle_url($pageurl, array('sesskey' => sesskey(), 'remove' => $slot));
738         $strdelete = get_string('delete');
740         $image = $this->pix_icon('t/delete', $strdelete);
742         return $this->action_link($url, $image, null, array('title' => $strdelete,
743                     'class' => 'cm-edit-action editing_delete', 'data-action' => 'delete'));
744     }
746     /**
747      * Display an icon to split or join two pages of the quiz.
748      *
749      * @param structure $structure object containing the structure of the quiz.
750      * @param int $slot the first slot on the page we are outputting.
751      * @return string HTML to output.
752      */
753     public function page_split_join_button($structure, $slot) {
754         $insertpagebreak = !$structure->is_last_slot_on_page($slot);
755         $url = new \moodle_url('repaginate.php', array('quizid' => $structure->get_quizid(),
756                 'slot' => $slot, 'repag' => $insertpagebreak ? 2 : 1, 'sesskey' => sesskey()));
758         if ($insertpagebreak) {
759             $title = get_string('addpagebreak', 'quiz');
760             $image = $this->pix_icon('e/insert_page_break', $title);
761             $action = 'addpagebreak';
762         } else {
763             $title = get_string('removepagebreak', 'quiz');
764             $image = $this->pix_icon('e/remove_page_break', $title);
765             $action = 'removepagebreak';
766         }
768         // Disable the link if quiz has attempts.
769         $disabled = null;
770         if (!$structure->can_be_edited()) {
771             $disabled = 'disabled';
772         }
773         return html_writer::span($this->action_link($url, $image, null, array('title' => $title,
774                     'class' => 'page_split_join cm-edit-action', 'disabled' => $disabled, 'data-action' => $action)),
775                 'page_split_join_wrapper');
776     }
778     /**
779      * Display the icon for whether this question can only be seen if the previous
780      * one has been answered.
781      *
782      * @param structure $structure object containing the structure of the quiz.
783      * @param int $slot the first slot on the page we are outputting.
784      * @return string HTML to output.
785      */
786     public function question_dependency_icon($structure, $slot) {
787         $a = array(
788             'thisq' => $structure->get_displayed_number_for_slot($slot),
789             'previousq' => $structure->get_displayed_number_for_slot(max($slot - 1, 1)),
790         );
791         if ($structure->is_question_dependent_on_previous_slot($slot)) {
792             $title = get_string('questiondependencyremove', 'quiz', $a);
793             $image = $this->pix_icon('t/locked', get_string('questiondependsonprevious', 'quiz'),
794                     'moodle', array('title' => ''));
795             $action = 'removedependency';
796         } else {
797             $title = get_string('questiondependencyadd', 'quiz', $a);
798             $image = $this->pix_icon('t/unlocked', get_string('questiondependencyfree', 'quiz'),
799                     'moodle', array('title' => ''));
800             $action = 'adddependency';
801         }
803         // Disable the link if quiz has attempts.
804         $disabled = null;
805         if (!$structure->can_be_edited()) {
806             $disabled = 'disabled';
807         }
808         $extraclass = '';
809         if (!$structure->can_question_depend_on_previous_slot($slot)) {
810             $extraclass = ' question_dependency_cannot_depend';
811         }
812         return html_writer::span($this->action_link('#', $image, null, array('title' => $title,
813                 'class' => 'cm-edit-action', 'disabled' => $disabled, 'data-action' => $action)),
814                 'question_dependency_wrapper' . $extraclass);
815     }
817     /**
818      * Renders html to display a name with the link to the question on a quiz edit page
819      *
820      * If the user does not have permission to edi the question, it is rendered
821      * without a link
822      *
823      * @param structure $structure object containing the structure of the quiz.
824      * @param int $slot which slot we are outputting.
825      * @param \moodle_url $pageurl the canonical URL of this page.
826      * @return string HTML to output.
827      */
828     public function question_name(structure $structure, $slot, $pageurl) {
829         $output = '';
831         $question = $structure->get_question_in_slot($slot);
832         $editurl = new \moodle_url('/question/question.php', array(
833                 'returnurl' => $pageurl->out_as_local_url(),
834                 'cmid' => $structure->get_cmid(), 'id' => $question->id));
836         $instancename = quiz_question_tostring($question);
838         $qtype = \question_bank::get_qtype($question->qtype, false);
839         $namestr = $qtype->local_name();
841         $icon = $this->pix_icon('icon', $namestr, $qtype->plugin_name(), array('title' => $namestr,
842                 'class' => 'icon activityicon', 'alt' => ' ', 'role' => 'presentation'));
844         $editicon = $this->pix_icon('t/edit', '', 'moodle', array('title' => ''));
846         // Need plain question name without html tags for link title.
847         $title = shorten_text(format_string($question->name), 100);
849         // Display the link itself.
850         $activitylink = $icon . html_writer::tag('span', $editicon . $instancename, array('class' => 'instancename'));
851         $output .= html_writer::link($editurl, $activitylink,
852                 array('title' => get_string('editquestion', 'quiz').' '.$title));
854         return $output;
855     }
857     /**
858      * Renders html to display a random question the link to edit the configuration
859      * and also to see that category in the question bank.
860      *
861      * @param structure $structure object containing the structure of the quiz.
862      * @param int $slot which slot we are outputting.
863      * @param \moodle_url $pageurl the canonical URL of this page.
864      * @return string HTML to output.
865      */
866     public function random_question(structure $structure, $slot, $pageurl) {
868         $question = $structure->get_question_in_slot($slot);
869         $editurl = new \moodle_url('/question/question.php', array(
870                 'returnurl' => $pageurl->out_as_local_url(),
871                 'cmid' => $structure->get_cmid(), 'id' => $question->id));
873         $temp = clone($question);
874         $temp->questiontext = '';
875         $instancename = quiz_question_tostring($temp);
877         $configuretitle = get_string('configurerandomquestion', 'quiz');
878         $qtype = \question_bank::get_qtype($question->qtype, false);
879         $namestr = $qtype->local_name();
880         $icon = $this->pix_icon('icon', $namestr, $qtype->plugin_name(), array('title' => $namestr,
881                 'class' => 'icon activityicon', 'alt' => ' ', 'role' => 'presentation'));
883         $editicon = $this->pix_icon('t/edit', $configuretitle, 'moodle', array('title' => ''));
885         // If this is a random question, display a link to show the questions
886         // selected from in the question bank.
887         $qbankurl = new \moodle_url('/question/edit.php', array(
888                 'cmid' => $structure->get_cmid(),
889                 'cat' => $question->category . ',' . $question->contextid,
890                 'recurse' => !empty($question->questiontext)));
891         $qbanklink = ' ' . \html_writer::link($qbankurl,
892                 get_string('seequestions', 'quiz'), array('class' => 'mod_quiz_random_qbank_link'));
894         return html_writer::link($editurl, $icon . $editicon, array('title' => $configuretitle)) .
895                 ' ' . $instancename . ' ' . $qbanklink;
896     }
898     /**
899      * Display the 'marked out of' information for a question.
900      * Along with the regrade action.
901      * @param structure $structure object containing the structure of the quiz.
902      * @param int $slot which slot we are outputting.
903      * @return string HTML to output.
904      */
905     public function marked_out_of_field(structure $structure, $slot) {
906         if (!$structure->is_real_question($slot)) {
907             $output = html_writer::span('',
908                     'instancemaxmark decimalplaces_' . $structure->get_decimal_places_for_question_marks());
910             $output .= html_writer::span(
911                     $this->pix_icon('spacer', '', 'moodle', array('class' => 'editicon visibleifjs', 'title' => '')),
912                     'editing_maxmark');
913             return html_writer::span($output, 'instancemaxmarkcontainer infoitem');
914         }
916         $output = html_writer::span($structure->formatted_question_grade($slot),
917                 'instancemaxmark decimalplaces_' . $structure->get_decimal_places_for_question_marks(),
918                 array('title' => get_string('maxmark', 'quiz')));
920         $output .= html_writer::span(
921             html_writer::link(
922                 new \moodle_url('#'),
923                 $this->pix_icon('t/editstring', '', 'moodle', array('class' => 'editicon visibleifjs', 'title' => '')),
924                 array(
925                     'class' => 'editing_maxmark',
926                     'data-action' => 'editmaxmark',
927                     'title' => get_string('editmaxmark', 'quiz'),
928                 )
929             )
930         );
931         return html_writer::span($output, 'instancemaxmarkcontainer');
932     }
934     /**
935      * Render the question type chooser dialogue.
936      * @return string HTML to output.
937      */
938     public function question_chooser() {
939         $container = html_writer::div(print_choose_qtype_to_add_form(array(), null, false), '',
940                 array('id' => 'qtypechoicecontainer'));
941         return html_writer::div($container, 'createnewquestion');
942     }
944     /**
945      * Render the contents of the question bank pop-up in its initial state,
946      * when it just contains a loading progress indicator.
947      * @return string HTML to output.
948      */
949     public function question_bank_loading() {
950         return html_writer::div(html_writer::empty_tag('img',
951                 array('alt' => 'loading', 'class' => 'loading-icon', 'src' => $this->pix_url('i/loading'))),
952                 'questionbankloading');
953     }
955     /**
956      * Return random question form.
957      * @param \moodle_url $thispageurl the canonical URL of this page.
958      * @param \question_edit_contexts $contexts the relevant question bank contexts.
959      * @param array $pagevars the variables from {@link \question_edit_setup()}.
960      * @return string HTML to output.
961      */
962     protected function random_question_form(\moodle_url $thispageurl, \question_edit_contexts $contexts, array $pagevars) {
964         if (!$contexts->have_cap('moodle/question:useall')) {
965             return '';
966         }
967         $randomform = new \quiz_add_random_form(new \moodle_url('/mod/quiz/addrandom.php'),
968                                  array('contexts' => $contexts, 'cat' => $pagevars['cat']));
969         $randomform->set_data(array(
970                 'category' => $pagevars['cat'],
971                 'returnurl' => $thispageurl->out_as_local_url(true),
972                 'randomnumber' => 1,
973                 'cmid' => $thispageurl->param('cmid'),
974         ));
975         return html_writer::div($randomform->render(), 'randomquestionformforpopup');
976     }
978     /**
979      * Initialise the JavaScript for the general editing. (JavaScript for popups
980      * is handled with the specific code for those.)
981      *
982      * @param structure $structure object containing the structure of the quiz.
983      * @param \question_edit_contexts $contexts the relevant question bank contexts.
984      * @param array $pagevars the variables from {@link \question_edit_setup()}.
985      * @param \moodle_url $pageurl the canonical URL of this page.
986      * @return bool Always returns true
987      */
988     protected function initialise_editing_javascript(structure $structure,
989             \question_edit_contexts $contexts, array $pagevars, \moodle_url $pageurl) {
991         $config = new \stdClass();
992         $config->resourceurl = '/mod/quiz/edit_rest.php';
993         $config->sectionurl = '/mod/quiz/edit_rest.php';
994         $config->pageparams = array();
995         $config->questiondecimalpoints = $structure->get_decimal_places_for_question_marks();
996         $config->pagehtml = $this->new_page_template($structure, $contexts, $pagevars, $pageurl);
997         $config->addpageiconhtml = $this->add_page_icon_template($structure);
999         $this->page->requires->yui_module('moodle-mod_quiz-toolboxes',
1000                 'M.mod_quiz.init_resource_toolbox',
1001                 array(array(
1002                         'courseid' => $structure->get_courseid(),
1003                         'quizid' => $structure->get_quizid(),
1004                         'ajaxurl' => $config->resourceurl,
1005                         'config' => $config,
1006                 ))
1007         );
1008         unset($config->pagehtml);
1009         unset($config->addpageiconhtml);
1011         $this->page->requires->yui_module('moodle-mod_quiz-toolboxes',
1012                 'M.mod_quiz.init_section_toolbox',
1013                 array(array(
1014                         'courseid' => $structure,
1015                         'quizid' => $structure->get_quizid(),
1016                         'ajaxurl' => $config->sectionurl,
1017                         'config' => $config,
1018                 ))
1019         );
1021         $this->page->requires->yui_module('moodle-mod_quiz-dragdrop', 'M.mod_quiz.init_section_dragdrop',
1022                 array(array(
1023                         'courseid' => $structure,
1024                         'quizid' => $structure->get_quizid(),
1025                         'ajaxurl' => $config->sectionurl,
1026                         'config' => $config,
1027                 )), null, true);
1029         $this->page->requires->yui_module('moodle-mod_quiz-dragdrop', 'M.mod_quiz.init_resource_dragdrop',
1030                 array(array(
1031                         'courseid' => $structure,
1032                         'quizid' => $structure->get_quizid(),
1033                         'ajaxurl' => $config->resourceurl,
1034                         'config' => $config,
1035                 )), null, true);
1037         // Require various strings for the command toolbox.
1038         $this->page->requires->strings_for_js(array(
1039                 'clicktohideshow',
1040                 'deletechecktype',
1041                 'deletechecktypename',
1042                 'edittitle',
1043                 'edittitleinstructions',
1044                 'emptydragdropregion',
1045                 'hide',
1046                 'markedthistopic',
1047                 'markthistopic',
1048                 'move',
1049                 'movecontent',
1050                 'moveleft',
1051                 'movesection',
1052                 'page',
1053                 'question',
1054                 'selectall',
1055                 'show',
1056                 'tocontent',
1057         ), 'moodle');
1059         $this->page->requires->strings_for_js(array(
1060                 'addpagebreak',
1061                 'confirmremovesectionheading',
1062                 'confirmremovequestion',
1063                 'dragtoafter',
1064                 'dragtostart',
1065                 'numquestionsx',
1066                 'sectionheadingedit',
1067                 'sectionheadingremove',
1068                 'removepagebreak',
1069                 'questiondependencyadd',
1070                 'questiondependencyfree',
1071                 'questiondependencyremove',
1072                 'questiondependsonprevious',
1073         ), 'quiz');
1075         foreach (\question_bank::get_all_qtypes() as $qtype => $notused) {
1076             $this->page->requires->string_for_js('pluginname', 'qtype_' . $qtype);
1077         }
1079         return true;
1080     }
1082     /**
1083      * HTML for a page, with ids stripped, so it can be used as a javascript template.
1084      *
1085      * @param structure $structure object containing the structure of the quiz.
1086      * @param \question_edit_contexts $contexts the relevant question bank contexts.
1087      * @param array $pagevars the variables from {@link \question_edit_setup()}.
1088      * @param \moodle_url $pageurl the canonical URL of this page.
1089      * @return string HTML for a new page.
1090      */
1091     protected function new_page_template(structure $structure,
1092             \question_edit_contexts $contexts, array $pagevars, \moodle_url $pageurl) {
1093         if (!$structure->has_questions()) {
1094             return '';
1095         }
1097         $pagehtml = $this->page_row($structure, 1, $contexts, $pagevars, $pageurl);
1099         // Normalise the page number.
1100         $pagenumber = $structure->get_page_number_for_slot(1);
1101         $strcontexts = array();
1102         $strcontexts[] = 'page-';
1103         $strcontexts[] = get_string('page') . ' ';
1104         $strcontexts[] = 'addonpage%3D';
1105         $strcontexts[] = 'addonpage=';
1106         $strcontexts[] = 'addonpage="';
1107         $strcontexts[] = get_string('addquestionfrombanktopage', 'quiz', '');
1108         $strcontexts[] = 'data-addonpage%3D';
1109         $strcontexts[] = 'action-menu-';
1111         foreach ($strcontexts as $strcontext) {
1112             $pagehtml = str_replace($strcontext . $pagenumber, $strcontext . '%%PAGENUMBER%%', $pagehtml);
1113         }
1115         return $pagehtml;
1116     }
1118     /**
1119      * HTML for a page, with ids stripped, so it can be used as a javascript template.
1120      *
1121      * @param structure $structure object containing the structure of the quiz.
1122      * @return string HTML for a new icon
1123      */
1124     protected function add_page_icon_template(structure $structure) {
1126         if (!$structure->has_questions()) {
1127             return '';
1128         }
1130         $html = $this->page_split_join_button($structure, 1);
1131         return str_replace('&amp;slot=1&amp;', '&amp;slot=%%SLOT%%&amp;', $html);
1132     }
1134     /**
1135      * Return the contents of the question bank, to be displayed in the question-bank pop-up.
1136      *
1137      * @param \mod_quiz\question\bank\custom_view $questionbank the question bank view object.
1138      * @param array $pagevars the variables from {@link \question_edit_setup()}.
1139      * @return string HTML to output / send back in response to an AJAX request.
1140      */
1141     public function question_bank_contents(\mod_quiz\question\bank\custom_view $questionbank, array $pagevars) {
1143         $qbank = $questionbank->render('editq', $pagevars['qpage'], $pagevars['qperpage'],
1144                 $pagevars['cat'], $pagevars['recurse'], $pagevars['showhidden'], $pagevars['qbshowtext']);
1145         return html_writer::div(html_writer::div($qbank, 'bd'), 'questionbankformforpopup');
1146     }