adbb92ad173abd0162e254d6579349a1ba4b63f0
[moodle.git] / question / category_class.php
1 <?php // $Id$
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  */
10 // number of categories to display on page
11 define("QUESTION_PAGE_LENGTH", 25);
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');
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;
30     public $context = null;
31     public $sortby = 'parent, sortorder, name';
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     }
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             redirect($CFG->wwwroot.'/question/contextmove.php?'.
56                 $this->pageurl->get_query_string(compact('cattomove', 'totop', 'toparent')));
57         }
58     }
59 }
61 class question_category_list_item extends list_item {
64     public function set_icon_html($first, $last, &$lastitem){
65         global $CFG;
66         $category = $this->item;
67         $this->icons['edit']= $this->image_icon(get_string('editthiscategory'),
68                 "{$CFG->wwwroot}/question/category.php?".$this->parentlist->pageurl->get_query_string(array('edit'=>$category->id)), '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             $this->icons['down'] = $this->image_icon(
73                 get_string('shareincontext', 'question', print_context_name($this->parentlist->nextlist->context)),
74                 $this->parentlist->pageurl->out_action(
75                     array('movedowncontext'=>$this->id, 'tocontext'=>$this->parentlist->nextlist->context->id)
76                 ), 'down');
77         }
78         if (($this->parentlist->lastlist !== null) && $first && $toplevel && (count($this->parentlist->items)>1)){
79             $this->icons['up'] = $this->image_icon(
80                 get_string('shareincontext', 'question', print_context_name($this->parentlist->lastlist->context)),
81                 $this->parentlist->pageurl->out_action(
82                     array('moveupcontext'=>$this->id, 'tocontext'=>$this->parentlist->lastlist->context->id)
83                 ), 'up');
84         }
85     }
86     public function item_html($extraargs = array()){
87         global $CFG, $OUTPUT;
88         $str = $extraargs['str'];
89         $category = $this->item;
91         $editqestions = get_string('editquestions', 'quiz');
93         /// Each section adds html to be displayed as part of this list item
94         $questionbankurl = "{$CFG->wwwroot}/question/edit.php?".
95                 $this->parentlist->pageurl->get_query_string(array('category'=>"$category->id,$category->contextid"));
96         $catediturl = $this->parentlist->pageurl->out(false, array('edit'=>$this->id));
97         $item = "<b><a title=\"{$str->edit}\" href=\"$catediturl\">".$category->name ."</a></b> <a title=\"$editqestions\" href=\"$questionbankurl\">".'('.$category->questioncount.')</a>';
99         $item .= '&nbsp;'. $category->info;
101         if (count($this->parentlist->records)!=1){ // don't allow delete if this is the last category in this context.
102             $item .=  '<a title="' . $str->delete . '" href="'.$this->parentlist->pageurl->out_action(array('delete'=>$this->id)).'">
103                     <img src="' . $OUTPUT->old_icon_url('t/delete.gif') . '" class="iconsmall" alt="' .$str->delete. '" /></a>';
104         }
106         return $item;
107     }
112 /**
113  * Class representing question categories
114  *
115  * @package questionbank
116  */
117 class question_category_object {
119     var $str;
120     /**
121      * Nested lists to display categories.
122      *
123      * @var array
124      */
125     var $editlists = array();
126     var $newtable;
127     var $tab;
128     var $tabsize = 3;
129 //------------------------------------------------------
130     /**
131      * @var moodle_url Object representing url for this page
132      */
133     var $pageurl;
134     /**
135      * @var question_category_edit_form Object representing form for adding / editing categories.
136      */
137     var $catform;
138     /**
139      * @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.
140      */
141     var $catform_rand;
143     /**
144      * Constructor
145      *
146      * Gets necessary strings and sets relevant path information
147      */
148     public function question_category_object($page, $pageurl, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts) {
149         global $CFG, $COURSE, $OUTPUT;
151         $this->tab = str_repeat('&nbsp;', $this->tabsize);
153         $this->str->course         = get_string('course');
154         $this->str->category       = get_string('category', 'quiz');
155         $this->str->categoryinfo   = get_string('categoryinfo', 'quiz');
156         $this->str->questions      = get_string('questions', 'quiz');
157         $this->str->add            = get_string('add');
158         $this->str->delete         = get_string('delete');
159         $this->str->moveup         = get_string('moveup');
160         $this->str->movedown       = get_string('movedown');
161         $this->str->edit           = get_string('editthiscategory');
162         $this->str->hide           = get_string('hide');
163         $this->str->publish        = get_string('publish', 'quiz');
164         $this->str->order          = get_string('order');
165         $this->str->parent         = get_string('parent', 'quiz');
166         $this->str->add            = get_string('add');
167         $this->str->action         = get_string('action');
168         $this->str->top            = get_string('top', 'quiz');
169         $this->str->addcategory    = get_string('addcategory', 'quiz');
170         $this->str->editcategory   = get_string('editcategory', 'quiz');
171         $this->str->cancel         = get_string('cancel');
172         $this->str->editcategories = get_string('editcategories', 'quiz');
173         $this->str->page           = get_string('page');
175         $this->pageurl = $pageurl;
177         $this->initialize($page, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts);
179     }
183     /**
184      * Initializes this classes general category-related variables
185      */
186     public function initialize($page, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts) {
187         $lastlist = null;
188         foreach ($contexts as $context){
189             $this->editlists[$context->id] = new question_category_list('ul', '', true, $this->pageurl, $page, 'cpage', QUESTION_PAGE_LENGTH, $context);
190             $this->editlists[$context->id]->lastlist =& $lastlist;
191             if ($lastlist!== null){
192                 $lastlist->nextlist =& $this->editlists[$context->id];
193             }
194             $lastlist =& $this->editlists[$context->id];
195         }
197         $count = 1;
198         $paged = false;
199         foreach ($this->editlists as $key => $list){
200             list($paged, $count) = $this->editlists[$key]->list_from_records($paged, $count);
201         }
202         $this->catform = new question_category_edit_form($this->pageurl, compact('contexts', 'currentcat'));
203         $this->catform_rand = new question_category_edit_form_randomquestion($this->pageurl, compact('contexts', 'currentcat'));
204         if (!$currentcat){
205             $this->catform->set_data(array('parent'=>$defaultcategory));
206             $this->catform_rand->set_data(array('parent'=>$defaultcategory));
207         }
208     }
209     /**
210      * Displays the user interface
211      *
212      */
213     public function display_user_interface() {
215         /// Interface for editing existing categories
216         $this->output_edit_lists();
219         echo '<br />';
220         /// Interface for adding a new category:
221         $this->output_new_table();
222         echo '<br />';
224     }
225     /**
226      * Displays the user interface
227      *
228      */
229     function display_randomquestion_user_interface($addonpage=0) {
230         $this->catform_rand->set_data(array('addonpage'=>$addonpage));
231         /// Interface for adding a new category:
232         $this->output_new_randomquestion_table();
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 table to allow entry of a new category
245      */
246     function output_new_randomquestion_table() {
247         $this->catform_rand->display();
248     }
251     /**
252      * Outputs a list to allow editing/rearranging of existing categories
253      *
254      * $this->initialize() must have already been called
255      *
256      */
257     public function output_edit_lists() {
258         print_heading_with_help(get_string('editcategories', 'quiz'), 'categories', 'question');
259         foreach ($this->editlists as $context => $list){
260             $listhtml = $list->to_html(0, array('str'=>$this->str));
261             if ($listhtml){
262                 print_box_start('boxwidthwide boxaligncenter generalbox questioncategories contextlevel' . $list->context->contextlevel);
263                 print_heading(get_string('questioncatsfor', 'question', print_context_name(get_context_instance_by_id($context))), '', 3);
264                 echo $listhtml;
265                 print_box_end();
266             }
267         }
268         echo $list->display_page_numbers();
269      }
273     /**
274      * gets all the courseids for the given categories
275      *
276      * @param array categories contains category objects in  a tree representation
277      * @return array courseids flat array in form categoryid=>courseid
278      */
279     public function get_course_ids($categories) {
280         $courseids = array();
281         foreach ($categories as $key=>$cat) {
282             $courseids[$key] = $cat->course;
283             if (!empty($cat->children)) {
284                 $courseids = array_merge($courseids, $this->get_course_ids($cat->children));
285             }
286         }
287         return $courseids;
288     }
292     public function edit_single_category($categoryid) {
293     /// Interface for adding a new category
294         global $COURSE, $DB;
295         /// Interface for editing existing categories
296         if ($category = $DB->get_record("question_categories", array("id" => $categoryid))) {
298             $category->parent = "$category->parent,$category->contextid";
299             $category->submitbutton = get_string('savechanges');
300             $category->categoryheader = $this->str->edit;
301             $this->catform->set_data($category);
302             $this->catform->display();
303         } else {
304             print_error('invalidcategory', '', '', $categoryid);
305         }
306     }
309     /**
310      * Sets the viable parents
311      *
312      *  Viable parents are any except for the category itself, or any of it's descendants
313      *  The parentstrings parameter is passed by reference and changed by this function.
314      *
315      * @param    array parentstrings a list of parentstrings
316      * @param   object category
317      */
318     public function set_viable_parents(&$parentstrings, $category) {
320         unset($parentstrings[$category->id]);
321         if (isset($category->children)) {
322             foreach ($category->children as $child) {
323                 $this->set_viable_parents($parentstrings, $child);
324             }
325         }
326     }
328     /**
329      * Gets question categories
330      *
331      * @param    int parent - if given, restrict records to those with this parent id.
332      * @param    string sort - [[sortfield [,sortfield]] {ASC|DESC}]
333      * @return   array categories
334      */
335     public function get_question_categories($parent=null, $sort="sortorder ASC") {
336         global $COURSE, $DB;
337         if (is_null($parent)) {
338             $categories = $DB->get_records('question_categories', array('course' => $COURSE->id), $sort);
339         } else {
340             $select = "parent = ? AND course = ?";
341             $categories = $DB->get_records_select('question_categories', $select, array($parent, $COURSE->id), $sort);
342         }
343         return $categories;
344     }
346     /**
347      * Deletes an existing question category
348      *
349      * @param int deletecat id of category to delete
350      */
351     public function delete_category($categoryid) {
352         global $CFG, $DB;
353         question_can_delete_cat($categoryid);
354         if (!$category = $DB->get_record("question_categories", array("id" => $categoryid))) {  // security
355             print_error('unknowcategory');
356         }
357         /// Send the children categories to live with their grandparent
358         $DB->set_field("question_categories", "parent", $category->parent, array("parent" => $category->id));
360         /// Finally delete the category itself
361         $DB->delete_records("question_categories", array("id" => $category->id));
362     }
364     public function move_questions_and_delete_category($oldcat, $newcat){
365         question_can_delete_cat($oldcat);
366         $this->move_questions($oldcat, $newcat);
367         $this->delete_category($oldcat);
368     }
370     public function display_move_form($questionsincategory, $category){
371         $vars = new stdClass;
372         $vars->name = $category->name;
373         $vars->count = $questionsincategory;
374         print_box(get_string('categorymove', 'quiz', $vars), 'generalbox boxaligncenter');
375         $this->moveform->display();
376     }
378     public function move_questions($oldcat, $newcat){
379         global $DB;
380         $questionids = $DB->get_records_select_menu('question', "category = ? AND (parent = 0 OR parent = id)", array($oldcat), '', 'id,1');
381         $ids = implode(',', array_keys($questionids));
382         if (!question_move_questions_to_category($ids, $newcat)) {
383             print_error('errormovingquestions', 'question', $this->pageurl->out(), $ids);
384         }
385     }
387     /**
388      * Creates a new category with given params
389      */
390     public function add_category($newparent, $newcategory, $newinfo, $return=false) {
391         global $DB;
392         if (empty($newcategory)) {
393             print_error('categorynamecantbeblank', 'quiz');
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', get_context_instance_by_id($contextid));
399         if ($parentid) {
400             if(!($DB->get_field('question_categories', 'contextid', array('id' => $parentid)) == $contextid)) {
401                 print_error('cannotinsertquestioncatecontext', 'question', '', array($newcategory, $contextid));
402             }
403         }
405         $cat = new object();
406         $cat->parent = $parentid;
407         $cat->contextid = $contextid;
408         $cat->name = $newcategory;
409         $cat->info = $newinfo;
410         $cat->sortorder = 999;
411         $cat->stamp = make_unique_id_code();
412         $categoryid = $DB->insert_record("question_categories", $cat);
413         if ($return) {
414             return $categoryid;
415         } else {
416             redirect($this->pageurl);//always redirect after successful action
417         }
418     }
420     /**
421      * Updates an existing category with given params
422      */
423     public function update_category($updateid, $newparent, $newname, $newinfo) {
424         global $CFG, $QTYPES, $DB;
425         if (empty($newname)) {
426             print_error('categorynamecantbeblank', 'quiz');
427         }
429         // Get the record we are updating.
430         $oldcat = $DB->get_record('question_categories', array('id' => $updateid));
431         $lastcategoryinthiscontext = question_is_only_toplevel_category_in_context($updateid);
433         if (!empty($newparent) && !$lastcategoryinthiscontext) {
434             list($parentid, $tocontextid) = explode(',', $newparent);
435         } else {
436             $parentid = $oldcat->parent;
437             $tocontextid = $oldcat->contextid;
438         }
440         // Check permissions.
441         $fromcontext = get_context_instance_by_id($oldcat->contextid);
442         require_capability('moodle/question:managecategory', $fromcontext);
444         // If moving to another context, check permissions some more.
445         if ($oldcat->contextid != $tocontextid){
446             $tocontext = get_context_instance_by_id($tocontextid);
447             require_capability('moodle/question:managecategory', $tocontext);
448         }
450         // Update the category record.
451         $cat = NULL;
452         $cat->id = $updateid;
453         $cat->name = $newname;
454         $cat->info = $newinfo;
455         $cat->parent = $parentid;
456         // We don't change $cat->contextid here, if necessary we redirect to contextmove.php later.
457         $DB->update_record('question_categories', $cat);
459         // If the category name has changed, rename any random questions in that category.
460         if ($oldcat->name != $cat->name) {
461             $where = "qtype = 'random' AND category = ? AND " . $DB->sql_compare_text('questiontext') . " = ?";
463             $randomqname = $QTYPES[RANDOM]->question_name($cat, false);
464             $DB->set_field_select('question', 'name', $randomqname, $where, array($cat->id, '0'));
466             $randomqname = $QTYPES[RANDOM]->question_name($cat, true);
467             $DB->set_field_select('question', 'name', $randomqname, $where, array($cat->id, '1'));
468         }
470         // Then redirect to an appropriate place.
471         if ($oldcat->contextid == $tocontextid) { // not moving contexts
472             redirect($this->pageurl);
473         } else {
474             redirect($CFG->wwwroot.'/question/contextmove.php?' .
475                     $this->pageurl->get_query_string(array(
476                     'cattomove' => $updateid, 'toparent'=>$newparent)));
477         }
478     }
480     public function move_question_from_cat_confirm($fromcat, $fromcourse, $tocat=null, $question=null){
481         global $QTYPES, $DB;
482         if (!$question){
483             $questions[] = $question;
484         } else {
485             $questions = $DB->get_records('question', array('category' => $tocat->id));
486         }
487         $urls = array();
488         foreach ($questions as $question){
489             $urls = array_merge($urls, $QTYPES[$question->qtype]->find_file_links_in_question($question));
490         }
491         if ($fromcourse){
492             $append = 'tocourse';
493         } else {
494             $append = 'tosite';
495         }
496         if ($tocat){
497             echo '<p>'.get_string('needtomovethesefilesincat','question').'</p>';
498         } else {
499             echo '<p>'.get_string('needtomovethesefilesinquestion','question').'</p>';
500         }
501     }
508 ?>