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