Merge branch 'MDL-38395' of git://github.com/timhunt/moodle
[moodle.git] / 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/>.
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  */
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
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;
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;
61     }
63     public function get_records() {
64         $this->records = get_categories_for_contexts($this->context->id, $this->sortby);
65     }
66 }
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     }
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 (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         }
124         return $item;
125     }
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 {
137     var $str;
138     /**
139      * Nested lists to display categories.
140      *
141      * @var array
142      */
143     var $editlists = array();
144     var $newtable;
145     var $tab;
146     var $tabsize = 3;
148     /**
149      * @var moodle_url Object representing url for this page
150      */
151     var $pageurl;
152     /**
153      * @var question_category_edit_form Object representing form for adding / editing categories.
154      */
155     var $catform;
157     /**
158      * Constructor
159      *
160      * Gets necessary strings and sets relevant path information
161      */
162     public function question_category_object($page, $pageurl, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts) {
163         global $CFG, $COURSE, $OUTPUT;
165         $this->tab = str_repeat('&nbsp;', $this->tabsize);
167         $this->str = new stdClass();
168         $this->str->course         = get_string('course');
169         $this->str->category       = get_string('category', 'question');
170         $this->str->categoryinfo   = get_string('categoryinfo', 'question');
171         $this->str->questions      = get_string('questions', 'question');
172         $this->str->add            = get_string('add');
173         $this->str->delete         = get_string('delete');
174         $this->str->moveup         = get_string('moveup');
175         $this->str->movedown       = get_string('movedown');
176         $this->str->edit           = get_string('editthiscategory', 'question');
177         $this->str->hide           = get_string('hide');
178         $this->str->order          = get_string('order');
179         $this->str->parent         = get_string('parent', 'question');
180         $this->str->add            = get_string('add');
181         $this->str->action         = get_string('action');
182         $this->str->top            = get_string('top');
183         $this->str->addcategory    = get_string('addcategory', 'question');
184         $this->str->editcategory   = get_string('editcategory', 'question');
185         $this->str->cancel         = get_string('cancel');
186         $this->str->editcategories = get_string('editcategories', 'question');
187         $this->str->page           = get_string('page');
189         $this->pageurl = $pageurl;
191         $this->initialize($page, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts);
192     }
194     /**
195      * Initializes this classes general category-related variables
196      */
197     public function initialize($page, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts) {
198         $lastlist = null;
199         foreach ($contexts as $context){
200             $this->editlists[$context->id] = new question_category_list('ul', '', true, $this->pageurl, $page, 'cpage', QUESTION_PAGE_LENGTH, $context);
201             $this->editlists[$context->id]->lastlist =& $lastlist;
202             if ($lastlist!== null){
203                 $lastlist->nextlist =& $this->editlists[$context->id];
204             }
205             $lastlist =& $this->editlists[$context->id];
206         }
208         $count = 1;
209         $paged = false;
210         foreach ($this->editlists as $key => $list){
211             list($paged, $count) = $this->editlists[$key]->list_from_records($paged, $count);
212         }
213         $this->catform = new question_category_edit_form($this->pageurl, compact('contexts', 'currentcat'));
214         if (!$currentcat){
215             $this->catform->set_data(array('parent'=>$defaultcategory));
216         }
217     }
219     /**
220      * Displays the user interface
221      *
222      */
223     public function display_user_interface() {
225         /// Interface for editing existing categories
226         $this->output_edit_lists();
229         echo '<br />';
230         /// Interface for adding a new category:
231         $this->output_new_table();
232         echo '<br />';
234     }
236     /**
237      * Outputs a table to allow entry of a new category
238      */
239     public function output_new_table() {
240         $this->catform->display();
241     }
243     /**
244      * Outputs a list to allow editing/rearranging of existing categories
245      *
246      * $this->initialize() must have already been called
247      *
248      */
249     public function output_edit_lists() {
250         global $OUTPUT;
252         echo $OUTPUT->heading_with_help(get_string('editcategories', 'question'), 'editcategories', 'question');
254         foreach ($this->editlists as $context => $list){
255             $listhtml = $list->to_html(0, array('str'=>$this->str));
256             if ($listhtml){
257                 echo $OUTPUT->box_start('boxwidthwide boxaligncenter generalbox questioncategories contextlevel' . $list->context->contextlevel);
258                 echo $OUTPUT->heading(get_string('questioncatsfor', 'question', print_context_name(context::instance_by_id($context))), 3);
259                 echo $listhtml;
260                 echo $OUTPUT->box_end();
261             }
262         }
263         echo $list->display_page_numbers();
264      }
266     /**
267      * gets all the courseids for the given categories
268      *
269      * @param array categories contains category objects in  a tree representation
270      * @return array courseids flat array in form categoryid=>courseid
271      */
272     public function get_course_ids($categories) {
273         $courseids = array();
274         foreach ($categories as $key=>$cat) {
275             $courseids[$key] = $cat->course;
276             if (!empty($cat->children)) {
277                 $courseids = array_merge($courseids, $this->get_course_ids($cat->children));
278             }
279         }
280         return $courseids;
281     }
283     public function edit_single_category($categoryid) {
284     /// Interface for adding a new category
285         global $COURSE, $DB;
286         /// Interface for editing existing categories
287         if ($category = $DB->get_record("question_categories", array("id" => $categoryid))) {
289             $category->parent = "$category->parent,$category->contextid";
290             $category->submitbutton = get_string('savechanges');
291             $category->categoryheader = $this->str->edit;
292             $this->catform->set_data($category);
293             $this->catform->display();
294         } else {
295             print_error('invalidcategory', '', '', $categoryid);
296         }
297     }
299     /**
300      * Sets the viable parents
301      *
302      *  Viable parents are any except for the category itself, or any of it's descendants
303      *  The parentstrings parameter is passed by reference and changed by this function.
304      *
305      * @param    array parentstrings a list of parentstrings
306      * @param   object category
307      */
308     public function set_viable_parents(&$parentstrings, $category) {
310         unset($parentstrings[$category->id]);
311         if (isset($category->children)) {
312             foreach ($category->children as $child) {
313                 $this->set_viable_parents($parentstrings, $child);
314             }
315         }
316     }
318     /**
319      * Gets question categories
320      *
321      * @param    int parent - if given, restrict records to those with this parent id.
322      * @param    string sort - [[sortfield [,sortfield]] {ASC|DESC}]
323      * @return   array categories
324      */
325     public function get_question_categories($parent=null, $sort="sortorder ASC") {
326         global $COURSE, $DB;
327         if (is_null($parent)) {
328             $categories = $DB->get_records('question_categories', array('course' => $COURSE->id), $sort);
329         } else {
330             $select = "parent = ? AND course = ?";
331             $categories = $DB->get_records_select('question_categories', $select, array($parent, $COURSE->id), $sort);
332         }
333         return $categories;
334     }
336     /**
337      * Deletes an existing question category
338      *
339      * @param int deletecat id of category to delete
340      */
341     public function delete_category($categoryid) {
342         global $CFG, $DB;
343         question_can_delete_cat($categoryid);
344         if (!$category = $DB->get_record("question_categories", array("id" => $categoryid))) {  // security
345             print_error('unknowcategory');
346         }
347         /// Send the children categories to live with their grandparent
348         $DB->set_field("question_categories", "parent", $category->parent, array("parent" => $category->id));
350         /// Finally delete the category itself
351         $DB->delete_records("question_categories", array("id" => $category->id));
352     }
354     public function move_questions_and_delete_category($oldcat, $newcat){
355         question_can_delete_cat($oldcat);
356         $this->move_questions($oldcat, $newcat);
357         $this->delete_category($oldcat);
358     }
360     public function display_move_form($questionsincategory, $category){
361         global $OUTPUT;
362         $vars = new stdClass();
363         $vars->name = $category->name;
364         $vars->count = $questionsincategory;
365         echo $OUTPUT->box(get_string('categorymove', 'question', $vars), 'generalbox boxaligncenter');
366         $this->moveform->display();
367     }
369     public function move_questions($oldcat, $newcat){
370         global $DB;
371         $questionids = $DB->get_records_select_menu('question',
372                 'category = ? AND (parent = 0 OR parent = id)', array($oldcat), '', 'id,1');
373         question_move_questions_to_category(array_keys($questionids), $newcat);
374     }
376     /**
377      * Creates a new category with given params
378      */
379     public function add_category($newparent, $newcategory, $newinfo, $return = false) {
380         global $DB;
381         if (empty($newcategory)) {
382             print_error('categorynamecantbeblank', 'question');
383         }
384         list($parentid, $contextid) = explode(',', $newparent);
385         //moodle_form makes sure select element output is legal no need for further cleaning
386         require_capability('moodle/question:managecategory', context::instance_by_id($contextid));
388         if ($parentid) {
389             if(!($DB->get_field('question_categories', 'contextid', array('id' => $parentid)) == $contextid)) {
390                 print_error('cannotinsertquestioncatecontext', 'question', '', array('cat'=>$newcategory, 'ctx'=>$contextid));
391             }
392         }
394         $cat = new stdClass();
395         $cat->parent = $parentid;
396         $cat->contextid = $contextid;
397         $cat->name = $newcategory;
398         $cat->info = $newinfo;
399         $cat->sortorder = 999;
400         $cat->stamp = make_unique_id_code();
401         $categoryid = $DB->insert_record("question_categories", $cat);
402         if ($return) {
403             return $categoryid;
404         } else {
405             redirect($this->pageurl);//always redirect after successful action
406         }
407     }
409     /**
410      * Updates an existing category with given params
411      */
412     public function update_category($updateid, $newparent, $newname, $newinfo) {
413         global $CFG, $DB;
414         if (empty($newname)) {
415             print_error('categorynamecantbeblank', 'question');
416         }
418         // Get the record we are updating.
419         $oldcat = $DB->get_record('question_categories', array('id' => $updateid));
420         $lastcategoryinthiscontext = question_is_only_toplevel_category_in_context($updateid);
422         if (!empty($newparent) && !$lastcategoryinthiscontext) {
423             list($parentid, $tocontextid) = explode(',', $newparent);
424         } else {
425             $parentid = $oldcat->parent;
426             $tocontextid = $oldcat->contextid;
427         }
429         // Check permissions.
430         $fromcontext = context::instance_by_id($oldcat->contextid);
431         require_capability('moodle/question:managecategory', $fromcontext);
433         // If moving to another context, check permissions some more.
434         if ($oldcat->contextid != $tocontextid) {
435             $tocontext = context::instance_by_id($tocontextid);
436             require_capability('moodle/question:managecategory', $tocontext);
437         }
439         // Update the category record.
440         $cat = new stdClass();
441         $cat->id = $updateid;
442         $cat->name = $newname;
443         $cat->info = $newinfo;
444         $cat->parent = $parentid;
445         $cat->contextid = $tocontextid;
446         $DB->update_record('question_categories', $cat);
448         // If the category name has changed, rename any random questions in that category.
449         if ($oldcat->name != $cat->name) {
450             $where = "qtype = 'random' AND category = ? AND " . $DB->sql_compare_text('questiontext') . " = ?";
452             $randomqtype = question_bank::get_qtype('random');
453             $randomqname = $randomqtype->question_name($cat, false);
454             $DB->set_field_select('question', 'name', $randomqname, $where, array($cat->id, '0'));
456             $randomqname = $randomqtype->question_name($cat, true);
457             $DB->set_field_select('question', 'name', $randomqname, $where, array($cat->id, '1'));
458         }
460         if ($oldcat->contextid != $tocontextid) {
461             // Moving to a new context. Must move files belonging to questions.
462             question_move_category_to_context($cat->id, $oldcat->contextid, $tocontextid);
463         }
465         // Cat param depends on the context id, so update it.
466         $this->pageurl->param('cat', $updateid . ',' . $tocontextid);
467         redirect($this->pageurl);
468     }