MDL-61133 core_output: add fontawesome mapping for tags icon
[moodle.git] / question / category_class.php
blobe4b19906cb5b7cb71fdc839b397a3d2bc1fd91ca
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.
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/>.
17 /**
18 * A class for representing question categories.
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
27 defined('MOODLE_INTERNAL') || die();
29 // number of categories to display on page
30 define('QUESTION_PAGE_LENGTH', 25);
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');
37 /**
38 * Class representing a list of question categories
40 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
41 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
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.
49 public $nextlist = null;
50 /**
51 * @var reference to list displayed above this one.
53 public $lastlist = null;
55 public $context = null;
56 public $sortby = 'parent, sortorder, name';
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;
63 public function get_records() {
64 $this->records = get_categories_for_contexts($this->context->id, $this->sortby);
69 /**
70 * An item in a list of question categories.
72 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
73 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
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');
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');
95 public function item_html($extraargs = array()){
96 global $CFG, $OUTPUT;
97 $str = $extraargs['str'];
98 $category = $this->item;
100 $editqestions = get_string('editquestions', 'question');
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));
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 $OUTPUT->pix_icon('t/delete', $str->delete),
120 array('title' => $str->delete));
123 return $item;
129 * Class representing q question category
131 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
132 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
134 class question_category_object {
137 * @var array common language strings.
139 public $str;
142 * @var array nested lists to display categories.
144 public $editlists = array();
145 public $newtable;
146 public $tab;
147 public $tabsize = 3;
150 * @var moodle_url Object representing url for this page
152 public $pageurl;
155 * @var question_category_edit_form Object representing form for adding / editing categories.
157 public $catform;
160 * Constructor
162 * Gets necessary strings and sets relevant path information
164 public function __construct($page, $pageurl, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts) {
165 global $CFG, $COURSE, $OUTPUT;
167 $this->tab = str_repeat('&nbsp;', $this->tabsize);
169 $this->str = new stdClass();
170 $this->str->course = get_string('course');
171 $this->str->category = get_string('category', 'question');
172 $this->str->categoryinfo = get_string('categoryinfo', 'question');
173 $this->str->questions = get_string('questions', 'question');
174 $this->str->add = get_string('add');
175 $this->str->delete = get_string('delete');
176 $this->str->moveup = get_string('moveup');
177 $this->str->movedown = get_string('movedown');
178 $this->str->edit = get_string('editthiscategory', 'question');
179 $this->str->hide = get_string('hide');
180 $this->str->order = get_string('order');
181 $this->str->parent = get_string('parent', 'question');
182 $this->str->add = get_string('add');
183 $this->str->action = get_string('action');
184 $this->str->top = get_string('top');
185 $this->str->addcategory = get_string('addcategory', 'question');
186 $this->str->editcategory = get_string('editcategory', 'question');
187 $this->str->cancel = get_string('cancel');
188 $this->str->editcategories = get_string('editcategories', 'question');
189 $this->str->page = get_string('page');
191 $this->pageurl = $pageurl;
193 $this->initialize($page, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts);
197 * Old syntax of class constructor. Deprecated in PHP7.
199 * @deprecated since Moodle 3.1
201 public function question_category_object($page, $pageurl, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts) {
202 debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
203 self::__construct($page, $pageurl, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts);
207 * Initializes this classes general category-related variables
209 public function initialize($page, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts) {
210 $lastlist = null;
211 foreach ($contexts as $context){
212 $this->editlists[$context->id] = new question_category_list('ul', '', true, $this->pageurl, $page, 'cpage', QUESTION_PAGE_LENGTH, $context);
213 $this->editlists[$context->id]->lastlist =& $lastlist;
214 if ($lastlist!== null){
215 $lastlist->nextlist =& $this->editlists[$context->id];
217 $lastlist =& $this->editlists[$context->id];
220 $count = 1;
221 $paged = false;
222 foreach ($this->editlists as $key => $list){
223 list($paged, $count) = $this->editlists[$key]->list_from_records($paged, $count);
225 $this->catform = new question_category_edit_form($this->pageurl, compact('contexts', 'currentcat'));
226 if (!$currentcat){
227 $this->catform->set_data(array('parent'=>$defaultcategory));
232 * Displays the user interface
235 public function display_user_interface() {
237 /// Interface for editing existing categories
238 $this->output_edit_lists();
241 echo '<br />';
242 /// Interface for adding a new category:
243 $this->output_new_table();
244 echo '<br />';
249 * Outputs a table to allow entry of a new category
251 public function output_new_table() {
252 $this->catform->display();
256 * Outputs a list to allow editing/rearranging of existing categories
258 * $this->initialize() must have already been called
261 public function output_edit_lists() {
262 global $OUTPUT;
264 echo $OUTPUT->heading_with_help(get_string('editcategories', 'question'), 'editcategories', 'question');
266 foreach ($this->editlists as $context => $list){
267 $listhtml = $list->to_html(0, array('str'=>$this->str));
268 if ($listhtml){
269 echo $OUTPUT->box_start('boxwidthwide boxaligncenter generalbox questioncategories contextlevel' . $list->context->contextlevel);
270 $fullcontext = context::instance_by_id($context);
271 echo $OUTPUT->heading(get_string('questioncatsfor', 'question', $fullcontext->get_context_name()), 3);
272 echo $listhtml;
273 echo $OUTPUT->box_end();
276 echo $list->display_page_numbers();
280 * gets all the courseids for the given categories
282 * @param array categories contains category objects in a tree representation
283 * @return array courseids flat array in form categoryid=>courseid
285 public function get_course_ids($categories) {
286 $courseids = array();
287 foreach ($categories as $key=>$cat) {
288 $courseids[$key] = $cat->course;
289 if (!empty($cat->children)) {
290 $courseids = array_merge($courseids, $this->get_course_ids($cat->children));
293 return $courseids;
296 public function edit_single_category($categoryid) {
297 /// Interface for adding a new category
298 global $COURSE, $DB;
299 /// Interface for editing existing categories
300 if ($category = $DB->get_record("question_categories", array("id" => $categoryid))) {
302 $category->parent = "{$category->parent},{$category->contextid}";
303 $category->submitbutton = get_string('savechanges');
304 $category->categoryheader = $this->str->edit;
305 $this->catform->set_data($category);
306 $this->catform->display();
307 } else {
308 print_error('invalidcategory', '', '', $categoryid);
313 * Sets the viable parents
315 * Viable parents are any except for the category itself, or any of it's descendants
316 * The parentstrings parameter is passed by reference and changed by this function.
318 * @param array parentstrings a list of parentstrings
319 * @param object category
321 public function set_viable_parents(&$parentstrings, $category) {
323 unset($parentstrings[$category->id]);
324 if (isset($category->children)) {
325 foreach ($category->children as $child) {
326 $this->set_viable_parents($parentstrings, $child);
332 * Gets question categories
334 * @param int parent - if given, restrict records to those with this parent id.
335 * @param string sort - [[sortfield [,sortfield]] {ASC|DESC}]
336 * @return array categories
338 public function get_question_categories($parent=null, $sort="sortorder ASC") {
339 global $COURSE, $DB;
340 if (is_null($parent)) {
341 $categories = $DB->get_records('question_categories', array('course' => $COURSE->id), $sort);
342 } else {
343 $select = "parent = ? AND course = ?";
344 $categories = $DB->get_records_select('question_categories', $select, array($parent, $COURSE->id), $sort);
346 return $categories;
350 * Deletes an existing question category
352 * @param int deletecat id of category to delete
354 public function delete_category($categoryid) {
355 global $CFG, $DB;
356 question_can_delete_cat($categoryid);
357 if (!$category = $DB->get_record("question_categories", array("id" => $categoryid))) { // security
358 print_error('unknowcategory');
360 /// Send the children categories to live with their grandparent
361 $DB->set_field("question_categories", "parent", $category->parent, array("parent" => $category->id));
363 /// Finally delete the category itself
364 $DB->delete_records("question_categories", array("id" => $category->id));
367 public function move_questions_and_delete_category($oldcat, $newcat){
368 question_can_delete_cat($oldcat);
369 $this->move_questions($oldcat, $newcat);
370 $this->delete_category($oldcat);
373 public function display_move_form($questionsincategory, $category){
374 global $OUTPUT;
375 $vars = new stdClass();
376 $vars->name = $category->name;
377 $vars->count = $questionsincategory;
378 echo $OUTPUT->box(get_string('categorymove', 'question', $vars), 'generalbox boxaligncenter');
379 $this->moveform->display();
382 public function move_questions($oldcat, $newcat){
383 global $DB;
384 $questionids = $DB->get_records_select_menu('question',
385 'category = ? AND (parent = 0 OR parent = id)', array($oldcat), '', 'id,1');
386 question_move_questions_to_category(array_keys($questionids), $newcat);
390 * Creates a new category with given params
392 public function add_category($newparent, $newcategory, $newinfo, $return = false, $newinfoformat = FORMAT_HTML) {
393 global $DB;
394 if (empty($newcategory)) {
395 print_error('categorynamecantbeblank', 'question');
397 list($parentid, $contextid) = explode(',', $newparent);
398 //moodle_form makes sure select element output is legal no need for further cleaning
399 require_capability('moodle/question:managecategory', context::instance_by_id($contextid));
401 if ($parentid) {
402 if(!($DB->get_field('question_categories', 'contextid', array('id' => $parentid)) == $contextid)) {
403 print_error('cannotinsertquestioncatecontext', 'question', '', array('cat'=>$newcategory, 'ctx'=>$contextid));
407 $cat = new stdClass();
408 $cat->parent = $parentid;
409 $cat->contextid = $contextid;
410 $cat->name = $newcategory;
411 $cat->info = $newinfo;
412 $cat->infoformat = $newinfoformat;
413 $cat->sortorder = 999;
414 $cat->stamp = make_unique_id_code();
415 $categoryid = $DB->insert_record("question_categories", $cat);
417 // Log the creation of this category.
418 $params = array(
419 'objectid' => $categoryid,
420 'contextid' => $contextid
422 $event = \core\event\question_category_created::create($params);
423 $event->trigger();
425 if ($return) {
426 return $categoryid;
427 } else {
428 redirect($this->pageurl);//always redirect after successful action
433 * Updates an existing category with given params
435 public function update_category($updateid, $newparent, $newname, $newinfo, $newinfoformat = FORMAT_HTML) {
436 global $CFG, $DB;
437 if (empty($newname)) {
438 print_error('categorynamecantbeblank', 'question');
441 // Get the record we are updating.
442 $oldcat = $DB->get_record('question_categories', array('id' => $updateid));
443 $lastcategoryinthiscontext = question_is_only_toplevel_category_in_context($updateid);
445 if (!empty($newparent) && !$lastcategoryinthiscontext) {
446 list($parentid, $tocontextid) = explode(',', $newparent);
447 } else {
448 $parentid = $oldcat->parent;
449 $tocontextid = $oldcat->contextid;
452 // Check permissions.
453 $fromcontext = context::instance_by_id($oldcat->contextid);
454 require_capability('moodle/question:managecategory', $fromcontext);
456 // If moving to another context, check permissions some more, and confirm contextid,stamp uniqueness.
457 $newstamprequired = false;
458 if ($oldcat->contextid != $tocontextid) {
459 $tocontext = context::instance_by_id($tocontextid);
460 require_capability('moodle/question:managecategory', $tocontext);
462 // Confirm stamp uniqueness in the new context. If the stamp already exists, generate a new one.
463 if ($DB->record_exists('question_categories', array('contextid' => $tocontextid, 'stamp' => $oldcat->stamp))) {
464 $newstamprequired = true;
468 // Update the category record.
469 $cat = new stdClass();
470 $cat->id = $updateid;
471 $cat->name = $newname;
472 $cat->info = $newinfo;
473 $cat->infoformat = $newinfoformat;
474 $cat->parent = $parentid;
475 $cat->contextid = $tocontextid;
476 if ($newstamprequired) {
477 $cat->stamp = make_unique_id_code();
479 $DB->update_record('question_categories', $cat);
481 // If the category name has changed, rename any random questions in that category.
482 if ($oldcat->name != $cat->name) {
483 $where = "qtype = 'random' AND category = ? AND " . $DB->sql_compare_text('questiontext') . " = ?";
485 $randomqtype = question_bank::get_qtype('random');
486 $randomqname = $randomqtype->question_name($cat, false);
487 $DB->set_field_select('question', 'name', $randomqname, $where, array($cat->id, '0'));
489 $randomqname = $randomqtype->question_name($cat, true);
490 $DB->set_field_select('question', 'name', $randomqname, $where, array($cat->id, '1'));
493 if ($oldcat->contextid != $tocontextid) {
494 // Moving to a new context. Must move files belonging to questions.
495 question_move_category_to_context($cat->id, $oldcat->contextid, $tocontextid);
498 // Cat param depends on the context id, so update it.
499 $this->pageurl->param('cat', $updateid . ',' . $tocontextid);
500 redirect($this->pageurl);