MDL-21625 question: Fixed phpdocs
[moodle.git] / question / editlib.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  * Functions used to show question editing interface
19  *
20  * @package    moodlecore
21  * @subpackage questionbank
22  * @copyright  1999 onwards Martin Dougiamas and others {@link http://moodle.com}
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
27 defined('MOODLE_INTERNAL') || die();
29 require_once($CFG->libdir . '/questionlib.php');
31 define('DEFAULT_QUESTIONS_PER_PAGE', 20);
33 function get_module_from_cmid($cmid) {
34     global $CFG, $DB;
35     if (!$cmrec = $DB->get_record_sql("SELECT cm.*, md.name as modname
36                                FROM {course_modules} cm,
37                                     {modules} md
38                                WHERE cm.id = ? AND
39                                      md.id = cm.module", array($cmid))){
40         print_error('invalidcoursemodule');
41     } elseif (!$modrec =$DB->get_record($cmrec->modname, array('id' => $cmrec->instance))) {
42         print_error('invalidcoursemodule');
43     }
44     $modrec->instance = $modrec->id;
45     $modrec->cmid = $cmrec->id;
46     $cmrec->name = $modrec->name;
48     return array($modrec, $cmrec);
49 }
50 /**
51 * Function to read all questions for category into big array
52 *
53 * @param int $category category number
54 * @param bool $noparent if true only questions with NO parent will be selected
55 * @param bool $recurse include subdirectories
56 * @param bool $export set true if this is called by questionbank export
57 */
58 function get_questions_category( $category, $noparent=false, $recurse=true, $export=true ) {
59     global $DB;
61     // Build sql bit for $noparent
62     $npsql = '';
63     if ($noparent) {
64       $npsql = " and parent='0' ";
65     }
67     // Get list of categories
68     if ($recurse) {
69         $categorylist = question_categorylist($category->id);
70     } else {
71         $categorylist = array($category->id);
72     }
74     // Get the list of questions for the category
75     list($usql, $params) = $DB->get_in_or_equal($categorylist);
76     $questions = $DB->get_records_select('question', "category $usql $npsql", $params, 'qtype, name');
78     // Iterate through questions, getting stuff we need
79     $qresults = array();
80     foreach($questions as $key => $question) {
81         $question->export_process = $export;
82         $qtype = question_bank::get_qtype($question->qtype, false);
83         if ($export && $qtype->name() == 'missingtype') {
84             // Unrecognised question type. Skip this question when exporting.
85             continue;
86         }
87         $qtype->get_question_options($question);
88         $qresults[] = $question;
89     }
91     return $qresults;
92 }
94 /**
95  * @param int $categoryid a category id.
96  * @return bool whether this is the only top-level category in a context.
97  */
98 function question_is_only_toplevel_category_in_context($categoryid) {
99     global $DB;
100     return 1 == $DB->count_records_sql("
101             SELECT count(*)
102               FROM {question_categories} c1,
103                    {question_categories} c2
104              WHERE c2.id = ?
105                AND c1.contextid = c2.contextid
106                AND c1.parent = 0 AND c2.parent = 0", array($categoryid));
109 /**
110  * Check whether this user is allowed to delete this category.
111  *
112  * @param int $todelete a category id.
113  */
114 function question_can_delete_cat($todelete) {
115     global $DB;
116     if (question_is_only_toplevel_category_in_context($todelete)) {
117         print_error('cannotdeletecate', 'question');
118     } else {
119         $contextid = $DB->get_field('question_categories', 'contextid', array('id' => $todelete));
120         require_capability('moodle/question:managecategory', context::instance_by_id($contextid));
121     }
125 /**
126  * Base class for representing a column in a {@link question_bank_view}.
127  *
128  * @copyright  2009 Tim Hunt
129  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
130  */
131 abstract class question_bank_column_base {
132     /**
133      * @var question_bank_view
134      */
135     protected $qbank;
137     /** @var bool determine whether the column is td or th. */
138     protected $isheading = false;
140     /**
141      * Constructor.
142      * @param $qbank the question_bank_view we are helping to render.
143      */
144     public function __construct(question_bank_view $qbank) {
145         $this->qbank = $qbank;
146         $this->init();
147     }
149     /**
150      * A chance for subclasses to initialise themselves, for example to load lang strings,
151      * without having to override the constructor.
152      */
153     protected function init() {
154     }
156     /**
157      * Set the column as heading
158      */
159     public function set_as_heading() {
160         $this->isheading = true;
161     }
163     public function is_extra_row() {
164         return false;
165     }
167     /**
168      * Output the column header cell.
169      */
170     public function display_header() {
171         echo '<th class="header ' . $this->get_classes() . '" scope="col">';
172         $sortable = $this->is_sortable();
173         $name = $this->get_name();
174         $title = $this->get_title();
175         $tip = $this->get_title_tip();
176         if (is_array($sortable)) {
177             if ($title) {
178                 echo '<div class="title">' . $title . '</div>';
179             }
180             $links = array();
181             foreach ($sortable as $subsort => $details) {
182                 $links[] = $this->make_sort_link($name . '_' . $subsort,
183                         $details['title'], '', !empty($details['reverse']));
184             }
185             echo '<div class="sorters">' . implode(' / ', $links) . '</div>';
186         } else if ($sortable) {
187             echo $this->make_sort_link($name, $title, $tip);
188         } else {
189             if ($tip) {
190                 echo '<span title="' . $tip . '">';
191             }
192             echo $title;
193             if ($tip) {
194                 echo '</span>';
195             }
196         }
197         echo "</th>\n";
198     }
200     /**
201      * Title for this column. Not used if is_sortable returns an array.
202      * @param object $question the row from the $question table, augmented with extra information.
203      * @param string $rowclasses CSS class names that should be applied to this row of output.
204      */
205     protected abstract function get_title();
207     /**
208      * @return string a fuller version of the name. Use this when get_title() returns
209      * something very short, and you want a longer version as a tool tip.
210      */
211     protected function get_title_tip() {
212         return '';
213     }
215     /**
216      * Get a link that changes the sort order, and indicates the current sort state.
217      * @param $name internal name used for this type of sorting.
218      * @param $currentsort the current sort order -1, 0, 1 for descending, none, ascending.
219      * @param $title the link text.
220      * @param $defaultreverse whether the default sort order for this column is descending, rather than ascending.
221      * @return string HTML fragment.
222      */
223     protected function make_sort_link($sort, $title, $tip, $defaultreverse = false) {
224         $currentsort = $this->qbank->get_primary_sort_order($sort);
225         $newsortreverse = $defaultreverse;
226         if ($currentsort) {
227             $newsortreverse = $currentsort > 0;
228         }
229         if (!$tip) {
230             $tip = $title;
231         }
232         if ($newsortreverse) {
233             $tip = get_string('sortbyxreverse', '', $tip);
234         } else {
235             $tip = get_string('sortbyx', '', $tip);
236         }
237         $link = '<a href="' . $this->qbank->new_sort_url($sort, $newsortreverse) . '" title="' . $tip . '">';
238         $link .= $title;
239         if ($currentsort) {
240             $link .= $this->get_sort_icon($currentsort < 0);
241         }
242         $link .= '</a>';
243         return $link;
244     }
246     /**
247      * Get an icon representing the corrent sort state.
248      * @param $reverse sort is descending, not ascending.
249      * @return string HTML image tag.
250      */
251     protected function get_sort_icon($reverse) {
252         global $OUTPUT;
253         if ($reverse) {
254             return ' <img src="' . $OUTPUT->pix_url('t/up') . '" alt="' . get_string('desc') . '" />';
255         } else {
256             return ' <img src="' . $OUTPUT->pix_url('t/down') . '" alt="' . get_string('asc') . '" />';
257         }
258     }
260     /**
261      * Output this column.
262      * @param object $question the row from the $question table, augmented with extra information.
263      * @param string $rowclasses CSS class names that should be applied to this row of output.
264      */
265     public function display($question, $rowclasses) {
266         $this->display_start($question, $rowclasses);
267         $this->display_content($question, $rowclasses);
268         $this->display_end($question, $rowclasses);
269     }
271     /**
272      * Output the opening column tag.  If it is set as heading, it will use <th> tag instead of <td>
273      *
274      * @param stdClass $question
275      * @param array $rowclasses
276      */
277     protected function display_start($question, $rowclasses) {
278         $tag = 'td';
279         $attr = array('class' => $this->get_classes());
280         if ($this->isheading) {
281             $tag = 'th';
282             $attr['scope'] = 'row';
283         }
284         echo html_writer::start_tag($tag, $attr);
285     }
287     /**
288      * @return string the CSS classes to apply to every cell in this column.
289      */
290     protected function get_classes() {
291         $classes = $this->get_extra_classes();
292         $classes[] = $this->get_name();
293         return implode(' ', $classes);
294     }
296     /**
297      * @param object $question the row from the $question table, augmented with extra information.
298      * @return string internal name for this column. Used as a CSS class name,
299      *     and to store information about the current sort. Must match PARAM_ALPHA.
300      */
301     public abstract function get_name();
303     /**
304      * @return array any extra class names you would like applied to every cell in this column.
305      */
306     public function get_extra_classes() {
307         return array();
308     }
310     /**
311      * Output the contents of this column.
312      * @param object $question the row from the $question table, augmented with extra information.
313      * @param string $rowclasses CSS class names that should be applied to this row of output.
314      */
315     protected abstract function display_content($question, $rowclasses);
317     /**
318      * Output the closing column tag
319      *
320      * @param object $question
321      * @param string $rowclasses
322      */
323     protected function display_end($question, $rowclasses) {
324         $tag = 'td';
325         if ($this->isheading) {
326             $tag = 'th';
327         }
328         echo html_writer::end_tag($tag);
329     }
331     /**
332      * Return an array 'table_alias' => 'JOIN clause' to bring in any data that
333      * this column required.
334      *
335      * The return values for all the columns will be checked. It is OK if two
336      * columns join in the same table with the same alias and identical JOIN clauses.
337      * If to columns try to use the same alias with different joins, you get an error.
338      * The only table included by default is the question table, which is aliased to 'q'.
339      *
340      * It is importnat that your join simply adds additional data (or NULLs) to the
341      * existing rows of the query. It must not cause additional rows.
342      *
343      * @return array 'table_alias' => 'JOIN clause'
344      */
345     public function get_extra_joins() {
346         return array();
347     }
349     /**
350      * @return array fields required. use table alias 'q' for the question table, or one of the
351      * ones from get_extra_joins. Every field requested must specify a table prefix.
352      */
353     public function get_required_fields() {
354         return array();
355     }
357     /**
358      * Can this column be sorted on? You can return either:
359      *  + false for no (the default),
360      *  + a field name, if sorting this column corresponds to sorting on that datbase field.
361      *  + an array of subnames to sort on as follows
362      *  return array(
363      *      'firstname' => array('field' => 'uc.firstname', 'title' => get_string('firstname')),
364      *      'lastname' => array('field' => 'uc.lastname', 'field' => get_string('lastname')),
365      *  );
366      * As well as field, and field, you can also add 'revers' => 1 if you want the default sort
367      * order to be DESC.
368      * @return mixed as above.
369      */
370     public function is_sortable() {
371         return false;
372     }
374     /**
375      * Helper method for building sort clauses.
376      * @param bool $reverse whether the normal direction should be reversed.
377      * @param string $normaldir 'ASC' or 'DESC'
378      * @return string 'ASC' or 'DESC'
379      */
380     protected function sortorder($reverse) {
381         if ($reverse) {
382             return ' DESC';
383         } else {
384             return ' ASC';
385         }
386     }
388     /**
389      * @param $reverse Whether to sort in the reverse of the default sort order.
390      * @param $subsort if is_sortable returns an array of subnames, then this will be
391      *      one of those. Otherwise will be empty.
392      * @return string some SQL to go in the order by clause.
393      */
394     public function sort_expression($reverse, $subsort) {
395         $sortable = $this->is_sortable();
396         if (is_array($sortable)) {
397             if (array_key_exists($subsort, $sortable)) {
398                 return $sortable[$subsort]['field'] . $this->sortorder($reverse, !empty($sortable[$subsort]['reverse']));
399             } else {
400                 throw new coding_exception('Unexpected $subsort type: ' . $subsort);
401             }
402         } else if ($sortable) {
403             return $sortable . $this->sortorder($reverse);
404         } else {
405             throw new coding_exception('sort_expression called on a non-sortable column.');
406         }
407     }
411 /**
412  * A column with a checkbox for each question with name q{questionid}.
413  *
414  * @copyright  2009 Tim Hunt
415  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
416  */
417 class question_bank_checkbox_column extends question_bank_column_base {
418     protected $strselect;
419     protected $firstrow = true;
421     public function init() {
422         $this->strselect = get_string('select');
423     }
425     public function get_name() {
426         return 'checkbox';
427     }
429     protected function get_title() {
430         return '<input type="checkbox" disabled="disabled" id="qbheadercheckbox" />';
431     }
433     protected function get_title_tip() {
434         return get_string('selectquestionsforbulk', 'question');
435     }
437     protected function display_content($question, $rowclasses) {
438         global $PAGE;
439         echo '<input title="' . $this->strselect . '" type="checkbox" name="q' .
440                 $question->id . '" id="checkq' . $question->id . '" value="1"/>';
441         if ($this->firstrow) {
442             $PAGE->requires->js('/question/qengine.js');
443             $module = array(
444                 'name'      => 'qbank',
445                 'fullpath'  => '/question/qbank.js',
446                 'requires'  => array('yui2-dom', 'yui2-event', 'yui2-container'),
447                 'strings'   => array(),
448                 'async'     => false,
449             );
450             $PAGE->requires->js_init_call('question_bank.init_checkbox_column', array(get_string('selectall'),
451                     get_string('deselectall'), 'checkq' . $question->id), false, $module);
452             $this->firstrow = false;
453         }
454     }
456     public function get_required_fields() {
457         return array('q.id');
458     }
462 /**
463  * A column type for the name of the question type.
464  *
465  * @copyright  2009 Tim Hunt
466  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
467  */
468 class question_bank_question_type_column extends question_bank_column_base {
469     public function get_name() {
470         return 'qtype';
471     }
473     protected function get_title() {
474         return get_string('qtypeveryshort', 'question');
475     }
477     protected function get_title_tip() {
478         return get_string('questiontype', 'question');
479     }
481     protected function display_content($question, $rowclasses) {
482         echo print_question_icon($question);
483     }
485     public function get_required_fields() {
486         return array('q.qtype');
487     }
489     public function is_sortable() {
490         return 'q.qtype';
491     }
495 /**
496  * A column type for the name of the question name.
497  *
498  * @copyright  2009 Tim Hunt
499  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
500  */
501 class question_bank_question_name_column extends question_bank_column_base {
502     protected $checkboxespresent = null;
504     public function get_name() {
505         return 'questionname';
506     }
508     protected function get_title() {
509         return get_string('question');
510     }
512     protected function label_for($question) {
513         if (is_null($this->checkboxespresent)) {
514             $this->checkboxespresent = $this->qbank->has_column('checkbox');
515         }
516         if ($this->checkboxespresent) {
517             return 'checkq' . $question->id;
518         } else {
519             return '';
520         }
521     }
523     protected function display_content($question, $rowclasses) {
524         $labelfor = $this->label_for($question);
525         if ($labelfor) {
526             echo '<label for="' . $labelfor . '">';
527         }
528         echo format_string($question->name);
529         if ($labelfor) {
530             echo '</label>';
531         }
532     }
534     public function get_required_fields() {
535         return array('q.id', 'q.name');
536     }
538     public function is_sortable() {
539         return 'q.name';
540     }
544 /**
545  * A column type for the name of the question creator.
546  *
547  * @copyright  2009 Tim Hunt
548  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
549  */
550 class question_bank_creator_name_column extends question_bank_column_base {
551     public function get_name() {
552         return 'creatorname';
553     }
555     protected function get_title() {
556         return get_string('createdby', 'question');
557     }
559     protected function display_content($question, $rowclasses) {
560         if (!empty($question->creatorfirstname) && !empty($question->creatorlastname)) {
561             $u = new stdClass();
562             $u->firstname = $question->creatorfirstname;
563             $u->lastname = $question->creatorlastname;
564             echo fullname($u);
565         }
566     }
568     public function get_extra_joins() {
569         return array('uc' => 'LEFT JOIN {user} uc ON uc.id = q.createdby');
570     }
572     public function get_required_fields() {
573         return array('uc.firstname AS creatorfirstname', 'uc.lastname AS creatorlastname');
574     }
576     public function is_sortable() {
577         return array(
578             'firstname' => array('field' => 'uc.firstname', 'title' => get_string('firstname')),
579             'lastname' => array('field' => 'uc.lastname', 'title' => get_string('lastname')),
580         );
581     }
585 /**
586  * A column type for the name of the question last modifier.
587  *
588  * @copyright  2009 Tim Hunt
589  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
590  */
591 class question_bank_modifier_name_column extends question_bank_column_base {
592     public function get_name() {
593         return 'modifiername';
594     }
596     protected function get_title() {
597         return get_string('lastmodifiedby', 'question');
598     }
600     protected function display_content($question, $rowclasses) {
601         if (!empty($question->modifierfirstname) && !empty($question->modifierlastname)) {
602             $u = new stdClass();
603             $u->firstname = $question->modifierfirstname;
604             $u->lastname = $question->modifierlastname;
605             echo fullname($u);
606         }
607     }
609     public function get_extra_joins() {
610         return array('um' => 'LEFT JOIN {user} um ON um.id = q.modifiedby');
611     }
613     public function get_required_fields() {
614         return array('um.firstname AS modifierfirstname', 'um.lastname AS modifierlastname');
615     }
617     public function is_sortable() {
618         return array(
619             'firstname' => array('field' => 'um.firstname', 'title' => get_string('firstname')),
620             'lastname' => array('field' => 'um.lastname', 'title' => get_string('lastname')),
621         );
622     }
626 /**
627  * A base class for actions that are an icon that lets you manipulate the question in some way.
628  *
629  * @copyright  2009 Tim Hunt
630  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
631  */
632 abstract class question_bank_action_column_base extends question_bank_column_base {
634     protected function get_title() {
635         return '&#160;';
636     }
638     public function get_extra_classes() {
639         return array('iconcol');
640     }
642     protected function print_icon($icon, $title, $url) {
643         global $OUTPUT;
644         echo '<a title="' . $title . '" href="' . $url . '">
645                 <img src="' . $OUTPUT->pix_url($icon) . '" class="iconsmall" alt="' . $title . '" /></a>';
646     }
648     public function get_required_fields() {
649         // createdby is required for permission checks.
650         return array('q.id', 'q.createdby');
651     }
655 /**
656  * Base class for question bank columns that just contain an action icon.
657  *
658  * @copyright  2009 Tim Hunt
659  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
660  */
661 class question_bank_edit_action_column extends question_bank_action_column_base {
662     protected $stredit;
663     protected $strview;
665     public function init() {
666         parent::init();
667         $this->stredit = get_string('edit');
668         $this->strview = get_string('view');
669     }
671     public function get_name() {
672         return 'editaction';
673     }
675     protected function display_content($question, $rowclasses) {
676         if (question_has_capability_on($question, 'edit')) {
677             $this->print_icon('t/edit', $this->stredit, $this->qbank->edit_question_url($question->id));
678         } else if (question_has_capability_on($question, 'view')) {
679             $this->print_icon('i/info', $this->strview, $this->qbank->edit_question_url($question->id));
680         }
681     }
685 /**
686  * Question bank columns for the preview action icon.
687  *
688  * @copyright  2009 Tim Hunt
689  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
690  */
691 class question_bank_preview_action_column extends question_bank_action_column_base {
692     protected $strpreview;
694     public function init() {
695         parent::init();
696         $this->strpreview = get_string('preview');
697     }
699     public function get_name() {
700         return 'previewaction';
701     }
703     protected function display_content($question, $rowclasses) {
704         global $OUTPUT;
705         if (question_has_capability_on($question, 'use')) {
706             // Build the icon.
707             $image = $OUTPUT->pix_icon('t/preview', $this->strpreview);
709             $link = $this->qbank->preview_question_url($question);
710             $action = new popup_action('click', $link, 'questionpreview',
711                     question_preview_popup_params());
713             echo $OUTPUT->action_link($link, $image, $action, array('title' => $this->strpreview));
714         }
715     }
717     public function get_required_fields() {
718         return array('q.id');
719     }
723 /**
724  * Question bank columns for the move action icon.
725  *
726  * @copyright  2009 Tim Hunt
727  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
728  */
729 class question_bank_move_action_column extends question_bank_action_column_base {
730     protected $strmove;
732     public function init() {
733         parent::init();
734         $this->strmove = get_string('move');
735     }
737     public function get_name() {
738         return 'moveaction';
739     }
741     protected function display_content($question, $rowclasses) {
742         if (question_has_capability_on($question, 'move')) {
743             $this->print_icon('t/move', $this->strmove, $this->qbank->move_question_url($question->id));
744         }
745     }
749 /**
750  * action to delete (or hide) a question, or restore a previously hidden question.
751  *
752  * @copyright  2009 Tim Hunt
753  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
754  */
755 class question_bank_delete_action_column extends question_bank_action_column_base {
756     protected $strdelete;
757     protected $strrestore;
759     public function init() {
760         parent::init();
761         $this->strdelete = get_string('delete');
762         $this->strrestore = get_string('restore');
763     }
765     public function get_name() {
766         return 'deleteaction';
767     }
769     protected function display_content($question, $rowclasses) {
770         if (question_has_capability_on($question, 'edit')) {
771             if ($question->hidden) {
772                 $url = new moodle_url($this->qbank->base_url(), array('unhide' => $question->id, 'sesskey'=>sesskey()));
773                 $this->print_icon('t/restore', $this->strrestore, $url);
774             } else {
775                 $url = new moodle_url($this->qbank->base_url(), array('deleteselected' => $question->id, 'q' . $question->id => 1, 'sesskey'=>sesskey()));
776                 $this->print_icon('t/delete', $this->strdelete, $url);
777             }
778         }
779     }
781     public function get_required_fields() {
782         return array('q.id', 'q.hidden');
783     }
786 /**
787  * Base class for 'columns' that are actually displayed as a row following the main question row.
788  *
789  * @copyright  2009 Tim Hunt
790  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
791  */
792 abstract class question_bank_row_base extends question_bank_column_base {
793     public function is_extra_row() {
794         return true;
795     }
797     protected function display_start($question, $rowclasses) {
798         if ($rowclasses) {
799             echo '<tr class="' . $rowclasses . '">' . "\n";
800         } else {
801             echo "<tr>\n";
802         }
803         echo '<td colspan="' . $this->qbank->get_column_count() . '" class="' . $this->get_name() . '">';
804     }
806     protected function display_end($question, $rowclasses) {
807         echo "</td></tr>\n";
808     }
811 /**
812  * A column type for the name of the question name.
813  *
814  * @copyright  2009 Tim Hunt
815  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
816  */
817 class question_bank_question_text_row extends question_bank_row_base {
818     protected $formatoptions;
820     protected function init() {
821         $this->formatoptions = new stdClass();
822         $this->formatoptions->noclean = true;
823         $this->formatoptions->para = false;
824     }
826     public function get_name() {
827         return 'questiontext';
828     }
830     protected function get_title() {
831         return get_string('questiontext', 'question');
832     }
834     protected function display_content($question, $rowclasses) {
835         $text = question_rewrite_questiontext_preview_urls($question->questiontext,
836                 $question->contextid, 'question', $question->id);
837         $text = format_text($text, $question->questiontextformat,
838                 $this->formatoptions);
839         if ($text == '') {
840             $text = '&#160;';
841         }
842         echo $text;
843     }
845     public function get_extra_joins() {
846         return array('qc' => 'JOIN {question_categories} qc ON qc.id = q.category');
847     }
849     public function get_required_fields() {
850         return array('q.id', 'q.questiontext', 'q.questiontextformat', 'qc.contextid');
851     }
854 /**
855  * This class prints a view of the question bank, including
856  *  + Some controls to allow users to to select what is displayed.
857  *  + A list of questions as a table.
858  *  + Further controls to do things with the questions.
859  *
860  * This class gives a basic view, and provides plenty of hooks where subclasses
861  * can override parts of the display.
862  *
863  * The list of questions presented as a table is generated by creating a list of
864  * question_bank_column objects, one for each 'column' to be displayed. These
865  * manage
866  *  + outputting the contents of that column, given a $question object, but also
867  *  + generating the right fragments of SQL to ensure the necessary data is present,
868  *    and sorted in the right order.
869  *  + outputting table headers.
870  *
871  * @copyright  2009 Tim Hunt
872  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
873  */
874 class question_bank_view {
875     const MAX_SORTS = 3;
877     protected $baseurl;
878     protected $editquestionurl;
879     protected $quizorcourseid;
880     protected $contexts;
881     protected $cm;
882     protected $course;
883     protected $knowncolumntypes;
884     protected $visiblecolumns;
885     protected $extrarows;
886     protected $requiredcolumns;
887     protected $sort;
888     protected $lastchangedid;
889     protected $countsql;
890     protected $loadsql;
891     protected $sqlparams;
893     /**
894      * Constructor
895      * @param question_edit_contexts $contexts
896      * @param moodle_url $pageurl
897      * @param object $course course settings
898      * @param object $cm (optional) activity settings.
899      */
900     public function __construct($contexts, $pageurl, $course, $cm = null) {
901         global $CFG, $PAGE;
903         $this->contexts = $contexts;
904         $this->baseurl = $pageurl;
905         $this->course = $course;
906         $this->cm = $cm;
908         if (!empty($cm) && $cm->modname == 'quiz') {
909             $this->quizorcourseid = '&amp;quizid=' . $cm->instance;
910         } else {
911             $this->quizorcourseid = '&amp;courseid=' .$this->course->id;
912         }
914         // Create the url of the new question page to forward to.
915         $returnurl = $pageurl->out_as_local_url(false);
916         $this->editquestionurl = new moodle_url('/question/question.php',
917                 array('returnurl' => $returnurl));
918         if ($cm !== null){
919             $this->editquestionurl->param('cmid', $cm->id);
920         } else {
921             $this->editquestionurl->param('courseid', $this->course->id);
922         }
924         $this->lastchangedid = optional_param('lastchanged',0,PARAM_INT);
926         $this->init_column_types();
927         $this->init_columns($this->wanted_columns(), $this->heading_column());
928         $this->init_sort();
929     }
931     protected function wanted_columns() {
932         $columns = array('checkbox', 'qtype', 'questionname', 'editaction',
933                 'previewaction', 'moveaction', 'deleteaction', 'creatorname',
934                 'modifiername');
935         if (optional_param('qbshowtext', false, PARAM_BOOL)) {
936             $columns[] = 'questiontext';
937         }
938         return $columns;
939     }
941     /**
942      * Specify the column heading
943      *
944      * @return string Column name for the heading
945      */
946     protected function heading_column() {
947         return 'questionname';
948     }
950     protected function known_field_types() {
951         return array(
952             new question_bank_checkbox_column($this),
953             new question_bank_question_type_column($this),
954             new question_bank_question_name_column($this),
955             new question_bank_creator_name_column($this),
956             new question_bank_modifier_name_column($this),
957             new question_bank_edit_action_column($this),
958             new question_bank_preview_action_column($this),
959             new question_bank_move_action_column($this),
960             new question_bank_delete_action_column($this),
961             new question_bank_question_text_row($this),
962         );
963     }
965     protected function init_column_types() {
966         $this->knowncolumntypes = array();
967         foreach ($this->known_field_types() as $col) {
968             $this->knowncolumntypes[$col->get_name()] = $col;
969         }
970     }
972     /**
973      * Initializing table columns
974      *
975      * @param array $wanted Collection of column names
976      * @param string $heading The name of column that is set as heading
977      */
978     protected function init_columns($wanted, $heading = '') {
979         $this->visiblecolumns = array();
980         $this->extrarows = array();
981         foreach ($wanted as $colname) {
982             if (!isset($this->knowncolumntypes[$colname])) {
983                 throw new coding_exception('Unknown column type ' . $colname . ' requested in init columns.');
984             }
985             $column = $this->knowncolumntypes[$colname];
986             if ($column->is_extra_row()) {
987                 $this->extrarows[$colname] = $column;
988             } else {
989                 $this->visiblecolumns[$colname] = $column;
990             }
991         }
992         $this->requiredcolumns = array_merge($this->visiblecolumns, $this->extrarows);
993         if (array_key_exists($heading, $this->requiredcolumns)) {
994             $this->requiredcolumns[$heading]->set_as_heading();
995         }
996     }
998     /**
999      * @param string $colname a column internal name.
1000      * @return bool is this column included in the output?
1001      */
1002     public function has_column($colname) {
1003         return isset($this->visiblecolumns[$colname]);
1004     }
1006     /**
1007      * @return int The number of columns in the table.
1008      */
1009     public function get_column_count() {
1010         return count($this->visiblecolumns);
1011     }
1013     public function get_courseid() {
1014         return $this->course->id;
1015     }
1017     protected function init_sort() {
1018         $this->init_sort_from_params();
1019         if (empty($this->sort)) {
1020             $this->sort = $this->default_sort();
1021         }
1022     }
1024     /**
1025      * Deal with a sort name of the form columnname, or colname_subsort by
1026      * breaking it up, validating the bits that are presend, and returning them.
1027      * If there is no subsort, then $subsort is returned as ''.
1028      * @return array array($colname, $subsort).
1029      */
1030     protected function parse_subsort($sort) {
1031     /// Do the parsing.
1032         if (strpos($sort, '_') !== false) {
1033             list($colname, $subsort) = explode('_', $sort, 2);
1034         } else {
1035             $colname = $sort;
1036             $subsort = '';
1037         }
1038     /// Validate the column name.
1039         if (!isset($this->knowncolumntypes[$colname]) || !$this->knowncolumntypes[$colname]->is_sortable()) {
1040             for ($i = 1; $i <= question_bank_view::MAX_SORTS; $i++) {
1041                 $this->baseurl->remove_params('qbs' . $i);
1042             }
1043             throw new moodle_exception('unknownsortcolumn', '', $link = $this->baseurl->out(), $colname);
1044         }
1045     /// Validate the subsort, if present.
1046         if ($subsort) {
1047             $subsorts = $this->knowncolumntypes[$colname]->is_sortable();
1048             if (!is_array($subsorts) || !isset($subsorts[$subsort])) {
1049                 throw new moodle_exception('unknownsortcolumn', '', $link = $this->baseurl->out(), $sort);
1050             }
1051         }
1052         return array($colname, $subsort);
1053     }
1055     protected function init_sort_from_params() {
1056         $this->sort = array();
1057         for ($i = 1; $i <= question_bank_view::MAX_SORTS; $i++) {
1058             if (!$sort = optional_param('qbs' . $i, '', PARAM_ALPHAEXT)) {
1059                 break;
1060             }
1061             // Work out the appropriate order.
1062             $order = 1;
1063             if ($sort[0] == '-') {
1064                 $order = -1;
1065                 $sort = substr($sort, 1);
1066                 if (!$sort) {
1067                     break;
1068                 }
1069             }
1070             // Deal with subsorts.
1071             list($colname, $subsort) = $this->parse_subsort($sort);
1072             $this->requiredcolumns[$colname] = $this->knowncolumntypes[$colname];
1073             $this->sort[$sort] = $order;
1074         }
1075     }
1077     protected function sort_to_params($sorts) {
1078         $params = array();
1079         $i = 0;
1080         foreach ($sorts as $sort => $order) {
1081             $i += 1;
1082             if ($order < 0) {
1083                 $sort = '-' . $sort;
1084             }
1085             $params['qbs' . $i] = $sort;
1086         }
1087         return $params;
1088     }
1090     protected function default_sort() {
1091         $this->requiredcolumns['qtype'] = $this->knowncolumntypes['qtype'];
1092         $this->requiredcolumns['questionname'] = $this->knowncolumntypes['questionname'];
1093         return array('qtype' => 1, 'questionname' => 1);
1094     }
1096     /**
1097      * @param $sort a column or column_subsort name.
1098      * @return int the current sort order for this column -1, 0, 1
1099      */
1100     public function get_primary_sort_order($sort) {
1101         $order = reset($this->sort);
1102         $primarysort = key($this->sort);
1103         if ($sort == $primarysort) {
1104             return $order;
1105         } else {
1106             return 0;
1107         }
1108     }
1110     /**
1111      * Get a URL to redisplay the page with a new sort for the question bank.
1112      * @param string $sort the column, or column_subsort to sort on.
1113      * @param bool $newsortreverse whether to sort in reverse order.
1114      * @return string The new URL.
1115      */
1116     public function new_sort_url($sort, $newsortreverse) {
1117         if ($newsortreverse) {
1118             $order = -1;
1119         } else {
1120             $order = 1;
1121         }
1122         // Tricky code to add the new sort at the start, removing it from where it was before, if it was present.
1123         $newsort = array_reverse($this->sort);
1124         if (isset($newsort[$sort])) {
1125             unset($newsort[$sort]);
1126         }
1127         $newsort[$sort] = $order;
1128         $newsort = array_reverse($newsort);
1129         if (count($newsort) > question_bank_view::MAX_SORTS) {
1130             $newsort = array_slice($newsort, 0, question_bank_view::MAX_SORTS, true);
1131         }
1132         return $this->baseurl->out(true, $this->sort_to_params($newsort));
1133     }
1135     protected function build_query_sql($category, $recurse, $showhidden) {
1136         global $DB;
1138     /// Get the required tables.
1139         $joins = array();
1140         foreach ($this->requiredcolumns as $column) {
1141             $extrajoins = $column->get_extra_joins();
1142             foreach ($extrajoins as $prefix => $join) {
1143                 if (isset($joins[$prefix]) && $joins[$prefix] != $join) {
1144                     throw new coding_exception('Join ' . $join . ' conflicts with previous join ' . $joins[$prefix]);
1145                 }
1146                 $joins[$prefix] = $join;
1147             }
1148         }
1150     /// Get the required fields.
1151         $fields = array('q.hidden', 'q.category');
1152         foreach ($this->visiblecolumns as $column) {
1153             $fields = array_merge($fields, $column->get_required_fields());
1154         }
1155         foreach ($this->extrarows as $row) {
1156             $fields = array_merge($fields, $row->get_required_fields());
1157         }
1158         $fields = array_unique($fields);
1160     /// Build the order by clause.
1161         $sorts = array();
1162         foreach ($this->sort as $sort => $order) {
1163             list($colname, $subsort) = $this->parse_subsort($sort);
1164             $sorts[] = $this->requiredcolumns[$colname]->sort_expression($order < 0, $subsort);
1165         }
1167     /// Build the where clause.
1168         $tests = array('q.parent = 0');
1170         if (!$showhidden) {
1171             $tests[] = 'q.hidden = 0';
1172         }
1174         if ($recurse) {
1175             $categoryids = question_categorylist($category->id);
1176         } else {
1177             $categoryids = array($category->id);
1178         }
1179         list($catidtest, $params) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED, 'cat');
1180         $tests[] = 'q.category ' . $catidtest;
1181         $this->sqlparams = $params;
1183     /// Build the SQL.
1184         $sql = ' FROM {question} q ' . implode(' ', $joins);
1185         $sql .= ' WHERE ' . implode(' AND ', $tests);
1186         $this->countsql = 'SELECT count(1)' . $sql;
1187         $this->loadsql = 'SELECT ' . implode(', ', $fields) . $sql . ' ORDER BY ' . implode(', ', $sorts);
1188         $this->sqlparams = $params;
1189     }
1191     protected function get_question_count() {
1192         global $DB;
1193         return $DB->count_records_sql($this->countsql, $this->sqlparams);
1194     }
1196     protected function load_page_questions($page, $perpage) {
1197         global $DB;
1198         $questions = $DB->get_recordset_sql($this->loadsql, $this->sqlparams, $page*$perpage, $perpage);
1199         if (!$questions->valid()) {
1200         /// No questions on this page. Reset to page 0.
1201             $questions = $DB->get_recordset_sql($this->loadsql, $this->sqlparams, 0, $perpage);
1202         }
1203         return $questions;
1204     }
1206     public function base_url() {
1207         return $this->baseurl;
1208     }
1210     public function edit_question_url($questionid) {
1211         return $this->editquestionurl->out(true, array('id' => $questionid));
1212     }
1214     public function move_question_url($questionid) {
1215         return $this->editquestionurl->out(true, array('id' => $questionid, 'movecontext' => 1));
1216     }
1218     public function preview_question_url($question) {
1219         return question_preview_url($question->id, null, null, null, null,
1220                 $this->contexts->lowest());
1221     }
1223     /**
1224      * Shows the question bank editing interface.
1225      *
1226      * The function also processes a number of actions:
1227      *
1228      * Actions affecting the question pool:
1229      * move           Moves a question to a different category
1230      * deleteselected Deletes the selected questions from the category
1231      * Other actions:
1232      * category      Chooses the category
1233      * displayoptions Sets display options
1234      */
1235     public function display($tabname, $page, $perpage, $cat,
1236             $recurse, $showhidden, $showquestiontext) {
1237         global $PAGE, $OUTPUT;
1239         if ($this->process_actions_needing_ui()) {
1240             return;
1241         }
1243         // Category selection form
1244         echo $OUTPUT->heading(get_string('questionbank', 'question'), 2);
1246         $this->display_category_form($this->contexts->having_one_edit_tab_cap($tabname),
1247                 $this->baseurl, $cat);
1248         $this->display_options($recurse, $showhidden, $showquestiontext);
1250         if (!$category = $this->get_current_category($cat)) {
1251             return;
1252         }
1253         $this->print_category_info($category);
1255         // continues with list of questions
1256         $this->display_question_list($this->contexts->having_one_edit_tab_cap($tabname),
1257                 $this->baseurl, $cat, $this->cm,
1258                 $recurse, $page, $perpage, $showhidden, $showquestiontext,
1259                 $this->contexts->having_cap('moodle/question:add'));
1260     }
1262     protected function print_choose_category_message($categoryandcontext) {
1263         echo "<p style=\"text-align:center;\"><b>";
1264         print_string('selectcategoryabove', 'question');
1265         echo "</b></p>";
1266     }
1268     protected function get_current_category($categoryandcontext) {
1269         global $DB, $OUTPUT;
1270         list($categoryid, $contextid) = explode(',', $categoryandcontext);
1271         if (!$categoryid) {
1272             $this->print_choose_category_message($categoryandcontext);
1273             return false;
1274         }
1276         if (!$category = $DB->get_record('question_categories',
1277                 array('id' => $categoryid, 'contextid' => $contextid))) {
1278             echo $OUTPUT->box_start('generalbox questionbank');
1279             echo $OUTPUT->notification('Category not found!');
1280             echo $OUTPUT->box_end();
1281             return false;
1282         }
1284         return $category;
1285     }
1287     protected function print_category_info($category) {
1288         $formatoptions = new stdClass();
1289         $formatoptions->noclean = true;
1290         $formatoptions->overflowdiv = true;
1291         echo '<div class="boxaligncenter">';
1292         echo format_text($category->info, $category->infoformat, $formatoptions, $this->course->id);
1293         echo "</div>\n";
1294     }
1296     /**
1297      * prints a form to choose categories
1298      */
1299     protected function display_category_form($contexts, $pageurl, $current) {
1300         global $CFG, $OUTPUT;
1302     /// Get all the existing categories now
1303         echo '<div class="choosecategory">';
1304         $catmenu = question_category_options($contexts, false, 0, true);
1306         $select = new single_select($this->baseurl, 'category', $catmenu, $current, null, 'catmenu');
1307         $select->set_label(get_string('selectacategory', 'question'));
1308         echo $OUTPUT->render($select);
1309         echo "</div>\n";
1310     }
1312     protected function display_options($recurse, $showhidden, $showquestiontext) {
1313         echo '<form method="get" action="edit.php" id="displayoptions">';
1314         echo "<fieldset class='invisiblefieldset'>";
1315         echo html_writer::input_hidden_params($this->baseurl, array('recurse', 'showhidden', 'qbshowtext'));
1316         $this->display_category_form_checkbox('recurse', $recurse, get_string('includesubcategories', 'question'));
1317         $this->display_category_form_checkbox('showhidden', $showhidden, get_string('showhidden', 'question'));
1318         $this->display_category_form_checkbox('qbshowtext', $showquestiontext, get_string('showquestiontext', 'question'));
1319         echo '<noscript><div class="centerpara"><input type="submit" value="'. get_string('go') .'" />';
1320         echo '</div></noscript></fieldset></form>';
1321     }
1323     /**
1324      * Print a single option checkbox. Used by the preceeding.
1325      */
1326     protected function display_category_form_checkbox($name, $value, $label) {
1327         echo '<div><input type="hidden" id="' . $name . '_off" name="' . $name . '" value="0" />';
1328         echo '<input type="checkbox" id="' . $name . '_on" name="' . $name . '" value="1"';
1329         if ($value) {
1330             echo ' checked="checked"';
1331         }
1332         echo ' onchange="getElementById(\'displayoptions\').submit(); return true;" />';
1333         echo '<label for="' . $name . '_on">' . $label . '</label>';
1334         echo "</div>\n";
1335     }
1337     protected function create_new_question_form($category, $canadd) {
1338         global $CFG;
1339         echo '<div class="createnewquestion">';
1340         if ($canadd) {
1341             create_new_question_button($category->id, $this->editquestionurl->params(),
1342                     get_string('createnewquestion', 'question'));
1343         } else {
1344             print_string('nopermissionadd', 'question');
1345         }
1346         echo '</div>';
1347     }
1349     /**
1350     * Prints the table of questions in a category with interactions
1351     *
1352     * @param object $course   The course object
1353     * @param int $categoryid  The id of the question category to be displayed
1354     * @param int $cm      The course module record if we are in the context of a particular module, 0 otherwise
1355     * @param int $recurse     This is 1 if subcategories should be included, 0 otherwise
1356     * @param int $page        The number of the page to be displayed
1357     * @param int $perpage     Number of questions to show per page
1358     * @param bool $showhidden   True if also hidden questions should be displayed
1359     * @param bool $showquestiontext whether the text of each question should be shown in the list
1360     */
1361     protected function display_question_list($contexts, $pageurl, $categoryandcontext,
1362             $cm = null, $recurse=1, $page=0, $perpage=100, $showhidden=false,
1363             $showquestiontext = false, $addcontexts = array()) {
1364         global $CFG, $DB, $OUTPUT;
1366         $category = $this->get_current_category($categoryandcontext);
1368         $cmoptions = new stdClass();
1369         $cmoptions->hasattempts = !empty($this->quizhasattempts);
1371         $strselectall = get_string('selectall');
1372         $strselectnone = get_string('deselectall');
1373         $strdelete = get_string('delete');
1375         list($categoryid, $contextid) = explode(',', $categoryandcontext);
1376         $catcontext = context::instance_by_id($contextid);
1378         $canadd = has_capability('moodle/question:add', $catcontext);
1379         $caneditall =has_capability('moodle/question:editall', $catcontext);
1380         $canuseall =has_capability('moodle/question:useall', $catcontext);
1381         $canmoveall =has_capability('moodle/question:moveall', $catcontext);
1383         $this->create_new_question_form($category, $canadd);
1385         $this->build_query_sql($category, $recurse, $showhidden);
1386         $totalnumber = $this->get_question_count();
1387         if ($totalnumber == 0) {
1388             return;
1389         }
1391         $questions = $this->load_page_questions($page, $perpage);
1393         echo '<div class="categorypagingbarcontainer">';
1394         $pageing_url = new moodle_url('edit.php');
1395         $r = $pageing_url->params($pageurl->params());
1396         $pagingbar = new paging_bar($totalnumber, $page, $perpage, $pageing_url);
1397         $pagingbar->pagevar = 'qpage';
1398         echo $OUTPUT->render($pagingbar);
1399         echo '</div>';
1401         echo '<form method="post" action="edit.php">';
1402         echo '<fieldset class="invisiblefieldset" style="display: block;">';
1403         echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
1404         echo html_writer::input_hidden_params($pageurl);
1406         echo '<div class="categoryquestionscontainer">';
1407         $this->start_table();
1408         $rowcount = 0;
1409         foreach ($questions as $question) {
1410             $this->print_table_row($question, $rowcount);
1411             $rowcount += 1;
1412         }
1413         $this->end_table();
1414         echo "</div>\n";
1416         echo '<div class="categorypagingbarcontainer pagingbottom">';
1417         echo $OUTPUT->render($pagingbar);
1418         if ($totalnumber > DEFAULT_QUESTIONS_PER_PAGE) {
1419             if ($perpage == DEFAULT_QUESTIONS_PER_PAGE) {
1420                 $url = new moodle_url('edit.php', array_merge($pageurl->params(), array('qperpage'=>1000)));
1421                 $showall = '<a href="'.$url.'">'.get_string('showall', 'moodle', $totalnumber).'</a>';
1422             } else {
1423                 $url = new moodle_url('edit.php', array_merge($pageurl->params(), array('qperpage'=>DEFAULT_QUESTIONS_PER_PAGE)));
1424                 $showall = '<a href="'.$url.'">'.get_string('showperpage', 'moodle', DEFAULT_QUESTIONS_PER_PAGE).'</a>';
1425             }
1426             echo "<div class='paging'>$showall</div>";
1427         }
1428         echo '</div>';
1430         echo '<div class="modulespecificbuttonscontainer">';
1431         if ($caneditall || $canmoveall || $canuseall){
1432             echo '<strong>&nbsp;'.get_string('withselected', 'question').':</strong><br />';
1434             if (function_exists('module_specific_buttons')) {
1435                 echo module_specific_buttons($this->cm->id,$cmoptions);
1436             }
1438             // print delete and move selected question
1439             if ($caneditall) {
1440                 echo '<input type="submit" name="deleteselected" value="' . $strdelete . "\" />\n";
1441             }
1443             if ($canmoveall && count($addcontexts)) {
1444                 echo '<input type="submit" name="move" value="'.get_string('moveto', 'question')."\" />\n";
1445                 question_category_select_menu($addcontexts, false, 0, "$category->id,$category->contextid");
1446             }
1448             if (function_exists('module_specific_controls') && $canuseall) {
1449                 $modulespecific = module_specific_controls($totalnumber, $recurse, $category, $this->cm->id,$cmoptions);
1450                 if(!empty($modulespecific)){
1451                     echo "<hr />$modulespecific";
1452                 }
1453             }
1454         }
1455         echo "</div>\n";
1457         echo '</fieldset>';
1458         echo "</form>\n";
1459     }
1461     protected function start_table() {
1462         echo '<table id="categoryquestions">' . "\n";
1463         echo "<thead>\n";
1464         $this->print_table_headers();
1465         echo "</thead>\n";
1466         echo "<tbody>\n";
1467     }
1469     protected function end_table() {
1470         echo "</tbody>\n";
1471         echo "</table>\n";
1472     }
1474     protected function print_table_headers() {
1475         echo "<tr>\n";
1476         foreach ($this->visiblecolumns as $column) {
1477             $column->display_header();
1478         }
1479         echo "</tr>\n";
1480     }
1482     protected function get_row_classes($question, $rowcount) {
1483         $classes = array();
1484         if ($question->hidden) {
1485             $classes[] = 'dimmed_text';
1486         }
1487         if ($question->id == $this->lastchangedid) {
1488             $classes[] ='highlight';
1489         }
1490         $classes[] = 'r' . ($rowcount % 2);
1491         return $classes;
1492     }
1494     protected function print_table_row($question, $rowcount) {
1495         $rowclasses = implode(' ', $this->get_row_classes($question, $rowcount));
1496         if ($rowclasses) {
1497             echo '<tr class="' . $rowclasses . '">' . "\n";
1498         } else {
1499             echo "<tr>\n";
1500         }
1501         foreach ($this->visiblecolumns as $column) {
1502             $column->display($question, $rowclasses);
1503         }
1504         echo "</tr>\n";
1505         foreach ($this->extrarows as $row) {
1506             $row->display($question, $rowclasses);
1507         }
1508     }
1510     public function process_actions() {
1511         global $CFG, $DB;
1512         /// Now, check for commands on this page and modify variables as necessary
1513         if (optional_param('move', false, PARAM_BOOL) and confirm_sesskey()) {
1514             // Move selected questions to new category
1515             $category = required_param('category', PARAM_SEQUENCE);
1516             list($tocategoryid, $contextid) = explode(',', $category);
1517             if (! $tocategory = $DB->get_record('question_categories', array('id' => $tocategoryid, 'contextid' => $contextid))) {
1518                 print_error('cannotfindcate', 'question');
1519             }
1520             $tocontext = context::instance_by_id($contextid);
1521             require_capability('moodle/question:add', $tocontext);
1522             $rawdata = (array) data_submitted();
1523             $questionids = array();
1524             foreach ($rawdata as $key => $value) {    // Parse input for question ids
1525                 if (preg_match('!^q([0-9]+)$!', $key, $matches)) {
1526                     $key = $matches[1];
1527                     $questionids[] = $key;
1528                 }
1529             }
1530             if ($questionids) {
1531                 list($usql, $params) = $DB->get_in_or_equal($questionids);
1532                 $sql = "";
1533                 $questions = $DB->get_records_sql("
1534                         SELECT q.*, c.contextid
1535                         FROM {question} q
1536                         JOIN {question_categories} c ON c.id = q.category
1537                         WHERE q.id $usql", $params);
1538                 foreach ($questions as $question){
1539                     question_require_capability_on($question, 'move');
1540                 }
1541                 question_move_questions_to_category($questionids, $tocategory->id);
1542                 redirect($this->baseurl->out(false,
1543                         array('category' => "$tocategoryid,$contextid")));
1544             }
1545         }
1547         if (optional_param('deleteselected', false, PARAM_BOOL)) { // delete selected questions from the category
1548             if (($confirm = optional_param('confirm', '', PARAM_ALPHANUM)) and confirm_sesskey()) { // teacher has already confirmed the action
1549                 $deleteselected = required_param('deleteselected', PARAM_RAW);
1550                 if ($confirm == md5($deleteselected)) {
1551                     if ($questionlist = explode(',', $deleteselected)) {
1552                         // for each question either hide it if it is in use or delete it
1553                         foreach ($questionlist as $questionid) {
1554                             $questionid = (int)$questionid;
1555                             question_require_capability_on($questionid, 'edit');
1556                             if (questions_in_use(array($questionid))) {
1557                                 $DB->set_field('question', 'hidden', 1, array('id' => $questionid));
1558                             } else {
1559                                 question_delete_question($questionid);
1560                             }
1561                         }
1562                     }
1563                     redirect($this->baseurl);
1564                 } else {
1565                     print_error('invalidconfirm', 'question');
1566                 }
1567             }
1568         }
1570         // Unhide a question
1571         if(($unhide = optional_param('unhide', '', PARAM_INT)) and confirm_sesskey()) {
1572             question_require_capability_on($unhide, 'edit');
1573             $DB->set_field('question', 'hidden', 0, array('id' => $unhide));
1575             // Purge these questions from the cache.
1576             question_bank::notify_question_edited($unhide);
1578             redirect($this->baseurl);
1579         }
1580     }
1582     public function process_actions_needing_ui() {
1583         global $DB, $OUTPUT;
1584         if (optional_param('deleteselected', false, PARAM_BOOL)) {
1585             // make a list of all the questions that are selected
1586             $rawquestions = $_REQUEST; // This code is called by both POST forms and GET links, so cannot use data_submitted.
1587             $questionlist = '';  // comma separated list of ids of questions to be deleted
1588             $questionnames = ''; // string with names of questions separated by <br /> with
1589                                  // an asterix in front of those that are in use
1590             $inuse = false;      // set to true if at least one of the questions is in use
1591             foreach ($rawquestions as $key => $value) {    // Parse input for question ids
1592                 if (preg_match('!^q([0-9]+)$!', $key, $matches)) {
1593                     $key = $matches[1];
1594                     $questionlist .= $key.',';
1595                     question_require_capability_on($key, 'edit');
1596                     if (questions_in_use(array($key))) {
1597                         $questionnames .= '* ';
1598                         $inuse = true;
1599                     }
1600                     $questionnames .= $DB->get_field('question', 'name', array('id' => $key)) . '<br />';
1601                 }
1602             }
1603             if (!$questionlist) { // no questions were selected
1604                 redirect($this->baseurl);
1605             }
1606             $questionlist = rtrim($questionlist, ',');
1608             // Add an explanation about questions in use
1609             if ($inuse) {
1610                 $questionnames .= '<br />'.get_string('questionsinuse', 'question');
1611             }
1612             $baseurl = new moodle_url('edit.php', $this->baseurl->params());
1613             $deleteurl = new moodle_url($baseurl, array('deleteselected'=>$questionlist, 'confirm'=>md5($questionlist), 'sesskey'=>sesskey()));
1615             echo $OUTPUT->confirm(get_string('deletequestionscheck', 'question', $questionnames), $deleteurl, $baseurl);
1617             return true;
1618         }
1619     }
1622 /**
1623  * Common setup for all pages for editing questions.
1624  * @param string $baseurl the name of the script calling this funciton. For examle 'qusetion/edit.php'.
1625  * @param string $edittab code for this edit tab
1626  * @param bool $requirecmid require cmid? default false
1627  * @param bool $requirecourseid require courseid, if cmid is not given? default true
1628  * @return array $thispageurl, $contexts, $cmid, $cm, $module, $pagevars
1629  */
1630 function question_edit_setup($edittab, $baseurl, $requirecmid = false, $requirecourseid = true) {
1631     global $DB, $PAGE;
1633     $thispageurl = new moodle_url($baseurl);
1634     $thispageurl->remove_all_params(); // We are going to explicity add back everything important - this avoids unwanted params from being retained.
1636     if ($requirecmid){
1637         $cmid =required_param('cmid', PARAM_INT);
1638     } else {
1639         $cmid = optional_param('cmid', 0, PARAM_INT);
1640     }
1641     if ($cmid){
1642         list($module, $cm) = get_module_from_cmid($cmid);
1643         $courseid = $cm->course;
1644         $thispageurl->params(compact('cmid'));
1645         require_login($courseid, false, $cm);
1646         $thiscontext = context_module::instance($cmid);
1647     } else {
1648         $module = null;
1649         $cm = null;
1650         if ($requirecourseid){
1651             $courseid  = required_param('courseid', PARAM_INT);
1652         } else {
1653             $courseid  = optional_param('courseid', 0, PARAM_INT);
1654         }
1655         if ($courseid){
1656             $thispageurl->params(compact('courseid'));
1657             require_login($courseid, false);
1658             $thiscontext = context_course::instance($courseid);
1659         } else {
1660             $thiscontext = null;
1661         }
1662     }
1664     if ($thiscontext){
1665         $contexts = new question_edit_contexts($thiscontext);
1666         $contexts->require_one_edit_tab_cap($edittab);
1668     } else {
1669         $contexts = null;
1670     }
1672     $PAGE->set_pagelayout('admin');
1674     $pagevars['qpage'] = optional_param('qpage', -1, PARAM_INT);
1676     //pass 'cat' from page to page and when 'category' comes from a drop down menu
1677     //then we also reset the qpage so we go to page 1 of
1678     //a new cat.
1679     $pagevars['cat'] = optional_param('cat', 0, PARAM_SEQUENCE); // if empty will be set up later
1680     if ($category = optional_param('category', 0, PARAM_SEQUENCE)) {
1681         if ($pagevars['cat'] != $category) { // is this a move to a new category?
1682             $pagevars['cat'] = $category;
1683             $pagevars['qpage'] = 0;
1684         }
1685     }
1686     if ($pagevars['cat']){
1687         $thispageurl->param('cat', $pagevars['cat']);
1688     }
1689     if (strpos($baseurl, '/question/') === 0) {
1690         navigation_node::override_active_url($thispageurl);
1691     }
1693     if ($pagevars['qpage'] > -1) {
1694         $thispageurl->param('qpage', $pagevars['qpage']);
1695     } else {
1696         $pagevars['qpage'] = 0;
1697     }
1699     $pagevars['qperpage'] = question_get_display_preference(
1700             'qperpage', DEFAULT_QUESTIONS_PER_PAGE, PARAM_INT, $thispageurl);
1702     for ($i = 1; $i <= question_bank_view::MAX_SORTS; $i++) {
1703         $param = 'qbs' . $i;
1704         if (!$sort = optional_param($param, '', PARAM_ALPHAEXT)) {
1705             break;
1706         }
1707         $thispageurl->param($param, $sort);
1708     }
1710     $defaultcategory = question_make_default_categories($contexts->all());
1712     $contextlistarr = array();
1713     foreach ($contexts->having_one_edit_tab_cap($edittab) as $context){
1714         $contextlistarr[] = "'$context->id'";
1715     }
1716     $contextlist = join($contextlistarr, ' ,');
1717     if (!empty($pagevars['cat'])){
1718         $catparts = explode(',', $pagevars['cat']);
1719         if (!$catparts[0] || (false !== array_search($catparts[1], $contextlistarr)) ||
1720                 !$DB->count_records_select("question_categories", "id = ? AND contextid = ?", array($catparts[0], $catparts[1]))) {
1721             print_error('invalidcategory', 'question');
1722         }
1723     } else {
1724         $category = $defaultcategory;
1725         $pagevars['cat'] = "$category->id,$category->contextid";
1726     }
1728     // Display options.
1729     $pagevars['recurse']    = question_get_display_preference('recurse',    1, PARAM_BOOL, $thispageurl);
1730     $pagevars['showhidden'] = question_get_display_preference('showhidden', 0, PARAM_BOOL, $thispageurl);
1731     $pagevars['qbshowtext'] = question_get_display_preference('qbshowtext', 0, PARAM_BOOL, $thispageurl);
1733     // Category list page.
1734     $pagevars['cpage'] = optional_param('cpage', 1, PARAM_INT);
1735     if ($pagevars['cpage'] != 1){
1736         $thispageurl->param('cpage', $pagevars['cpage']);
1737     }
1739     return array($thispageurl, $contexts, $cmid, $cm, $module, $pagevars);
1742 /**
1743  * Get a particular question preference that is also stored as a user preference.
1744  * If the the value is given in the GET/POST request, then that value is used,
1745  * and the user preference is updated to that value. Otherwise, the last set
1746  * value of the user preference is used, or if it has never been set the default
1747  * passed to this function.
1748  *
1749  * @param string $param the param name. The URL parameter set, and the GET/POST
1750  *      parameter read. The user_preference name is 'question_bank_' . $param.
1751  * @param mixed $default The default value to use, if not otherwise set.
1752  * @param int $type one of the PARAM_... constants.
1753  * @param moodle_url $thispageurl if the value has been explicitly set, we add
1754  *      it to this URL.
1755  * @return mixed the parameter value to use.
1756  */
1757 function question_get_display_preference($param, $default, $type, $thispageurl) {
1758     $submittedvalue = optional_param($param, null, $type);
1759     if (is_null($submittedvalue)) {
1760         return get_user_preferences('question_bank_' . $param, $default);
1761     }
1763     set_user_preference('question_bank_' . $param, $submittedvalue);
1764     $thispageurl->param($param, $submittedvalue);
1765     return $submittedvalue;
1768 /**
1769  * Make sure user is logged in as required in this context.
1770  */
1771 function require_login_in_context($contextorid = null){
1772     global $DB, $CFG;
1773     if (!is_object($contextorid)){
1774         $context = context::instance_by_id($contextorid, IGNORE_MISSING);
1775     } else {
1776         $context = $contextorid;
1777     }
1778     if ($context && ($context->contextlevel == CONTEXT_COURSE)) {
1779         require_login($context->instanceid);
1780     } else if ($context && ($context->contextlevel == CONTEXT_MODULE)) {
1781         if ($cm = $DB->get_record('course_modules',array('id' =>$context->instanceid))) {
1782             if (!$course = $DB->get_record('course', array('id' => $cm->course))) {
1783                 print_error('invalidcourseid');
1784             }
1785             require_course_login($course, true, $cm);
1787         } else {
1788             print_error('invalidcoursemodule');
1789         }
1790     } else if ($context && ($context->contextlevel == CONTEXT_SYSTEM)) {
1791         if (!empty($CFG->forcelogin)) {
1792             require_login();
1793         }
1795     } else {
1796         require_login();
1797     }
1800 /**
1801  * Print a form to let the user choose which question type to add.
1802  * When the form is submitted, it goes to the question.php script.
1803  * @param $hiddenparams hidden parameters to add to the form, in addition to
1804  *      the qtype radio buttons.
1805  * @param $allowedqtypes optional list of qtypes that are allowed. If given, only
1806  *      those qtypes will be shown. Example value array('description', 'multichoice').
1807  */
1808 function print_choose_qtype_to_add_form($hiddenparams, array $allowedqtypes = null) {
1809     global $CFG, $PAGE, $OUTPUT;
1811     echo '<div id="chooseqtypehead" class="hd">' . "\n";
1812     echo $OUTPUT->heading(get_string('chooseqtypetoadd', 'question'), 3);
1813     echo "</div>\n";
1814     echo '<div id="chooseqtype">' . "\n";
1815     echo '<form action="' . $CFG->wwwroot . '/question/question.php" method="get"><div id="qtypeformdiv">' . "\n";
1816     foreach ($hiddenparams as $name => $value) {
1817         echo '<input type="hidden" name="' . s($name) . '" value="' . s($value) . '" />' . "\n";
1818     }
1819     echo "</div>\n";
1820     echo '<div class="qtypes">' . "\n";
1821     echo '<div class="instruction">' . get_string('selectaqtypefordescription', 'question') . "</div>\n";
1822     echo '<div class="realqtypes">' . "\n";
1823     $fakeqtypes = array();
1824     foreach (question_bank::get_creatable_qtypes() as $qtypename => $qtype) {
1825         if ($allowedqtypes && !in_array($qtypename, $allowedqtypes)) {
1826             continue;
1827         }
1828         if ($qtype->is_real_question_type()) {
1829             print_qtype_to_add_option($qtype);
1830         } else {
1831             $fakeqtypes[] = $qtype;
1832         }
1833     }
1834     echo "</div>\n";
1835     echo '<div class="fakeqtypes">' . "\n";
1836     foreach ($fakeqtypes as $qtype) {
1837         print_qtype_to_add_option($qtype);
1838     }
1839     echo "</div>\n";
1840     echo "</div>\n";
1841     echo '<div class="submitbuttons">' . "\n";
1842     echo '<input type="submit" value="' . get_string('next') . '" id="chooseqtype_submit" />' . "\n";
1843     echo '<input type="submit" id="chooseqtypecancel" name="addcancel" value="' . get_string('cancel') . '" />' . "\n";
1844     echo "</div></form>\n";
1845     echo "</div>\n";
1847     $PAGE->requires->js('/question/qengine.js');
1848     $module = array(
1849         'name'      => 'qbank',
1850         'fullpath'  => '/question/qbank.js',
1851         'requires'  => array('yui2-dom', 'yui2-event', 'yui2-container'),
1852         'strings'   => array(),
1853         'async'     => false,
1854     );
1855     $PAGE->requires->js_init_call('qtype_chooser.init', array('chooseqtype'), false, $module);
1858 /**
1859  * Private function used by the preceding one.
1860  * @param question_type $qtype the question type.
1861  */
1862 function print_qtype_to_add_option($qtype) {
1863     echo '<div class="qtypeoption">' . "\n";
1864     echo '<label for="' . $qtype->plugin_name() . '">';
1865     echo '<input type="radio" name="qtype" id="' . $qtype->plugin_name() .
1866             '" value="' . $qtype->name() . '" />';
1867     echo '<span class="qtypename">';
1868     $fakequestion = new stdClass();
1869     $fakequestion->qtype = $qtype->name();
1870     echo print_question_icon($fakequestion);
1871     echo $qtype->menu_name() . '</span><span class="qtypesummary">' .
1872             get_string('pluginnamesummary', $qtype->plugin_name());
1873     echo "</span></label>\n";
1874     echo "</div>\n";
1877 /**
1878  * Print a button for creating a new question. This will open question/addquestion.php,
1879  * which in turn goes to question/question.php before getting back to $params['returnurl']
1880  * (by default the question bank screen).
1881  *
1882  * @param int $categoryid The id of the category that the new question should be added to.
1883  * @param array $params Other paramters to add to the URL. You need either $params['cmid'] or
1884  *      $params['courseid'], and you should probably set $params['returnurl']
1885  * @param string $caption the text to display on the button.
1886  * @param string $tooltip a tooltip to add to the button (optional).
1887  * @param bool $disabled if true, the button will be disabled.
1888  */
1889 function create_new_question_button($categoryid, $params, $caption, $tooltip = '', $disabled = false) {
1890     global $CFG, $PAGE, $OUTPUT;
1891     static $choiceformprinted = false;
1892     $params['category'] = $categoryid;
1893     $url = new moodle_url('/question/addquestion.php', $params);
1894     echo $OUTPUT->single_button($url, $caption, 'get', array('disabled'=>$disabled, 'title'=>$tooltip));
1896     if (!$choiceformprinted) {
1897         echo '<div id="qtypechoicecontainer">';
1898         print_choose_qtype_to_add_form(array());
1899         echo "</div>\n";
1900         $choiceformprinted = true;
1901     }