2 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
18 * Functions used to show question editing interface
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
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) {
35 if (!$cmrec = $DB->get_record_sql("SELECT cm.*, md.name as modname
36 FROM {course_modules} cm,
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');
44 $modrec->instance
= $modrec->id
;
45 $modrec->cmid
= $cmrec->id
;
46 $cmrec->name
= $modrec->name
;
48 return array($modrec, $cmrec);
51 * Function to read all questions for category into big array
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
58 function get_questions_category( $category, $noparent=false, $recurse=true, $export=true ) {
61 // Build sql bit for $noparent
64 $npsql = " and parent='0' ";
67 // Get list of categories
69 $categorylist = question_categorylist($category->id
);
71 $categorylist = array($category->id
);
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
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.
87 $qtype->get_question_options($question);
88 $qresults[] = $question;
95 * @param int $categoryid a category id.
96 * @return bool whether this is the only top-level category in a context.
98 function question_is_only_toplevel_category_in_context($categoryid) {
100 return 1 == $DB->count_records_sql("
102 FROM {question_categories} c1,
103 {question_categories} c2
105 AND c1.contextid = c2.contextid
106 AND c1.parent = 0 AND c2.parent = 0", array($categoryid));
110 * Check whether this user is allowed to delete this category.
112 * @param int $todelete a category id.
114 function question_can_delete_cat($todelete) {
116 if (question_is_only_toplevel_category_in_context($todelete)) {
117 print_error('cannotdeletecate', 'question');
119 $contextid = $DB->get_field('question_categories', 'contextid', array('id' => $todelete));
120 require_capability('moodle/question:managecategory', context
::instance_by_id($contextid));
126 * Base class for representing a column in a {@link question_bank_view}.
128 * @copyright 2009 Tim Hunt
129 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
131 abstract class question_bank_column_base
{
133 * @var question_bank_view
137 /** @var bool determine whether the column is td or th. */
138 protected $isheading = false;
142 * @param $qbank the question_bank_view we are helping to render.
144 public function __construct(question_bank_view
$qbank) {
145 $this->qbank
= $qbank;
150 * A chance for subclasses to initialise themselves, for example to load lang strings,
151 * without having to override the constructor.
153 protected function init() {
157 * Set the column as heading
159 public function set_as_heading() {
160 $this->isheading
= true;
163 public function is_extra_row() {
168 * Output the column header cell.
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)) {
178 echo '<div class="title">' . $title . '</div>';
181 foreach ($sortable as $subsort => $details) {
182 $links[] = $this->make_sort_link($name . '_' . $subsort,
183 $details['title'], '', !empty($details['reverse']));
185 echo '<div class="sorters">' . implode(' / ', $links) . '</div>';
186 } else if ($sortable) {
187 echo $this->make_sort_link($name, $title, $tip);
190 echo '<span title="' . $tip . '">';
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.
205 protected abstract function get_title();
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.
211 protected function get_title_tip() {
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.
223 protected function make_sort_link($sort, $title, $tip, $defaultreverse = false) {
224 $currentsort = $this->qbank
->get_primary_sort_order($sort);
225 $newsortreverse = $defaultreverse;
227 $newsortreverse = $currentsort > 0;
232 if ($newsortreverse) {
233 $tip = get_string('sortbyxreverse', '', $tip);
235 $tip = get_string('sortbyx', '', $tip);
237 $link = '<a href="' . $this->qbank
->new_sort_url($sort, $newsortreverse) . '" title="' . $tip . '">';
240 $link .= $this->get_sort_icon($currentsort < 0);
247 * Get an icon representing the corrent sort state.
248 * @param $reverse sort is descending, not ascending.
249 * @return string HTML image tag.
251 protected function get_sort_icon($reverse) {
254 return $OUTPUT->pix_icon('t/sort_desc', get_string('desc'), '', array('class' => 'iconsort'));
256 return $OUTPUT->pix_icon('t/sort_asc', get_string('asc'), '', array('class' => 'iconsort'));
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.
265 public function display($question, $rowclasses) {
266 $this->display_start($question, $rowclasses);
267 $this->display_content($question, $rowclasses);
268 $this->display_end($question, $rowclasses);
272 * Output the opening column tag. If it is set as heading, it will use <th> tag instead of <td>
274 * @param stdClass $question
275 * @param array $rowclasses
277 protected function display_start($question, $rowclasses) {
279 $attr = array('class' => $this->get_classes());
280 if ($this->isheading
) {
282 $attr['scope'] = 'row';
284 echo html_writer
::start_tag($tag, $attr);
288 * @return string the CSS classes to apply to every cell in this column.
290 protected function get_classes() {
291 $classes = $this->get_extra_classes();
292 $classes[] = $this->get_name();
293 return implode(' ', $classes);
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.
301 public abstract function get_name();
304 * @return array any extra class names you would like applied to every cell in this column.
306 public function get_extra_classes() {
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.
315 protected abstract function display_content($question, $rowclasses);
318 * Output the closing column tag
320 * @param object $question
321 * @param string $rowclasses
323 protected function display_end($question, $rowclasses) {
325 if ($this->isheading
) {
328 echo html_writer
::end_tag($tag);
332 * Return an array 'table_alias' => 'JOIN clause' to bring in any data that
333 * this column required.
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'.
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.
343 * @return array 'table_alias' => 'JOIN clause'
345 public function get_extra_joins() {
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.
353 public function get_required_fields() {
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
363 * 'firstname' => array('field' => 'uc.firstname', 'title' => get_string('firstname')),
364 * 'lastname' => array('field' => 'uc.lastname', 'field' => get_string('lastname')),
366 * As well as field, and field, you can also add 'revers' => 1 if you want the default sort
368 * @return mixed as above.
370 public function is_sortable() {
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'
380 protected function sortorder($reverse) {
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.
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']));
400 throw new coding_exception('Unexpected $subsort type: ' . $subsort);
402 } else if ($sortable) {
403 return $sortable . $this->sortorder($reverse);
405 throw new coding_exception('sort_expression called on a non-sortable column.');
412 * A column with a checkbox for each question with name q{questionid}.
414 * @copyright 2009 Tim Hunt
415 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
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');
425 public function get_name() {
429 protected function get_title() {
430 return '<input type="checkbox" disabled="disabled" id="qbheadercheckbox" />';
433 protected function get_title_tip() {
434 return get_string('selectquestionsforbulk', 'question');
437 protected function display_content($question, $rowclasses) {
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');
445 'fullpath' => '/question/qbank.js',
446 'requires' => array('yui2-dom', 'yui2-event', 'yui2-container'),
447 'strings' => array(),
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;
456 public function get_required_fields() {
457 return array('q.id');
463 * A column type for the name of the question type.
465 * @copyright 2009 Tim Hunt
466 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
468 class question_bank_question_type_column
extends question_bank_column_base
{
469 public function get_name() {
473 protected function get_title() {
474 return get_string('qtypeveryshort', 'question');
477 protected function get_title_tip() {
478 return get_string('questiontype', 'question');
481 protected function display_content($question, $rowclasses) {
482 echo print_question_icon($question);
485 public function get_required_fields() {
486 return array('q.qtype');
489 public function is_sortable() {
496 * A column type for the name of the question name.
498 * @copyright 2009 Tim Hunt
499 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
501 class question_bank_question_name_column
extends question_bank_column_base
{
502 protected $checkboxespresent = null;
504 public function get_name() {
505 return 'questionname';
508 protected function get_title() {
509 return get_string('question');
512 protected function label_for($question) {
513 if (is_null($this->checkboxespresent
)) {
514 $this->checkboxespresent
= $this->qbank
->has_column('checkbox');
516 if ($this->checkboxespresent
) {
517 return 'checkq' . $question->id
;
523 protected function display_content($question, $rowclasses) {
524 $labelfor = $this->label_for($question);
526 echo '<label for="' . $labelfor . '">';
528 echo format_string($question->name
);
534 public function get_required_fields() {
535 return array('q.id', 'q.name');
538 public function is_sortable() {
545 * A column type for the name of the question creator.
547 * @copyright 2009 Tim Hunt
548 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
550 class question_bank_creator_name_column
extends question_bank_column_base
{
551 public function get_name() {
552 return 'creatorname';
555 protected function get_title() {
556 return get_string('createdby', 'question');
559 protected function display_content($question, $rowclasses) {
560 if (!empty($question->creatorfirstname
) && !empty($question->creatorlastname
)) {
562 $allnames = get_all_user_name_fields();
563 foreach ($allnames as $allname) {
564 $tempname = 'creator' . $allname;
565 if (isset($question->$tempname)) {
566 $u->$allname = $question->$tempname;
573 public function get_extra_joins() {
574 return array('uc' => 'LEFT JOIN {user} uc ON uc.id = q.createdby');
577 public function get_required_fields() {
578 $allnames = get_all_user_name_fields();
579 $requiredfields = array();
580 foreach ($allnames as $allname) {
581 $requiredfields[] = 'uc.' . $allname . ' AS creator' . $allname;
583 return $requiredfields;
586 public function is_sortable() {
588 'firstname' => array('field' => 'uc.firstname', 'title' => get_string('firstname')),
589 'lastname' => array('field' => 'uc.lastname', 'title' => get_string('lastname')),
596 * A column type for the name of the question last modifier.
598 * @copyright 2009 Tim Hunt
599 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
601 class question_bank_modifier_name_column
extends question_bank_column_base
{
602 public function get_name() {
603 return 'modifiername';
606 protected function get_title() {
607 return get_string('lastmodifiedby', 'question');
610 protected function display_content($question, $rowclasses) {
611 if (!empty($question->modifierfirstname
) && !empty($question->modifierlastname
)) {
613 $allnames = get_all_user_name_fields();
614 foreach ($allnames as $allname) {
615 $tempname = 'modifier' . $allname;
616 if (isset($question->$tempname)) {
617 $u->$allname = $question->$tempname;
624 public function get_extra_joins() {
625 return array('um' => 'LEFT JOIN {user} um ON um.id = q.modifiedby');
628 public function get_required_fields() {
629 $allnames = get_all_user_name_fields();
630 $requiredfields = array();
631 foreach ($allnames as $allname) {
632 $requiredfields[] = 'um.' . $allname . ' AS modifier' . $allname;
634 return $requiredfields;
637 public function is_sortable() {
639 'firstname' => array('field' => 'um.firstname', 'title' => get_string('firstname')),
640 'lastname' => array('field' => 'um.lastname', 'title' => get_string('lastname')),
647 * A base class for actions that are an icon that lets you manipulate the question in some way.
649 * @copyright 2009 Tim Hunt
650 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
652 abstract class question_bank_action_column_base
extends question_bank_column_base
{
654 protected function get_title() {
658 public function get_extra_classes() {
659 return array('iconcol');
662 protected function print_icon($icon, $title, $url) {
664 echo '<a title="' . $title . '" href="' . $url . '">
665 <img src="' . $OUTPUT->pix_url($icon) . '" class="iconsmall" alt="' . $title . '" /></a>';
668 public function get_required_fields() {
669 // createdby is required for permission checks.
670 return array('q.id', 'q.createdby');
676 * Base class for question bank columns that just contain an action icon.
678 * @copyright 2009 Tim Hunt
679 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
681 class question_bank_edit_action_column
extends question_bank_action_column_base
{
685 public function init() {
687 $this->stredit
= get_string('edit');
688 $this->strview
= get_string('view');
691 public function get_name() {
695 protected function display_content($question, $rowclasses) {
696 if (question_has_capability_on($question, 'edit')) {
697 $this->print_icon('t/edit', $this->stredit
, $this->qbank
->edit_question_url($question->id
));
698 } else if (question_has_capability_on($question, 'view')) {
699 $this->print_icon('i/info', $this->strview
, $this->qbank
->edit_question_url($question->id
));
706 * Question bank columns for the preview action icon.
708 * @copyright 2009 Tim Hunt
709 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
711 class question_bank_preview_action_column
extends question_bank_action_column_base
{
712 protected $strpreview;
714 public function init() {
716 $this->strpreview
= get_string('preview');
719 public function get_name() {
720 return 'previewaction';
723 protected function display_content($question, $rowclasses) {
725 if (question_has_capability_on($question, 'use')) {
727 $image = $OUTPUT->pix_icon('t/preview', $this->strpreview
, '', array('class' => 'iconsmall'));
729 $link = $this->qbank
->preview_question_url($question);
730 $action = new popup_action('click', $link, 'questionpreview',
731 question_preview_popup_params());
733 echo $OUTPUT->action_link($link, $image, $action, array('title' => $this->strpreview
));
737 public function get_required_fields() {
738 return array('q.id');
744 * Question bank columns for the move action icon.
746 * @copyright 2009 Tim Hunt
747 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
749 class question_bank_move_action_column
extends question_bank_action_column_base
{
752 public function init() {
754 $this->strmove
= get_string('move');
757 public function get_name() {
761 protected function display_content($question, $rowclasses) {
762 if (question_has_capability_on($question, 'move')) {
763 $this->print_icon('t/move', $this->strmove
, $this->qbank
->move_question_url($question->id
));
770 * action to delete (or hide) a question, or restore a previously hidden question.
772 * @copyright 2009 Tim Hunt
773 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
775 class question_bank_delete_action_column
extends question_bank_action_column_base
{
776 protected $strdelete;
777 protected $strrestore;
779 public function init() {
781 $this->strdelete
= get_string('delete');
782 $this->strrestore
= get_string('restore');
785 public function get_name() {
786 return 'deleteaction';
789 protected function display_content($question, $rowclasses) {
790 if (question_has_capability_on($question, 'edit')) {
791 if ($question->hidden
) {
792 $url = new moodle_url($this->qbank
->base_url(), array('unhide' => $question->id
, 'sesskey'=>sesskey()));
793 $this->print_icon('t/restore', $this->strrestore
, $url);
795 $url = new moodle_url($this->qbank
->base_url(), array('deleteselected' => $question->id
, 'q' . $question->id
=> 1, 'sesskey'=>sesskey()));
796 $this->print_icon('t/delete', $this->strdelete
, $url);
801 public function get_required_fields() {
802 return array('q.id', 'q.hidden');
807 * Base class for 'columns' that are actually displayed as a row following the main question row.
809 * @copyright 2009 Tim Hunt
810 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
812 abstract class question_bank_row_base
extends question_bank_column_base
{
813 public function is_extra_row() {
817 protected function display_start($question, $rowclasses) {
819 echo '<tr class="' . $rowclasses . '">' . "\n";
823 echo '<td colspan="' . $this->qbank
->get_column_count() . '" class="' . $this->get_name() . '">';
826 protected function display_end($question, $rowclasses) {
832 * A column type for the name of the question name.
834 * @copyright 2009 Tim Hunt
835 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
837 class question_bank_question_text_row
extends question_bank_row_base
{
838 protected $formatoptions;
840 protected function init() {
841 $this->formatoptions
= new stdClass();
842 $this->formatoptions
->noclean
= true;
843 $this->formatoptions
->para
= false;
846 public function get_name() {
847 return 'questiontext';
850 protected function get_title() {
851 return get_string('questiontext', 'question');
854 protected function display_content($question, $rowclasses) {
855 $text = question_rewrite_question_preview_urls($question->questiontext
, $question->id
,
856 $question->contextid
, 'question', 'questiontext', $question->id
,
857 $question->contextid
, 'core_question');
858 $text = format_text($text, $question->questiontextformat
,
859 $this->formatoptions
);
866 public function get_extra_joins() {
867 return array('qc' => 'JOIN {question_categories} qc ON qc.id = q.category');
870 public function get_required_fields() {
871 return array('q.id', 'q.questiontext', 'q.questiontextformat', 'qc.contextid');
876 * This class prints a view of the question bank, including
877 * + Some controls to allow users to to select what is displayed.
878 * + A list of questions as a table.
879 * + Further controls to do things with the questions.
881 * This class gives a basic view, and provides plenty of hooks where subclasses
882 * can override parts of the display.
884 * The list of questions presented as a table is generated by creating a list of
885 * question_bank_column objects, one for each 'column' to be displayed. These
887 * + outputting the contents of that column, given a $question object, but also
888 * + generating the right fragments of SQL to ensure the necessary data is present,
889 * and sorted in the right order.
890 * + outputting table headers.
892 * @copyright 2009 Tim Hunt
893 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
895 class question_bank_view
{
899 protected $editquestionurl;
900 protected $quizorcourseid;
904 protected $knowncolumntypes;
905 protected $visiblecolumns;
906 protected $extrarows;
907 protected $requiredcolumns;
909 protected $lastchangedid;
912 protected $sqlparams;
916 * @param question_edit_contexts $contexts
917 * @param moodle_url $pageurl
918 * @param object $course course settings
919 * @param object $cm (optional) activity settings.
921 public function __construct($contexts, $pageurl, $course, $cm = null) {
924 $this->contexts
= $contexts;
925 $this->baseurl
= $pageurl;
926 $this->course
= $course;
929 if (!empty($cm) && $cm->modname
== 'quiz') {
930 $this->quizorcourseid
= '&quizid=' . $cm->instance
;
932 $this->quizorcourseid
= '&courseid=' .$this->course
->id
;
935 // Create the url of the new question page to forward to.
936 $returnurl = $pageurl->out_as_local_url(false);
937 $this->editquestionurl
= new moodle_url('/question/question.php',
938 array('returnurl' => $returnurl));
940 $this->editquestionurl
->param('cmid', $cm->id
);
942 $this->editquestionurl
->param('courseid', $this->course
->id
);
945 $this->lastchangedid
= optional_param('lastchanged',0,PARAM_INT
);
947 $this->init_column_types();
948 $this->init_columns($this->wanted_columns(), $this->heading_column());
952 protected function wanted_columns() {
953 $columns = array('checkbox', 'qtype', 'questionname', 'editaction',
954 'previewaction', 'moveaction', 'deleteaction', 'creatorname',
956 if (optional_param('qbshowtext', false, PARAM_BOOL
)) {
957 $columns[] = 'questiontext';
963 * Specify the column heading
965 * @return string Column name for the heading
967 protected function heading_column() {
968 return 'questionname';
971 protected function known_field_types() {
973 new question_bank_checkbox_column($this),
974 new question_bank_question_type_column($this),
975 new question_bank_question_name_column($this),
976 new question_bank_creator_name_column($this),
977 new question_bank_modifier_name_column($this),
978 new question_bank_edit_action_column($this),
979 new question_bank_preview_action_column($this),
980 new question_bank_move_action_column($this),
981 new question_bank_delete_action_column($this),
982 new question_bank_question_text_row($this),
986 protected function init_column_types() {
987 $this->knowncolumntypes
= array();
988 foreach ($this->known_field_types() as $col) {
989 $this->knowncolumntypes
[$col->get_name()] = $col;
994 * Initializing table columns
996 * @param array $wanted Collection of column names
997 * @param string $heading The name of column that is set as heading
999 protected function init_columns($wanted, $heading = '') {
1000 $this->visiblecolumns
= array();
1001 $this->extrarows
= array();
1002 foreach ($wanted as $colname) {
1003 if (!isset($this->knowncolumntypes
[$colname])) {
1004 throw new coding_exception('Unknown column type ' . $colname . ' requested in init columns.');
1006 $column = $this->knowncolumntypes
[$colname];
1007 if ($column->is_extra_row()) {
1008 $this->extrarows
[$colname] = $column;
1010 $this->visiblecolumns
[$colname] = $column;
1013 $this->requiredcolumns
= array_merge($this->visiblecolumns
, $this->extrarows
);
1014 if (array_key_exists($heading, $this->requiredcolumns
)) {
1015 $this->requiredcolumns
[$heading]->set_as_heading();
1020 * @param string $colname a column internal name.
1021 * @return bool is this column included in the output?
1023 public function has_column($colname) {
1024 return isset($this->visiblecolumns
[$colname]);
1028 * @return int The number of columns in the table.
1030 public function get_column_count() {
1031 return count($this->visiblecolumns
);
1034 public function get_courseid() {
1035 return $this->course
->id
;
1038 protected function init_sort() {
1039 $this->init_sort_from_params();
1040 if (empty($this->sort
)) {
1041 $this->sort
= $this->default_sort();
1046 * Deal with a sort name of the form columnname, or colname_subsort by
1047 * breaking it up, validating the bits that are presend, and returning them.
1048 * If there is no subsort, then $subsort is returned as ''.
1049 * @return array array($colname, $subsort).
1051 protected function parse_subsort($sort) {
1053 if (strpos($sort, '_') !== false) {
1054 list($colname, $subsort) = explode('_', $sort, 2);
1059 /// Validate the column name.
1060 if (!isset($this->knowncolumntypes
[$colname]) ||
!$this->knowncolumntypes
[$colname]->is_sortable()) {
1061 for ($i = 1; $i <= question_bank_view
::MAX_SORTS
; $i++
) {
1062 $this->baseurl
->remove_params('qbs' . $i);
1064 throw new moodle_exception('unknownsortcolumn', '', $link = $this->baseurl
->out(), $colname);
1066 /// Validate the subsort, if present.
1068 $subsorts = $this->knowncolumntypes
[$colname]->is_sortable();
1069 if (!is_array($subsorts) ||
!isset($subsorts[$subsort])) {
1070 throw new moodle_exception('unknownsortcolumn', '', $link = $this->baseurl
->out(), $sort);
1073 return array($colname, $subsort);
1076 protected function init_sort_from_params() {
1077 $this->sort
= array();
1078 for ($i = 1; $i <= question_bank_view
::MAX_SORTS
; $i++
) {
1079 if (!$sort = optional_param('qbs' . $i, '', PARAM_ALPHAEXT
)) {
1082 // Work out the appropriate order.
1084 if ($sort[0] == '-') {
1086 $sort = substr($sort, 1);
1091 // Deal with subsorts.
1092 list($colname, $subsort) = $this->parse_subsort($sort);
1093 $this->requiredcolumns
[$colname] = $this->knowncolumntypes
[$colname];
1094 $this->sort
[$sort] = $order;
1098 protected function sort_to_params($sorts) {
1101 foreach ($sorts as $sort => $order) {
1104 $sort = '-' . $sort;
1106 $params['qbs' . $i] = $sort;
1111 protected function default_sort() {
1112 $this->requiredcolumns
['qtype'] = $this->knowncolumntypes
['qtype'];
1113 $this->requiredcolumns
['questionname'] = $this->knowncolumntypes
['questionname'];
1114 return array('qtype' => 1, 'questionname' => 1);
1118 * @param $sort a column or column_subsort name.
1119 * @return int the current sort order for this column -1, 0, 1
1121 public function get_primary_sort_order($sort) {
1122 $order = reset($this->sort
);
1123 $primarysort = key($this->sort
);
1124 if ($sort == $primarysort) {
1132 * Get a URL to redisplay the page with a new sort for the question bank.
1133 * @param string $sort the column, or column_subsort to sort on.
1134 * @param bool $newsortreverse whether to sort in reverse order.
1135 * @return string The new URL.
1137 public function new_sort_url($sort, $newsortreverse) {
1138 if ($newsortreverse) {
1143 // Tricky code to add the new sort at the start, removing it from where it was before, if it was present.
1144 $newsort = array_reverse($this->sort
);
1145 if (isset($newsort[$sort])) {
1146 unset($newsort[$sort]);
1148 $newsort[$sort] = $order;
1149 $newsort = array_reverse($newsort);
1150 if (count($newsort) > question_bank_view
::MAX_SORTS
) {
1151 $newsort = array_slice($newsort, 0, question_bank_view
::MAX_SORTS
, true);
1153 return $this->baseurl
->out(true, $this->sort_to_params($newsort));
1156 protected function build_query_sql($category, $recurse, $showhidden) {
1159 /// Get the required tables.
1161 foreach ($this->requiredcolumns
as $column) {
1162 $extrajoins = $column->get_extra_joins();
1163 foreach ($extrajoins as $prefix => $join) {
1164 if (isset($joins[$prefix]) && $joins[$prefix] != $join) {
1165 throw new coding_exception('Join ' . $join . ' conflicts with previous join ' . $joins[$prefix]);
1167 $joins[$prefix] = $join;
1171 /// Get the required fields.
1172 $fields = array('q.hidden', 'q.category');
1173 foreach ($this->visiblecolumns
as $column) {
1174 $fields = array_merge($fields, $column->get_required_fields());
1176 foreach ($this->extrarows
as $row) {
1177 $fields = array_merge($fields, $row->get_required_fields());
1179 $fields = array_unique($fields);
1181 /// Build the order by clause.
1183 foreach ($this->sort
as $sort => $order) {
1184 list($colname, $subsort) = $this->parse_subsort($sort);
1185 $sorts[] = $this->requiredcolumns
[$colname]->sort_expression($order < 0, $subsort);
1188 /// Build the where clause.
1189 $tests = array('q.parent = 0');
1192 $tests[] = 'q.hidden = 0';
1196 $categoryids = question_categorylist($category->id
);
1198 $categoryids = array($category->id
);
1200 list($catidtest, $params) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED
, 'cat');
1201 $tests[] = 'q.category ' . $catidtest;
1202 $this->sqlparams
= $params;
1205 $sql = ' FROM {question} q ' . implode(' ', $joins);
1206 $sql .= ' WHERE ' . implode(' AND ', $tests);
1207 $this->countsql
= 'SELECT count(1)' . $sql;
1208 $this->loadsql
= 'SELECT ' . implode(', ', $fields) . $sql . ' ORDER BY ' . implode(', ', $sorts);
1209 $this->sqlparams
= $params;
1212 protected function get_question_count() {
1214 return $DB->count_records_sql($this->countsql
, $this->sqlparams
);
1217 protected function load_page_questions($page, $perpage) {
1219 $questions = $DB->get_recordset_sql($this->loadsql
, $this->sqlparams
, $page*$perpage, $perpage);
1220 if (!$questions->valid()) {
1221 /// No questions on this page. Reset to page 0.
1222 $questions = $DB->get_recordset_sql($this->loadsql
, $this->sqlparams
, 0, $perpage);
1227 public function base_url() {
1228 return $this->baseurl
;
1231 public function edit_question_url($questionid) {
1232 return $this->editquestionurl
->out(true, array('id' => $questionid));
1235 public function move_question_url($questionid) {
1236 return $this->editquestionurl
->out(true, array('id' => $questionid, 'movecontext' => 1));
1239 public function preview_question_url($question) {
1240 return question_preview_url($question->id
, null, null, null, null,
1241 $this->contexts
->lowest());
1245 * Shows the question bank editing interface.
1247 * The function also processes a number of actions:
1249 * Actions affecting the question pool:
1250 * move Moves a question to a different category
1251 * deleteselected Deletes the selected questions from the category
1253 * category Chooses the category
1254 * displayoptions Sets display options
1256 public function display($tabname, $page, $perpage, $cat,
1257 $recurse, $showhidden, $showquestiontext) {
1258 global $PAGE, $OUTPUT;
1260 if ($this->process_actions_needing_ui()) {
1264 // Category selection form
1265 echo $OUTPUT->heading(get_string('questionbank', 'question'), 2);
1267 $this->display_category_form($this->contexts
->having_one_edit_tab_cap($tabname),
1268 $this->baseurl
, $cat);
1269 $this->display_options($recurse, $showhidden, $showquestiontext);
1271 if (!$category = $this->get_current_category($cat)) {
1274 $this->print_category_info($category);
1276 // continues with list of questions
1277 $this->display_question_list($this->contexts
->having_one_edit_tab_cap($tabname),
1278 $this->baseurl
, $cat, $this->cm
,
1279 $recurse, $page, $perpage, $showhidden, $showquestiontext,
1280 $this->contexts
->having_cap('moodle/question:add'));
1283 protected function print_choose_category_message($categoryandcontext) {
1284 echo "<p style=\"text-align:center;\"><b>";
1285 print_string('selectcategoryabove', 'question');
1289 protected function get_current_category($categoryandcontext) {
1290 global $DB, $OUTPUT;
1291 list($categoryid, $contextid) = explode(',', $categoryandcontext);
1293 $this->print_choose_category_message($categoryandcontext);
1297 if (!$category = $DB->get_record('question_categories',
1298 array('id' => $categoryid, 'contextid' => $contextid))) {
1299 echo $OUTPUT->box_start('generalbox questionbank');
1300 echo $OUTPUT->notification('Category not found!');
1301 echo $OUTPUT->box_end();
1308 protected function print_category_info($category) {
1309 $formatoptions = new stdClass();
1310 $formatoptions->noclean
= true;
1311 $formatoptions->overflowdiv
= true;
1312 echo '<div class="boxaligncenter">';
1313 echo format_text($category->info
, $category->infoformat
, $formatoptions, $this->course
->id
);
1318 * prints a form to choose categories
1320 protected function display_category_form($contexts, $pageurl, $current) {
1321 global $CFG, $OUTPUT;
1323 /// Get all the existing categories now
1324 echo '<div class="choosecategory">';
1325 $catmenu = question_category_options($contexts, false, 0, true);
1327 $select = new single_select($this->baseurl
, 'category', $catmenu, $current, null, 'catmenu');
1328 $select->set_label(get_string('selectacategory', 'question'));
1329 echo $OUTPUT->render($select);
1333 protected function display_options($recurse, $showhidden, $showquestiontext) {
1334 echo '<form method="get" action="edit.php" id="displayoptions">';
1335 echo "<fieldset class='invisiblefieldset'>";
1336 echo html_writer
::input_hidden_params($this->baseurl
, array('recurse', 'showhidden', 'qbshowtext'));
1337 $this->display_category_form_checkbox('recurse', $recurse, get_string('includesubcategories', 'question'));
1338 $this->display_category_form_checkbox('showhidden', $showhidden, get_string('showhidden', 'question'));
1339 $this->display_category_form_checkbox('qbshowtext', $showquestiontext, get_string('showquestiontext', 'question'));
1340 echo '<noscript><div class="centerpara"><input type="submit" value="'. get_string('go') .'" />';
1341 echo '</div></noscript></fieldset></form>';
1345 * Print a single option checkbox. Used by the preceeding.
1347 protected function display_category_form_checkbox($name, $value, $label) {
1348 echo '<div><input type="hidden" id="' . $name . '_off" name="' . $name . '" value="0" />';
1349 echo '<input type="checkbox" id="' . $name . '_on" name="' . $name . '" value="1"';
1351 echo ' checked="checked"';
1353 echo ' onchange="getElementById(\'displayoptions\').submit(); return true;" />';
1354 echo '<label for="' . $name . '_on">' . $label . '</label>';
1358 protected function create_new_question_form($category, $canadd) {
1360 echo '<div class="createnewquestion">';
1362 create_new_question_button($category->id
, $this->editquestionurl
->params(),
1363 get_string('createnewquestion', 'question'));
1365 print_string('nopermissionadd', 'question');
1371 * Prints the table of questions in a category with interactions
1373 * @param object $course The course object
1374 * @param int $categoryid The id of the question category to be displayed
1375 * @param int $cm The course module record if we are in the context of a particular module, 0 otherwise
1376 * @param int $recurse This is 1 if subcategories should be included, 0 otherwise
1377 * @param int $page The number of the page to be displayed
1378 * @param int $perpage Number of questions to show per page
1379 * @param bool $showhidden True if also hidden questions should be displayed
1380 * @param bool $showquestiontext whether the text of each question should be shown in the list
1382 protected function display_question_list($contexts, $pageurl, $categoryandcontext,
1383 $cm = null, $recurse=1, $page=0, $perpage=100, $showhidden=false,
1384 $showquestiontext = false, $addcontexts = array()) {
1385 global $CFG, $DB, $OUTPUT;
1387 $category = $this->get_current_category($categoryandcontext);
1389 $cmoptions = new stdClass();
1390 $cmoptions->hasattempts
= !empty($this->quizhasattempts
);
1392 $strselectall = get_string('selectall');
1393 $strselectnone = get_string('deselectall');
1394 $strdelete = get_string('delete');
1396 list($categoryid, $contextid) = explode(',', $categoryandcontext);
1397 $catcontext = context
::instance_by_id($contextid);
1399 $canadd = has_capability('moodle/question:add', $catcontext);
1400 $caneditall =has_capability('moodle/question:editall', $catcontext);
1401 $canuseall =has_capability('moodle/question:useall', $catcontext);
1402 $canmoveall =has_capability('moodle/question:moveall', $catcontext);
1404 $this->create_new_question_form($category, $canadd);
1406 $this->build_query_sql($category, $recurse, $showhidden);
1407 $totalnumber = $this->get_question_count();
1408 if ($totalnumber == 0) {
1411 $questions = $this->load_page_questions($page, $perpage);
1413 echo '<div class="categorypagingbarcontainer">';
1414 $pageing_url = new moodle_url('edit.php');
1415 $r = $pageing_url->params($pageurl->params());
1416 $pagingbar = new paging_bar($totalnumber, $page, $perpage, $pageing_url);
1417 $pagingbar->pagevar
= 'qpage';
1418 echo $OUTPUT->render($pagingbar);
1421 echo '<form method="post" action="edit.php">';
1422 echo '<fieldset class="invisiblefieldset" style="display: block;">';
1423 echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
1424 echo html_writer
::input_hidden_params($pageurl);
1426 echo '<div class="categoryquestionscontainer">';
1427 $this->start_table();
1429 foreach ($questions as $question) {
1430 $this->print_table_row($question, $rowcount);
1436 echo '<div class="categorypagingbarcontainer pagingbottom">';
1437 echo $OUTPUT->render($pagingbar);
1438 if ($totalnumber > DEFAULT_QUESTIONS_PER_PAGE
) {
1439 if ($perpage == DEFAULT_QUESTIONS_PER_PAGE
) {
1440 $url = new moodle_url('edit.php', array_merge($pageurl->params(), array('qperpage'=>1000)));
1441 $showall = '<a href="'.$url.'">'.get_string('showall', 'moodle', $totalnumber).'</a>';
1443 $url = new moodle_url('edit.php', array_merge($pageurl->params(), array('qperpage'=>DEFAULT_QUESTIONS_PER_PAGE
)));
1444 $showall = '<a href="'.$url.'">'.get_string('showperpage', 'moodle', DEFAULT_QUESTIONS_PER_PAGE
).'</a>';
1446 echo "<div class='paging'>$showall</div>";
1450 echo '<div class="modulespecificbuttonscontainer">';
1451 if ($caneditall ||
$canmoveall ||
$canuseall){
1452 echo '<strong> '.get_string('withselected', 'question').':</strong><br />';
1454 if (function_exists('module_specific_buttons')) {
1455 echo module_specific_buttons($this->cm
->id
,$cmoptions);
1458 // print delete and move selected question
1460 echo '<input type="submit" name="deleteselected" value="' . $strdelete . "\" />\n";
1463 if ($canmoveall && count($addcontexts)) {
1464 echo '<input type="submit" name="move" value="'.get_string('moveto', 'question')."\" />\n";
1465 question_category_select_menu($addcontexts, false, 0, "$category->id,$category->contextid");
1468 if (function_exists('module_specific_controls') && $canuseall) {
1469 $modulespecific = module_specific_controls($totalnumber, $recurse, $category, $this->cm
->id
,$cmoptions);
1470 if(!empty($modulespecific)){
1471 echo "<hr />$modulespecific";
1481 protected function start_table() {
1482 echo '<table id="categoryquestions">' . "\n";
1484 $this->print_table_headers();
1489 protected function end_table() {
1494 protected function print_table_headers() {
1496 foreach ($this->visiblecolumns
as $column) {
1497 $column->display_header();
1502 protected function get_row_classes($question, $rowcount) {
1504 if ($question->hidden
) {
1505 $classes[] = 'dimmed_text';
1507 if ($question->id
== $this->lastchangedid
) {
1508 $classes[] ='highlight';
1510 $classes[] = 'r' . ($rowcount %
2);
1514 protected function print_table_row($question, $rowcount) {
1515 $rowclasses = implode(' ', $this->get_row_classes($question, $rowcount));
1517 echo '<tr class="' . $rowclasses . '">' . "\n";
1521 foreach ($this->visiblecolumns
as $column) {
1522 $column->display($question, $rowclasses);
1525 foreach ($this->extrarows
as $row) {
1526 $row->display($question, $rowclasses);
1530 public function process_actions() {
1532 /// Now, check for commands on this page and modify variables as necessary
1533 if (optional_param('move', false, PARAM_BOOL
) and confirm_sesskey()) {
1534 // Move selected questions to new category
1535 $category = required_param('category', PARAM_SEQUENCE
);
1536 list($tocategoryid, $contextid) = explode(',', $category);
1537 if (! $tocategory = $DB->get_record('question_categories', array('id' => $tocategoryid, 'contextid' => $contextid))) {
1538 print_error('cannotfindcate', 'question');
1540 $tocontext = context
::instance_by_id($contextid);
1541 require_capability('moodle/question:add', $tocontext);
1542 $rawdata = (array) data_submitted();
1543 $questionids = array();
1544 foreach ($rawdata as $key => $value) { // Parse input for question ids
1545 if (preg_match('!^q([0-9]+)$!', $key, $matches)) {
1547 $questionids[] = $key;
1551 list($usql, $params) = $DB->get_in_or_equal($questionids);
1553 $questions = $DB->get_records_sql("
1554 SELECT q.*, c.contextid
1556 JOIN {question_categories} c ON c.id = q.category
1557 WHERE q.id $usql", $params);
1558 foreach ($questions as $question){
1559 question_require_capability_on($question, 'move');
1561 question_move_questions_to_category($questionids, $tocategory->id
);
1562 redirect($this->baseurl
->out(false,
1563 array('category' => "$tocategoryid,$contextid")));
1567 if (optional_param('deleteselected', false, PARAM_BOOL
)) { // delete selected questions from the category
1568 if (($confirm = optional_param('confirm', '', PARAM_ALPHANUM
)) and confirm_sesskey()) { // teacher has already confirmed the action
1569 $deleteselected = required_param('deleteselected', PARAM_RAW
);
1570 if ($confirm == md5($deleteselected)) {
1571 if ($questionlist = explode(',', $deleteselected)) {
1572 // for each question either hide it if it is in use or delete it
1573 foreach ($questionlist as $questionid) {
1574 $questionid = (int)$questionid;
1575 question_require_capability_on($questionid, 'edit');
1576 if (questions_in_use(array($questionid))) {
1577 $DB->set_field('question', 'hidden', 1, array('id' => $questionid));
1579 question_delete_question($questionid);
1583 redirect($this->baseurl
);
1585 print_error('invalidconfirm', 'question');
1590 // Unhide a question
1591 if(($unhide = optional_param('unhide', '', PARAM_INT
)) and confirm_sesskey()) {
1592 question_require_capability_on($unhide, 'edit');
1593 $DB->set_field('question', 'hidden', 0, array('id' => $unhide));
1595 // Purge these questions from the cache.
1596 question_bank
::notify_question_edited($unhide);
1598 redirect($this->baseurl
);
1602 public function process_actions_needing_ui() {
1603 global $DB, $OUTPUT;
1604 if (optional_param('deleteselected', false, PARAM_BOOL
)) {
1605 // make a list of all the questions that are selected
1606 $rawquestions = $_REQUEST; // This code is called by both POST forms and GET links, so cannot use data_submitted.
1607 $questionlist = ''; // comma separated list of ids of questions to be deleted
1608 $questionnames = ''; // string with names of questions separated by <br /> with
1609 // an asterix in front of those that are in use
1610 $inuse = false; // set to true if at least one of the questions is in use
1611 foreach ($rawquestions as $key => $value) { // Parse input for question ids
1612 if (preg_match('!^q([0-9]+)$!', $key, $matches)) {
1614 $questionlist .= $key.',';
1615 question_require_capability_on($key, 'edit');
1616 if (questions_in_use(array($key))) {
1617 $questionnames .= '* ';
1620 $questionnames .= $DB->get_field('question', 'name', array('id' => $key)) . '<br />';
1623 if (!$questionlist) { // no questions were selected
1624 redirect($this->baseurl
);
1626 $questionlist = rtrim($questionlist, ',');
1628 // Add an explanation about questions in use
1630 $questionnames .= '<br />'.get_string('questionsinuse', 'question');
1632 $baseurl = new moodle_url('edit.php', $this->baseurl
->params());
1633 $deleteurl = new moodle_url($baseurl, array('deleteselected'=>$questionlist, 'confirm'=>md5($questionlist), 'sesskey'=>sesskey()));
1635 echo $OUTPUT->confirm(get_string('deletequestionscheck', 'question', $questionnames), $deleteurl, $baseurl);
1643 * Common setup for all pages for editing questions.
1644 * @param string $baseurl the name of the script calling this funciton. For examle 'qusetion/edit.php'.
1645 * @param string $edittab code for this edit tab
1646 * @param bool $requirecmid require cmid? default false
1647 * @param bool $requirecourseid require courseid, if cmid is not given? default true
1648 * @return array $thispageurl, $contexts, $cmid, $cm, $module, $pagevars
1650 function question_edit_setup($edittab, $baseurl, $requirecmid = false, $requirecourseid = true) {
1653 $thispageurl = new moodle_url($baseurl);
1654 $thispageurl->remove_all_params(); // We are going to explicity add back everything important - this avoids unwanted params from being retained.
1657 $cmid =required_param('cmid', PARAM_INT
);
1659 $cmid = optional_param('cmid', 0, PARAM_INT
);
1662 list($module, $cm) = get_module_from_cmid($cmid);
1663 $courseid = $cm->course
;
1664 $thispageurl->params(compact('cmid'));
1665 require_login($courseid, false, $cm);
1666 $thiscontext = context_module
::instance($cmid);
1670 if ($requirecourseid){
1671 $courseid = required_param('courseid', PARAM_INT
);
1673 $courseid = optional_param('courseid', 0, PARAM_INT
);
1676 $thispageurl->params(compact('courseid'));
1677 require_login($courseid, false);
1678 $thiscontext = context_course
::instance($courseid);
1680 $thiscontext = null;
1685 $contexts = new question_edit_contexts($thiscontext);
1686 $contexts->require_one_edit_tab_cap($edittab);
1692 $PAGE->set_pagelayout('admin');
1694 $pagevars['qpage'] = optional_param('qpage', -1, PARAM_INT
);
1696 //pass 'cat' from page to page and when 'category' comes from a drop down menu
1697 //then we also reset the qpage so we go to page 1 of
1699 $pagevars['cat'] = optional_param('cat', 0, PARAM_SEQUENCE
); // if empty will be set up later
1700 if ($category = optional_param('category', 0, PARAM_SEQUENCE
)) {
1701 if ($pagevars['cat'] != $category) { // is this a move to a new category?
1702 $pagevars['cat'] = $category;
1703 $pagevars['qpage'] = 0;
1706 if ($pagevars['cat']){
1707 $thispageurl->param('cat', $pagevars['cat']);
1709 if (strpos($baseurl, '/question/') === 0) {
1710 navigation_node
::override_active_url($thispageurl);
1713 if ($pagevars['qpage'] > -1) {
1714 $thispageurl->param('qpage', $pagevars['qpage']);
1716 $pagevars['qpage'] = 0;
1719 $pagevars['qperpage'] = question_get_display_preference(
1720 'qperpage', DEFAULT_QUESTIONS_PER_PAGE
, PARAM_INT
, $thispageurl);
1722 for ($i = 1; $i <= question_bank_view
::MAX_SORTS
; $i++
) {
1723 $param = 'qbs' . $i;
1724 if (!$sort = optional_param($param, '', PARAM_ALPHAEXT
)) {
1727 $thispageurl->param($param, $sort);
1730 $defaultcategory = question_make_default_categories($contexts->all());
1732 $contextlistarr = array();
1733 foreach ($contexts->having_one_edit_tab_cap($edittab) as $context){
1734 $contextlistarr[] = "'$context->id'";
1736 $contextlist = join($contextlistarr, ' ,');
1737 if (!empty($pagevars['cat'])){
1738 $catparts = explode(',', $pagevars['cat']);
1739 if (!$catparts[0] ||
(false !== array_search($catparts[1], $contextlistarr)) ||
1740 !$DB->count_records_select("question_categories", "id = ? AND contextid = ?", array($catparts[0], $catparts[1]))) {
1741 print_error('invalidcategory', 'question');
1744 $category = $defaultcategory;
1745 $pagevars['cat'] = "$category->id,$category->contextid";
1749 $pagevars['recurse'] = question_get_display_preference('recurse', 1, PARAM_BOOL
, $thispageurl);
1750 $pagevars['showhidden'] = question_get_display_preference('showhidden', 0, PARAM_BOOL
, $thispageurl);
1751 $pagevars['qbshowtext'] = question_get_display_preference('qbshowtext', 0, PARAM_BOOL
, $thispageurl);
1753 // Category list page.
1754 $pagevars['cpage'] = optional_param('cpage', 1, PARAM_INT
);
1755 if ($pagevars['cpage'] != 1){
1756 $thispageurl->param('cpage', $pagevars['cpage']);
1759 return array($thispageurl, $contexts, $cmid, $cm, $module, $pagevars);
1763 * Get a particular question preference that is also stored as a user preference.
1764 * If the the value is given in the GET/POST request, then that value is used,
1765 * and the user preference is updated to that value. Otherwise, the last set
1766 * value of the user preference is used, or if it has never been set the default
1767 * passed to this function.
1769 * @param string $param the param name. The URL parameter set, and the GET/POST
1770 * parameter read. The user_preference name is 'question_bank_' . $param.
1771 * @param mixed $default The default value to use, if not otherwise set.
1772 * @param int $type one of the PARAM_... constants.
1773 * @param moodle_url $thispageurl if the value has been explicitly set, we add
1775 * @return mixed the parameter value to use.
1777 function question_get_display_preference($param, $default, $type, $thispageurl) {
1778 $submittedvalue = optional_param($param, null, $type);
1779 if (is_null($submittedvalue)) {
1780 return get_user_preferences('question_bank_' . $param, $default);
1783 set_user_preference('question_bank_' . $param, $submittedvalue);
1784 $thispageurl->param($param, $submittedvalue);
1785 return $submittedvalue;
1789 * Make sure user is logged in as required in this context.
1791 function require_login_in_context($contextorid = null){
1793 if (!is_object($contextorid)){
1794 $context = context
::instance_by_id($contextorid, IGNORE_MISSING
);
1796 $context = $contextorid;
1798 if ($context && ($context->contextlevel
== CONTEXT_COURSE
)) {
1799 require_login($context->instanceid
);
1800 } else if ($context && ($context->contextlevel
== CONTEXT_MODULE
)) {
1801 if ($cm = $DB->get_record('course_modules',array('id' =>$context->instanceid
))) {
1802 if (!$course = $DB->get_record('course', array('id' => $cm->course
))) {
1803 print_error('invalidcourseid');
1805 require_course_login($course, true, $cm);
1808 print_error('invalidcoursemodule');
1810 } else if ($context && ($context->contextlevel
== CONTEXT_SYSTEM
)) {
1811 if (!empty($CFG->forcelogin
)) {
1821 * Print a form to let the user choose which question type to add.
1822 * When the form is submitted, it goes to the question.php script.
1823 * @param $hiddenparams hidden parameters to add to the form, in addition to
1824 * the qtype radio buttons.
1825 * @param $allowedqtypes optional list of qtypes that are allowed. If given, only
1826 * those qtypes will be shown. Example value array('description', 'multichoice').
1828 function print_choose_qtype_to_add_form($hiddenparams, array $allowedqtypes = null) {
1829 global $CFG, $PAGE, $OUTPUT;
1831 echo '<div id="chooseqtypehead" class="hd">' . "\n";
1832 echo $OUTPUT->heading(get_string('chooseqtypetoadd', 'question'), 3);
1834 echo '<div id="chooseqtype">' . "\n";
1835 echo '<form action="' . $CFG->wwwroot
. '/question/question.php" method="get"><div id="qtypeformdiv">' . "\n";
1836 foreach ($hiddenparams as $name => $value) {
1837 echo '<input type="hidden" name="' . s($name) . '" value="' . s($value) . '" />' . "\n";
1840 echo '<div class="qtypes">' . "\n";
1841 echo '<div class="instruction">' . get_string('selectaqtypefordescription', 'question') . "</div>\n";
1842 echo '<div class="realqtypes">' . "\n";
1843 $fakeqtypes = array();
1844 foreach (question_bank
::get_creatable_qtypes() as $qtypename => $qtype) {
1845 if ($allowedqtypes && !in_array($qtypename, $allowedqtypes)) {
1848 if ($qtype->is_real_question_type()) {
1849 print_qtype_to_add_option($qtype);
1851 $fakeqtypes[] = $qtype;
1855 echo '<div class="fakeqtypes">' . "\n";
1856 foreach ($fakeqtypes as $qtype) {
1857 print_qtype_to_add_option($qtype);
1861 echo '<div class="submitbuttons">' . "\n";
1862 echo '<input type="submit" value="' . get_string('next') . '" id="chooseqtype_submit" />' . "\n";
1863 echo '<input type="submit" id="chooseqtypecancel" name="addcancel" value="' . get_string('cancel') . '" />' . "\n";
1864 echo "</div></form>\n";
1867 $PAGE->requires
->js('/question/qengine.js');
1870 'fullpath' => '/question/qbank.js',
1871 'requires' => array('yui2-dom', 'yui2-event', 'yui2-container'),
1872 'strings' => array(),
1875 $PAGE->requires
->js_init_call('qtype_chooser.init', array('chooseqtype'), false, $module);
1879 * Private function used by the preceding one.
1880 * @param question_type $qtype the question type.
1882 function print_qtype_to_add_option($qtype) {
1883 echo '<div class="qtypeoption">' . "\n";
1884 echo '<label for="' . $qtype->plugin_name() . '">';
1885 echo '<input type="radio" name="qtype" id="' . $qtype->plugin_name() .
1886 '" value="' . $qtype->name() . '" />';
1887 echo '<span class="qtypename">';
1888 $fakequestion = new stdClass();
1889 $fakequestion->qtype
= $qtype->name();
1890 echo print_question_icon($fakequestion);
1891 echo $qtype->menu_name() . '</span><span class="qtypesummary">' .
1892 get_string('pluginnamesummary', $qtype->plugin_name());
1893 echo "</span></label>\n";
1898 * Print a button for creating a new question. This will open question/addquestion.php,
1899 * which in turn goes to question/question.php before getting back to $params['returnurl']
1900 * (by default the question bank screen).
1902 * @param int $categoryid The id of the category that the new question should be added to.
1903 * @param array $params Other paramters to add to the URL. You need either $params['cmid'] or
1904 * $params['courseid'], and you should probably set $params['returnurl']
1905 * @param string $caption the text to display on the button.
1906 * @param string $tooltip a tooltip to add to the button (optional).
1907 * @param bool $disabled if true, the button will be disabled.
1909 function create_new_question_button($categoryid, $params, $caption, $tooltip = '', $disabled = false) {
1910 global $CFG, $PAGE, $OUTPUT;
1911 static $choiceformprinted = false;
1912 $params['category'] = $categoryid;
1913 $url = new moodle_url('/question/addquestion.php', $params);
1914 echo $OUTPUT->single_button($url, $caption, 'get', array('disabled'=>$disabled, 'title'=>$tooltip));
1916 if (!$choiceformprinted) {
1917 echo '<div id="qtypechoicecontainer">';
1918 print_choose_qtype_to_add_form(array());
1920 $choiceformprinted = true;