weekly release 3.6dev
[moodle.git] / question / category_class.php
CommitLineData
aeb15530 1<?php
d3603157
TH
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/>.
16
17/**
18 * A class for representing question categories.
19 *
20 * @package moodlecore
21 * @subpackage questionbank
22 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24 */
25
516cf3eb 26
a17b297d
TH
27defined('MOODLE_INTERNAL') || die();
28
516cf3eb 29// number of categories to display on page
d3603157 30define('QUESTION_PAGE_LENGTH', 25);
dac786f3 31
94dbfb3a
TH
32require_once($CFG->libdir . '/listlib.php');
33require_once($CFG->dirroot . '/question/category_form.php');
017bc1d9
TH
34require_once($CFG->dirroot . '/question/move_form.php');
35
dac786f3 36
017bc1d9
TH
37/**
38 * Class representing a list of question categories
39 *
40 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
41 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
42 */
dac786f3 43class question_category_list extends moodle_list {
f34488b2 44 public $table = "question_categories";
45 public $listitemclassname = 'question_category_list_item';
271e6dec 46 /**
47 * @var reference to list displayed below this one.
48 */
f34488b2 49 public $nextlist = null;
271e6dec 50 /**
51 * @var reference to list displayed above this one.
52 */
f34488b2 53 public $lastlist = null;
271e6dec 54
f34488b2 55 public $context = null;
c65921d4 56 public $sortby = 'parent, sortorder, name';
271e6dec 57
20d89122
TH
58 public function __construct($type='ul', $attributes='', $editable = false, $pageurl=null, $page = 0, $pageparamname = 'page', $itemsperpage = 20, $context = null){
59 parent::__construct('ul', '', $editable, $pageurl, $page, 'cpage', $itemsperpage);
271e6dec 60 $this->context = $context;
61 }
986effb6 62
f34488b2 63 public function get_records() {
271e6dec 64 $this->records = get_categories_for_contexts($this->context->id, $this->sortby);
65 }
18d6ff78
SR
66
67 /**
68 * Returns the highest category id that the $item can have as its parent.
69 * Note: question categories cannot go higher than the TOP category.
70 *
71 * @param list_item $item The item which its top level parent is going to be returned.
72 * @return int
73 */
74 public function get_top_level_parent_id($item) {
75 // Put the item at the highest level it can go.
76 $topcategory = question_get_top_category($item->item->contextid, true);
77 return $topcategory->id;
78 }
dac786f3 79}
80
017bc1d9
TH
81
82/**
83 * An item in a list of question categories.
84 *
85 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
86 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
87 */
dac786f3 88class question_category_list_item extends list_item {
e2bb3c92 89 public function set_icon_html($first, $last, $lastitem){
271e6dec 90 global $CFG;
91 $category = $this->item;
8afba50b
PS
92 $url = new moodle_url('/question/category.php', ($this->parentlist->pageurl->params() + array('edit'=>$category->id)));
93 $this->icons['edit']= $this->image_icon(get_string('editthiscategory', 'question'), $url, 'edit');
271e6dec 94 parent::set_icon_html($first, $last, $lastitem);
95 $toplevel = ($this->parentlist->parentitem === null);//this is a top level item
96 if (($this->parentlist->nextlist !== null) && $last && $toplevel && (count($this->parentlist->items)>1)){
8afba50b 97 $url = new moodle_url($this->parentlist->pageurl, array('movedowncontext'=>$this->id, 'tocontext'=>$this->parentlist->nextlist->context->id, 'sesskey'=>sesskey()));
f34488b2 98 $this->icons['down'] = $this->image_icon(
329846f1 99 get_string('shareincontext', 'question', $this->parentlist->nextlist->context->get_context_name()), $url, 'down');
271e6dec 100 }
101 if (($this->parentlist->lastlist !== null) && $first && $toplevel && (count($this->parentlist->items)>1)){
8afba50b 102 $url = new moodle_url($this->parentlist->pageurl, array('moveupcontext'=>$this->id, 'tocontext'=>$this->parentlist->lastlist->context->id, 'sesskey'=>sesskey()));
f34488b2 103 $this->icons['up'] = $this->image_icon(
329846f1 104 get_string('shareincontext', 'question', $this->parentlist->lastlist->context->get_context_name()), $url, 'up');
271e6dec 105 }
106 }
20d89122 107
f34488b2 108 public function item_html($extraargs = array()){
42d5737a 109 global $CFG, $OUTPUT;
dac786f3 110 $str = $extraargs['str'];
111 $category = $this->item;
112
5e8a85aa 113 $editqestions = get_string('editquestions', 'question');
dac786f3 114
8009810e
TH
115 // Each section adds html to be displayed as part of this list item.
116 $questionbankurl = new moodle_url('/question/edit.php', $this->parentlist->pageurl->params());
117 $questionbankurl->param('cat', $category->id . ',' . $category->contextid);
118 $catediturl = new moodle_url($this->parentlist->pageurl, array('edit' => $this->id));
119 $item = '';
120 $item .= html_writer::tag('b', html_writer::link($catediturl,
121 format_string($category->name, true, array('context' => $this->parentlist->context)),
122 array('title' => $str->edit))) . ' ';
123 $item .= html_writer::link($questionbankurl, '(' . $category->questioncount . ')',
124 array('title' => $editqestions)) . ' ';
125 $item .= format_text($category->info, $category->infoformat,
fc51c2bc 126 array('context' => $this->parentlist->context, 'noclean' => true));
dac786f3 127
9275220d
SR
128 // Don't allow delete if this is the top category, or the last editable category in this context.
129 if ($category->parent && !question_is_only_child_of_top_category_in_context($category->id)) {
8009810e
TH
130 $deleteurl = new moodle_url($this->parentlist->pageurl, array('delete' => $this->id, 'sesskey' => sesskey()));
131 $item .= html_writer::link($deleteurl,
663640f5 132 $OUTPUT->pix_icon('t/delete', $str->delete),
8009810e 133 array('title' => $str->delete));
dac786f3 134 }
135
136 return $item;
dac786f3 137 }
dac786f3 138}
139
516cf3eb 140
4323d029 141/**
017bc1d9 142 * Class representing q question category
dac786f3 143 *
017bc1d9
TH
144 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
145 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4323d029 146 */
dc1f00de 147class question_category_object {
516cf3eb 148
dac786f3 149 /**
fa5c608c 150 * @var array common language strings.
dac786f3 151 */
fa5c608c
TH
152 public $str;
153
154 /**
155 * @var array nested lists to display categories.
156 */
157 public $editlists = array();
158 public $newtable;
159 public $tab;
160 public $tabsize = 3;
017bc1d9 161
986effb6 162 /**
163 * @var moodle_url Object representing url for this page
164 */
fa5c608c
TH
165 public $pageurl;
166
271e6dec 167 /**
168 * @var question_category_edit_form Object representing form for adding / editing categories.
169 */
fa5c608c 170 public $catform;
516cf3eb 171
bc649d80 172 /**
173 * Constructor
174 *
175 * Gets necessary strings and sets relevant path information
176 */
c4d0b752 177 public function __construct($page, $pageurl, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts) {
a5cb8d69 178 global $CFG, $COURSE, $OUTPUT;
516cf3eb 179
180 $this->tab = str_repeat('&nbsp;', $this->tabsize);
181
e2bb3c92 182 $this->str = new stdClass();
516cf3eb 183 $this->str->course = get_string('course');
5e8a85aa
TH
184 $this->str->category = get_string('category', 'question');
185 $this->str->categoryinfo = get_string('categoryinfo', 'question');
186 $this->str->questions = get_string('questions', 'question');
516cf3eb 187 $this->str->add = get_string('add');
188 $this->str->delete = get_string('delete');
189 $this->str->moveup = get_string('moveup');
190 $this->str->movedown = get_string('movedown');
85edde5c 191 $this->str->edit = get_string('editthiscategory', 'question');
516cf3eb 192 $this->str->hide = get_string('hide');
516cf3eb 193 $this->str->order = get_string('order');
5e8a85aa 194 $this->str->parent = get_string('parent', 'question');
516cf3eb 195 $this->str->add = get_string('add');
196 $this->str->action = get_string('action');
5e8a85aa
TH
197 $this->str->top = get_string('top');
198 $this->str->addcategory = get_string('addcategory', 'question');
199 $this->str->editcategory = get_string('editcategory', 'question');
516cf3eb 200 $this->str->cancel = get_string('cancel');
5e8a85aa 201 $this->str->editcategories = get_string('editcategories', 'question');
2befe778 202 $this->str->page = get_string('page');
516cf3eb 203
986effb6 204 $this->pageurl = $pageurl;
271e6dec 205
206 $this->initialize($page, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts);
516cf3eb 207 }
271e6dec 208
9e313e79
DM
209 /**
210 * Old syntax of class constructor. Deprecated in PHP7.
211 *
212 * @deprecated since Moodle 3.1
213 */
214 public function question_category_object($page, $pageurl, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts) {
215 debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
216 self::__construct($page, $pageurl, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts);
217 }
218
271e6dec 219 /**
220 * Initializes this classes general category-related variables
221 */
f34488b2 222 public function initialize($page, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts) {
271e6dec 223 $lastlist = null;
224 foreach ($contexts as $context){
225 $this->editlists[$context->id] = new question_category_list('ul', '', true, $this->pageurl, $page, 'cpage', QUESTION_PAGE_LENGTH, $context);
226 $this->editlists[$context->id]->lastlist =& $lastlist;
227 if ($lastlist!== null){
228 $lastlist->nextlist =& $this->editlists[$context->id];
229 }
230 $lastlist =& $this->editlists[$context->id];
231 }
232
233 $count = 1;
234 $paged = false;
235 foreach ($this->editlists as $key => $list){
20f500dc 236 list($paged, $count) = $this->editlists[$key]->list_from_records($paged, $count);
271e6dec 237 }
238 $this->catform = new question_category_edit_form($this->pageurl, compact('contexts', 'currentcat'));
239 if (!$currentcat){
240 $this->catform->set_data(array('parent'=>$defaultcategory));
241 }
242 }
017bc1d9 243
bc649d80 244 /**
245 * Displays the user interface
246 *
bc649d80 247 */
f34488b2 248 public function display_user_interface() {
dac786f3 249
250 /// Interface for editing existing categories
271e6dec 251 $this->output_edit_lists();
dac786f3 252
516cf3eb 253
dac786f3 254 echo '<br />';
516cf3eb 255 /// Interface for adding a new category:
516cf3eb 256 $this->output_new_table();
257 echo '<br />';
258
516cf3eb 259 }
260
bc649d80 261 /**
262 * Outputs a table to allow entry of a new category
263 */
f34488b2 264 public function output_new_table() {
271e6dec 265 $this->catform->display();
516cf3eb 266 }
267
bc649d80 268 /**
dac786f3 269 * Outputs a list to allow editing/rearranging of existing categories
bc649d80 270 *
271 * $this->initialize() must have already been called
272 *
bc649d80 273 */
f34488b2 274 public function output_edit_lists() {
723d610c 275 global $OUTPUT;
1d58b567 276
5fcefc97 277 echo $OUTPUT->heading_with_help(get_string('editcategories', 'question'), 'editcategories', 'question');
1d58b567 278
271e6dec 279 foreach ($this->editlists as $context => $list){
280 $listhtml = $list->to_html(0, array('str'=>$this->str));
281 if ($listhtml){
beb677cd 282 echo $OUTPUT->box_start('boxwidthwide boxaligncenter generalbox questioncategories contextlevel' . $list->context->contextlevel);
329846f1
AG
283 $fullcontext = context::instance_by_id($context);
284 echo $OUTPUT->heading(get_string('questioncatsfor', 'question', $fullcontext->get_context_name()), 3);
271e6dec 285 echo $listhtml;
beb677cd 286 echo $OUTPUT->box_end();
271e6dec 287 }
288 }
289 echo $list->display_page_numbers();
290 }
516cf3eb 291
bc649d80 292 /**
293 * gets all the courseids for the given categories
294 *
295 * @param array categories contains category objects in a tree representation
296 * @return array courseids flat array in form categoryid=>courseid
297 */
f34488b2 298 public function get_course_ids($categories) {
516cf3eb 299 $courseids = array();
300 foreach ($categories as $key=>$cat) {
301 $courseids[$key] = $cat->course;
302 if (!empty($cat->children)) {
303 $courseids = array_merge($courseids, $this->get_course_ids($cat->children));
304 }
305 }
306 return $courseids;
307 }
308
f34488b2 309 public function edit_single_category($categoryid) {
516cf3eb 310 /// Interface for adding a new category
9275220d 311 global $DB;
516cf3eb 312 /// Interface for editing existing categories
9275220d
SR
313 $category = $DB->get_record("question_categories", array("id" => $categoryid));
314 if (empty($category)) {
315 print_error('invalidcategory', '', '', $categoryid);
316 } else if ($category->parent == 0) {
317 print_error('cannotedittopcat', 'question', '', $categoryid);
318 } else {
f4fe3968 319 $category->parent = "{$category->parent},{$category->contextid}";
271e6dec 320 $category->submitbutton = get_string('savechanges');
321 $category->categoryheader = $this->str->edit;
322 $this->catform->set_data($category);
323 $this->catform->display();
516cf3eb 324 }
516cf3eb 325 }
326
bc649d80 327 /**
328 * Sets the viable parents
329 *
330 * Viable parents are any except for the category itself, or any of it's descendants
331 * The parentstrings parameter is passed by reference and changed by this function.
332 *
333 * @param array parentstrings a list of parentstrings
334 * @param object category
335 */
f34488b2 336 public function set_viable_parents(&$parentstrings, $category) {
516cf3eb 337
338 unset($parentstrings[$category->id]);
339 if (isset($category->children)) {
340 foreach ($category->children as $child) {
341 $this->set_viable_parents($parentstrings, $child);
342 }
343 }
344 }
345
bc649d80 346 /**
347 * Gets question categories
348 *
349 * @param int parent - if given, restrict records to those with this parent id.
350 * @param string sort - [[sortfield [,sortfield]] {ASC|DESC}]
351 * @return array categories
352 */
f34488b2 353 public function get_question_categories($parent=null, $sort="sortorder ASC") {
354 global $COURSE, $DB;
516cf3eb 355 if (is_null($parent)) {
f34488b2 356 $categories = $DB->get_records('question_categories', array('course' => $COURSE->id), $sort);
516cf3eb 357 } else {
f34488b2 358 $select = "parent = ? AND course = ?";
359 $categories = $DB->get_records_select('question_categories', $select, array($parent, $COURSE->id), $sort);
516cf3eb 360 }
361 return $categories;
362 }
363
bc649d80 364 /**
365 * Deletes an existing question category
366 *
21cbf9da 367 * @param int deletecat id of category to delete
bc649d80 368 */
f34488b2 369 public function delete_category($categoryid) {
370 global $CFG, $DB;
271e6dec 371 question_can_delete_cat($categoryid);
f34488b2 372 if (!$category = $DB->get_record("question_categories", array("id" => $categoryid))) { // security
64e71d27 373 print_error('unknowcategory');
516cf3eb 374 }
516cf3eb 375 /// Send the children categories to live with their grandparent
bb4b6010 376 $DB->set_field("question_categories", "parent", $category->parent, array("parent" => $category->id));
516cf3eb 377
378 /// Finally delete the category itself
21cbf9da 379 $DB->delete_records("question_categories", array("id" => $category->id));
516cf3eb 380 }
21cbf9da 381
f34488b2 382 public function move_questions_and_delete_category($oldcat, $newcat){
271e6dec 383 question_can_delete_cat($oldcat);
384 $this->move_questions($oldcat, $newcat);
385 $this->delete_category($oldcat);
386 }
516cf3eb 387
f34488b2 388 public function display_move_form($questionsincategory, $category){
beb677cd 389 global $OUTPUT;
0ff4bd08 390 $vars = new stdClass();
271e6dec 391 $vars->name = $category->name;
392 $vars->count = $questionsincategory;
5e8a85aa 393 echo $OUTPUT->box(get_string('categorymove', 'question', $vars), 'generalbox boxaligncenter');
271e6dec 394 $this->moveform->display();
395 }
516cf3eb 396
f34488b2 397 public function move_questions($oldcat, $newcat){
534792cd 398 global $DB;
5d548d3e
TH
399 $questionids = $DB->get_records_select_menu('question',
400 'category = ? AND (parent = 0 OR parent = id)', array($oldcat), '', 'id,1');
9d0ac0ff 401 question_move_questions_to_category(array_keys($questionids), $newcat);
516cf3eb 402 }
403
bc649d80 404 /**
405 * Creates a new category with given params
bc649d80 406 */
fa5c608c 407 public function add_category($newparent, $newcategory, $newinfo, $return = false, $newinfoformat = FORMAT_HTML) {
f34488b2 408 global $DB;
bc649d80 409 if (empty($newcategory)) {
5e8a85aa 410 print_error('categorynamecantbeblank', 'question');
bc649d80 411 }
271e6dec 412 list($parentid, $contextid) = explode(',', $newparent);
413 //moodle_form makes sure select element output is legal no need for further cleaning
d197ea43 414 require_capability('moodle/question:managecategory', context::instance_by_id($contextid));
516cf3eb 415
271e6dec 416 if ($parentid) {
f34488b2 417 if(!($DB->get_field('question_categories', 'contextid', array('id' => $parentid)) == $contextid)) {
3e0e25ef 418 print_error('cannotinsertquestioncatecontext', 'question', '', array('cat'=>$newcategory, 'ctx'=>$contextid));
516cf3eb 419 }
420 }
421
7f389342 422 $cat = new stdClass();
271e6dec 423 $cat->parent = $parentid;
424 $cat->contextid = $contextid;
516cf3eb 425 $cat->name = $newcategory;
426 $cat->info = $newinfo;
fa5c608c 427 $cat->infoformat = $newinfoformat;
516cf3eb 428 $cat->sortorder = 999;
429 $cat->stamp = make_unique_id_code();
bb4b6010 430 $categoryid = $DB->insert_record("question_categories", $cat);
58940b19
MN
431
432 // Log the creation of this category.
433 $params = array(
434 'objectid' => $categoryid,
435 'contextid' => $contextid
436 );
437 $event = \core\event\question_category_created::create($params);
438 $event->trigger();
439
bb4b6010 440 if ($return) {
441 return $categoryid;
516cf3eb 442 } else {
e42f153c 443 redirect($this->pageurl);//always redirect after successful action
516cf3eb 444 }
516cf3eb 445 }
446
bc649d80 447 /**
448 * Updates an existing category with given params
bc649d80 449 */
fa5c608c 450 public function update_category($updateid, $newparent, $newname, $newinfo, $newinfoformat = FORMAT_HTML) {
f9b0500f 451 global $CFG, $DB;
271e6dec 452 if (empty($newname)) {
5e8a85aa 453 print_error('categorynamecantbeblank', 'question');
bc649d80 454 }
516cf3eb 455
41c96651 456 // Get the record we are updating.
f34488b2 457 $oldcat = $DB->get_record('question_categories', array('id' => $updateid));
9275220d 458 $lastcategoryinthiscontext = question_is_only_child_of_top_category_in_context($updateid);
41c96651 459
460 if (!empty($newparent) && !$lastcategoryinthiscontext) {
461 list($parentid, $tocontextid) = explode(',', $newparent);
462 } else {
463 $parentid = $oldcat->parent;
464 $tocontextid = $oldcat->contextid;
465 }
466
467 // Check permissions.
d197ea43 468 $fromcontext = context::instance_by_id($oldcat->contextid);
271e6dec 469 require_capability('moodle/question:managecategory', $fromcontext);
41c96651 470
d7d4a097
JD
471 // If moving to another context, check permissions some more, and confirm contextid,stamp uniqueness.
472 $newstamprequired = false;
5d548d3e 473 if ($oldcat->contextid != $tocontextid) {
d197ea43 474 $tocontext = context::instance_by_id($tocontextid);
271e6dec 475 require_capability('moodle/question:managecategory', $tocontext);
d7d4a097
JD
476
477 // Confirm stamp uniqueness in the new context. If the stamp already exists, generate a new one.
478 if ($DB->record_exists('question_categories', array('contextid' => $tocontextid, 'stamp' => $oldcat->stamp))) {
479 $newstamprequired = true;
480 }
271e6dec 481 }
41c96651 482
483 // Update the category record.
9aa09d8f 484 $cat = new stdClass();
516cf3eb 485 $cat->id = $updateid;
271e6dec 486 $cat->name = $newname;
487 $cat->info = $newinfo;
fa5c608c 488 $cat->infoformat = $newinfoformat;
41c96651 489 $cat->parent = $parentid;
5d548d3e 490 $cat->contextid = $tocontextid;
d7d4a097
JD
491 if ($newstamprequired) {
492 $cat->stamp = make_unique_id_code();
493 }
bb4b6010 494 $DB->update_record('question_categories', $cat);
f59dba84 495
df4e2244 496 // If the category name has changed, rename any random questions in that category.
41c96651 497 if ($oldcat->name != $cat->name) {
3cac440b 498 $where = "qtype = 'random' AND category = ? AND " . $DB->sql_compare_text('questiontext') . " = ?";
499
f9b0500f
TH
500 $randomqtype = question_bank::get_qtype('random');
501 $randomqname = $randomqtype->question_name($cat, false);
3cac440b 502 $DB->set_field_select('question', 'name', $randomqname, $where, array($cat->id, '0'));
503
f9b0500f 504 $randomqname = $randomqtype->question_name($cat, true);
3cac440b 505 $DB->set_field_select('question', 'name', $randomqname, $where, array($cat->id, '1'));
41c96651 506 }
507
5d548d3e
TH
508 if ($oldcat->contextid != $tocontextid) {
509 // Moving to a new context. Must move files belonging to questions.
510 question_move_category_to_context($cat->id, $oldcat->contextid, $tocontextid);
516cf3eb 511 }
271e6dec 512
9645fe83
TH
513 // Cat param depends on the context id, so update it.
514 $this->pageurl->param('cat', $updateid . ',' . $tocontextid);
5d548d3e 515 redirect($this->pageurl);
271e6dec 516 }
516cf3eb 517}