weekly release 2.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 }
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
TH
115 // don't allow delete if this is the last category in this context.
116 if (count($this->parentlist->records) != 1) {
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
137 var $str;
dac786f3 138 /**
271e6dec 139 * Nested lists to display categories.
dac786f3 140 *
271e6dec 141 * @var array
dac786f3 142 */
271e6dec 143 var $editlists = array();
516cf3eb 144 var $newtable;
145 var $tab;
146 var $tabsize = 3;
017bc1d9 147
986effb6 148 /**
149 * @var moodle_url Object representing url for this page
150 */
a982d582 151 var $pageurl;
271e6dec 152 /**
153 * @var question_category_edit_form Object representing form for adding / editing categories.
154 */
155 var $catform;
516cf3eb 156
bc649d80 157 /**
158 * Constructor
159 *
160 * Gets necessary strings and sets relevant path information
161 */
f34488b2 162 public function question_category_object($page, $pageurl, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts) {
a5cb8d69 163 global $CFG, $COURSE, $OUTPUT;
516cf3eb 164
165 $this->tab = str_repeat('&nbsp;', $this->tabsize);
166
e2bb3c92 167 $this->str = new stdClass();
516cf3eb 168 $this->str->course = get_string('course');
5e8a85aa
TH
169 $this->str->category = get_string('category', 'question');
170 $this->str->categoryinfo = get_string('categoryinfo', 'question');
171 $this->str->questions = get_string('questions', 'question');
516cf3eb 172 $this->str->add = get_string('add');
173 $this->str->delete = get_string('delete');
174 $this->str->moveup = get_string('moveup');
175 $this->str->movedown = get_string('movedown');
85edde5c 176 $this->str->edit = get_string('editthiscategory', 'question');
516cf3eb 177 $this->str->hide = get_string('hide');
516cf3eb 178 $this->str->order = get_string('order');
5e8a85aa 179 $this->str->parent = get_string('parent', 'question');
516cf3eb 180 $this->str->add = get_string('add');
181 $this->str->action = get_string('action');
5e8a85aa
TH
182 $this->str->top = get_string('top');
183 $this->str->addcategory = get_string('addcategory', 'question');
184 $this->str->editcategory = get_string('editcategory', 'question');
516cf3eb 185 $this->str->cancel = get_string('cancel');
5e8a85aa 186 $this->str->editcategories = get_string('editcategories', 'question');
2befe778 187 $this->str->page = get_string('page');
516cf3eb 188
986effb6 189 $this->pageurl = $pageurl;
271e6dec 190
191 $this->initialize($page, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts);
516cf3eb 192 }
271e6dec 193
271e6dec 194 /**
195 * Initializes this classes general category-related variables
196 */
f34488b2 197 public function initialize($page, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts) {
271e6dec 198 $lastlist = null;
199 foreach ($contexts as $context){
200 $this->editlists[$context->id] = new question_category_list('ul', '', true, $this->pageurl, $page, 'cpage', QUESTION_PAGE_LENGTH, $context);
201 $this->editlists[$context->id]->lastlist =& $lastlist;
202 if ($lastlist!== null){
203 $lastlist->nextlist =& $this->editlists[$context->id];
204 }
205 $lastlist =& $this->editlists[$context->id];
206 }
207
208 $count = 1;
209 $paged = false;
210 foreach ($this->editlists as $key => $list){
20f500dc 211 list($paged, $count) = $this->editlists[$key]->list_from_records($paged, $count);
271e6dec 212 }
213 $this->catform = new question_category_edit_form($this->pageurl, compact('contexts', 'currentcat'));
214 if (!$currentcat){
215 $this->catform->set_data(array('parent'=>$defaultcategory));
216 }
217 }
017bc1d9 218
bc649d80 219 /**
220 * Displays the user interface
221 *
bc649d80 222 */
f34488b2 223 public function display_user_interface() {
dac786f3 224
225 /// Interface for editing existing categories
271e6dec 226 $this->output_edit_lists();
dac786f3 227
516cf3eb 228
dac786f3 229 echo '<br />';
516cf3eb 230 /// Interface for adding a new category:
516cf3eb 231 $this->output_new_table();
232 echo '<br />';
233
516cf3eb 234 }
235
bc649d80 236 /**
237 * Outputs a table to allow entry of a new category
238 */
f34488b2 239 public function output_new_table() {
271e6dec 240 $this->catform->display();
516cf3eb 241 }
242
bc649d80 243 /**
dac786f3 244 * Outputs a list to allow editing/rearranging of existing categories
bc649d80 245 *
246 * $this->initialize() must have already been called
247 *
bc649d80 248 */
f34488b2 249 public function output_edit_lists() {
723d610c 250 global $OUTPUT;
1d58b567 251
5fcefc97 252 echo $OUTPUT->heading_with_help(get_string('editcategories', 'question'), 'editcategories', 'question');
1d58b567 253
271e6dec 254 foreach ($this->editlists as $context => $list){
255 $listhtml = $list->to_html(0, array('str'=>$this->str));
256 if ($listhtml){
beb677cd 257 echo $OUTPUT->box_start('boxwidthwide boxaligncenter generalbox questioncategories contextlevel' . $list->context->contextlevel);
329846f1
AG
258 $fullcontext = context::instance_by_id($context);
259 echo $OUTPUT->heading(get_string('questioncatsfor', 'question', $fullcontext->get_context_name()), 3);
271e6dec 260 echo $listhtml;
beb677cd 261 echo $OUTPUT->box_end();
271e6dec 262 }
263 }
264 echo $list->display_page_numbers();
265 }
516cf3eb 266
bc649d80 267 /**
268 * gets all the courseids for the given categories
269 *
270 * @param array categories contains category objects in a tree representation
271 * @return array courseids flat array in form categoryid=>courseid
272 */
f34488b2 273 public function get_course_ids($categories) {
516cf3eb 274 $courseids = array();
275 foreach ($categories as $key=>$cat) {
276 $courseids[$key] = $cat->course;
277 if (!empty($cat->children)) {
278 $courseids = array_merge($courseids, $this->get_course_ids($cat->children));
279 }
280 }
281 return $courseids;
282 }
283
f34488b2 284 public function edit_single_category($categoryid) {
516cf3eb 285 /// Interface for adding a new category
f34488b2 286 global $COURSE, $DB;
516cf3eb 287 /// Interface for editing existing categories
f34488b2 288 if ($category = $DB->get_record("question_categories", array("id" => $categoryid))) {
516cf3eb 289
271e6dec 290 $category->parent = "$category->parent,$category->contextid";
291 $category->submitbutton = get_string('savechanges');
292 $category->categoryheader = $this->str->edit;
293 $this->catform->set_data($category);
294 $this->catform->display();
295 } else {
64e71d27 296 print_error('invalidcategory', '', '', $categoryid);
516cf3eb 297 }
516cf3eb 298 }
299
bc649d80 300 /**
301 * Sets the viable parents
302 *
303 * Viable parents are any except for the category itself, or any of it's descendants
304 * The parentstrings parameter is passed by reference and changed by this function.
305 *
306 * @param array parentstrings a list of parentstrings
307 * @param object category
308 */
f34488b2 309 public function set_viable_parents(&$parentstrings, $category) {
516cf3eb 310
311 unset($parentstrings[$category->id]);
312 if (isset($category->children)) {
313 foreach ($category->children as $child) {
314 $this->set_viable_parents($parentstrings, $child);
315 }
316 }
317 }
318
bc649d80 319 /**
320 * Gets question categories
321 *
322 * @param int parent - if given, restrict records to those with this parent id.
323 * @param string sort - [[sortfield [,sortfield]] {ASC|DESC}]
324 * @return array categories
325 */
f34488b2 326 public function get_question_categories($parent=null, $sort="sortorder ASC") {
327 global $COURSE, $DB;
516cf3eb 328 if (is_null($parent)) {
f34488b2 329 $categories = $DB->get_records('question_categories', array('course' => $COURSE->id), $sort);
516cf3eb 330 } else {
f34488b2 331 $select = "parent = ? AND course = ?";
332 $categories = $DB->get_records_select('question_categories', $select, array($parent, $COURSE->id), $sort);
516cf3eb 333 }
334 return $categories;
335 }
336
bc649d80 337 /**
338 * Deletes an existing question category
339 *
21cbf9da 340 * @param int deletecat id of category to delete
bc649d80 341 */
f34488b2 342 public function delete_category($categoryid) {
343 global $CFG, $DB;
271e6dec 344 question_can_delete_cat($categoryid);
f34488b2 345 if (!$category = $DB->get_record("question_categories", array("id" => $categoryid))) { // security
64e71d27 346 print_error('unknowcategory');
516cf3eb 347 }
516cf3eb 348 /// Send the children categories to live with their grandparent
bb4b6010 349 $DB->set_field("question_categories", "parent", $category->parent, array("parent" => $category->id));
516cf3eb 350
351 /// Finally delete the category itself
21cbf9da 352 $DB->delete_records("question_categories", array("id" => $category->id));
516cf3eb 353 }
21cbf9da 354
f34488b2 355 public function move_questions_and_delete_category($oldcat, $newcat){
271e6dec 356 question_can_delete_cat($oldcat);
357 $this->move_questions($oldcat, $newcat);
358 $this->delete_category($oldcat);
359 }
516cf3eb 360
f34488b2 361 public function display_move_form($questionsincategory, $category){
beb677cd 362 global $OUTPUT;
0ff4bd08 363 $vars = new stdClass();
271e6dec 364 $vars->name = $category->name;
365 $vars->count = $questionsincategory;
5e8a85aa 366 echo $OUTPUT->box(get_string('categorymove', 'question', $vars), 'generalbox boxaligncenter');
271e6dec 367 $this->moveform->display();
368 }
516cf3eb 369
f34488b2 370 public function move_questions($oldcat, $newcat){
534792cd 371 global $DB;
5d548d3e
TH
372 $questionids = $DB->get_records_select_menu('question',
373 'category = ? AND (parent = 0 OR parent = id)', array($oldcat), '', 'id,1');
9d0ac0ff 374 question_move_questions_to_category(array_keys($questionids), $newcat);
516cf3eb 375 }
376
bc649d80 377 /**
378 * Creates a new category with given params
bc649d80 379 */
94dbfb3a 380 public function add_category($newparent, $newcategory, $newinfo, $return = false) {
f34488b2 381 global $DB;
bc649d80 382 if (empty($newcategory)) {
5e8a85aa 383 print_error('categorynamecantbeblank', 'question');
bc649d80 384 }
271e6dec 385 list($parentid, $contextid) = explode(',', $newparent);
386 //moodle_form makes sure select element output is legal no need for further cleaning
d197ea43 387 require_capability('moodle/question:managecategory', context::instance_by_id($contextid));
516cf3eb 388
271e6dec 389 if ($parentid) {
f34488b2 390 if(!($DB->get_field('question_categories', 'contextid', array('id' => $parentid)) == $contextid)) {
3e0e25ef 391 print_error('cannotinsertquestioncatecontext', 'question', '', array('cat'=>$newcategory, 'ctx'=>$contextid));
516cf3eb 392 }
393 }
394
7f389342 395 $cat = new stdClass();
271e6dec 396 $cat->parent = $parentid;
397 $cat->contextid = $contextid;
516cf3eb 398 $cat->name = $newcategory;
399 $cat->info = $newinfo;
516cf3eb 400 $cat->sortorder = 999;
401 $cat->stamp = make_unique_id_code();
bb4b6010 402 $categoryid = $DB->insert_record("question_categories", $cat);
403 if ($return) {
404 return $categoryid;
516cf3eb 405 } else {
e42f153c 406 redirect($this->pageurl);//always redirect after successful action
516cf3eb 407 }
516cf3eb 408 }
409
bc649d80 410 /**
411 * Updates an existing category with given params
bc649d80 412 */
f34488b2 413 public function update_category($updateid, $newparent, $newname, $newinfo) {
f9b0500f 414 global $CFG, $DB;
271e6dec 415 if (empty($newname)) {
5e8a85aa 416 print_error('categorynamecantbeblank', 'question');
bc649d80 417 }
516cf3eb 418
41c96651 419 // Get the record we are updating.
f34488b2 420 $oldcat = $DB->get_record('question_categories', array('id' => $updateid));
df4e2244 421 $lastcategoryinthiscontext = question_is_only_toplevel_category_in_context($updateid);
41c96651 422
423 if (!empty($newparent) && !$lastcategoryinthiscontext) {
424 list($parentid, $tocontextid) = explode(',', $newparent);
425 } else {
426 $parentid = $oldcat->parent;
427 $tocontextid = $oldcat->contextid;
428 }
429
430 // Check permissions.
d197ea43 431 $fromcontext = context::instance_by_id($oldcat->contextid);
271e6dec 432 require_capability('moodle/question:managecategory', $fromcontext);
41c96651 433
434 // If moving to another context, check permissions some more.
5d548d3e 435 if ($oldcat->contextid != $tocontextid) {
d197ea43 436 $tocontext = context::instance_by_id($tocontextid);
271e6dec 437 require_capability('moodle/question:managecategory', $tocontext);
438 }
41c96651 439
440 // Update the category record.
9aa09d8f 441 $cat = new stdClass();
516cf3eb 442 $cat->id = $updateid;
271e6dec 443 $cat->name = $newname;
444 $cat->info = $newinfo;
41c96651 445 $cat->parent = $parentid;
5d548d3e 446 $cat->contextid = $tocontextid;
bb4b6010 447 $DB->update_record('question_categories', $cat);
f59dba84 448
df4e2244 449 // If the category name has changed, rename any random questions in that category.
41c96651 450 if ($oldcat->name != $cat->name) {
3cac440b 451 $where = "qtype = 'random' AND category = ? AND " . $DB->sql_compare_text('questiontext') . " = ?";
452
f9b0500f
TH
453 $randomqtype = question_bank::get_qtype('random');
454 $randomqname = $randomqtype->question_name($cat, false);
3cac440b 455 $DB->set_field_select('question', 'name', $randomqname, $where, array($cat->id, '0'));
456
f9b0500f 457 $randomqname = $randomqtype->question_name($cat, true);
3cac440b 458 $DB->set_field_select('question', 'name', $randomqname, $where, array($cat->id, '1'));
41c96651 459 }
460
5d548d3e
TH
461 if ($oldcat->contextid != $tocontextid) {
462 // Moving to a new context. Must move files belonging to questions.
463 question_move_category_to_context($cat->id, $oldcat->contextid, $tocontextid);
516cf3eb 464 }
271e6dec 465
9645fe83
TH
466 // Cat param depends on the context id, so update it.
467 $this->pageurl->param('cat', $updateid . ',' . $tocontextid);
5d548d3e 468 redirect($this->pageurl);
271e6dec 469 }
516cf3eb 470}