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