question/category_class.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  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
  26
  27 defined('MOODLE_INTERNAL') || die();
  28
  29 // number of categories to display on page
  30 define('QUESTION_PAGE_LENGTH', 25);
  31
  32 require_once($CFG->libdir . '/listlib.php');
  33 require_once($CFG->dirroot . '/question/category_form.php');
  34 require_once($CFG->dirroot . '/question/move_form.php');
  35
  36
  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  */
  43 class question_category_list extends moodle_list {
  44     public $table = "question_categories";
  45     public $listitemclassname = 'question_category_list_item';
  46     /**
  47      * @var reference to list displayed below this one.
  48      */
  49     public $nextlist = null;
  50     /**
  51      * @var reference to list displayed above this one.
  52      */
  53     public $lastlist = null;
  54
  55     public $context = null;
  56     public $sortby = 'parent, sortorder, name';
  57
  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);
  60         $this->context = $context;
  61     }
  62
  63     public function get_records() {
  64         $this->records = get_categories_for_contexts($this->context->id, $this->sortby);
  65     }
  66 }
  67
  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  */
  75 class question_category_list_item extends list_item {
  76     public function set_icon_html($first, $last, &$lastitem){
  77         global $CFG;
  78         $category = $this->item;
  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');
  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)){
  84             $url = new moodle_url($this->parentlist->pageurl, array('movedowncontext'=>$this->id, 'tocontext'=>$this->parentlist->nextlist->context->id, 'sesskey'=>sesskey()));
  85             $this->icons['down'] = $this->image_icon(
  86                 get_string('shareincontext', 'question', print_context_name($this->parentlist->nextlist->context)), $url, 'down');
  87         }
  88         if (($this->parentlist->lastlist !== null) && $first && $toplevel && (count($this->parentlist->items)>1)){
  89             $url = new moodle_url($this->parentlist->pageurl, array('moveupcontext'=>$this->id, 'tocontext'=>$this->parentlist->lastlist->context->id, 'sesskey'=>sesskey()));
  90             $this->icons['up'] = $this->image_icon(
  91                 get_string('shareincontext', 'question', print_context_name($this->parentlist->lastlist->context)), $url, 'up');
  92         }
  93     }
  94
  95     public function item_html($extraargs = array()){
  96         global $CFG, $OUTPUT;
  97         $str = $extraargs['str'];
  98         $category = $this->item;
  99
 100         $editqestions = get_string('editquestions', 'question');
 101
 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() + array('category'=>"$category->id,$category->contextid")));
 104         $catediturl = $this->parentlist->pageurl->out(true, array('edit' => $this->id));
 105         $item = "<b><a title=\"{$str->edit}\" href=\"$catediturl\">".$category->name ."</a></b> <a title=\"$editqestions\" href=\"$questionbankurl\">".'('.$category->questioncount.')</a>';
 106
 107         $item .= '&nbsp;'. $category->info;
 108
 109         // don't allow delete if this is the last category in this context.
 110         if (count($this->parentlist->records) != 1) {
 111             $item .=  '<a title="' . $str->delete . '" href="'.$this->parentlist->pageurl->out(true, array('delete'=>$this->id, 'sesskey'=>sesskey())).'">
 112                     <img src="' . $OUTPUT->pix_url('t/delete') . '" class="iconsmall" alt="' .$str->delete. '" /></a>';
 113         }
 114
 115         return $item;
 116     }
 117 }
 118
 119
 120 /**
 121  * Class representing q question category
 122  *
 123  * @copyright  1999 onwards Martin Dougiamas {@link http://moodle.com}
 124  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 125  */
 126 class question_category_object {
 127
 128     var $str;
 129     /**
 130      * Nested lists to display categories.
 131      *
 132      * @var array
 133      */
 134     var $editlists = array();
 135     var $newtable;
 136     var $tab;
 137     var $tabsize = 3;
 138
 139     /**
 140      * @var moodle_url Object representing url for this page
 141      */
 142     var $pageurl;
 143     /**
 144      * @var question_category_edit_form Object representing form for adding / editing categories.
 145      */
 146     var $catform;
 147
 148     /**
 149      * Constructor
 150      *
 151      * Gets necessary strings and sets relevant path information
 152      */
 153     public function question_category_object($page, $pageurl, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts) {
 154         global $CFG, $COURSE, $OUTPUT;
 155
 156         $this->tab = str_repeat('&nbsp;', $this->tabsize);
 157
 158         $this->str->course         = get_string('course');
 159         $this->str->category       = get_string('category', 'question');
 160         $this->str->categoryinfo   = get_string('categoryinfo', 'question');
 161         $this->str->questions      = get_string('questions', 'question');
 162         $this->str->add            = get_string('add');
 163         $this->str->delete         = get_string('delete');
 164         $this->str->moveup         = get_string('moveup');
 165         $this->str->movedown       = get_string('movedown');
 166         $this->str->edit           = get_string('editthiscategory', 'question');
 167         $this->str->hide           = get_string('hide');
 168         $this->str->order          = get_string('order');
 169         $this->str->parent         = get_string('parent', 'question');
 170         $this->str->add            = get_string('add');
 171         $this->str->action         = get_string('action');
 172         $this->str->top            = get_string('top');
 173         $this->str->addcategory    = get_string('addcategory', 'question');
 174         $this->str->editcategory   = get_string('editcategory', 'question');
 175         $this->str->cancel         = get_string('cancel');
 176         $this->str->editcategories = get_string('editcategories', 'question');
 177         $this->str->page           = get_string('page');
 178
 179         $this->pageurl = $pageurl;
 180
 181         $this->initialize($page, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts);
 182     }
 183
 184     /**
 185      * Initializes this classes general category-related variables
 186      */
 187     public function initialize($page, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts) {
 188         $lastlist = null;
 189         foreach ($contexts as $context){
 190             $this->editlists[$context->id] = new question_category_list('ul', '', true, $this->pageurl, $page, 'cpage', QUESTION_PAGE_LENGTH, $context);
 191             $this->editlists[$context->id]->lastlist =& $lastlist;
 192             if ($lastlist!== null){
 193                 $lastlist->nextlist =& $this->editlists[$context->id];
 194             }
 195             $lastlist =& $this->editlists[$context->id];
 196         }
 197
 198         $count = 1;
 199         $paged = false;
 200         foreach ($this->editlists as $key => $list){
 201             list($paged, $count) = $this->editlists[$key]->list_from_records($paged, $count);
 202         }
 203         $this->catform = new question_category_edit_form($this->pageurl, compact('contexts', 'currentcat'));
 204         if (!$currentcat){
 205             $this->catform->set_data(array('parent'=>$defaultcategory));
 206         }
 207     }
 208
 209     /**
 210      * Displays the user interface
 211      *
 212      */
 213     public function display_user_interface() {
 214
 215         /// Interface for editing existing categories
 216         $this->output_edit_lists();
 217
 218
 219         echo '<br />';
 220         /// Interface for adding a new category:
 221         $this->output_new_table();
 222         echo '<br />';
 223
 224     }
 225
 226     /**
 227      * Outputs a table to allow entry of a new category
 228      */
 229     public function output_new_table() {
 230         $this->catform->display();
 231     }
 232
 233     /**
 234      * Outputs a list to allow editing/rearranging of existing categories
 235      *
 236      * $this->initialize() must have already been called
 237      *
 238      */
 239     public function output_edit_lists() {
 240         global $OUTPUT;
 241
 242         echo $OUTPUT->heading_with_help(get_string('editcategories', 'question'), 'editcategories', 'question');
 243
 244         foreach ($this->editlists as $context => $list){
 245             $listhtml = $list->to_html(0, array('str'=>$this->str));
 246             if ($listhtml){
 247                 echo $OUTPUT->box_start('boxwidthwide boxaligncenter generalbox questioncategories contextlevel' . $list->context->contextlevel);
 248                 echo $OUTPUT->heading(get_string('questioncatsfor', 'question', print_context_name(get_context_instance_by_id($context))), 3);
 249                 echo $listhtml;
 250                 echo $OUTPUT->box_end();
 251             }
 252         }
 253         echo $list->display_page_numbers();
 254      }
 255
 256     /**
 257      * gets all the courseids for the given categories
 258      *
 259      * @param array categories contains category objects in  a tree representation
 260      * @return array courseids flat array in form categoryid=>courseid
 261      */
 262     public function get_course_ids($categories) {
 263         $courseids = array();
 264         foreach ($categories as $key=>$cat) {
 265             $courseids[$key] = $cat->course;
 266             if (!empty($cat->children)) {
 267                 $courseids = array_merge($courseids, $this->get_course_ids($cat->children));
 268             }
 269         }
 270         return $courseids;
 271     }
 272
 273     public function edit_single_category($categoryid) {
 274     /// Interface for adding a new category
 275         global $COURSE, $DB;
 276         /// Interface for editing existing categories
 277         if ($category = $DB->get_record("question_categories", array("id" => $categoryid))) {
 278
 279             $category->parent = "$category->parent,$category->contextid";
 280             $category->submitbutton = get_string('savechanges');
 281             $category->categoryheader = $this->str->edit;
 282             $this->catform->set_data($category);
 283             $this->catform->display();
 284         } else {
 285             print_error('invalidcategory', '', '', $categoryid);
 286         }
 287     }
 288
 289     /**
 290      * Sets the viable parents
 291      *
 292      *  Viable parents are any except for the category itself, or any of it's descendants
 293      *  The parentstrings parameter is passed by reference and changed by this function.
 294      *
 295      * @param    array parentstrings a list of parentstrings
 296      * @param   object category
 297      */
 298     public function set_viable_parents(&$parentstrings, $category) {
 299
 300         unset($parentstrings[$category->id]);
 301         if (isset($category->children)) {
 302             foreach ($category->children as $child) {
 303                 $this->set_viable_parents($parentstrings, $child);
 304             }
 305         }
 306     }
 307
 308     /**
 309      * Gets question categories
 310      *
 311      * @param    int parent - if given, restrict records to those with this parent id.
 312      * @param    string sort - [[sortfield [,sortfield]] {ASC|DESC}]
 313      * @return   array categories
 314      */
 315     public function get_question_categories($parent=null, $sort="sortorder ASC") {
 316         global $COURSE, $DB;
 317         if (is_null($parent)) {
 318             $categories = $DB->get_records('question_categories', array('course' => $COURSE->id), $sort);
 319         } else {
 320             $select = "parent = ? AND course = ?";
 321             $categories = $DB->get_records_select('question_categories', $select, array($parent, $COURSE->id), $sort);
 322         }
 323         return $categories;
 324     }
 325
 326     /**
 327      * Deletes an existing question category
 328      *
 329      * @param int deletecat id of category to delete
 330      */
 331     public function delete_category($categoryid) {
 332         global $CFG, $DB;
 333         question_can_delete_cat($categoryid);
 334         if (!$category = $DB->get_record("question_categories", array("id" => $categoryid))) {  // security
 335             print_error('unknowcategory');
 336         }
 337         /// Send the children categories to live with their grandparent
 338         $DB->set_field("question_categories", "parent", $category->parent, array("parent" => $category->id));
 339
 340         /// Finally delete the category itself
 341         $DB->delete_records("question_categories", array("id" => $category->id));
 342     }
 343
 344     public function move_questions_and_delete_category($oldcat, $newcat){
 345         question_can_delete_cat($oldcat);
 346         $this->move_questions($oldcat, $newcat);
 347         $this->delete_category($oldcat);
 348     }
 349
 350     public function display_move_form($questionsincategory, $category){
 351         global $OUTPUT;
 352         $vars = new stdClass();
 353         $vars->name = $category->name;
 354         $vars->count = $questionsincategory;
 355         echo $OUTPUT->box(get_string('categorymove', 'question', $vars), 'generalbox boxaligncenter');
 356         $this->moveform->display();
 357     }
 358
 359     public function move_questions($oldcat, $newcat){
 360         global $DB;
 361         $questionids = $DB->get_records_select_menu('question',
 362                 'category = ? AND (parent = 0 OR parent = id)', array($oldcat), '', 'id,1');
 363         question_move_questions_to_category($questionids, $newcat);
 364     }
 365
 366     /**
 367      * Creates a new category with given params
 368      */
 369     public function add_category($newparent, $newcategory, $newinfo, $return = false) {
 370         global $DB;
 371         if (empty($newcategory)) {
 372             print_error('categorynamecantbeblank', 'question');
 373         }
 374         list($parentid, $contextid) = explode(',', $newparent);
 375         //moodle_form makes sure select element output is legal no need for further cleaning
 376         require_capability('moodle/question:managecategory', get_context_instance_by_id($contextid));
 377
 378         if ($parentid) {
 379             if(!($DB->get_field('question_categories', 'contextid', array('id' => $parentid)) == $contextid)) {
 380                 print_error('cannotinsertquestioncatecontext', 'question', '', array('cat'=>$newcategory, 'ctx'=>$contextid));
 381             }
 382         }
 383
 384         $cat = new stdClass();
 385         $cat->parent = $parentid;
 386         $cat->contextid = $contextid;
 387         $cat->name = $newcategory;
 388         $cat->info = $newinfo;
 389         $cat->sortorder = 999;
 390         $cat->stamp = make_unique_id_code();
 391         $categoryid = $DB->insert_record("question_categories", $cat);
 392         if ($return) {
 393             return $categoryid;
 394         } else {
 395             redirect($this->pageurl);//always redirect after successful action
 396         }
 397     }
 398
 399     /**
 400      * Updates an existing category with given params
 401      */
 402     public function update_category($updateid, $newparent, $newname, $newinfo) {
 403         global $CFG, $DB;
 404         if (empty($newname)) {
 405             print_error('categorynamecantbeblank', 'question');
 406         }
 407
 408         // Get the record we are updating.
 409         $oldcat = $DB->get_record('question_categories', array('id' => $updateid));
 410         $lastcategoryinthiscontext = question_is_only_toplevel_category_in_context($updateid);
 411
 412         if (!empty($newparent) && !$lastcategoryinthiscontext) {
 413             list($parentid, $tocontextid) = explode(',', $newparent);
 414         } else {
 415             $parentid = $oldcat->parent;
 416             $tocontextid = $oldcat->contextid;
 417         }
 418
 419         // Check permissions.
 420         $fromcontext = get_context_instance_by_id($oldcat->contextid);
 421         require_capability('moodle/question:managecategory', $fromcontext);
 422
 423         // If moving to another context, check permissions some more.
 424         if ($oldcat->contextid != $tocontextid) {
 425             $tocontext = get_context_instance_by_id($tocontextid);
 426             require_capability('moodle/question:managecategory', $tocontext);
 427         }
 428
 429         // Update the category record.
 430         $cat = null;
 431         $cat->id = $updateid;
 432         $cat->name = $newname;
 433         $cat->info = $newinfo;
 434         $cat->parent = $parentid;
 435         $cat->contextid = $tocontextid;
 436         $DB->update_record('question_categories', $cat);
 437
 438         // If the category name has changed, rename any random questions in that category.
 439         if ($oldcat->name != $cat->name) {
 440             $where = "qtype = 'random' AND category = ? AND " . $DB->sql_compare_text('questiontext') . " = ?";
 441
 442             $randomqtype = question_bank::get_qtype('random');
 443             $randomqname = $randomqtype->question_name($cat, false);
 444             $DB->set_field_select('question', 'name', $randomqname, $where, array($cat->id, '0'));
 445
 446             $randomqname = $randomqtype->question_name($cat, true);
 447             $DB->set_field_select('question', 'name', $randomqname, $where, array($cat->id, '1'));
 448         }
 449
 450         if ($oldcat->contextid != $tocontextid) {
 451             // Moving to a new context. Must move files belonging to questions.
 452             question_move_category_to_context($cat->id, $oldcat->contextid, $tocontextid);
 453         }
 454
 455         redirect($this->pageurl);
 456     }
 457 }