| [ Index ] |
PHP Cross Reference of moodle-2.8 |
[Summary view] [Print] [Text view]
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 (count($this->parentlist->records) != 1) { 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 question_category_object($page, $pageurl, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts) { 166 global $CFG, $COURSE, $OUTPUT; 167 168 $this->tab = str_repeat(' ', $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 * Initializes this classes general category-related variables 199 */ 200 public function initialize($page, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts) { 201 $lastlist = null; 202 foreach ($contexts as $context){ 203 $this->editlists[$context->id] = new question_category_list('ul', '', true, $this->pageurl, $page, 'cpage', QUESTION_PAGE_LENGTH, $context); 204 $this->editlists[$context->id]->lastlist =& $lastlist; 205 if ($lastlist!== null){ 206 $lastlist->nextlist =& $this->editlists[$context->id]; 207 } 208 $lastlist =& $this->editlists[$context->id]; 209 } 210 211 $count = 1; 212 $paged = false; 213 foreach ($this->editlists as $key => $list){ 214 list($paged, $count) = $this->editlists[$key]->list_from_records($paged, $count); 215 } 216 $this->catform = new question_category_edit_form($this->pageurl, compact('contexts', 'currentcat')); 217 if (!$currentcat){ 218 $this->catform->set_data(array('parent'=>$defaultcategory)); 219 } 220 } 221 222 /** 223 * Displays the user interface 224 * 225 */ 226 public function display_user_interface() { 227 228 /// Interface for editing existing categories 229 $this->output_edit_lists(); 230 231 232 echo '<br />'; 233 /// Interface for adding a new category: 234 $this->output_new_table(); 235 echo '<br />'; 236 237 } 238 239 /** 240 * Outputs a table to allow entry of a new category 241 */ 242 public function output_new_table() { 243 $this->catform->display(); 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 $fullcontext = context::instance_by_id($context); 262 echo $OUTPUT->heading(get_string('questioncatsfor', 'question', $fullcontext->get_context_name()), 3); 263 echo $listhtml; 264 echo $OUTPUT->box_end(); 265 } 266 } 267 echo $list->display_page_numbers(); 268 } 269 270 /** 271 * gets all the courseids for the given categories 272 * 273 * @param array categories contains category objects in a tree representation 274 * @return array courseids flat array in form categoryid=>courseid 275 */ 276 public function get_course_ids($categories) { 277 $courseids = array(); 278 foreach ($categories as $key=>$cat) { 279 $courseids[$key] = $cat->course; 280 if (!empty($cat->children)) { 281 $courseids = array_merge($courseids, $this->get_course_ids($cat->children)); 282 } 283 } 284 return $courseids; 285 } 286 287 public function edit_single_category($categoryid) { 288 /// Interface for adding a new category 289 global $COURSE, $DB; 290 /// Interface for editing existing categories 291 if ($category = $DB->get_record("question_categories", array("id" => $categoryid))) { 292 293 $category->parent = "{$category->parent},{$category->contextid}"; 294 $category->submitbutton = get_string('savechanges'); 295 $category->categoryheader = $this->str->edit; 296 $this->catform->set_data($category); 297 $this->catform->display(); 298 } else { 299 print_error('invalidcategory', '', '', $categoryid); 300 } 301 } 302 303 /** 304 * Sets the viable parents 305 * 306 * Viable parents are any except for the category itself, or any of it's descendants 307 * The parentstrings parameter is passed by reference and changed by this function. 308 * 309 * @param array parentstrings a list of parentstrings 310 * @param object category 311 */ 312 public function set_viable_parents(&$parentstrings, $category) { 313 314 unset($parentstrings[$category->id]); 315 if (isset($category->children)) { 316 foreach ($category->children as $child) { 317 $this->set_viable_parents($parentstrings, $child); 318 } 319 } 320 } 321 322 /** 323 * Gets question categories 324 * 325 * @param int parent - if given, restrict records to those with this parent id. 326 * @param string sort - [[sortfield [,sortfield]] {ASC|DESC}] 327 * @return array categories 328 */ 329 public function get_question_categories($parent=null, $sort="sortorder ASC") { 330 global $COURSE, $DB; 331 if (is_null($parent)) { 332 $categories = $DB->get_records('question_categories', array('course' => $COURSE->id), $sort); 333 } else { 334 $select = "parent = ? AND course = ?"; 335 $categories = $DB->get_records_select('question_categories', $select, array($parent, $COURSE->id), $sort); 336 } 337 return $categories; 338 } 339 340 /** 341 * Deletes an existing question category 342 * 343 * @param int deletecat id of category to delete 344 */ 345 public function delete_category($categoryid) { 346 global $CFG, $DB; 347 question_can_delete_cat($categoryid); 348 if (!$category = $DB->get_record("question_categories", array("id" => $categoryid))) { // security 349 print_error('unknowcategory'); 350 } 351 /// Send the children categories to live with their grandparent 352 $DB->set_field("question_categories", "parent", $category->parent, array("parent" => $category->id)); 353 354 /// Finally delete the category itself 355 $DB->delete_records("question_categories", array("id" => $category->id)); 356 } 357 358 public function move_questions_and_delete_category($oldcat, $newcat){ 359 question_can_delete_cat($oldcat); 360 $this->move_questions($oldcat, $newcat); 361 $this->delete_category($oldcat); 362 } 363 364 public function display_move_form($questionsincategory, $category){ 365 global $OUTPUT; 366 $vars = new stdClass(); 367 $vars->name = $category->name; 368 $vars->count = $questionsincategory; 369 echo $OUTPUT->box(get_string('categorymove', 'question', $vars), 'generalbox boxaligncenter'); 370 $this->moveform->display(); 371 } 372 373 public function move_questions($oldcat, $newcat){ 374 global $DB; 375 $questionids = $DB->get_records_select_menu('question', 376 'category = ? AND (parent = 0 OR parent = id)', array($oldcat), '', 'id,1'); 377 question_move_questions_to_category(array_keys($questionids), $newcat); 378 } 379 380 /** 381 * Creates a new category with given params 382 */ 383 public function add_category($newparent, $newcategory, $newinfo, $return = false, $newinfoformat = FORMAT_HTML) { 384 global $DB; 385 if (empty($newcategory)) { 386 print_error('categorynamecantbeblank', 'question'); 387 } 388 list($parentid, $contextid) = explode(',', $newparent); 389 //moodle_form makes sure select element output is legal no need for further cleaning 390 require_capability('moodle/question:managecategory', context::instance_by_id($contextid)); 391 392 if ($parentid) { 393 if(!($DB->get_field('question_categories', 'contextid', array('id' => $parentid)) == $contextid)) { 394 print_error('cannotinsertquestioncatecontext', 'question', '', array('cat'=>$newcategory, 'ctx'=>$contextid)); 395 } 396 } 397 398 $cat = new stdClass(); 399 $cat->parent = $parentid; 400 $cat->contextid = $contextid; 401 $cat->name = $newcategory; 402 $cat->info = $newinfo; 403 $cat->infoformat = $newinfoformat; 404 $cat->sortorder = 999; 405 $cat->stamp = make_unique_id_code(); 406 $categoryid = $DB->insert_record("question_categories", $cat); 407 408 // Log the creation of this category. 409 $params = array( 410 'objectid' => $categoryid, 411 'contextid' => $contextid 412 ); 413 $event = \core\event\question_category_created::create($params); 414 $event->trigger(); 415 416 if ($return) { 417 return $categoryid; 418 } else { 419 redirect($this->pageurl);//always redirect after successful action 420 } 421 } 422 423 /** 424 * Updates an existing category with given params 425 */ 426 public function update_category($updateid, $newparent, $newname, $newinfo, $newinfoformat = FORMAT_HTML) { 427 global $CFG, $DB; 428 if (empty($newname)) { 429 print_error('categorynamecantbeblank', 'question'); 430 } 431 432 // Get the record we are updating. 433 $oldcat = $DB->get_record('question_categories', array('id' => $updateid)); 434 $lastcategoryinthiscontext = question_is_only_toplevel_category_in_context($updateid); 435 436 if (!empty($newparent) && !$lastcategoryinthiscontext) { 437 list($parentid, $tocontextid) = explode(',', $newparent); 438 } else { 439 $parentid = $oldcat->parent; 440 $tocontextid = $oldcat->contextid; 441 } 442 443 // Check permissions. 444 $fromcontext = context::instance_by_id($oldcat->contextid); 445 require_capability('moodle/question:managecategory', $fromcontext); 446 447 // If moving to another context, check permissions some more. 448 if ($oldcat->contextid != $tocontextid) { 449 $tocontext = context::instance_by_id($tocontextid); 450 require_capability('moodle/question:managecategory', $tocontext); 451 } 452 453 // Update the category record. 454 $cat = new stdClass(); 455 $cat->id = $updateid; 456 $cat->name = $newname; 457 $cat->info = $newinfo; 458 $cat->infoformat = $newinfoformat; 459 $cat->parent = $parentid; 460 $cat->contextid = $tocontextid; 461 $DB->update_record('question_categories', $cat); 462 463 // If the category name has changed, rename any random questions in that category. 464 if ($oldcat->name != $cat->name) { 465 $where = "qtype = 'random' AND category = ? AND " . $DB->sql_compare_text('questiontext') . " = ?"; 466 467 $randomqtype = question_bank::get_qtype('random'); 468 $randomqname = $randomqtype->question_name($cat, false); 469 $DB->set_field_select('question', 'name', $randomqname, $where, array($cat->id, '0')); 470 471 $randomqname = $randomqtype->question_name($cat, true); 472 $DB->set_field_select('question', 'name', $randomqname, $where, array($cat->id, '1')); 473 } 474 475 if ($oldcat->contextid != $tocontextid) { 476 // Moving to a new context. Must move files belonging to questions. 477 question_move_category_to_context($cat->id, $oldcat->contextid, $tocontextid); 478 } 479 480 // Cat param depends on the context id, so update it. 481 $this->pageurl->param('cat', $updateid . ',' . $tocontextid); 482 redirect($this->pageurl); 483 } 484 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated: Fri Nov 28 20:29:05 2014 | Cross-referenced by PHPXref 0.7.1 |