question/category_class.php

   1 <?php
   2 /**
   3  * Class representing question categories
   4  *
   5  * @author Martin Dougiamas and many others. {@link http://moodle.org}
   6  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
   7  * @package questionbank
   8  */
   9
  10 // number of categories to display on page
  11 define("QUESTION_PAGE_LENGTH", 25);
  12
  13 require_once("$CFG->libdir/listlib.php");
  14 require_once("$CFG->dirroot/question/category_form.php");
  15 require_once("$CFG->dirroot/question/category_form_randomquestion.php");
  16 require_once('move_form.php');
  17
  18 class question_category_list extends moodle_list {
  19     public $table = "question_categories";
  20     public $listitemclassname = 'question_category_list_item';
  21     /**
  22      * @var reference to list displayed below this one.
  23      */
  24     public $nextlist = null;
  25     /**
  26      * @var reference to list displayed above this one.
  27      */
  28     public $lastlist = null;
  29
  30     public $context = null;
  31     public $sortby = 'parent, sortorder, name';
  32
  33     public function question_category_list($type='ul', $attributes='', $editable = false, $pageurl=null, $page = 0, $pageparamname = 'page', $itemsperpage = 20, $context = null){
  34         parent::moodle_list('ul', '', $editable, $pageurl, $page, 'cpage', $itemsperpage);
  35         $this->context = $context;
  36     }
  37
  38     public function get_records() {
  39         $this->records = get_categories_for_contexts($this->context->id, $this->sortby);
  40     }
  41     public function process_actions($left, $right, $moveup, $movedown, $moveupcontext, $movedowncontext, $tocontext){
  42         global $CFG;
  43         //parent::procces_actions redirects after any action
  44         parent::process_actions($left, $right, $moveup, $movedown);
  45         if ($tocontext == $this->context->id){
  46             //only called on toplevel list
  47             if ($moveupcontext){
  48                 $cattomove = $moveupcontext;
  49                 $totop = 0;
  50             } elseif ($movedowncontext){
  51                 $cattomove = $movedowncontext;
  52                 $totop = 1;
  53             }
  54             $toparent = "0,{$this->context->id}";
  55             $url = new moodle_url('/question/contextmove.php?', $this->pageurl->params() + compact('cattomove', 'totop', 'toparent'));
  56             redirect($url);
  57         }
  58     }
  59 }
  60
  61 class question_category_list_item extends list_item {
  62
  63
  64     public function set_icon_html($first, $last, &$lastitem){
  65         global $CFG;
  66         $category = $this->item;
  67         $url = new moodle_url('/question/category.php', ($this->parentlist->pageurl->params() + array('edit'=>$category->id)));
  68         $this->icons['edit']= $this->image_icon(get_string('editthiscategory', 'question'), $url, 'edit');
  69         parent::set_icon_html($first, $last, $lastitem);
  70         $toplevel = ($this->parentlist->parentitem === null);//this is a top level item
  71         if (($this->parentlist->nextlist !== null) && $last && $toplevel && (count($this->parentlist->items)>1)){
  72             $url = new moodle_url($this->parentlist->pageurl, array('movedowncontext'=>$this->id, 'tocontext'=>$this->parentlist->nextlist->context->id, 'sesskey'=>sesskey()));
  73             $this->icons['down'] = $this->image_icon(
  74                 get_string('shareincontext', 'question', print_context_name($this->parentlist->nextlist->context)), $url, 'down');
  75         }
  76         if (($this->parentlist->lastlist !== null) && $first && $toplevel && (count($this->parentlist->items)>1)){
  77             $url = new moodle_url($this->parentlist->pageurl, array('moveupcontext'=>$this->id, 'tocontext'=>$this->parentlist->lastlist->context->id, 'sesskey'=>sesskey()));
  78             $this->icons['up'] = $this->image_icon(
  79                 get_string('shareincontext', 'question', print_context_name($this->parentlist->lastlist->context)), $url, 'up');
  80         }
  81     }
  82     public function item_html($extraargs = array()){
  83         global $CFG, $OUTPUT;
  84         $str = $extraargs['str'];
  85         $category = $this->item;
  86
  87         $editqestions = get_string('editquestions', 'quiz');
  88
  89         /// Each section adds html to be displayed as part of this list item
  90         $questionbankurl = new moodle_url("/question/edit.php", ($this->parentlist->pageurl->params() + array('category'=>"$category->id,$category->contextid")));
  91         $catediturl = $this->parentlist->pageurl->out(true, array('edit'=>$this->id));
  92         $item = "<b><a title=\"{$str->edit}\" href=\"$catediturl\">".$category->name ."</a></b> <a title=\"$editqestions\" href=\"$questionbankurl\">".'('.$category->questioncount.')</a>';
  93
  94         $item .= '&nbsp;'. $category->info;
  95
  96         if (count($this->parentlist->records)!=1){ // don't allow delete if this is the last category in this context.
  97             $item .=  '<a title="' . $str->delete . '" href="'.$this->parentlist->pageurl->out(true, array('delete'=>$this->id, 'sesskey'=>sesskey())).'">
  98                     <img src="' . $OUTPUT->pix_url('t/delete') . '" class="iconsmall" alt="' .$str->delete. '" /></a>';
  99         }
 100
 101         return $item;
 102     }
 103
 104 }
 105
 106
 107 /**
 108  * Class representing question categories
 109  *
 110  * @package questionbank
 111  */
 112 class question_category_object {
 113
 114     var $str;
 115     /**
 116      * Nested lists to display categories.
 117      *
 118      * @var array
 119      */
 120     var $editlists = array();
 121     var $newtable;
 122     var $tab;
 123     var $tabsize = 3;
 124 //------------------------------------------------------
 125     /**
 126      * @var moodle_url Object representing url for this page
 127      */
 128     var $pageurl;
 129     /**
 130      * @var question_category_edit_form Object representing form for adding / editing categories.
 131      */
 132     var $catform;
 133     /**
 134      * @var question_category_edit_form_randomquestion Object representing simplified form for adding a category in order to add it into a quiz as a random question.
 135      */
 136     var $catform_rand;
 137
 138     /**
 139      * Constructor
 140      *
 141      * Gets necessary strings and sets relevant path information
 142      */
 143     public function question_category_object($page, $pageurl, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts) {
 144         global $CFG, $COURSE, $OUTPUT;
 145
 146         $this->tab = str_repeat('&nbsp;', $this->tabsize);
 147
 148         $this->str->course         = get_string('course');
 149         $this->str->category       = get_string('category', 'quiz');
 150         $this->str->categoryinfo   = get_string('categoryinfo', 'quiz');
 151         $this->str->questions      = get_string('questions', 'quiz');
 152         $this->str->add            = get_string('add');
 153         $this->str->delete         = get_string('delete');
 154         $this->str->moveup         = get_string('moveup');
 155         $this->str->movedown       = get_string('movedown');
 156         $this->str->edit           = get_string('editthiscategory', 'question');
 157         $this->str->hide           = get_string('hide');
 158         $this->str->publish        = get_string('publish', 'quiz');
 159         $this->str->order          = get_string('order');
 160         $this->str->parent         = get_string('parent', 'quiz');
 161         $this->str->add            = get_string('add');
 162         $this->str->action         = get_string('action');
 163         $this->str->top            = get_string('top', 'quiz');
 164         $this->str->addcategory    = get_string('addcategory', 'quiz');
 165         $this->str->editcategory   = get_string('editcategory', 'quiz');
 166         $this->str->cancel         = get_string('cancel');
 167         $this->str->editcategories = get_string('editcategories', 'quiz');
 168         $this->str->page           = get_string('page');
 169
 170         $this->pageurl = $pageurl;
 171
 172         $this->initialize($page, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts);
 173
 174     }
 175
 176
 177
 178     /**
 179      * Initializes this classes general category-related variables
 180      */
 181     public function initialize($page, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts) {
 182         $lastlist = null;
 183         foreach ($contexts as $context){
 184             $this->editlists[$context->id] = new question_category_list('ul', '', true, $this->pageurl, $page, 'cpage', QUESTION_PAGE_LENGTH, $context);
 185             $this->editlists[$context->id]->lastlist =& $lastlist;
 186             if ($lastlist!== null){
 187                 $lastlist->nextlist =& $this->editlists[$context->id];
 188             }
 189             $lastlist =& $this->editlists[$context->id];
 190         }
 191
 192         $count = 1;
 193         $paged = false;
 194         foreach ($this->editlists as $key => $list){
 195             list($paged, $count) = $this->editlists[$key]->list_from_records($paged, $count);
 196         }
 197         $this->catform = new question_category_edit_form($this->pageurl, compact('contexts', 'currentcat'));
 198         $this->catform_rand = new question_category_edit_form_randomquestion($this->pageurl, compact('contexts', 'currentcat'));
 199         if (!$currentcat){
 200             $this->catform->set_data(array('parent'=>$defaultcategory));
 201             $this->catform_rand->set_data(array('parent'=>$defaultcategory));
 202         }
 203     }
 204     /**
 205      * Displays the user interface
 206      *
 207      */
 208     public function display_user_interface() {
 209
 210         /// Interface for editing existing categories
 211         $this->output_edit_lists();
 212
 213
 214         echo '<br />';
 215         /// Interface for adding a new category:
 216         $this->output_new_table();
 217         echo '<br />';
 218
 219     }
 220     /**
 221      * Displays the user interface
 222      *
 223      */
 224     function display_randomquestion_user_interface($addonpage=0) {
 225         $this->catform_rand->set_data(array('addonpage'=>$addonpage));
 226         /// Interface for adding a new category:
 227         $this->output_new_randomquestion_table();
 228
 229     }
 230
 231     /**
 232      * Outputs a table to allow entry of a new category
 233      */
 234     public function output_new_table() {
 235         $this->catform->display();
 236     }
 237
 238     /**
 239      * Outputs a table to allow entry of a new category
 240      */
 241     function output_new_randomquestion_table() {
 242         $this->catform_rand->display();
 243     }
 244
 245
 246     /**
 247      * Outputs a list to allow editing/rearranging of existing categories
 248      *
 249      * $this->initialize() must have already been called
 250      *
 251      */
 252     public function output_edit_lists() {
 253         global $OUTPUT;
 254
 255         echo $OUTPUT->heading_with_help(get_string('editcategories', 'question'), 'editcategories', 'question');
 256
 257         foreach ($this->editlists as $context => $list){
 258             $listhtml = $list->to_html(0, array('str'=>$this->str));
 259             if ($listhtml){
 260                 echo $OUTPUT->box_start('boxwidthwide boxaligncenter generalbox questioncategories contextlevel' . $list->context->contextlevel);
 261                 echo $OUTPUT->heading(get_string('questioncatsfor', 'question', print_context_name(get_context_instance_by_id($context))), 3);
 262                 echo $listhtml;
 263                 echo $OUTPUT->box_end();
 264             }
 265         }
 266         echo $list->display_page_numbers();
 267      }
 268
 269
 270
 271     /**
 272      * gets all the courseids for the given categories
 273      *
 274      * @param array categories contains category objects in  a tree representation
 275      * @return array courseids flat array in form categoryid=>courseid
 276      */
 277     public function get_course_ids($categories) {
 278         $courseids = array();
 279         foreach ($categories as $key=>$cat) {
 280             $courseids[$key] = $cat->course;
 281             if (!empty($cat->children)) {
 282                 $courseids = array_merge($courseids, $this->get_course_ids($cat->children));
 283             }
 284         }
 285         return $courseids;
 286     }
 287
 288
 289
 290     public function edit_single_category($categoryid) {
 291     /// Interface for adding a new category
 292         global $COURSE, $DB;
 293         /// Interface for editing existing categories
 294         if ($category = $DB->get_record("question_categories", array("id" => $categoryid))) {
 295
 296             $category->parent = "$category->parent,$category->contextid";
 297             $category->submitbutton = get_string('savechanges');
 298             $category->categoryheader = $this->str->edit;
 299             $this->catform->set_data($category);
 300             $this->catform->display();
 301         } else {
 302             print_error('invalidcategory', '', '', $categoryid);
 303         }
 304     }
 305
 306
 307     /**
 308      * Sets the viable parents
 309      *
 310      *  Viable parents are any except for the category itself, or any of it's descendants
 311      *  The parentstrings parameter is passed by reference and changed by this function.
 312      *
 313      * @param    array parentstrings a list of parentstrings
 314      * @param   object category
 315      */
 316     public function set_viable_parents(&$parentstrings, $category) {
 317
 318         unset($parentstrings[$category->id]);
 319         if (isset($category->children)) {
 320             foreach ($category->children as $child) {
 321                 $this->set_viable_parents($parentstrings, $child);
 322             }
 323         }
 324     }
 325
 326     /**
 327      * Gets question categories
 328      *
 329      * @param    int parent - if given, restrict records to those with this parent id.
 330      * @param    string sort - [[sortfield [,sortfield]] {ASC|DESC}]
 331      * @return   array categories
 332      */
 333     public function get_question_categories($parent=null, $sort="sortorder ASC") {
 334         global $COURSE, $DB;
 335         if (is_null($parent)) {
 336             $categories = $DB->get_records('question_categories', array('course' => $COURSE->id), $sort);
 337         } else {
 338             $select = "parent = ? AND course = ?";
 339             $categories = $DB->get_records_select('question_categories', $select, array($parent, $COURSE->id), $sort);
 340         }
 341         return $categories;
 342     }
 343
 344     /**
 345      * Deletes an existing question category
 346      *
 347      * @param int deletecat id of category to delete
 348      */
 349     public function delete_category($categoryid) {
 350         global $CFG, $DB;
 351         question_can_delete_cat($categoryid);
 352         if (!$category = $DB->get_record("question_categories", array("id" => $categoryid))) {  // security
 353             print_error('unknowcategory');
 354         }
 355         /// Send the children categories to live with their grandparent
 356         $DB->set_field("question_categories", "parent", $category->parent, array("parent" => $category->id));
 357
 358         /// Finally delete the category itself
 359         $DB->delete_records("question_categories", array("id" => $category->id));
 360     }
 361
 362     public function move_questions_and_delete_category($oldcat, $newcat){
 363         question_can_delete_cat($oldcat);
 364         $this->move_questions($oldcat, $newcat);
 365         $this->delete_category($oldcat);
 366     }
 367
 368     public function display_move_form($questionsincategory, $category){
 369         global $OUTPUT;
 370         $vars = new stdClass;
 371         $vars->name = $category->name;
 372         $vars->count = $questionsincategory;
 373         echo $OUTPUT->box(get_string('categorymove', 'quiz', $vars), 'generalbox boxaligncenter');
 374         $this->moveform->display();
 375     }
 376
 377     public function move_questions($oldcat, $newcat){
 378         global $DB;
 379         $questionids = $DB->get_records_select_menu('question', "category = ? AND (parent = 0 OR parent = id)", array($oldcat), '', 'id,1');
 380         $ids = implode(',', array_keys($questionids));
 381         if (!question_move_questions_to_category($ids, $newcat)) {
 382             print_error('errormovingquestions', 'question', $this->pageurl->out(), $ids);
 383         }
 384     }
 385
 386     /**
 387      * Creates a new category with given params
 388      */
 389     public function add_category($newparent, $newcategory, $newinfo, $return=false) {
 390         global $DB;
 391         if (empty($newcategory)) {
 392             print_error('categorynamecantbeblank', 'quiz');
 393         }
 394         list($parentid, $contextid) = explode(',', $newparent);
 395         //moodle_form makes sure select element output is legal no need for further cleaning
 396         require_capability('moodle/question:managecategory', get_context_instance_by_id($contextid));
 397
 398         if ($parentid) {
 399             if(!($DB->get_field('question_categories', 'contextid', array('id' => $parentid)) == $contextid)) {
 400                 print_error('cannotinsertquestioncatecontext', 'question', '', array('cat'=>$newcategory, 'ctx'=>$contextid));
 401             }
 402         }
 403
 404         $cat = new object();
 405         $cat->parent = $parentid;
 406         $cat->contextid = $contextid;
 407         $cat->name = $newcategory;
 408         $cat->info = $newinfo;
 409         $cat->sortorder = 999;
 410         $cat->stamp = make_unique_id_code();
 411         $categoryid = $DB->insert_record("question_categories", $cat);
 412         if ($return) {
 413             return $categoryid;
 414         } else {
 415             redirect($this->pageurl);//always redirect after successful action
 416         }
 417     }
 418
 419     /**
 420      * Updates an existing category with given params
 421      */
 422     public function update_category($updateid, $newparent, $newname, $newinfo) {
 423         global $CFG, $QTYPES, $DB;
 424         if (empty($newname)) {
 425             print_error('categorynamecantbeblank', 'quiz');
 426         }
 427
 428         // Get the record we are updating.
 429         $oldcat = $DB->get_record('question_categories', array('id' => $updateid));
 430         $lastcategoryinthiscontext = question_is_only_toplevel_category_in_context($updateid);
 431
 432         if (!empty($newparent) && !$lastcategoryinthiscontext) {
 433             list($parentid, $tocontextid) = explode(',', $newparent);
 434         } else {
 435             $parentid = $oldcat->parent;
 436             $tocontextid = $oldcat->contextid;
 437         }
 438
 439         // Check permissions.
 440         $fromcontext = get_context_instance_by_id($oldcat->contextid);
 441         require_capability('moodle/question:managecategory', $fromcontext);
 442
 443         // If moving to another context, check permissions some more.
 444         if ($oldcat->contextid != $tocontextid){
 445             $tocontext = get_context_instance_by_id($tocontextid);
 446             require_capability('moodle/question:managecategory', $tocontext);
 447         }
 448
 449         // Update the category record.
 450         $cat = NULL;
 451         $cat->id = $updateid;
 452         $cat->name = $newname;
 453         $cat->info = $newinfo;
 454         $cat->parent = $parentid;
 455         // We don't change $cat->contextid here, if necessary we redirect to contextmove.php later.
 456         $DB->update_record('question_categories', $cat);
 457
 458         // If the category name has changed, rename any random questions in that category.
 459         if ($oldcat->name != $cat->name) {
 460             $where = "qtype = 'random' AND category = ? AND " . $DB->sql_compare_text('questiontext') . " = ?";
 461
 462             $randomqname = $QTYPES[RANDOM]->question_name($cat, false);
 463             $DB->set_field_select('question', 'name', $randomqname, $where, array($cat->id, '0'));
 464
 465             $randomqname = $QTYPES[RANDOM]->question_name($cat, true);
 466             $DB->set_field_select('question', 'name', $randomqname, $where, array($cat->id, '1'));
 467         }
 468
 469         // Then redirect to an appropriate place.
 470         if ($oldcat->contextid == $tocontextid) { // not moving contexts
 471             redirect($this->pageurl);
 472         } else {
 473             $url = new moodle_url('/question/contextmove.php', ($this->pageurl->params() + array('cattomove' => $updateid, 'toparent'=>$newparent)));
 474             redirect($url);
 475         }
 476     }
 477
 478     public function move_question_from_cat_confirm($fromcat, $fromcourse, $tocat=null, $question=null){
 479         global $QTYPES, $DB;
 480         if (!$question){
 481             $questions[] = $question;
 482         } else {
 483             $questions = $DB->get_records('question', array('category' => $tocat->id));
 484         }
 485         $urls = array();
 486         foreach ($questions as $question){
 487             $urls = array_merge($urls, $QTYPES[$question->qtype]->find_file_links_in_question($question));
 488         }
 489         if ($fromcourse){
 490             $append = 'tocourse';
 491         } else {
 492             $append = 'tosite';
 493         }
 494         if ($tocat){
 495             echo '<p>'.get_string('needtomovethesefilesincat','question').'</p>';
 496         } else {
 497             echo '<p>'.get_string('needtomovethesefilesinquestion','question').'</p>';
 498         }
 499     }
 500
 501
 502
 503
 504 }
 505
 506