MDL-57431 mod_quiz: Quiz editing help icon fix
[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;
30 use renderable;
32 /**
33  * Renderer outputting the quiz editing UI.
34  *
35  * @copyright 2013 The Open University.
36  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37  * @since Moodle 2.7
38  */
39 class edit_renderer extends \plugin_renderer_base {
41     /**
42      * Render the edit page
43      *
44      * @param \quiz $quizobj object containing all the quiz settings information.
45      * @param structure $structure object containing the structure of the quiz.
46      * @param \question_edit_contexts $contexts the relevant question bank contexts.
47      * @param \moodle_url $pageurl the canonical URL of this page.
48      * @param array $pagevars the variables from {@link question_edit_setup()}.
49      * @return string HTML to output.
50      */
51     public function edit_page(\quiz $quizobj, structure $structure,
52             \question_edit_contexts $contexts, \moodle_url $pageurl, array $pagevars) {
53         $output = '';
55         // Page title.
56         $output .= $this->heading_with_help(get_string('editingquizx', 'quiz',
57                 format_string($quizobj->get_quiz_name())), 'editingquiz', 'quiz', '',
58                 get_string('basicideasofquiz', 'quiz'), 2);
60         // Information at the top.
61         $output .= $this->quiz_state_warnings($structure);
63         $output .= html_writer::start_div('mod_quiz-edit-top-controls');
64         $output .= $this->quiz_information($structure);
65         $output .= $this->maximum_grade_input($structure, $pageurl);
67         $output .= html_writer::start_div('mod_quiz-edit-action-buttons btn-group edit-toolbar', ['role' => 'group']);
68         $output .= $this->repaginate_button($structure, $pageurl);
69         $output .= $this->selectmultiple_button($structure);
70         $output .= html_writer::end_tag('div');
72         $output .= $this->total_marks($quizobj->get_quiz());
74         $output .= $this->selectmultiple_controls($structure);
75         $output .= html_writer::end_tag('div');
77         // Show the questions organised into sections and pages.
78         $output .= $this->start_section_list($structure);
80         foreach ($structure->get_sections() as $section) {
81             $output .= $this->start_section($structure, $section);
82             $output .= $this->questions_in_section($structure, $section, $contexts, $pagevars, $pageurl);
84             if ($structure->is_last_section($section)) {
85                 $output .= \html_writer::start_div('last-add-menu');
86                 $output .= html_writer::tag('span', $this->add_menu_actions($structure, 0,
87                         $pageurl, $contexts, $pagevars), array('class' => 'add-menu-outer'));
88                 $output .= \html_writer::end_div();
89             }
91             $output .= $this->end_section();
92         }
94         $output .= $this->end_section_list();
96         // Initialise the JavaScript.
97         $this->initialise_editing_javascript($structure, $contexts, $pagevars, $pageurl);
99         // Include the contents of any other popups required.
100         if ($structure->can_be_edited()) {
101             $popups = '';
103             $popups .= $this->question_bank_loading();
104             $this->page->requires->yui_module('moodle-mod_quiz-quizquestionbank',
105                     'M.mod_quiz.quizquestionbank.init',
106                     array('class' => 'questionbank', 'cmid' => $structure->get_cmid()));
108             $popups .= $this->random_question_form($pageurl, $contexts, $pagevars);
109             $this->page->requires->yui_module('moodle-mod_quiz-randomquestion',
110                     'M.mod_quiz.randomquestion.init');
112             $output .= html_writer::div($popups, 'mod_quiz_edit_forms');
114             // Include the question chooser.
115             $output .= $this->question_chooser();
116         }
118         return $output;
119     }
121     /**
122      * Render any warnings that might be required about the state of the quiz,
123      * e.g. if it has been attempted, or if the shuffle questions option is
124      * turned on.
125      *
126      * @param structure $structure the quiz structure.
127      * @return string HTML to output.
128      */
129     public function quiz_state_warnings(structure $structure) {
130         $warnings = $structure->get_edit_page_warnings();
132         if (empty($warnings)) {
133             return '';
134         }
136         $output = array();
137         foreach ($warnings as $warning) {
138             $output[] = \html_writer::tag('p', $warning);
139         }
140         return $this->box(implode("\n", $output), 'statusdisplay');
141     }
143     /**
144      * Render the status bar.
145      *
146      * @param structure $structure the quiz structure.
147      * @return string HTML to output.
148      */
149     public function quiz_information(structure $structure) {
150         list($currentstatus, $explanation) = $structure->get_dates_summary();
152         $output = html_writer::span(
153                     get_string('numquestionsx', 'quiz', $structure->get_question_count()),
154                     'numberofquestions') . ' | ' .
155                 html_writer::span($currentstatus, 'quizopeningstatus',
156                     array('title' => $explanation));
158         return html_writer::div($output, 'statusbar');
159     }
161     /**
162      * Render the form for setting a quiz' overall grade
163      *
164      * @param structure $structure the quiz structure.
165      * @param \moodle_url $pageurl the canonical URL of this page.
166      * @return string HTML to output.
167      */
168     public function maximum_grade_input($structure, \moodle_url $pageurl) {
169         $output = '';
170         $output .= html_writer::start_div('maxgrade');
171         $output .= html_writer::start_tag('form', array('method' => 'post', 'action' => 'edit.php',
172                 'class' => 'quizsavegradesform form-inline'));
173         $output .= html_writer::start_tag('fieldset', array('class' => 'invisiblefieldset'));
174         $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'sesskey', 'value' => sesskey()));
175         $output .= html_writer::input_hidden_params($pageurl);
176         $output .= html_writer::tag('label', get_string('maximumgrade') . ' ',
177                 array('for' => 'inputmaxgrade'));
178         $output .= html_writer::empty_tag('input', array('type' => 'text', 'id' => 'inputmaxgrade',
179                 'name' => 'maxgrade', 'size' => ($structure->get_decimal_places_for_grades() + 2),
180                 'value' => $structure->formatted_quiz_grade(),
181                 'class' => 'form-control'));
182         $output .= html_writer::empty_tag('input', array('type' => 'submit', 'class' => 'btn btn-secondary m-l-1',
183                 'name' => 'savechanges', 'value' => get_string('save', 'quiz')));
184         $output .= html_writer::end_tag('fieldset');
185         $output .= html_writer::end_tag('form');
186         $output .= html_writer::end_tag('div');
187         return $output;
188     }
190     /**
191      * Return the repaginate button
192      * @param structure $structure the structure of the quiz being edited.
193      * @param \moodle_url $pageurl the canonical URL of this page.
194      * @return string HTML to output.
195      */
196     protected function repaginate_button(structure $structure, \moodle_url $pageurl) {
198         $header = html_writer::tag('span', get_string('repaginatecommand', 'quiz'), array('class' => 'repaginatecommand'));
199         $form = $this->repaginate_form($structure, $pageurl);
201         $buttonoptions = array(
202             'type'  => 'submit',
203             'name'  => 'repaginate',
204             'id'    => 'repaginatecommand',
205             'value' => get_string('repaginatecommand', 'quiz'),
206             'class' => 'btn btn-secondary m-b-1',
207             'data-header' => $header,
208             'data-form'   => $form,
209         );
210         if (!$structure->can_be_repaginated()) {
211             $buttonoptions['disabled'] = 'disabled';
212         } else {
213             $this->page->requires->yui_module('moodle-mod_quiz-repaginate', 'M.mod_quiz.repaginate.init');
214         }
216         return html_writer::empty_tag('input', $buttonoptions);
217     }
219     /**
220      * Generate the bulk action button.
221      *
222      * @param structure $structure the structure of the quiz being edited.
223      * @return string HTML to output.
224      */
225     protected function selectmultiple_button(structure $structure) {
226         $buttonoptions = array(
227             'type'  => 'button',
228             'name'  => 'selectmultiple',
229             'id'    => 'selectmultiplecommand',
230             'value' => get_string('selectmultipleitems', 'quiz'),
231             'class' => 'btn btn-secondary m-b-1'
232         );
233         if (!$structure->can_be_edited()) {
234             $buttonoptions['disabled'] = 'disabled';
235         }
237         return html_writer::tag('button', get_string('selectmultipleitems', 'quiz'), $buttonoptions);
238     }
240     /**
241      * Generate the controls that appear when the bulk action button is pressed.
242      *
243      * @param structure $structure the structure of the quiz being edited.
244      * @return string HTML to output.
245      */
246     protected function selectmultiple_controls(structure $structure) {
247         $output = '';
249         // Bulk action button delete and bulk action button cancel.
250         $buttondeleteoptions = array(
251             'type' => 'button',
252             'id' => 'selectmultipledeletecommand',
253             'value' => get_string('deleteselected', 'mod_quiz'),
254             'class' => 'btn btn-secondary'
255         );
256         $buttoncanceloptions = array(
257             'type' => 'button',
258             'id' => 'selectmultiplecancelcommand',
259             'value' => get_string('cancel', 'moodle'),
260             'class' => 'btn btn-secondary'
261         );
263         $groupoptions = array(
264             'class' => 'btn-group selectmultiplecommand actions',
265             'role' => 'group'
266         );
268         $output .= html_writer::tag('div',
269                         html_writer::tag('button', get_string('deleteselected', 'mod_quiz'), $buttondeleteoptions) .
270                         " " .
271                         html_writer::tag('button', get_string('cancel', 'moodle'),
272                 $buttoncanceloptions), $groupoptions);
274         $toolbaroptions = array(
275             'class' => 'btn-toolbar',
276             'role' => 'toolbar',
277             'aria-label' => get_string('selectmultipletoolbar', 'quiz'),
278         );
280         // Select all/deselect all questions.
281         $buttonselectalloptions = array(
282             'role' => 'button',
283             'id' => 'questionselectall',
284             'class' => 'btn btn-link'
285         );
286         $buttondeselectalloptions = array(
287             'role' => 'button',
288             'id' => 'questiondeselectall',
289             'class' => 'btn btn-link'
290         );
291         $output .= html_writer::tag('div',
292                 html_writer::tag('div',
293                         html_writer::link('#', get_string('selectall', 'quiz'), $buttonselectalloptions) .
294                         html_writer::tag('span', "/", ['class' => 'separator']) .
295                         html_writer::link('#', get_string('selectnone', 'quiz'), $buttondeselectalloptions),
296                         array('class' => 'btn-group selectmultiplecommandbuttons')),
297                 $toolbaroptions);
298         return $output;
299     }
301     /**
302      * Return the repaginate form
303      * @param structure $structure the structure of the quiz being edited.
304      * @param \moodle_url $pageurl the canonical URL of this page.
305      * @return string HTML to output.
306      */
307     protected function repaginate_form(structure $structure, \moodle_url $pageurl) {
308         $perpage = array();
309         $perpage[0] = get_string('allinone', 'quiz');
310         for ($i = 1; $i <= 50; ++$i) {
311             $perpage[$i] = $i;
312         }
314         $hiddenurl = clone($pageurl);
315         $hiddenurl->param('sesskey', sesskey());
317         $select = html_writer::select($perpage, 'questionsperpage',
318                 $structure->get_questions_per_page(), false, array('class' => 'custom-select'));
320         $buttonattributes = array(
321             'type' => 'submit',
322             'name' => 'repaginate',
323             'value' => get_string('go'),
324             'class' => 'btn btn-secondary m-l-1'
325         );
327         $formcontent = html_writer::tag('form', html_writer::div(
328                     html_writer::input_hidden_params($hiddenurl) .
329                     get_string('repaginate', 'quiz', $select) .
330                     html_writer::empty_tag('input', $buttonattributes)
331                 ), array('action' => 'edit.php', 'method' => 'post'));
333         return html_writer::div($formcontent, '', array('id' => 'repaginatedialog'));
334     }
336     /**
337      * Render the total marks available for the quiz.
338      *
339      * @param \stdClass $quiz the quiz settings from the database.
340      * @return string HTML to output.
341      */
342     public function total_marks($quiz) {
343         $totalmark = html_writer::span(quiz_format_grade($quiz, $quiz->sumgrades), 'mod_quiz_summarks');
344         return html_writer::tag('span',
345                 get_string('totalmarksx', 'quiz', $totalmark),
346                 array('class' => 'totalpoints'));
347     }
349     /**
350      * Generate the starting container html for the start of a list of sections
351      * @param structure $structure the structure of the quiz being edited.
352      * @return string HTML to output.
353      */
354     protected function start_section_list(structure $structure) {
355         $class = 'slots';
356         if ($structure->get_section_count() == 1) {
357             $class .= ' only-one-section';
358         }
359         return html_writer::start_tag('ul', array('class' => $class));
360     }
362     /**
363      * Generate the closing container html for the end of a list of sections
364      * @return string HTML to output.
365      */
366     protected function end_section_list() {
367         return html_writer::end_tag('ul');
368     }
370     /**
371      * Display the start of a section, before the questions.
372      *
373      * @param structure $structure the structure of the quiz being edited.
374      * @param \stdClass $section The quiz_section entry from DB
375      * @return string HTML to output.
376      */
377     protected function start_section($structure, $section) {
379         $output = '';
381         $sectionstyle = '';
382         if ($structure->is_only_one_slot_in_section($section)) {
383             $sectionstyle = ' only-has-one-slot';
384         }
386         $output .= html_writer::start_tag('li', array('id' => 'section-'.$section->id,
387             'class' => 'section main clearfix'.$sectionstyle, 'role' => 'region',
388             'aria-label' => $section->heading));
390         $output .= html_writer::start_div('content');
392         $output .= html_writer::start_div('section-heading');
394         $headingtext = $this->heading(html_writer::span(
395                 html_writer::span($section->heading, 'instancesection'), 'sectioninstance'), 3);
397         if (!$structure->can_be_edited()) {
398             $editsectionheadingicon = '';
399         } else {
400             $editsectionheadingicon = html_writer::link(new \moodle_url('#'),
401                 $this->pix_icon('t/editstring', get_string('sectionheadingedit', 'quiz', $section->heading),
402                         'moodle', array('class' => 'editicon visibleifjs')),
403                         array('class' => 'editing_section', 'data-action' => 'edit_section_title'));
404         }
405         $output .= html_writer::div($headingtext . $editsectionheadingicon, 'instancesectioncontainer');
407         if (!$structure->is_first_section($section) && $structure->can_be_edited()) {
408             $output .= $this->section_remove_icon($section);
409         }
410         $output .= $this->section_shuffle_questions($structure, $section);
412         $output .= html_writer::end_div($output, 'section-heading');
414         return $output;
415     }
417     /**
418      * Display a checkbox for shuffling question within a section.
419      *
420      * @param structure $structure object containing the structure of the quiz.
421      * @param \stdClass $section data from the quiz_section table.
422      * @return string HTML to output.
423      */
424     public function section_shuffle_questions(structure $structure, $section) {
425         $checkboxattributes = array(
426             'type' => 'checkbox',
427             'id' => 'shuffle-' . $section->id,
428             'value' => 1,
429             'data-action' => 'shuffle_questions',
430             'class' => 'cm-edit-action',
431         );
433         if (!$structure->can_be_edited()) {
434             $checkboxattributes['disabled'] = 'disabled';
435         }
436         if ($section->shufflequestions) {
437             $checkboxattributes['checked'] = 'checked';
438         }
440         if ($structure->is_first_section($section)) {
441             $help = $this->help_icon('shufflequestions', 'quiz');
442         } else {
443             $help = '';
444         }
446         $helpspan = html_writer::span($help, 'shuffle-help-tip');
447         $progressspan = html_writer::span('', 'shuffle-progress');
448         $checkbox = html_writer::empty_tag('input', $checkboxattributes);
449         $label = html_writer::label(get_string('shufflequestions', 'quiz'),
450                 $checkboxattributes['id'], false);
451         return html_writer::span($progressspan . $checkbox . $label. ' ' . $helpspan,
452                 'instanceshufflequestions', array('data-action' => 'shuffle_questions'));
453     }
455     /**
456      * Display the end of a section, after the questions.
457      *
458      * @return string HTML to output.
459      */
460     protected function end_section() {
461         $output = html_writer::end_tag('div');
462         $output .= html_writer::end_tag('li');
464         return $output;
465     }
467     /**
468      * Render an icon to remove a section from the quiz.
469      *
470      * @param object $section the section to be removed.
471      * @return string HTML to output.
472      */
473     public function section_remove_icon($section) {
474         $title = get_string('sectionheadingremove', 'quiz', $section->heading);
475         $url = new \moodle_url('/mod/quiz/edit.php',
476                 array('sesskey' => sesskey(), 'removesection' => '1', 'sectionid' => $section->id));
477         $image = $this->pix_icon('t/delete', $title);
478         return $this->action_link($url, $image, null, array(
479                 'class' => 'cm-edit-action editing_delete', 'data-action' => 'deletesection'));
480     }
482     /**
483      * Renders HTML to display the questions in a section of the quiz.
484      *
485      * This function calls {@link core_course_renderer::quiz_section_question()}
486      *
487      * @param structure $structure object containing the structure of the quiz.
488      * @param \stdClass $section information about the section.
489      * @param \question_edit_contexts $contexts the relevant question bank contexts.
490      * @param array $pagevars the variables from {@link \question_edit_setup()}.
491      * @param \moodle_url $pageurl the canonical URL of this page.
492      * @return string HTML to output.
493      */
494     public function questions_in_section(structure $structure, $section,
495             $contexts, $pagevars, $pageurl) {
497         $output = '';
498         foreach ($structure->get_slots_in_section($section->id) as $slot) {
499             $output .= $this->question_row($structure, $slot, $contexts, $pagevars, $pageurl);
500         }
501         return html_writer::tag('ul', $output, array('class' => 'section img-text'));
502     }
504     /**
505      * Displays one question with the surrounding controls.
506      *
507      * @param structure $structure object containing the structure of the quiz.
508      * @param int $slot which slot we are outputting.
509      * @param \question_edit_contexts $contexts the relevant question bank contexts.
510      * @param array $pagevars the variables from {@link \question_edit_setup()}.
511      * @param \moodle_url $pageurl the canonical URL of this page.
512      * @return string HTML to output.
513      */
514     public function question_row(structure $structure, $slot, $contexts, $pagevars, $pageurl) {
515         $output = '';
517         $output .= $this->page_row($structure, $slot, $contexts, $pagevars, $pageurl);
519         // Page split/join icon.
520         $joinhtml = '';
521         if ($structure->can_be_edited() && !$structure->is_last_slot_in_quiz($slot) &&
522                                             !$structure->is_last_slot_in_section($slot)) {
523             $joinhtml = $this->page_split_join_button($structure, $slot);
524         }
525         // Question HTML.
526         $questionhtml = $this->question($structure, $slot, $pageurl);
527         $qtype = $structure->get_question_type_for_slot($slot);
528         $questionclasses = 'activity ' . $qtype . ' qtype_' . $qtype . ' slot';
530         $output .= html_writer::tag('li', $questionhtml . $joinhtml,
531                 array('class' => $questionclasses, 'id' => 'slot-' . $structure->get_slot_id_for_slot($slot),
532                         'data-canfinish' => $structure->can_finish_during_the_attempt($slot)));
534         return $output;
535     }
537     /**
538      * Displays one question with the surrounding controls.
539      *
540      * @param structure $structure object containing the structure of the quiz.
541      * @param int $slot the first slot on the page we are outputting.
542      * @param \question_edit_contexts $contexts the relevant question bank contexts.
543      * @param array $pagevars the variables from {@link \question_edit_setup()}.
544      * @param \moodle_url $pageurl the canonical URL of this page.
545      * @return string HTML to output.
546      */
547     public function page_row(structure $structure, $slot, $contexts, $pagevars, $pageurl) {
548         $output = '';
550         $pagenumber = $structure->get_page_number_for_slot($slot);
552         // Put page in a heading for accessibility and styling.
553         $page = $this->heading(get_string('page') . ' ' . $pagenumber, 4);
555         if ($structure->is_first_slot_on_page($slot)) {
556             // Add the add-menu at the page level.
557             $addmenu = html_writer::tag('span', $this->add_menu_actions($structure,
558                     $pagenumber, $pageurl, $contexts, $pagevars),
559                     array('class' => 'add-menu-outer'));
561             $addquestionform = $this->add_question_form($structure,
562                     $pagenumber, $pageurl, $pagevars);
564             $output .= html_writer::tag('li', $page . $addmenu . $addquestionform,
565                     array('class' => 'pagenumber activity yui3-dd-drop page', 'id' => 'page-' . $pagenumber));
566         }
568         return $output;
569     }
571     /**
572      * Returns the add menu that is output once per page.
573      * @param structure $structure object containing the structure of the quiz.
574      * @param int $page the page number that this menu will add to.
575      * @param \moodle_url $pageurl the canonical URL of this page.
576      * @param \question_edit_contexts $contexts the relevant question bank contexts.
577      * @param array $pagevars the variables from {@link \question_edit_setup()}.
578      * @return string HTML to output.
579      */
580     public function add_menu_actions(structure $structure, $page, \moodle_url $pageurl,
581             \question_edit_contexts $contexts, array $pagevars) {
583         $actions = $this->edit_menu_actions($structure, $page, $pageurl, $pagevars);
584         if (empty($actions)) {
585             return '';
586         }
587         $menu = new \action_menu();
588         $menu->set_alignment(\action_menu::TR, \action_menu::TR);
589         $menu->set_constraint('.mod-quiz-edit-content');
590         $trigger = html_writer::tag('span', get_string('add', 'quiz'), array('class' => 'add-menu'));
591         $menu->set_menu_trigger($trigger);
592         // The menu appears within an absolutely positioned element causing width problems.
593         // Make sure no-wrap is set so that we don't get a squashed menu.
594         $menu->set_nowrap_on_items(true);
596         // Disable the link if quiz has attempts.
597         if (!$structure->can_be_edited()) {
598             return $this->render($menu);
599         }
601         foreach ($actions as $action) {
602             if ($action instanceof \action_menu_link) {
603                 $action->add_class('add-menu');
604             }
605             $menu->add($action);
606         }
607         $menu->attributes['class'] .= ' page-add-actions commands';
609         // Prioritise the menu ahead of all other actions.
610         $menu->prioritise = true;
612         return $this->render($menu);
613     }
615     /**
616      * Returns the list of actions to go in the add menu.
617      * @param structure $structure object containing the structure of the quiz.
618      * @param int $page the page number that this menu will add to.
619      * @param \moodle_url $pageurl the canonical URL of this page.
620      * @param array $pagevars the variables from {@link \question_edit_setup()}.
621      * @return array the actions.
622      */
623     public function edit_menu_actions(structure $structure, $page,
624             \moodle_url $pageurl, array $pagevars) {
625         $questioncategoryid = question_get_category_id_from_pagevars($pagevars);
626         static $str;
627         if (!isset($str)) {
628             $str = get_strings(array('addasection', 'addaquestion', 'addarandomquestion',
629                     'addarandomselectedquestion', 'questionbank'), 'quiz');
630         }
632         // Get section, page, slotnumber and maxmark.
633         $actions = array();
635         // Add a new section to the add_menu if possible. This is always added to the HTML
636         // then hidden with CSS when no needed, so that as things are re-ordered, etc. with
637         // Ajax it can be relevaled again when necessary.
638         $params = array('cmid' => $structure->get_cmid(), 'addsectionatpage' => $page);
640         $actions['addasection'] = new \action_menu_link_secondary(
641                 new \moodle_url($pageurl, $params),
642                 new \pix_icon('t/add', $str->addasection, 'moodle', array('class' => 'iconsmall', 'title' => '')),
643                 $str->addasection, array('class' => 'cm-edit-action addasection', 'data-action' => 'addasection')
644         );
646         // Add a new question to the quiz.
647         $returnurl = new \moodle_url($pageurl, array('addonpage' => $page));
648         $params = array('returnurl' => $returnurl->out_as_local_url(false),
649                 'cmid' => $structure->get_cmid(), 'category' => $questioncategoryid,
650                 'addonpage' => $page, 'appendqnumstring' => 'addquestion');
652         $actions['addaquestion'] = new \action_menu_link_secondary(
653             new \moodle_url('/question/addquestion.php', $params),
654             new \pix_icon('t/add', $str->addaquestion, 'moodle', array('class' => 'iconsmall', 'title' => '')),
655             $str->addaquestion, array('class' => 'cm-edit-action addquestion', 'data-action' => 'addquestion')
656         );
658         // Call question bank.
659         $icon = new \pix_icon('t/add', $str->questionbank, 'moodle', array('class' => 'iconsmall', 'title' => ''));
660         if ($page) {
661             $title = get_string('addquestionfrombanktopage', 'quiz', $page);
662         } else {
663             $title = get_string('addquestionfrombankatend', 'quiz');
664         }
665         $attributes = array('class' => 'cm-edit-action questionbank',
666                 'data-header' => $title, 'data-action' => 'questionbank', 'data-addonpage' => $page);
667         $actions['questionbank'] = new \action_menu_link_secondary($pageurl, $icon, $str->questionbank, $attributes);
669         // Add a random question.
670         $returnurl = new \moodle_url('/mod/quiz/edit.php', array('cmid' => $structure->get_cmid(), 'data-addonpage' => $page));
671         $params = array('returnurl' => $returnurl, 'cmid' => $structure->get_cmid(), 'appendqnumstring' => 'addarandomquestion');
672         $url = new \moodle_url('/mod/quiz/addrandom.php', $params);
673         $icon = new \pix_icon('t/add', $str->addarandomquestion, 'moodle', array('class' => 'iconsmall', 'title' => ''));
674         $attributes = array('class' => 'cm-edit-action addarandomquestion', 'data-action' => 'addarandomquestion');
675         if ($page) {
676             $title = get_string('addrandomquestiontopage', 'quiz', $page);
677         } else {
678             $title = get_string('addrandomquestionatend', 'quiz');
679         }
680         $attributes = array_merge(array('data-header' => $title, 'data-addonpage' => $page), $attributes);
681         $actions['addarandomquestion'] = new \action_menu_link_secondary($url, $icon, $str->addarandomquestion, $attributes);
683         return $actions;
684     }
686     /**
687      * Render the form that contains the data for adding a new question to the quiz.
688      *
689      * @param structure $structure object containing the structure of the quiz.
690      * @param int $page the page number that this menu will add to.
691      * @param \moodle_url $pageurl the canonical URL of this page.
692      * @param array $pagevars the variables from {@link \question_edit_setup()}.
693      * @return string HTML to output.
694      */
695     protected function add_question_form(structure $structure, $page, \moodle_url $pageurl, array $pagevars) {
697         $questioncategoryid = question_get_category_id_from_pagevars($pagevars);
699         $output = html_writer::tag('input', null,
700                 array('type' => 'hidden', 'name' => 'returnurl',
701                         'value' => $pageurl->out_as_local_url(false, array('addonpage' => $page))));
702         $output .= html_writer::tag('input', null,
703                 array('type' => 'hidden', 'name' => 'cmid', 'value' => $structure->get_cmid()));
704         $output .= html_writer::tag('input', null,
705                 array('type' => 'hidden', 'name' => 'appendqnumstring', 'value' => 'addquestion'));
706         $output .= html_writer::tag('input', null,
707                 array('type' => 'hidden', 'name' => 'category', 'value' => $questioncategoryid));
709         return html_writer::tag('form', html_writer::div($output),
710                 array('class' => 'addnewquestion', 'method' => 'post',
711                         'action' => new \moodle_url('/question/addquestion.php')));
712     }
714     /**
715      * Display a question.
716      *
717      * @param structure $structure object containing the structure of the quiz.
718      * @param int $slot the first slot on the page we are outputting.
719      * @param \moodle_url $pageurl the canonical URL of this page.
720      * @return string HTML to output.
721      */
722     public function question(structure $structure, $slot, \moodle_url $pageurl) {
723         $output = '';
724         $output .= html_writer::start_tag('div');
726         if ($structure->can_be_edited()) {
727             $output .= $this->question_move_icon($structure, $slot);
728         }
730         $output .= html_writer::start_div('mod-indent-outer');
731         $output .= html_writer::tag('input', '', array('id' => 'selectquestion-' .
732                 $structure->get_displayed_number_for_slot($slot), 'name' => 'selectquestion[]',
733                'type' => 'checkbox', 'class' => 'select-multiple-checkbox',
734                'value' => $structure->get_displayed_number_for_slot($slot)));
735         $output .= $this->question_number($structure->get_displayed_number_for_slot($slot));
737         // This div is used to indent the content.
738         $output .= html_writer::div('', 'mod-indent');
740         // Display the link to the question (or do nothing if question has no url).
741         if ($structure->get_question_type_for_slot($slot) == 'random') {
742             $questionname = $this->random_question($structure, $slot, $pageurl);
743         } else {
744             $questionname = $this->question_name($structure, $slot, $pageurl);
745         }
747         // Start the div for the activity title, excluding the edit icons.
748         $output .= html_writer::start_div('activityinstance');
749         $output .= $questionname;
751         // Closing the tag which contains everything but edit icons. Content part of the module should not be part of this.
752         $output .= html_writer::end_tag('div'); // .activityinstance.
754         // Action icons.
755         $questionicons = '';
756         $questionicons .= $this->question_preview_icon($structure->get_quiz(), $structure->get_question_in_slot($slot));
757         if ($structure->can_be_edited()) {
758             $questionicons .= $this->question_remove_icon($structure, $slot, $pageurl);
759         }
760         $questionicons .= $this->marked_out_of_field($structure, $slot);
761         $output .= html_writer::span($questionicons, 'actions'); // Required to add js spinner icon.
762         if ($structure->can_be_edited()) {
763             $output .= $this->question_dependency_icon($structure, $slot);
764         }
766         // End of indentation div.
767         $output .= html_writer::end_tag('div');
768         $output .= html_writer::end_tag('div');
770         return $output;
771     }
773     /**
774      * Render the move icon.
775      *
776      * @param structure $structure object containing the structure of the quiz.
777      * @param int $slot the first slot on the page we are outputting.
778      * @return string The markup for the move action.
779      */
780     public function question_move_icon(structure $structure, $slot) {
781         return html_writer::link(new \moodle_url('#'),
782             $this->pix_icon('i/dragdrop', get_string('move'), 'moodle', array('class' => 'iconsmall', 'title' => '')),
783             array('class' => 'editing_move', 'data-action' => 'move')
784         );
785     }
787     /**
788      * Output the question number.
789      * @param string $number The number, or 'i'.
790      * @return string HTML to output.
791      */
792     public function question_number($number) {
793         if (is_numeric($number)) {
794             $number = html_writer::span(get_string('question'), 'accesshide') . ' ' . $number;
795         }
796         return html_writer::tag('span', $number, array('class' => 'slotnumber'));
797     }
799     /**
800      * Render the preview icon.
801      *
802      * @param \stdClass $quiz the quiz settings from the database.
803      * @param \stdClass $question data from the question and quiz_slots tables.
804      * @param bool $label if true, show the preview question label after the icon
805      * @param int $variant which question variant to preview (optional).
806      * @return string HTML to output.
807      */
808     public function question_preview_icon($quiz, $question, $label = null, $variant = null) {
809         $url = quiz_question_preview_url($quiz, $question, $variant);
811         // Do we want a label?
812         $strpreviewlabel = '';
813         if ($label) {
814             $strpreviewlabel = ' ' . get_string('preview', 'quiz');
815         }
817         // Build the icon.
818         $strpreviewquestion = get_string('previewquestion', 'quiz');
819         $image = $this->pix_icon('t/preview', $strpreviewquestion);
821         $action = new \popup_action('click', $url, 'questionpreview',
822                                         question_preview_popup_params());
824         return $this->action_link($url, $image . $strpreviewlabel, $action,
825                 array('title' => $strpreviewquestion, 'class' => 'preview'));
826     }
828     /**
829      * Render an icon to remove a question from the quiz.
830      *
831      * @param structure $structure object containing the structure of the quiz.
832      * @param int $slot the first slot on the page we are outputting.
833      * @param \moodle_url $pageurl the canonical URL of the edit page.
834      * @return string HTML to output.
835      */
836     public function question_remove_icon(structure $structure, $slot, $pageurl) {
837         $url = new \moodle_url($pageurl, array('sesskey' => sesskey(), 'remove' => $slot));
838         $strdelete = get_string('delete');
840         $image = $this->pix_icon('t/delete', $strdelete);
842         return $this->action_link($url, $image, null, array('title' => $strdelete,
843                     'class' => 'cm-edit-action editing_delete', 'data-action' => 'delete'));
844     }
846     /**
847      * Display an icon to split or join two pages of the quiz.
848      *
849      * @param structure $structure object containing the structure of the quiz.
850      * @param int $slot the first slot on the page we are outputting.
851      * @return string HTML to output.
852      */
853     public function page_split_join_button($structure, $slot) {
854         $insertpagebreak = !$structure->is_last_slot_on_page($slot);
855         $url = new \moodle_url('repaginate.php', array('quizid' => $structure->get_quizid(),
856                 'slot' => $slot, 'repag' => $insertpagebreak ? 2 : 1, 'sesskey' => sesskey()));
858         if ($insertpagebreak) {
859             $title = get_string('addpagebreak', 'quiz');
860             $image = $this->image_icon('e/insert_page_break', $title);
861             $action = 'addpagebreak';
862         } else {
863             $title = get_string('removepagebreak', 'quiz');
864             $image = $this->image_icon('e/remove_page_break', $title);
865             $action = 'removepagebreak';
866         }
868         // Disable the link if quiz has attempts.
869         $disabled = null;
870         if (!$structure->can_be_edited()) {
871             $disabled = 'disabled';
872         }
873         return html_writer::span($this->action_link($url, $image, null, array('title' => $title,
874                     'class' => 'page_split_join cm-edit-action', 'disabled' => $disabled, 'data-action' => $action)),
875                 'page_split_join_wrapper');
876     }
878     /**
879      * Display the icon for whether this question can only be seen if the previous
880      * one has been answered.
881      *
882      * @param structure $structure object containing the structure of the quiz.
883      * @param int $slot the first slot on the page we are outputting.
884      * @return string HTML to output.
885      */
886     public function question_dependency_icon($structure, $slot) {
887         $a = array(
888             'thisq' => $structure->get_displayed_number_for_slot($slot),
889             'previousq' => $structure->get_displayed_number_for_slot(max($slot - 1, 1)),
890         );
891         if ($structure->is_question_dependent_on_previous_slot($slot)) {
892             $title = get_string('questiondependencyremove', 'quiz', $a);
893             $image = $this->pix_icon('t/locked', get_string('questiondependsonprevious', 'quiz'),
894                     'moodle', array('title' => ''));
895             $action = 'removedependency';
896         } else {
897             $title = get_string('questiondependencyadd', 'quiz', $a);
898             $image = $this->pix_icon('t/unlocked', get_string('questiondependencyfree', 'quiz'),
899                     'moodle', array('title' => ''));
900             $action = 'adddependency';
901         }
903         // Disable the link if quiz has attempts.
904         $disabled = null;
905         if (!$structure->can_be_edited()) {
906             $disabled = 'disabled';
907         }
908         $extraclass = '';
909         if (!$structure->can_question_depend_on_previous_slot($slot)) {
910             $extraclass = ' question_dependency_cannot_depend';
911         }
912         return html_writer::span($this->action_link('#', $image, null, array('title' => $title,
913                 'class' => 'cm-edit-action', 'disabled' => $disabled, 'data-action' => $action)),
914                 'question_dependency_wrapper' . $extraclass);
915     }
917     /**
918      * Renders html to display a name with the link to the question on a quiz edit page
919      *
920      * If the user does not have permission to edi the question, it is rendered
921      * without a link
922      *
923      * @param structure $structure object containing the structure of the quiz.
924      * @param int $slot which slot we are outputting.
925      * @param \moodle_url $pageurl the canonical URL of this page.
926      * @return string HTML to output.
927      */
928     public function question_name(structure $structure, $slot, $pageurl) {
929         $output = '';
931         $question = $structure->get_question_in_slot($slot);
932         $editurl = new \moodle_url('/question/question.php', array(
933                 'returnurl' => $pageurl->out_as_local_url(),
934                 'cmid' => $structure->get_cmid(), 'id' => $question->id));
936         $instancename = quiz_question_tostring($question);
938         $qtype = \question_bank::get_qtype($question->qtype, false);
939         $namestr = $qtype->local_name();
941         $icon = $this->pix_icon('icon', $namestr, $qtype->plugin_name(), array('title' => $namestr,
942                 'class' => 'icon activityicon', 'alt' => ' ', 'role' => 'presentation'));
944         $editicon = $this->pix_icon('t/edit', '', 'moodle', array('title' => ''));
946         // Need plain question name without html tags for link title.
947         $title = shorten_text(format_string($question->name), 100);
949         // Display the link itself.
950         $activitylink = $icon . html_writer::tag('span', $editicon . $instancename, array('class' => 'instancename'));
951         $output .= html_writer::link($editurl, $activitylink,
952                 array('title' => get_string('editquestion', 'quiz').' '.$title));
954         return $output;
955     }
957     /**
958      * Renders html to display a random question the link to edit the configuration
959      * and also to see that category in the question bank.
960      *
961      * @param structure $structure object containing the structure of the quiz.
962      * @param int $slot which slot we are outputting.
963      * @param \moodle_url $pageurl the canonical URL of this page.
964      * @return string HTML to output.
965      */
966     public function random_question(structure $structure, $slot, $pageurl) {
968         $question = $structure->get_question_in_slot($slot);
969         $editurl = new \moodle_url('/question/question.php', array(
970                 'returnurl' => $pageurl->out_as_local_url(),
971                 'cmid' => $structure->get_cmid(), 'id' => $question->id));
973         $temp = clone($question);
974         $temp->questiontext = '';
975         $instancename = quiz_question_tostring($temp);
977         $configuretitle = get_string('configurerandomquestion', 'quiz');
978         $qtype = \question_bank::get_qtype($question->qtype, false);
979         $namestr = $qtype->local_name();
980         $icon = $this->pix_icon('icon', $namestr, $qtype->plugin_name(), array('title' => $namestr,
981                 'class' => 'icon activityicon', 'alt' => ' ', 'role' => 'presentation'));
983         $editicon = $this->pix_icon('t/edit', $configuretitle, 'moodle', array('title' => ''));
985         // If this is a random question, display a link to show the questions
986         // selected from in the question bank.
987         $qbankurl = new \moodle_url('/question/edit.php', array(
988                 'cmid' => $structure->get_cmid(),
989                 'cat' => $question->category . ',' . $question->contextid,
990                 'recurse' => !empty($question->questiontext)));
991         $qbanklink = ' ' . \html_writer::link($qbankurl,
992                 get_string('seequestions', 'quiz'), array('class' => 'mod_quiz_random_qbank_link'));
994         return html_writer::link($editurl, $icon . $editicon, array('title' => $configuretitle)) .
995                 ' ' . $instancename . ' ' . $qbanklink;
996     }
998     /**
999      * Display the 'marked out of' information for a question.
1000      * Along with the regrade action.
1001      * @param structure $structure object containing the structure of the quiz.
1002      * @param int $slot which slot we are outputting.
1003      * @return string HTML to output.
1004      */
1005     public function marked_out_of_field(structure $structure, $slot) {
1006         if (!$structure->is_real_question($slot)) {
1007             $output = html_writer::span('',
1008                     'instancemaxmark decimalplaces_' . $structure->get_decimal_places_for_question_marks());
1010             $output .= html_writer::span(
1011                     $this->pix_icon('spacer', '', 'moodle', array('class' => 'editicon visibleifjs', 'title' => '')),
1012                     'editing_maxmark');
1013             return html_writer::span($output, 'instancemaxmarkcontainer infoitem');
1014         }
1016         $output = html_writer::span($structure->formatted_question_grade($slot),
1017                 'instancemaxmark decimalplaces_' . $structure->get_decimal_places_for_question_marks(),
1018                 array('title' => get_string('maxmark', 'quiz')));
1020         $output .= html_writer::span(
1021             html_writer::link(
1022                 new \moodle_url('#'),
1023                 $this->pix_icon('t/editstring', '', 'moodle', array('class' => 'editicon visibleifjs', 'title' => '')),
1024                 array(
1025                     'class' => 'editing_maxmark',
1026                     'data-action' => 'editmaxmark',
1027                     'title' => get_string('editmaxmark', 'quiz'),
1028                 )
1029             )
1030         );
1031         return html_writer::span($output, 'instancemaxmarkcontainer');
1032     }
1034     /**
1035      * Renders the question chooser.
1036      *
1037      * @param renderable
1038      * @return string
1039      */
1040     public function render_question_chooser(renderable $chooser) {
1041         return $this->render_from_template('mod_quiz/question_chooser', $chooser->export_for_template($this));
1042     }
1044     /**
1045      * Render the question type chooser dialogue.
1046      * @return string HTML to output.
1047      */
1048     public function question_chooser() {
1049         $chooser = \mod_quiz\output\question_chooser::get($this->page->course, [], null);
1050         $container = html_writer::div($this->render($chooser), '', array('id' => 'qtypechoicecontainer'));
1051         return html_writer::div($container, 'createnewquestion');
1052     }
1054     /**
1055      * Render the contents of the question bank pop-up in its initial state,
1056      * when it just contains a loading progress indicator.
1057      * @return string HTML to output.
1058      */
1059     public function question_bank_loading() {
1060         return html_writer::div($this->pix_icon('i/loading', get_string('loading')), 'questionbankloading');
1061     }
1063     /**
1064      * Return random question form.
1065      * @param \moodle_url $thispageurl the canonical URL of this page.
1066      * @param \question_edit_contexts $contexts the relevant question bank contexts.
1067      * @param array $pagevars the variables from {@link \question_edit_setup()}.
1068      * @return string HTML to output.
1069      */
1070     protected function random_question_form(\moodle_url $thispageurl, \question_edit_contexts $contexts, array $pagevars) {
1072         if (!$contexts->have_cap('moodle/question:useall')) {
1073             return '';
1074         }
1075         $randomform = new \quiz_add_random_form(new \moodle_url('/mod/quiz/addrandom.php'),
1076                                  array('contexts' => $contexts, 'cat' => $pagevars['cat']));
1077         $randomform->set_data(array(
1078                 'category' => $pagevars['cat'],
1079                 'returnurl' => $thispageurl->out_as_local_url(true),
1080                 'randomnumber' => 1,
1081                 'cmid' => $thispageurl->param('cmid'),
1082         ));
1083         return html_writer::div($randomform->render(), 'randomquestionformforpopup');
1084     }
1086     /**
1087      * Initialise the JavaScript for the general editing. (JavaScript for popups
1088      * is handled with the specific code for those.)
1089      *
1090      * @param structure $structure object containing the structure of the quiz.
1091      * @param \question_edit_contexts $contexts the relevant question bank contexts.
1092      * @param array $pagevars the variables from {@link \question_edit_setup()}.
1093      * @param \moodle_url $pageurl the canonical URL of this page.
1094      * @return bool Always returns true
1095      */
1096     protected function initialise_editing_javascript(structure $structure,
1097             \question_edit_contexts $contexts, array $pagevars, \moodle_url $pageurl) {
1099         $config = new \stdClass();
1100         $config->resourceurl = '/mod/quiz/edit_rest.php';
1101         $config->sectionurl = '/mod/quiz/edit_rest.php';
1102         $config->pageparams = array();
1103         $config->questiondecimalpoints = $structure->get_decimal_places_for_question_marks();
1104         $config->pagehtml = $this->new_page_template($structure, $contexts, $pagevars, $pageurl);
1105         $config->addpageiconhtml = $this->add_page_icon_template($structure);
1107         $this->page->requires->yui_module('moodle-mod_quiz-toolboxes',
1108                 'M.mod_quiz.init_resource_toolbox',
1109                 array(array(
1110                         'courseid' => $structure->get_courseid(),
1111                         'quizid' => $structure->get_quizid(),
1112                         'ajaxurl' => $config->resourceurl,
1113                         'config' => $config,
1114                 ))
1115         );
1116         unset($config->pagehtml);
1117         unset($config->addpageiconhtml);
1119         $this->page->requires->strings_for_js(array('areyousureremoveselected'), 'quiz');
1120         $this->page->requires->yui_module('moodle-mod_quiz-toolboxes',
1121                 'M.mod_quiz.init_section_toolbox',
1122                 array(array(
1123                         'courseid' => $structure,
1124                         'quizid' => $structure->get_quizid(),
1125                         'ajaxurl' => $config->sectionurl,
1126                         'config' => $config,
1127                 ))
1128         );
1130         $this->page->requires->yui_module('moodle-mod_quiz-dragdrop', 'M.mod_quiz.init_section_dragdrop',
1131                 array(array(
1132                         'courseid' => $structure,
1133                         'quizid' => $structure->get_quizid(),
1134                         'ajaxurl' => $config->sectionurl,
1135                         'config' => $config,
1136                 )), null, true);
1138         $this->page->requires->yui_module('moodle-mod_quiz-dragdrop', 'M.mod_quiz.init_resource_dragdrop',
1139                 array(array(
1140                         'courseid' => $structure,
1141                         'quizid' => $structure->get_quizid(),
1142                         'ajaxurl' => $config->resourceurl,
1143                         'config' => $config,
1144                 )), null, true);
1146         // Require various strings for the command toolbox.
1147         $this->page->requires->strings_for_js(array(
1148                 'clicktohideshow',
1149                 'deletechecktype',
1150                 'deletechecktypename',
1151                 'edittitle',
1152                 'edittitleinstructions',
1153                 'emptydragdropregion',
1154                 'hide',
1155                 'markedthistopic',
1156                 'markthistopic',
1157                 'move',
1158                 'movecontent',
1159                 'moveleft',
1160                 'movesection',
1161                 'page',
1162                 'question',
1163                 'selectall',
1164                 'show',
1165                 'tocontent',
1166         ), 'moodle');
1168         $this->page->requires->strings_for_js(array(
1169                 'addpagebreak',
1170                 'confirmremovesectionheading',
1171                 'confirmremovequestion',
1172                 'dragtoafter',
1173                 'dragtostart',
1174                 'numquestionsx',
1175                 'sectionheadingedit',
1176                 'sectionheadingremove',
1177                 'removepagebreak',
1178                 'questiondependencyadd',
1179                 'questiondependencyfree',
1180                 'questiondependencyremove',
1181                 'questiondependsonprevious',
1182         ), 'quiz');
1184         foreach (\question_bank::get_all_qtypes() as $qtype => $notused) {
1185             $this->page->requires->string_for_js('pluginname', 'qtype_' . $qtype);
1186         }
1188         return true;
1189     }
1191     /**
1192      * HTML for a page, with ids stripped, so it can be used as a javascript template.
1193      *
1194      * @param structure $structure object containing the structure of the quiz.
1195      * @param \question_edit_contexts $contexts the relevant question bank contexts.
1196      * @param array $pagevars the variables from {@link \question_edit_setup()}.
1197      * @param \moodle_url $pageurl the canonical URL of this page.
1198      * @return string HTML for a new page.
1199      */
1200     protected function new_page_template(structure $structure,
1201             \question_edit_contexts $contexts, array $pagevars, \moodle_url $pageurl) {
1202         if (!$structure->has_questions()) {
1203             return '';
1204         }
1206         $pagehtml = $this->page_row($structure, 1, $contexts, $pagevars, $pageurl);
1208         // Normalise the page number.
1209         $pagenumber = $structure->get_page_number_for_slot(1);
1210         $strcontexts = array();
1211         $strcontexts[] = 'page-';
1212         $strcontexts[] = get_string('page') . ' ';
1213         $strcontexts[] = 'addonpage%3D';
1214         $strcontexts[] = 'addonpage=';
1215         $strcontexts[] = 'addonpage="';
1216         $strcontexts[] = get_string('addquestionfrombanktopage', 'quiz', '');
1217         $strcontexts[] = 'data-addonpage%3D';
1218         $strcontexts[] = 'action-menu-';
1220         foreach ($strcontexts as $strcontext) {
1221             $pagehtml = str_replace($strcontext . $pagenumber, $strcontext . '%%PAGENUMBER%%', $pagehtml);
1222         }
1224         return $pagehtml;
1225     }
1227     /**
1228      * HTML for a page, with ids stripped, so it can be used as a javascript template.
1229      *
1230      * @param structure $structure object containing the structure of the quiz.
1231      * @return string HTML for a new icon
1232      */
1233     protected function add_page_icon_template(structure $structure) {
1235         if (!$structure->has_questions()) {
1236             return '';
1237         }
1239         $html = $this->page_split_join_button($structure, 1);
1240         return str_replace('&amp;slot=1&amp;', '&amp;slot=%%SLOT%%&amp;', $html);
1241     }
1243     /**
1244      * Return the contents of the question bank, to be displayed in the question-bank pop-up.
1245      *
1246      * @param \mod_quiz\question\bank\custom_view $questionbank the question bank view object.
1247      * @param array $pagevars the variables from {@link \question_edit_setup()}.
1248      * @return string HTML to output / send back in response to an AJAX request.
1249      */
1250     public function question_bank_contents(\mod_quiz\question\bank\custom_view $questionbank, array $pagevars) {
1252         $qbank = $questionbank->render('editq', $pagevars['qpage'], $pagevars['qperpage'],
1253                 $pagevars['cat'], $pagevars['recurse'], $pagevars['showhidden'], $pagevars['qbshowtext']);
1254         return html_writer::div(html_writer::div($qbank, 'bd'), 'questionbankformforpopup');
1255     }