Merge branch 'MDL-37973' of https://github.com/merrill-oakland/moodle
[moodle.git] / course / renderer.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Renderer for use with the course section and all the goodness that falls
20  * within it.
21  *
22  * This renderer should contain methods useful to courses, and categories.
23  *
24  * @package   moodlecore
25  * @copyright 2010 Sam Hemelryk
26  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27  */
29 /**
30  * The core course renderer
31  *
32  * Can be retrieved with the following:
33  * $renderer = $PAGE->get_renderer('core','course');
34  */
35 class core_course_renderer extends plugin_renderer_base {
36     const COURSECAT_SHOW_COURSES_NONE = 0; /* do not show courses at all */
37     const COURSECAT_SHOW_COURSES_COUNT = 5; /* do not show courses but show number of courses next to category name */
38     const COURSECAT_SHOW_COURSES_COLLAPSED = 10;
39     const COURSECAT_SHOW_COURSES_AUTO = 15; /* will choose between collapsed and expanded automatically */
40     const COURSECAT_SHOW_COURSES_EXPANDED = 20;
41     const COURSECAT_SHOW_COURSES_EXPANDED_WITH_CAT = 30;
43     const COURSECAT_TYPE_CATEGORY = 0;
44     const COURSECAT_TYPE_COURSE = 1;
46     /**
47      * A cache of strings
48      * @var stdClass
49      */
50     protected $strings;
52     /**
53      * Override the constructor so that we can initialise the string cache
54      *
55      * @param moodle_page $page
56      * @param string $target
57      */
58     public function __construct(moodle_page $page, $target) {
59         $this->strings = new stdClass;
60         parent::__construct($page, $target);
61         $this->add_modchoosertoggle();
62     }
64     /**
65      * Adds the item in course settings navigation to toggle modchooser
66      *
67      * Theme can overwrite as an empty function to exclude it (for example if theme does not
68      * use modchooser at all)
69      */
70     protected function add_modchoosertoggle() {
71         global $CFG;
72         static $modchoosertoggleadded = false;
73         // Add the module chooser toggle to the course page
74         if ($modchoosertoggleadded || $this->page->state > moodle_page::STATE_PRINTING_HEADER ||
75                 $this->page->course->id == SITEID ||
76                 !$this->page->user_is_editing() ||
77                 !($context = context_course::instance($this->page->course->id)) ||
78                 !has_capability('moodle/course:manageactivities', $context) ||
79                 !course_ajax_enabled($this->page->course) ||
80                 !($coursenode = $this->page->settingsnav->find('courseadmin', navigation_node::TYPE_COURSE)) ||
81                 !($turneditingnode = $coursenode->get('turneditingonoff'))) {
82             // too late or we are on site page or we could not find the adjacent nodes in course settings menu
83             // or we are not allowed to edit
84             return;
85         }
86         $modchoosertoggleadded = true;
87         if ($this->page->url->compare(new moodle_url('/course/view.php'), URL_MATCH_BASE)) {
88             // We are on the course page, retain the current page params e.g. section.
89             $modchoosertoggleurl = clone($this->page->url);
90         } else {
91             // Edit on the main course page.
92             $modchoosertoggleurl = new moodle_url('/course/view.php', array('id' => $this->page->course->id,
93                 'return' => $this->page->url->out_as_local_url(false)));
94         }
95         $modchoosertoggleurl->param('sesskey', sesskey());
96         if ($usemodchooser = get_user_preferences('usemodchooser', $CFG->modchooserdefault)) {
97             $modchoosertogglestring = get_string('modchooserdisable', 'moodle');
98             $modchoosertoggleurl->param('modchooser', 'off');
99         } else {
100             $modchoosertogglestring = get_string('modchooserenable', 'moodle');
101             $modchoosertoggleurl->param('modchooser', 'on');
102         }
103         $modchoosertoggle = navigation_node::create($modchoosertogglestring, $modchoosertoggleurl, navigation_node::TYPE_SETTING, null, 'modchoosertoggle');
105         // Insert the modchoosertoggle after the settings node 'turneditingonoff' (navigation_node only has function to insert before, so we insert before and then swap).
106         $coursenode->add_node($modchoosertoggle, 'turneditingonoff');
107         $turneditingnode->remove();
108         $coursenode->add_node($turneditingnode, 'modchoosertoggle');
110         $modchoosertoggle->add_class('modchoosertoggle');
111         $modchoosertoggle->add_class('visibleifjs');
112         user_preference_allow_ajax_update('usemodchooser', PARAM_BOOL);
113     }
115     /**
116      * Renders course info box.
117      *
118      * @param stdClass|course_in_list $course
119      * @return string
120      */
121     public function course_info_box(stdClass $course) {
122         $content = '';
123         $content .= $this->output->box_start('generalbox info');
124         $chelper = new coursecat_helper();
125         $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_EXPANDED);
126         $content .= $this->coursecat_coursebox($chelper, $course);
127         $content .= $this->output->box_end();
128         return $content;
129     }
131     /**
132      * Renderers a structured array of courses and categories into a nice XHTML tree structure.
133      *
134      * @deprecated since 2.5
135      *
136      * Please see http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
137      *
138      * @param array $ignored argument ignored
139      * @return string
140      */
141     public final function course_category_tree(array $ignored) {
142         debugging('Function core_course_renderer::course_category_tree() is deprecated, please use frontpage_combo_list()', DEBUG_DEVELOPER);
143         return $this->frontpage_combo_list();
144     }
146     /**
147      * Renderers a category for use with course_category_tree
148      *
149      * @deprecated since 2.5
150      *
151      * Please see http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
152      *
153      * @param array $category
154      * @param int $depth
155      * @return string
156      */
157     protected final function course_category_tree_category(stdClass $category, $depth=1) {
158         debugging('Function core_course_renderer::course_category_tree_category() is deprecated', DEBUG_DEVELOPER);
159         return '';
160     }
162     /**
163      * Build the HTML for the module chooser javascript popup
164      *
165      * @param array $modules A set of modules as returned form @see
166      * get_module_metadata
167      * @param object $course The course that will be displayed
168      * @return string The composed HTML for the module
169      */
170     public function course_modchooser($modules, $course) {
171         static $isdisplayed = false;
172         if ($isdisplayed) {
173             return '';
174         }
175         $isdisplayed = true;
177         // Add the module chooser
178         $this->page->requires->yui_module('moodle-course-modchooser',
179         'M.course.init_chooser',
180         array(array('courseid' => $course->id, 'closeButtonTitle' => get_string('close', 'editor')))
181         );
182         $this->page->requires->strings_for_js(array(
183                 'addresourceoractivity',
184                 'modchooserenable',
185                 'modchooserdisable',
186         ), 'moodle');
188         // Add the header
189         $header = html_writer::tag('div', get_string('addresourceoractivity', 'moodle'),
190                 array('class' => 'hd choosertitle'));
192         $formcontent = html_writer::start_tag('form', array('action' => new moodle_url('/course/jumpto.php'),
193                 'id' => 'chooserform', 'method' => 'post'));
194         $formcontent .= html_writer::start_tag('div', array('id' => 'typeformdiv'));
195         $formcontent .= html_writer::tag('input', '', array('type' => 'hidden', 'id' => 'course',
196                 'name' => 'course', 'value' => $course->id));
197         $formcontent .= html_writer::tag('input', '',
198                 array('type' => 'hidden', 'class' => 'jump', 'name' => 'jump', 'value' => ''));
199         $formcontent .= html_writer::tag('input', '', array('type' => 'hidden', 'name' => 'sesskey',
200                 'value' => sesskey()));
201         $formcontent .= html_writer::end_tag('div');
203         // Put everything into one tag 'options'
204         $formcontent .= html_writer::start_tag('div', array('class' => 'options'));
205         $formcontent .= html_writer::tag('div', get_string('selectmoduletoviewhelp', 'moodle'),
206                 array('class' => 'instruction'));
207         // Put all options into one tag 'alloptions' to allow us to handle scrolling
208         $formcontent .= html_writer::start_tag('div', array('class' => 'alloptions'));
210          // Activities
211         $activities = array_filter($modules, create_function('$mod', 'return ($mod->archetype !== MOD_ARCHETYPE_RESOURCE && $mod->archetype !== MOD_ARCHETYPE_SYSTEM);'));
212         if (count($activities)) {
213             $formcontent .= $this->course_modchooser_title('activities');
214             $formcontent .= $this->course_modchooser_module_types($activities);
215         }
217         // Resources
218         $resources = array_filter($modules, create_function('$mod', 'return ($mod->archetype === MOD_ARCHETYPE_RESOURCE);'));
219         if (count($resources)) {
220             $formcontent .= $this->course_modchooser_title('resources');
221             $formcontent .= $this->course_modchooser_module_types($resources);
222         }
224         $formcontent .= html_writer::end_tag('div'); // modoptions
225         $formcontent .= html_writer::end_tag('div'); // types
227         $formcontent .= html_writer::start_tag('div', array('class' => 'submitbuttons'));
228         $formcontent .= html_writer::tag('input', '',
229                 array('type' => 'submit', 'name' => 'submitbutton', 'class' => 'submitbutton', 'value' => get_string('add')));
230         $formcontent .= html_writer::tag('input', '',
231                 array('type' => 'submit', 'name' => 'addcancel', 'class' => 'addcancel', 'value' => get_string('cancel')));
232         $formcontent .= html_writer::end_tag('div');
233         $formcontent .= html_writer::end_tag('form');
235         // Wrap the whole form in a div
236         $formcontent = html_writer::tag('div', $formcontent, array('id' => 'chooseform'));
238         // Put all of the content together
239         $content = $formcontent;
241         $content = html_writer::tag('div', $content, array('class' => 'choosercontainer'));
242         return $header . html_writer::tag('div', $content, array('class' => 'chooserdialoguebody'));
243     }
245     /**
246      * Build the HTML for a specified set of modules
247      *
248      * @param array $modules A set of modules as used by the
249      * course_modchooser_module function
250      * @return string The composed HTML for the module
251      */
252     protected function course_modchooser_module_types($modules) {
253         $return = '';
254         foreach ($modules as $module) {
255             if (!isset($module->types)) {
256                 $return .= $this->course_modchooser_module($module);
257             } else {
258                 $return .= $this->course_modchooser_module($module, array('nonoption'));
259                 foreach ($module->types as $type) {
260                     $return .= $this->course_modchooser_module($type, array('option', 'subtype'));
261                 }
262             }
263         }
264         return $return;
265     }
267     /**
268      * Return the HTML for the specified module adding any required classes
269      *
270      * @param object $module An object containing the title, and link. An
271      * icon, and help text may optionally be specified. If the module
272      * contains subtypes in the types option, then these will also be
273      * displayed.
274      * @param array $classes Additional classes to add to the encompassing
275      * div element
276      * @return string The composed HTML for the module
277      */
278     protected function course_modchooser_module($module, $classes = array('option')) {
279         $output = '';
280         $output .= html_writer::start_tag('div', array('class' => implode(' ', $classes)));
281         $output .= html_writer::start_tag('label', array('for' => 'module_' . $module->name));
282         if (!isset($module->types)) {
283             $output .= html_writer::tag('input', '', array('type' => 'radio',
284                     'name' => 'jumplink', 'id' => 'module_' . $module->name, 'value' => $module->link));
285         }
287         $output .= html_writer::start_tag('span', array('class' => 'modicon'));
288         if (isset($module->icon)) {
289             // Add an icon if we have one
290             $output .= $module->icon;
291         }
292         $output .= html_writer::end_tag('span');
294         $output .= html_writer::tag('span', $module->title, array('class' => 'typename'));
295         if (!isset($module->help)) {
296             // Add help if found
297             $module->help = get_string('nohelpforactivityorresource', 'moodle');
298         }
300         // Format the help text using markdown with the following options
301         $options = new stdClass();
302         $options->trusted = false;
303         $options->noclean = false;
304         $options->smiley = false;
305         $options->filter = false;
306         $options->para = true;
307         $options->newlines = false;
308         $options->overflowdiv = false;
309         $module->help = format_text($module->help, FORMAT_MARKDOWN, $options);
310         $output .= html_writer::tag('span', $module->help, array('class' => 'typesummary'));
311         $output .= html_writer::end_tag('label');
312         $output .= html_writer::end_tag('div');
314         return $output;
315     }
317     protected function course_modchooser_title($title, $identifier = null) {
318         $module = new stdClass();
319         $module->name = $title;
320         $module->types = array();
321         $module->title = get_string($title, $identifier);
322         $module->help = '';
323         return $this->course_modchooser_module($module, array('moduletypetitle'));
324     }
326     /**
327      * Renders HTML for displaying the sequence of course module editing buttons
328      *
329      * @see course_get_cm_edit_actions()
330      *
331      * @param action_link[] $actions Array of action_link objects
332      * @param cm_info $mod The module we are displaying actions for.
333      * @param array $displayoptions additional display options:
334      *     ownerselector => A JS/CSS selector that can be used to find an cm node.
335      *         If specified the owning node will be given the class 'action-menu-shown' when the action
336      *         menu is being displayed.
337      *     constraintselector => A JS/CSS selector that can be used to find the parent node for which to constrain
338      *         the action menu to when it is being displayed.
339      *     donotenhance => If set to true the action menu that gets displayed won't be enhanced by JS.
340      * @return string
341      */
342     public function course_section_cm_edit_actions($actions, cm_info $mod = null, $displayoptions = array()) {
343         global $CFG;
345         if (empty($actions)) {
346             return '';
347         }
349         if (isset($displayoptions['ownerselector'])) {
350             $ownerselector = $displayoptions['ownerselector'];
351         } else if ($mod) {
352             $ownerselector = '#module-'.$mod->id;
353         } else {
354             debugging('You should upgrade your call to '.__FUNCTION__.' and provide $mod', DEBUG_DEVELOPER);
355             $ownerselector = 'li.activity';
356         }
358         if (isset($displayoptions['constraintselector'])) {
359             $constraint = $displayoptions['constraintselector'];
360         } else {
361             $constraint = '.course-content';
362         }
364         $menu = new action_menu();
365         $menu->set_owner_selector($ownerselector);
366         $menu->set_contraint($constraint);
367         $menu->set_alignment(action_menu::TL, action_menu::TR);
368         if (isset($CFG->modeditingmenu) && !$CFG->modeditingmenu || !empty($displayoptions['donotenhance'])) {
369             $menu->do_not_enhance();
370         }
371         foreach ($actions as $action) {
372             if ($action instanceof action_menu_link) {
373                 $action->add_class('cm-edit-action');
374             }
375             $menu->add($action);
376         }
377         $menu->attributes['class'] .= ' section-cm-edit-actions commands';
378         return $this->render($menu);
379     }
381     /**
382      * Renders HTML for the menus to add activities and resources to the current course
383      *
384      * Note, if theme overwrites this function and it does not use modchooser,
385      * see also {@link core_course_renderer::add_modchoosertoggle()}
386      *
387      * @param stdClass $course
388      * @param int $section relative section number (field course_sections.section)
389      * @param int $sectionreturn The section to link back to
390      * @param array $displayoptions additional display options, for example blocks add
391      *     option 'inblock' => true, suggesting to display controls vertically
392      * @return string
393      */
394     function course_section_add_cm_control($course, $section, $sectionreturn = null, $displayoptions = array()) {
395         global $CFG;
397         $vertical = !empty($displayoptions['inblock']);
399         // check to see if user can add menus and there are modules to add
400         if (!has_capability('moodle/course:manageactivities', context_course::instance($course->id))
401                 || !$this->page->user_is_editing()
402                 || !($modnames = get_module_types_names()) || empty($modnames)) {
403             return '';
404         }
406         // Retrieve all modules with associated metadata
407         $modules = get_module_metadata($course, $modnames, $sectionreturn);
408         $urlparams = array('section' => $section);
410         // We'll sort resources and activities into two lists
411         $activities = array(MOD_CLASS_ACTIVITY => array(), MOD_CLASS_RESOURCE => array());
413         foreach ($modules as $module) {
414             if (isset($module->types)) {
415                 // This module has a subtype
416                 // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
417                 $subtypes = array();
418                 foreach ($module->types as $subtype) {
419                     $link = $subtype->link->out(true, $urlparams);
420                     $subtypes[$link] = $subtype->title;
421                 }
423                 // Sort module subtypes into the list
424                 $activityclass = MOD_CLASS_ACTIVITY;
425                 if ($module->archetype == MOD_CLASS_RESOURCE) {
426                     $activityclass = MOD_CLASS_RESOURCE;
427                 }
428                 if (!empty($module->title)) {
429                     // This grouping has a name
430                     $activities[$activityclass][] = array($module->title => $subtypes);
431                 } else {
432                     // This grouping does not have a name
433                     $activities[$activityclass] = array_merge($activities[$activityclass], $subtypes);
434                 }
435             } else {
436                 // This module has no subtypes
437                 $activityclass = MOD_CLASS_ACTIVITY;
438                 if ($module->archetype == MOD_ARCHETYPE_RESOURCE) {
439                     $activityclass = MOD_CLASS_RESOURCE;
440                 } else if ($module->archetype === MOD_ARCHETYPE_SYSTEM) {
441                     // System modules cannot be added by user, do not add to dropdown
442                     continue;
443                 }
444                 $link = $module->link->out(true, $urlparams);
445                 $activities[$activityclass][$link] = $module->title;
446             }
447         }
449         $straddactivity = get_string('addactivity');
450         $straddresource = get_string('addresource');
451         $sectionname = get_section_name($course, $section);
452         $strresourcelabel = get_string('addresourcetosection', null, $sectionname);
453         $stractivitylabel = get_string('addactivitytosection', null, $sectionname);
455         $output = html_writer::start_tag('div', array('class' => 'section_add_menus', 'id' => 'add_menus-section-' . $section));
457         if (!$vertical) {
458             $output .= html_writer::start_tag('div', array('class' => 'horizontal'));
459         }
461         if (!empty($activities[MOD_CLASS_RESOURCE])) {
462             $select = new url_select($activities[MOD_CLASS_RESOURCE], '', array(''=>$straddresource), "ressection$section");
463             $select->set_help_icon('resources');
464             $select->set_label($strresourcelabel, array('class' => 'accesshide'));
465             $output .= $this->output->render($select);
466         }
468         if (!empty($activities[MOD_CLASS_ACTIVITY])) {
469             $select = new url_select($activities[MOD_CLASS_ACTIVITY], '', array(''=>$straddactivity), "section$section");
470             $select->set_help_icon('activities');
471             $select->set_label($stractivitylabel, array('class' => 'accesshide'));
472             $output .= $this->output->render($select);
473         }
475         if (!$vertical) {
476             $output .= html_writer::end_tag('div');
477         }
479         $output .= html_writer::end_tag('div');
481         if (course_ajax_enabled($course) && $course->id == $this->page->course->id) {
482             // modchooser can be added only for the current course set on the page!
483             $straddeither = get_string('addresourceoractivity');
484             // The module chooser link
485             $modchooser = html_writer::start_tag('div', array('class' => 'mdl-right'));
486             $modchooser.= html_writer::start_tag('div', array('class' => 'section-modchooser'));
487             $icon = $this->output->pix_icon('t/add', '');
488             $span = html_writer::tag('span', $straddeither, array('class' => 'section-modchooser-text'));
489             $modchooser .= html_writer::tag('span', $icon . $span, array('class' => 'section-modchooser-link'));
490             $modchooser.= html_writer::end_tag('div');
491             $modchooser.= html_writer::end_tag('div');
493             // Wrap the normal output in a noscript div
494             $usemodchooser = get_user_preferences('usemodchooser', $CFG->modchooserdefault);
495             if ($usemodchooser) {
496                 $output = html_writer::tag('div', $output, array('class' => 'hiddenifjs addresourcedropdown'));
497                 $modchooser = html_writer::tag('div', $modchooser, array('class' => 'visibleifjs addresourcemodchooser'));
498             } else {
499                 // If the module chooser is disabled, we need to ensure that the dropdowns are shown even if javascript is disabled
500                 $output = html_writer::tag('div', $output, array('class' => 'show addresourcedropdown'));
501                 $modchooser = html_writer::tag('div', $modchooser, array('class' => 'hide addresourcemodchooser'));
502             }
503             $output = $this->course_modchooser($modules, $course) . $modchooser . $output;
504         }
506         return $output;
507     }
509     /**
510      * Renders html to display a course search form
511      *
512      * @param string $value default value to populate the search field
513      * @param string $format display format - 'plain' (default), 'short' or 'navbar'
514      * @return string
515      */
516     function course_search_form($value = '', $format = 'plain') {
517         static $count = 0;
518         $formid = 'coursesearch';
519         if ((++$count) > 1) {
520             $formid .= $count;
521         }
523         switch ($format) {
524             case 'navbar' :
525                 $formid = 'coursesearchnavbar';
526                 $inputid = 'navsearchbox';
527                 $inputsize = 20;
528                 break;
529             case 'short' :
530                 $inputid = 'shortsearchbox';
531                 $inputsize = 12;
532                 break;
533             default :
534                 $inputid = 'coursesearchbox';
535                 $inputsize = 30;
536         }
538         $strsearchcourses= get_string("searchcourses");
539         $searchurl = new moodle_url('/course/search.php');
541         $output = html_writer::start_tag('form', array('id' => $formid, 'action' => $searchurl, 'method' => 'get'));
542         $output .= html_writer::start_tag('fieldset', array('class' => 'coursesearchbox invisiblefieldset'));
543         $output .= html_writer::tag('label', $strsearchcourses.': ', array('for' => $inputid));
544         $output .= html_writer::empty_tag('input', array('type' => 'text', 'id' => $inputid,
545             'size' => $inputsize, 'name' => 'search', 'value' => s($value)));
546         $output .= html_writer::empty_tag('input', array('type' => 'submit',
547             'value' => get_string('go')));
548         $output .= html_writer::end_tag('fieldset');
549         $output .= html_writer::end_tag('form');
551         return $output;
552     }
554     /**
555      * Renders html for completion box on course page
556      *
557      * If completion is disabled, returns empty string
558      * If completion is automatic, returns an icon of the current completion state
559      * If completion is manual, returns a form (with an icon inside) that allows user to
560      * toggle completion
561      *
562      * @param stdClass $course course object
563      * @param completion_info $completioninfo completion info for the course, it is recommended
564      *     to fetch once for all modules in course/section for performance
565      * @param cm_info $mod module to show completion for
566      * @param array $displayoptions display options, not used in core
567      * @return string
568      */
569     public function course_section_cm_completion($course, &$completioninfo, cm_info $mod, $displayoptions = array()) {
570         global $CFG;
571         $output = '';
572         if (!empty($displayoptions['hidecompletion']) || !isloggedin() || isguestuser() || !$mod->uservisible) {
573             return $output;
574         }
575         if ($completioninfo === null) {
576             $completioninfo = new completion_info($course);
577         }
578         $completion = $completioninfo->is_enabled($mod);
579         if ($completion == COMPLETION_TRACKING_NONE) {
580             return $output;
581         }
583         $completiondata = $completioninfo->get_data($mod, true);
584         $completionicon = '';
586         if ($this->page->user_is_editing()) {
587             switch ($completion) {
588                 case COMPLETION_TRACKING_MANUAL :
589                     $completionicon = 'manual-enabled'; break;
590                 case COMPLETION_TRACKING_AUTOMATIC :
591                     $completionicon = 'auto-enabled'; break;
592             }
593         } else if ($completion == COMPLETION_TRACKING_MANUAL) {
594             switch($completiondata->completionstate) {
595                 case COMPLETION_INCOMPLETE:
596                     $completionicon = 'manual-n'; break;
597                 case COMPLETION_COMPLETE:
598                     $completionicon = 'manual-y'; break;
599             }
600         } else { // Automatic
601             switch($completiondata->completionstate) {
602                 case COMPLETION_INCOMPLETE:
603                     $completionicon = 'auto-n'; break;
604                 case COMPLETION_COMPLETE:
605                     $completionicon = 'auto-y'; break;
606                 case COMPLETION_COMPLETE_PASS:
607                     $completionicon = 'auto-pass'; break;
608                 case COMPLETION_COMPLETE_FAIL:
609                     $completionicon = 'auto-fail'; break;
610             }
611         }
612         if ($completionicon) {
613             $formattedname = $mod->get_formatted_name();
614             $imgalt = get_string('completion-alt-' . $completionicon, 'completion', $formattedname);
615             if ($completion == COMPLETION_TRACKING_MANUAL && !$this->page->user_is_editing()) {
616                 $imgtitle = get_string('completion-title-' . $completionicon, 'completion', $formattedname);
617                 $newstate =
618                     $completiondata->completionstate == COMPLETION_COMPLETE
619                     ? COMPLETION_INCOMPLETE
620                     : COMPLETION_COMPLETE;
621                 // In manual mode the icon is a toggle form...
623                 // If this completion state is used by the
624                 // conditional activities system, we need to turn
625                 // off the JS.
626                 $extraclass = '';
627                 if (!empty($CFG->enableavailability) &&
628                         condition_info::completion_value_used_as_condition($course, $mod)) {
629                     $extraclass = ' preventjs';
630                 }
631                 $output .= html_writer::start_tag('form', array('method' => 'post',
632                     'action' => new moodle_url('/course/togglecompletion.php'),
633                     'class' => 'togglecompletion'. $extraclass));
634                 $output .= html_writer::start_tag('div');
635                 $output .= html_writer::empty_tag('input', array(
636                     'type' => 'hidden', 'name' => 'id', 'value' => $mod->id));
637                 $output .= html_writer::empty_tag('input', array(
638                     'type' => 'hidden', 'name' => 'sesskey', 'value' => sesskey()));
639                 $output .= html_writer::empty_tag('input', array(
640                     'type' => 'hidden', 'name' => 'modulename', 'value' => $mod->name));
641                 $output .= html_writer::empty_tag('input', array(
642                     'type' => 'hidden', 'name' => 'completionstate', 'value' => $newstate));
643                 $output .= html_writer::empty_tag('input', array(
644                     'type' => 'image',
645                     'src' => $this->output->pix_url('i/completion-'.$completionicon),
646                     'alt' => $imgalt, 'title' => $imgtitle,
647                     'aria-live' => 'polite'));
648                 $output .= html_writer::end_tag('div');
649                 $output .= html_writer::end_tag('form');
650             } else {
651                 // In auto mode, or when editing, the icon is just an image
652                 $completionpixicon = new pix_icon('i/completion-'.$completionicon, $imgalt, '',
653                         array('title' => $imgalt));
654                 $output .= html_writer::tag('span', $this->output->render($completionpixicon),
655                         array('class' => 'autocompletion'));
656             }
657         }
658         return $output;
659     }
661     /**
662      * Checks if course module has any conditions that may make it unavailable for
663      * all or some of the students
664      *
665      * This function is internal and is only used to create CSS classes for the module name/text
666      *
667      * @param cm_info $mod
668      * @return bool
669      */
670     protected function is_cm_conditionally_hidden(cm_info $mod) {
671         global $CFG;
672         $conditionalhidden = false;
673         if (!empty($CFG->enableavailability)) {
674             $conditionalhidden = $mod->availablefrom > time() ||
675                 ($mod->availableuntil && $mod->availableuntil < time()) ||
676                 count($mod->conditionsgrade) > 0 ||
677                 count($mod->conditionscompletion) > 0;
678         }
679         return $conditionalhidden;
680     }
682     /**
683      * Renders html to display a name with the link to the course module on a course page
684      *
685      * If module is unavailable for user but still needs to be displayed
686      * in the list, just the name is returned without a link
687      *
688      * Note, that for course modules that never have separate pages (i.e. labels)
689      * this function return an empty string
690      *
691      * @param cm_info $mod
692      * @param array $displayoptions
693      * @return string
694      */
695     public function course_section_cm_name(cm_info $mod, $displayoptions = array()) {
696         global $CFG;
697         $output = '';
698         if (!$mod->uservisible &&
699                 (empty($mod->showavailability) || empty($mod->availableinfo))) {
700             // nothing to be displayed to the user
701             return $output;
702         }
703         $url = $mod->get_url();
704         if (!$url) {
705             return $output;
706         }
708         //Accessibility: for files get description via icon, this is very ugly hack!
709         $instancename = $mod->get_formatted_name();
710         $altname = $mod->modfullname;
711         // Avoid unnecessary duplication: if e.g. a forum name already
712         // includes the word forum (or Forum, etc) then it is unhelpful
713         // to include that in the accessible description that is added.
714         if (false !== strpos(core_text::strtolower($instancename),
715                 core_text::strtolower($altname))) {
716             $altname = '';
717         }
718         // File type after name, for alphabetic lists (screen reader).
719         if ($altname) {
720             $altname = get_accesshide(' '.$altname);
721         }
723         // For items which are hidden but available to current user
724         // ($mod->uservisible), we show those as dimmed only if the user has
725         // viewhiddenactivities, so that teachers see 'items which might not
726         // be available to some students' dimmed but students do not see 'item
727         // which is actually available to current student' dimmed.
728         $conditionalhidden = $this->is_cm_conditionally_hidden($mod);
729         $accessiblebutdim = (!$mod->visible || $conditionalhidden) &&
730                 (!$mod->uservisible || has_capability('moodle/course:viewhiddenactivities',
731                         context_course::instance($mod->course)));
733         $linkclasses = '';
734         $accesstext = '';
735         $textclasses = '';
736         if ($accessiblebutdim) {
737             $linkclasses .= ' dimmed';
738             $textclasses .= ' dimmed_text';
739             if ($conditionalhidden) {
740                 $linkclasses .= ' conditionalhidden';
741                 $textclasses .= ' conditionalhidden';
742             }
743             if ($mod->uservisible) {
744                 // show accessibility note only if user can access the module himself
745                 $accesstext = get_accesshide(get_string('hiddenfromstudents').':'. $mod->modfullname);
746             }
747         }
749         // Get on-click attribute value if specified and decode the onclick - it
750         // has already been encoded for display (puke).
751         $onclick = htmlspecialchars_decode($mod->get_on_click(), ENT_QUOTES);
753         $groupinglabel = '';
754         if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', context_course::instance($mod->course))) {
755             $groupings = groups_get_all_groupings($mod->course);
756             $groupinglabel = html_writer::tag('span', '('.format_string($groupings[$mod->groupingid]->name).')',
757                     array('class' => 'groupinglabel '.$textclasses));
758         }
760         // Display link itself.
761         $activitylink = html_writer::empty_tag('img', array('src' => $mod->get_icon_url(),
762                 'class' => 'iconlarge activityicon', 'alt' => ' ', 'role' => 'presentation')) . $accesstext .
763                 html_writer::tag('span', $instancename . $altname, array('class' => 'instancename'));
764         if ($mod->uservisible) {
765             $output .= html_writer::link($url, $activitylink, array('class' => $linkclasses, 'onclick' => $onclick)) .
766                     $groupinglabel;
767         } else {
768             // We may be displaying this just in order to show information
769             // about visibility, without the actual link ($mod->uservisible)
770             $output .= html_writer::tag('div', $activitylink, array('class' => $textclasses)) .
771                     $groupinglabel;
772         }
773         return $output;
774     }
776     /**
777      * Renders html to display the module content on the course page (i.e. text of the labels)
778      *
779      * @param cm_info $mod
780      * @param array $displayoptions
781      * @return string
782      */
783     public function course_section_cm_text(cm_info $mod, $displayoptions = array()) {
784         $output = '';
785         if (!$mod->uservisible &&
786                 (empty($mod->showavailability) || empty($mod->availableinfo))) {
787             // nothing to be displayed to the user
788             return $output;
789         }
790         $content = $mod->get_formatted_content(array('overflowdiv' => true, 'noclean' => true));
791         if ($this->page->user_is_editing()) {
792             // In editing mode, when an item is conditionally hidden from some users
793             // we show it as greyed out.
794             $conditionalhidden = $this->is_cm_conditionally_hidden($mod);
795             $dim = !$mod->visible || $conditionalhidden;
796         } else {
797             // When not in editing mode, we only show item as hidden if it is
798             // actually not available to the user
799             $conditionalhidden = false;
800             $dim = !$mod->uservisible;
801         }
802         $textclasses = '';
803         $accesstext = '';
804         if ($dim) {
805             $textclasses .= ' dimmed_text';
806             if ($conditionalhidden) {
807                 $textclasses .= ' conditionalhidden';
808             }
809             if ($mod->uservisible) {
810                 // show accessibility note only if user can access the module himself
811                 $accesstext = get_accesshide(get_string('hiddenfromstudents').': ');
812             }
813         }
814         if ($mod->get_url()) {
815             if ($content) {
816                 // If specified, display extra content after link.
817                 $output = html_writer::tag('div', $content, array('class' =>
818                         trim('contentafterlink ' . $textclasses)));
819             }
820         } else {
821             // No link, so display only content.
822             $output = html_writer::tag('div', $accesstext . $content, array('class' => $textclasses));
823         }
824         return $output;
825     }
827     /**
828      * Renders HTML to show course module availability information (for someone who isn't allowed
829      * to see the activity itself, or for staff)
830      *
831      * @param cm_info $mod
832      * @param array $displayoptions
833      * @return string
834      */
835     public function course_section_cm_availability(cm_info $mod, $displayoptions = array()) {
836         global $CFG;
837         if (!$mod->uservisible) {
838             // this is a student who is not allowed to see the module but might be allowed
839             // to see availability info (i.e. "Available from ...")
840             if (!empty($mod->showavailability) && !empty($mod->availableinfo)) {
841                 $output = html_writer::tag('div', $mod->availableinfo, array('class' => 'availabilityinfo'));
842             }
843             return $output;
844         }
845         // this is a teacher who is allowed to see module but still should see the
846         // information that module is not available to all/some students
847         $modcontext = context_module::instance($mod->id);
848         $canviewhidden = has_capability('moodle/course:viewhiddenactivities', $modcontext);
849         if ($canviewhidden && !empty($CFG->enableavailability)) {
850             // Don't add availability information if user is not editing and activity is hidden.
851             if ($mod->visible || $this->page->user_is_editing()) {
852                 $hidinfoclass = '';
853                 if (!$mod->visible) {
854                     $hidinfoclass = 'hide';
855                 }
856                 $ci = new condition_info($mod);
857                 $fullinfo = $ci->get_full_information();
858                 if($fullinfo) {
859                     return '<div class="availabilityinfo '.$hidinfoclass.'">'.get_string($mod->showavailability
860                         ? 'userrestriction_visible'
861                         : 'userrestriction_hidden','condition',
862                         $fullinfo).'</div>';
863                 }
864             }
865         }
866         return '';
867     }
869     /**
870      * Renders HTML to display one course module for display within a section.
871      *
872      * This function calls:
873      * {@link core_course_renderer::course_section_cm()}
874      *
875      * @param stdClass $course
876      * @param completion_info $completioninfo
877      * @param cm_info $mod
878      * @param int|null $sectionreturn
879      * @param array $displayoptions
880      * @return String
881      */
882     public function course_section_cm_list_item($course, &$completioninfo, cm_info $mod, $sectionreturn, $displayoptions = array()) {
883         $output = '';
884         if ($modulehtml = $this->course_section_cm($course, $completioninfo, $mod, $sectionreturn, $displayoptions)) {
885             $modclasses = 'activity ' . $mod->modname . ' modtype_' . $mod->modname . ' ' . $mod->get_extra_classes();
886             $output .= html_writer::tag('li', $modulehtml, array('class' => $modclasses, 'id' => 'module-' . $mod->id));
887         }
888         return $output;
889     }
891     /**
892      * Renders HTML to display one course module in a course section
893      *
894      * This includes link, content, availability, completion info and additional information
895      * that module type wants to display (i.e. number of unread forum posts)
896      *
897      * This function calls:
898      * {@link core_course_renderer::course_section_cm_name()}
899      * {@link cm_info::get_after_link()}
900      * {@link core_course_renderer::course_section_cm_text()}
901      * {@link core_course_renderer::course_section_cm_availability()}
902      * {@link core_course_renderer::course_section_cm_completion()}
903      * {@link course_get_cm_edit_actions()}
904      * {@link core_course_renderer::course_section_cm_edit_actions()}
905      *
906      * @param stdClass $course
907      * @param completion_info $completioninfo
908      * @param cm_info $mod
909      * @param int|null $sectionreturn
910      * @param array $displayoptions
911      * @return string
912      */
913     public function course_section_cm($course, &$completioninfo, cm_info $mod, $sectionreturn, $displayoptions = array()) {
914         $output = '';
915         // We return empty string (because course module will not be displayed at all)
916         // if:
917         // 1) The activity is not visible to users
918         // and
919         // 2a) The 'showavailability' option is not set (if that is set,
920         //     we need to display the activity so we can show
921         //     availability info)
922         // or
923         // 2b) The 'availableinfo' is empty, i.e. the activity was
924         //     hidden in a way that leaves no info, such as using the
925         //     eye icon.
926         if (!$mod->uservisible &&
927             (empty($mod->showavailability) || empty($mod->availableinfo))) {
928             return $output;
929         }
931         $indentclasses = 'mod-indent';
932         if (!empty($mod->indent)) {
933             $indentclasses .= ' mod-indent-'.$mod->indent;
934             if ($mod->indent > 15) {
935                 $indentclasses .= ' mod-indent-huge';
936             }
937         }
938         $output .= html_writer::start_tag('div', array('class' => $indentclasses));
940         // Start the div for the activity title, excluding the edit icons.
941         $output .= html_writer::start_tag('div', array('class' => 'activityinstance'));
943         // Display the link to the module (or do nothing if module has no url)
944         $output .= $this->course_section_cm_name($mod, $displayoptions);
946         // Module can put text after the link (e.g. forum unread)
947         $output .= $mod->get_after_link();
949         // Closing the tag which contains everything but edit icons. Content part of the module should not be part of this.
950         $output .= html_writer::end_tag('div'); // .activityinstance
952         // If there is content but NO link (eg label), then display the
953         // content here (BEFORE any icons). In this case cons must be
954         // displayed after the content so that it makes more sense visually
955         // and for accessibility reasons, e.g. if you have a one-line label
956         // it should work similarly (at least in terms of ordering) to an
957         // activity.
958         $contentpart = $this->course_section_cm_text($mod, $displayoptions);
959         $url = $mod->get_url();
960         if (empty($url)) {
961             $output .= $contentpart;
962         }
964         if ($this->page->user_is_editing()) {
965             $editactions = course_get_cm_edit_actions($mod, $mod->indent, $sectionreturn);
966             $output .= ' '. $this->course_section_cm_edit_actions($editactions, $mod, $displayoptions);
967             $output .= $mod->get_after_edit_icons();
968         }
970         $output .= $this->course_section_cm_completion($course, $completioninfo, $mod, $displayoptions);
972         // If there is content AND a link, then display the content here
973         // (AFTER any icons). Otherwise it was displayed before
974         if (!empty($url)) {
975             $output .= $contentpart;
976         }
978         // show availability info (if module is not available)
979         $output .= $this->course_section_cm_availability($mod, $displayoptions);
981         $output .= html_writer::end_tag('div'); // $indentclasses
982         return $output;
983     }
985     /**
986      * Renders HTML to display a list of course modules in a course section
987      * Also displays "move here" controls in Javascript-disabled mode
988      *
989      * This function calls {@link core_course_renderer::course_section_cm()}
990      *
991      * @param stdClass $course course object
992      * @param int|stdClass|section_info $section relative section number or section object
993      * @param int $sectionreturn section number to return to
994      * @param int $displayoptions
995      * @return void
996      */
997     public function course_section_cm_list($course, $section, $sectionreturn = null, $displayoptions = array()) {
998         global $USER;
1000         $output = '';
1001         $modinfo = get_fast_modinfo($course);
1002         if (is_object($section)) {
1003             $section = $modinfo->get_section_info($section->section);
1004         } else {
1005             $section = $modinfo->get_section_info($section);
1006         }
1007         $completioninfo = new completion_info($course);
1009         // check if we are currently in the process of moving a module with JavaScript disabled
1010         $ismoving = $this->page->user_is_editing() && ismoving($course->id);
1011         if ($ismoving) {
1012             $movingpix = new pix_icon('movehere', get_string('movehere'), 'moodle', array('class' => 'movetarget'));
1013             $strmovefull = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'"));
1014         }
1016         // Get the list of modules visible to user (excluding the module being moved if there is one)
1017         $moduleshtml = array();
1018         if (!empty($modinfo->sections[$section->section])) {
1019             foreach ($modinfo->sections[$section->section] as $modnumber) {
1020                 $mod = $modinfo->cms[$modnumber];
1022                 if ($ismoving and $mod->id == $USER->activitycopy) {
1023                     // do not display moving mod
1024                     continue;
1025                 }
1027                 if ($modulehtml = $this->course_section_cm_list_item($course,
1028                         $completioninfo, $mod, $sectionreturn, $displayoptions)) {
1029                     $moduleshtml[$modnumber] = $modulehtml;
1030                 }
1031             }
1032         }
1034         $sectionoutput = '';
1035         if (!empty($moduleshtml) || $ismoving) {
1036             foreach ($moduleshtml as $modnumber => $modulehtml) {
1037                 if ($ismoving) {
1038                     $movingurl = new moodle_url('/course/mod.php', array('moveto' => $modnumber, 'sesskey' => sesskey()));
1039                     $sectionoutput .= html_writer::tag('li', html_writer::link($movingurl, $this->output->render($movingpix)),
1040                             array('class' => 'movehere', 'title' => $strmovefull));
1041                 }
1043                 $sectionoutput .= $modulehtml;
1044             }
1046             if ($ismoving) {
1047                 $movingurl = new moodle_url('/course/mod.php', array('movetosection' => $section->id, 'sesskey' => sesskey()));
1048                 $sectionoutput .= html_writer::tag('li', html_writer::link($movingurl, $this->output->render($movingpix)),
1049                         array('class' => 'movehere', 'title' => $strmovefull));
1050             }
1051         }
1053         // Always output the section module list.
1054         $output .= html_writer::tag('ul', $sectionoutput, array('class' => 'section img-text'));
1056         return $output;
1057     }
1059     /**
1060      * Displays a custom list of courses with paging bar if necessary
1061      *
1062      * If $paginationurl is specified but $totalcount is not, the link 'View more'
1063      * appears under the list.
1064      *
1065      * If both $paginationurl and $totalcount are specified, and $totalcount is
1066      * bigger than count($courses), a paging bar is displayed above and under the
1067      * courses list.
1068      *
1069      * @param array $courses array of course records (or instances of course_in_list) to show on this page
1070      * @param bool $showcategoryname whether to add category name to the course description
1071      * @param string $additionalclasses additional CSS classes to add to the div.courses
1072      * @param moodle_url $paginationurl url to view more or url to form links to the other pages in paging bar
1073      * @param int $totalcount total number of courses on all pages, if omitted $paginationurl will be displayed as 'View more' link
1074      * @param int $page current page number (defaults to 0 referring to the first page)
1075      * @param int $perpage number of records per page (defaults to $CFG->coursesperpage)
1076      * @return string
1077      */
1078     public function courses_list($courses, $showcategoryname = false, $additionalclasses = null, $paginationurl = null, $totalcount = null, $page = 0, $perpage = null) {
1079         global $CFG;
1080         // create instance of coursecat_helper to pass display options to function rendering courses list
1081         $chelper = new coursecat_helper();
1082         if ($showcategoryname) {
1083             $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_EXPANDED_WITH_CAT);
1084         } else {
1085             $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_EXPANDED);
1086         }
1087         if ($totalcount !== null && $paginationurl !== null) {
1088             // add options to display pagination
1089             if ($perpage === null) {
1090                 $perpage = $CFG->coursesperpage;
1091             }
1092             $chelper->set_courses_display_options(array(
1093                 'limit' => $perpage,
1094                 'offset' => ((int)$page) * $perpage,
1095                 'paginationurl' => $paginationurl,
1096             ));
1097         } else if ($paginationurl !== null) {
1098             // add options to display 'View more' link
1099             $chelper->set_courses_display_options(array('viewmoreurl' => $paginationurl));
1100             $totalcount = count($courses) + 1; // has to be bigger than count($courses) otherwise link will not be displayed
1101         }
1102         $chelper->set_attributes(array('class' => $additionalclasses));
1103         $content = $this->coursecat_courses($chelper, $courses, $totalcount);
1104         return $content;
1105     }
1107     /**
1108      * Displays one course in the list of courses.
1109      *
1110      * This is an internal function, to display an information about just one course
1111      * please use {@link core_course_renderer::course_info_box()}
1112      *
1113      * @param coursecat_helper $chelper various display options
1114      * @param course_in_list|stdClass $course
1115      * @param string $additionalclasses additional classes to add to the main <div> tag (usually
1116      *    depend on the course position in list - first/last/even/odd)
1117      * @return string
1118      */
1119     protected function coursecat_coursebox(coursecat_helper $chelper, $course, $additionalclasses = '') {
1120         global $CFG;
1121         if (!isset($this->strings->summary)) {
1122             $this->strings->summary = get_string('summary');
1123         }
1124         if ($chelper->get_show_courses() <= self::COURSECAT_SHOW_COURSES_COUNT) {
1125             return '';
1126         }
1127         if ($course instanceof stdClass) {
1128             require_once($CFG->libdir. '/coursecatlib.php');
1129             $course = new course_in_list($course);
1130         }
1131         $content = '';
1132         $classes = trim('coursebox clearfix '. $additionalclasses);
1133         if ($chelper->get_show_courses() >= self::COURSECAT_SHOW_COURSES_EXPANDED) {
1134             $nametag = 'h3';
1135         } else {
1136             $classes .= ' collapsed';
1137             $nametag = 'div';
1138         }
1140         // .coursebox
1141         $content .= html_writer::start_tag('div', array(
1142             'class' => $classes,
1143             'data-courseid' => $course->id,
1144             'data-type' => self::COURSECAT_TYPE_COURSE,
1145         ));
1147         $content .= html_writer::start_tag('div', array('class' => 'info'));
1149         // course name
1150         $coursename = $chelper->get_course_formatted_name($course);
1151         $coursenamelink = html_writer::link(new moodle_url('/course/view.php', array('id' => $course->id)),
1152                 $coursename, array('class' => $course->visible ? '' : 'dimmed'));
1153         $content .= html_writer::tag($nametag, $coursenamelink, array('class' => 'name'));
1155         // If we display course in collapsed form but the course has summary or course contacts, display the link to the info page.
1156         $content .= html_writer::start_tag('div', array('class' => 'moreinfo'));
1157         if ($chelper->get_show_courses() < self::COURSECAT_SHOW_COURSES_EXPANDED) {
1158             if ($course->has_summary() || $course->has_course_contacts() || $course->has_course_overviewfiles()) {
1159                 $url = new moodle_url('/course/info.php', array('id' => $course->id));
1160                 $image = html_writer::empty_tag('img', array('src' => $this->output->pix_url('i/info'),
1161                     'alt' => $this->strings->summary));
1162                 $content .= html_writer::link($url, $image, array('title' => $this->strings->summary));
1163                 // Make sure JS file to expand course content is included.
1164                 $this->coursecat_include_js();
1165             }
1166         }
1167         $content .= html_writer::end_tag('div'); // .moreinfo
1169         // print enrolmenticons
1170         if ($icons = enrol_get_course_info_icons($course)) {
1171             $content .= html_writer::start_tag('div', array('class' => 'enrolmenticons'));
1172             foreach ($icons as $pix_icon) {
1173                 $content .= $this->render($pix_icon);
1174             }
1175             $content .= html_writer::end_tag('div'); // .enrolmenticons
1176         }
1178         $content .= html_writer::end_tag('div'); // .info
1180         $content .= html_writer::start_tag('div', array('class' => 'content'));
1181         $content .= $this->coursecat_coursebox_content($chelper, $course);
1182         $content .= html_writer::end_tag('div'); // .content
1184         $content .= html_writer::end_tag('div'); // .coursebox
1185         return $content;
1186     }
1188     /**
1189      * Returns HTML to display course content (summary, course contacts and optionally category name)
1190      *
1191      * This method is called from coursecat_coursebox() and may be re-used in AJAX
1192      *
1193      * @param coursecat_helper $chelper various display options
1194      * @param stdClass|course_in_list $course
1195      * @return string
1196      */
1197     protected function coursecat_coursebox_content(coursecat_helper $chelper, $course) {
1198         global $CFG;
1199         if ($chelper->get_show_courses() < self::COURSECAT_SHOW_COURSES_EXPANDED) {
1200             return '';
1201         }
1202         if ($course instanceof stdClass) {
1203             require_once($CFG->libdir. '/coursecatlib.php');
1204             $course = new course_in_list($course);
1205         }
1206         $content = '';
1208         // display course summary
1209         if ($course->has_summary()) {
1210             $content .= html_writer::start_tag('div', array('class' => 'summary'));
1211             $content .= $chelper->get_course_formatted_summary($course,
1212                     array('overflowdiv' => true, 'noclean' => true, 'para' => false));
1213             $content .= html_writer::end_tag('div'); // .summary
1214         }
1216         // display course overview files
1217         $contentimages = $contentfiles = '';
1218         foreach ($course->get_course_overviewfiles() as $file) {
1219             $isimage = $file->is_valid_image();
1220             $url = file_encode_url("$CFG->wwwroot/pluginfile.php",
1221                     '/'. $file->get_contextid(). '/'. $file->get_component(). '/'.
1222                     $file->get_filearea(). $file->get_filepath(). $file->get_filename(), !$isimage);
1223             if ($isimage) {
1224                 $contentimages .= html_writer::tag('div',
1225                         html_writer::empty_tag('img', array('src' => $url)),
1226                         array('class' => 'courseimage'));
1227             } else {
1228                 $image = $this->output->pix_icon(file_file_icon($file, 24), $file->get_filename(), 'moodle');
1229                 $filename = html_writer::tag('span', $image, array('class' => 'fp-icon')).
1230                         html_writer::tag('span', $file->get_filename(), array('class' => 'fp-filename'));
1231                 $contentfiles .= html_writer::tag('span',
1232                         html_writer::link($url, $filename),
1233                         array('class' => 'coursefile fp-filename-icon'));
1234             }
1235         }
1236         $content .= $contentimages. $contentfiles;
1238         // display course contacts. See course_in_list::get_course_contacts()
1239         if ($course->has_course_contacts()) {
1240             $content .= html_writer::start_tag('ul', array('class' => 'teachers'));
1241             foreach ($course->get_course_contacts() as $userid => $coursecontact) {
1242                 $name = $coursecontact['rolename'].': '.
1243                         html_writer::link(new moodle_url('/user/view.php',
1244                                 array('id' => $userid, 'course' => SITEID)),
1245                             $coursecontact['username']);
1246                 $content .= html_writer::tag('li', $name);
1247             }
1248             $content .= html_writer::end_tag('ul'); // .teachers
1249         }
1251         // display course category if necessary (for example in search results)
1252         if ($chelper->get_show_courses() == self::COURSECAT_SHOW_COURSES_EXPANDED_WITH_CAT) {
1253             require_once($CFG->libdir. '/coursecatlib.php');
1254             if ($cat = coursecat::get($course->category, IGNORE_MISSING)) {
1255                 $content .= html_writer::start_tag('div', array('class' => 'coursecat'));
1256                 $content .= get_string('category').': '.
1257                         html_writer::link(new moodle_url('/course/index.php', array('categoryid' => $cat->id)),
1258                                 $cat->get_formatted_name(), array('class' => $cat->visible ? '' : 'dimmed'));
1259                 $content .= html_writer::end_tag('div'); // .coursecat
1260             }
1261         }
1263         return $content;
1264     }
1266     /**
1267      * Renders the list of courses
1268      *
1269      * This is internal function, please use {@link core_course_renderer::courses_list()} or another public
1270      * method from outside of the class
1271      *
1272      * If list of courses is specified in $courses; the argument $chelper is only used
1273      * to retrieve display options and attributes, only methods get_show_courses(),
1274      * get_courses_display_option() and get_and_erase_attributes() are called.
1275      *
1276      * @param coursecat_helper $chelper various display options
1277      * @param array $courses the list of courses to display
1278      * @param int|null $totalcount total number of courses (affects display mode if it is AUTO or pagination if applicable),
1279      *     defaulted to count($courses)
1280      * @return string
1281      */
1282     protected function coursecat_courses(coursecat_helper $chelper, $courses, $totalcount = null) {
1283         global $CFG;
1284         if ($totalcount === null) {
1285             $totalcount = count($courses);
1286         }
1287         if (!$totalcount) {
1288             // Courses count is cached during courses retrieval.
1289             return '';
1290         }
1292         if ($chelper->get_show_courses() == self::COURSECAT_SHOW_COURSES_AUTO) {
1293             // In 'auto' course display mode we analyse if number of courses is more or less than $CFG->courseswithsummarieslimit
1294             if ($totalcount <= $CFG->courseswithsummarieslimit) {
1295                 $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_EXPANDED);
1296             } else {
1297                 $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_COLLAPSED);
1298             }
1299         }
1301         // prepare content of paging bar if it is needed
1302         $paginationurl = $chelper->get_courses_display_option('paginationurl');
1303         $paginationallowall = $chelper->get_courses_display_option('paginationallowall');
1304         if ($totalcount > count($courses)) {
1305             // there are more results that can fit on one page
1306             if ($paginationurl) {
1307                 // the option paginationurl was specified, display pagingbar
1308                 $perpage = $chelper->get_courses_display_option('limit', $CFG->coursesperpage);
1309                 $page = $chelper->get_courses_display_option('offset') / $perpage;
1310                 $pagingbar = $this->paging_bar($totalcount, $page, $perpage,
1311                         $paginationurl->out(false, array('perpage' => $perpage)));
1312                 if ($paginationallowall) {
1313                     $pagingbar .= html_writer::tag('div', html_writer::link($paginationurl->out(false, array('perpage' => 'all')),
1314                             get_string('showall', '', $totalcount)), array('class' => 'paging paging-showall'));
1315                 }
1316             } else if ($viewmoreurl = $chelper->get_courses_display_option('viewmoreurl')) {
1317                 // the option for 'View more' link was specified, display more link
1318                 $viewmoretext = $chelper->get_courses_display_option('viewmoretext', new lang_string('viewmore'));
1319                 $morelink = html_writer::tag('div', html_writer::link($viewmoreurl, $viewmoretext),
1320                         array('class' => 'paging paging-morelink'));
1321             }
1322         } else if (($totalcount > $CFG->coursesperpage) && $paginationurl && $paginationallowall) {
1323             // there are more than one page of results and we are in 'view all' mode, suggest to go back to paginated view mode
1324             $pagingbar = html_writer::tag('div', html_writer::link($paginationurl->out(false, array('perpage' => $CFG->coursesperpage)),
1325                 get_string('showperpage', '', $CFG->coursesperpage)), array('class' => 'paging paging-showperpage'));
1326         }
1328         // display list of courses
1329         $attributes = $chelper->get_and_erase_attributes('courses');
1330         $content = html_writer::start_tag('div', $attributes);
1332         if (!empty($pagingbar)) {
1333             $content .= $pagingbar;
1334         }
1336         $coursecount = 0;
1337         foreach ($courses as $course) {
1338             $coursecount ++;
1339             $classes = ($coursecount%2) ? 'odd' : 'even';
1340             if ($coursecount == 1) {
1341                 $classes .= ' first';
1342             }
1343             if ($coursecount >= count($courses)) {
1344                 $classes .= ' last';
1345             }
1346             $content .= $this->coursecat_coursebox($chelper, $course, $classes);
1347         }
1349         if (!empty($pagingbar)) {
1350             $content .= $pagingbar;
1351         }
1352         if (!empty($morelink)) {
1353             $content .= $morelink;
1354         }
1356         $content .= html_writer::end_tag('div'); // .courses
1357         return $content;
1358     }
1360     /**
1361      * Renders the list of subcategories in a category
1362      *
1363      * @param coursecat_helper $chelper various display options
1364      * @param coursecat $coursecat
1365      * @param int $depth depth of the category in the current tree
1366      * @return string
1367      */
1368     protected function coursecat_subcategories(coursecat_helper $chelper, $coursecat, $depth) {
1369         global $CFG;
1370         $subcategories = array();
1371         if (!$chelper->get_categories_display_option('nodisplay')) {
1372             $subcategories = $coursecat->get_children($chelper->get_categories_display_options());
1373         }
1374         $totalcount = $coursecat->get_children_count();
1375         if (!$totalcount) {
1376             // Note that we call get_child_categories_count() AFTER get_child_categories() to avoid extra DB requests.
1377             // Categories count is cached during children categories retrieval.
1378             return '';
1379         }
1381         // prepare content of paging bar or more link if it is needed
1382         $paginationurl = $chelper->get_categories_display_option('paginationurl');
1383         $paginationallowall = $chelper->get_categories_display_option('paginationallowall');
1384         if ($totalcount > count($subcategories)) {
1385             if ($paginationurl) {
1386                 // the option 'paginationurl was specified, display pagingbar
1387                 $perpage = $chelper->get_categories_display_option('limit', $CFG->coursesperpage);
1388                 $page = $chelper->get_categories_display_option('offset') / $perpage;
1389                 $pagingbar = $this->paging_bar($totalcount, $page, $perpage,
1390                         $paginationurl->out(false, array('perpage' => $perpage)));
1391                 if ($paginationallowall) {
1392                     $pagingbar .= html_writer::tag('div', html_writer::link($paginationurl->out(false, array('perpage' => 'all')),
1393                             get_string('showall', '', $totalcount)), array('class' => 'paging paging-showall'));
1394                 }
1395             } else if ($viewmoreurl = $chelper->get_categories_display_option('viewmoreurl')) {
1396                 // the option 'viewmoreurl' was specified, display more link (if it is link to category view page, add category id)
1397                 if ($viewmoreurl->compare(new moodle_url('/course/index.php'), URL_MATCH_BASE)) {
1398                     $viewmoreurl->param('categoryid', $coursecat->id);
1399                 }
1400                 $viewmoretext = $chelper->get_categories_display_option('viewmoretext', new lang_string('viewmore'));
1401                 $morelink = html_writer::tag('div', html_writer::link($viewmoreurl, $viewmoretext),
1402                         array('class' => 'paging paging-morelink'));
1403             }
1404         } else if (($totalcount > $CFG->coursesperpage) && $paginationurl && $paginationallowall) {
1405             // there are more than one page of results and we are in 'view all' mode, suggest to go back to paginated view mode
1406             $pagingbar = html_writer::tag('div', html_writer::link($paginationurl->out(false, array('perpage' => $CFG->coursesperpage)),
1407                 get_string('showperpage', '', $CFG->coursesperpage)), array('class' => 'paging paging-showperpage'));
1408         }
1410         // display list of subcategories
1411         $content = html_writer::start_tag('div', array('class' => 'subcategories'));
1413         if (!empty($pagingbar)) {
1414             $content .= $pagingbar;
1415         }
1417         foreach ($subcategories as $subcategory) {
1418             $content .= $this->coursecat_category($chelper, $subcategory, $depth + 1);
1419         }
1421         if (!empty($pagingbar)) {
1422             $content .= $pagingbar;
1423         }
1424         if (!empty($morelink)) {
1425             $content .= $morelink;
1426         }
1428         $content .= html_writer::end_tag('div');
1429         return $content;
1430     }
1432     /**
1433      * Make sure that javascript file for AJAX expanding of courses and categories content is included
1434      */
1435     protected function coursecat_include_js() {
1436         global $CFG;
1437         static $jsloaded = false;
1438         if (!$jsloaded && $CFG->enableajax) {
1439             // We must only load this module once.
1440             $this->page->requires->yui_module('moodle-course-categoryexpander',
1441                     'Y.Moodle.course.categoryexpander.init');
1442             $jsloaded = true;
1443         }
1444     }
1446     /**
1447      * Returns HTML to display the subcategories and courses in the given category
1448      *
1449      * This method is re-used by AJAX to expand content of not loaded category
1450      *
1451      * @param coursecat_helper $chelper various display options
1452      * @param coursecat $coursecat
1453      * @param int $depth depth of the category in the current tree
1454      * @return string
1455      */
1456     protected function coursecat_category_content(coursecat_helper $chelper, $coursecat, $depth) {
1457         $content = '';
1458         // Subcategories
1459         $content .= $this->coursecat_subcategories($chelper, $coursecat, $depth);
1461         // AUTO show courses: Courses will be shown expanded if this is not nested category,
1462         // and number of courses no bigger than $CFG->courseswithsummarieslimit.
1463         $showcoursesauto = $chelper->get_show_courses() == self::COURSECAT_SHOW_COURSES_AUTO;
1464         if ($showcoursesauto && $depth) {
1465             // this is definitely collapsed mode
1466             $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_COLLAPSED);
1467         }
1469         // Courses
1470         if ($chelper->get_show_courses() > core_course_renderer::COURSECAT_SHOW_COURSES_COUNT) {
1471             $courses = array();
1472             if (!$chelper->get_courses_display_option('nodisplay')) {
1473                 $courses = $coursecat->get_courses($chelper->get_courses_display_options());
1474             }
1475             if ($viewmoreurl = $chelper->get_courses_display_option('viewmoreurl')) {
1476                 // the option for 'View more' link was specified, display more link (if it is link to category view page, add category id)
1477                 if ($viewmoreurl->compare(new moodle_url('/course/index.php'), URL_MATCH_BASE)) {
1478                     $chelper->set_courses_display_option('viewmoreurl', new moodle_url($viewmoreurl, array('categoryid' => $coursecat->id)));
1479                 }
1480             }
1481             $content .= $this->coursecat_courses($chelper, $courses, $coursecat->get_courses_count());
1482         }
1484         if ($showcoursesauto) {
1485             // restore the show_courses back to AUTO
1486             $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_AUTO);
1487         }
1489         return $content;
1490     }
1492     /**
1493      * Returns HTML to display a course category as a part of a tree
1494      *
1495      * This is an internal function, to display a particular category and all its contents
1496      * use {@link core_course_renderer::course_category()}
1497      *
1498      * @param coursecat_helper $chelper various display options
1499      * @param coursecat $coursecat
1500      * @param int $depth depth of this category in the current tree
1501      * @return string
1502      */
1503     protected function coursecat_category(coursecat_helper $chelper, $coursecat, $depth) {
1504         // open category tag
1505         $classes = array('category');
1506         if (empty($coursecat->visible)) {
1507             $classes[] = 'dimmed_category';
1508         }
1509         if ($chelper->get_subcat_depth() > 0 && $depth >= $chelper->get_subcat_depth()) {
1510             // do not load content
1511             $categorycontent = '';
1512             $classes[] = 'notloaded';
1513             if ($coursecat->get_children_count() ||
1514                     ($chelper->get_show_courses() >= self::COURSECAT_SHOW_COURSES_COLLAPSED && $coursecat->get_courses_count())) {
1515                 $classes[] = 'with_children';
1516                 $classes[] = 'collapsed';
1517             }
1518             // Make sure JS file to expand category content is included.
1519             $this->coursecat_include_js();
1520         } else {
1521             // load category content
1522             $categorycontent = $this->coursecat_category_content($chelper, $coursecat, $depth);
1523             $classes[] = 'loaded';
1524             if (!empty($categorycontent)) {
1525                 $classes[] = 'with_children';
1526             }
1527         }
1528         $content = html_writer::start_tag('div', array(
1529             'class' => join(' ', $classes),
1530             'data-categoryid' => $coursecat->id,
1531             'data-depth' => $depth,
1532             'data-showcourses' => $chelper->get_show_courses(),
1533             'data-type' => self::COURSECAT_TYPE_CATEGORY,
1534         ));
1536         // category name
1537         $categoryname = $coursecat->get_formatted_name();
1538         $categoryname = html_writer::link(new moodle_url('/course/index.php',
1539                 array('categoryid' => $coursecat->id)),
1540                 $categoryname);
1541         if ($chelper->get_show_courses() == self::COURSECAT_SHOW_COURSES_COUNT
1542                 && ($coursescount = $coursecat->get_courses_count())) {
1543             $categoryname .= html_writer::tag('span', ' ('. $coursescount.')',
1544                     array('title' => get_string('numberofcourses'), 'class' => 'numberofcourse'));
1545         }
1546         $content .= html_writer::start_tag('div', array('class' => 'info'));
1547         $content .= html_writer::tag(($depth > 1) ? 'h4' : 'h3', $categoryname, array('class' => 'name'));
1548         $content .= html_writer::end_tag('div'); // .info
1550         // add category content to the output
1551         $content .= html_writer::tag('div', $categorycontent, array('class' => 'content'));
1553         $content .= html_writer::end_tag('div'); // .category
1555         // Return the course category tree HTML
1556         return $content;
1557     }
1559     /**
1560      * Returns HTML to display a tree of subcategories and courses in the given category
1561      *
1562      * @param coursecat_helper $chelper various display options
1563      * @param coursecat $coursecat top category (this category's name and description will NOT be added to the tree)
1564      * @return string
1565      */
1566     protected function coursecat_tree(coursecat_helper $chelper, $coursecat) {
1567         $categorycontent = $this->coursecat_category_content($chelper, $coursecat, 0);
1568         if (empty($categorycontent)) {
1569             return '';
1570         }
1572         // Start content generation
1573         $content = '';
1574         $attributes = $chelper->get_and_erase_attributes('course_category_tree clearfix');
1575         $content .= html_writer::start_tag('div', $attributes);
1577         if ($coursecat->get_children_count()) {
1578             $classes = array(
1579                 'collapseexpand',
1580                 'collapse-all',
1581             );
1582             if ($chelper->get_subcat_depth() == 1) {
1583                 $classes[] = 'disabled';
1584             }
1585             // Only show the collapse/expand if there are children to expand.
1586             $content .= html_writer::start_tag('div', array('class' => 'collapsible-actions'));
1587             $content .= html_writer::link('#', get_string('collapseall'),
1588                     array('class' => implode(' ', $classes)));
1589             $content .= html_writer::end_tag('div');
1590             $this->page->requires->strings_for_js(array('collapseall', 'expandall'), 'moodle');
1591         }
1593         $content .= html_writer::tag('div', $categorycontent, array('class' => 'content'));
1595         $content .= html_writer::end_tag('div'); // .course_category_tree
1597         return $content;
1598     }
1600     /**
1601      * Renders HTML to display particular course category - list of it's subcategories and courses
1602      *
1603      * Invoked from /course/index.php
1604      *
1605      * @param int|stdClass|coursecat $category
1606      */
1607     public function course_category($category) {
1608         global $CFG;
1609         require_once($CFG->libdir. '/coursecatlib.php');
1610         $coursecat = coursecat::get(is_object($category) ? $category->id : $category);
1611         $site = get_site();
1612         $output = '';
1614         $this->page->set_button($this->course_search_form('', 'navbar'));
1615         if (!$coursecat->id) {
1616             if (can_edit_in_category()) {
1617                 // add 'Manage' button instead of course search form
1618                 $managebutton = $this->single_button(new moodle_url('/course/manage.php'),
1619                                 get_string('managecourses'), 'get');
1620                 $this->page->set_button($managebutton);
1621             }
1622             if (coursecat::count_all() == 1) {
1623                 // There exists only one category in the system, do not display link to it
1624                 $coursecat = coursecat::get_default();
1625                 $strfulllistofcourses = get_string('fulllistofcourses');
1626                 $this->page->set_title("$site->shortname: $strfulllistofcourses");
1627             } else {
1628                 $strcategories = get_string('categories');
1629                 $this->page->set_title("$site->shortname: $strcategories");
1630             }
1631         } else {
1632             $this->page->set_title("$site->shortname: ". $coursecat->get_formatted_name());
1634             // Print the category selector
1635             $output .= html_writer::start_tag('div', array('class' => 'categorypicker'));
1636             $select = new single_select(new moodle_url('/course/index.php'), 'categoryid',
1637                     coursecat::make_categories_list(), $coursecat->id, null, 'switchcategory');
1638             $select->set_label(get_string('categories').':');
1639             $output .= $this->render($select);
1640             $output .= html_writer::end_tag('div'); // .categorypicker
1641         }
1643         // Print current category description
1644         $chelper = new coursecat_helper();
1645         if ($description = $chelper->get_category_formatted_description($coursecat)) {
1646             $output .= $this->box($description, array('class' => 'generalbox info'));
1647         }
1649         // Prepare parameters for courses and categories lists in the tree
1650         $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_AUTO)
1651                 ->set_attributes(array('class' => 'category-browse category-browse-'.$coursecat->id));
1653         $coursedisplayoptions = array();
1654         $catdisplayoptions = array();
1655         $browse = optional_param('browse', null, PARAM_ALPHA);
1656         $perpage = optional_param('perpage', $CFG->coursesperpage, PARAM_INT);
1657         $page = optional_param('page', 0, PARAM_INT);
1658         $baseurl = new moodle_url('/course/index.php');
1659         if ($coursecat->id) {
1660             $baseurl->param('categoryid', $coursecat->id);
1661         }
1662         if ($perpage != $CFG->coursesperpage) {
1663             $baseurl->param('perpage', $perpage);
1664         }
1665         $coursedisplayoptions['limit'] = $perpage;
1666         $catdisplayoptions['limit'] = $perpage;
1667         if ($browse === 'courses' || !$coursecat->has_children()) {
1668             $coursedisplayoptions['offset'] = $page * $perpage;
1669             $coursedisplayoptions['paginationurl'] = new moodle_url($baseurl, array('browse' => 'courses'));
1670             $catdisplayoptions['nodisplay'] = true;
1671             $catdisplayoptions['viewmoreurl'] = new moodle_url($baseurl, array('browse' => 'categories'));
1672             $catdisplayoptions['viewmoretext'] = new lang_string('viewallsubcategories');
1673         } else if ($browse === 'categories' || !$coursecat->has_courses()) {
1674             $coursedisplayoptions['nodisplay'] = true;
1675             $catdisplayoptions['offset'] = $page * $perpage;
1676             $catdisplayoptions['paginationurl'] = new moodle_url($baseurl, array('browse' => 'categories'));
1677             $coursedisplayoptions['viewmoreurl'] = new moodle_url($baseurl, array('browse' => 'courses'));
1678             $coursedisplayoptions['viewmoretext'] = new lang_string('viewallcourses');
1679         } else {
1680             // we have a category that has both subcategories and courses, display pagination separately
1681             $coursedisplayoptions['viewmoreurl'] = new moodle_url($baseurl, array('browse' => 'courses', 'page' => 1));
1682             $catdisplayoptions['viewmoreurl'] = new moodle_url($baseurl, array('browse' => 'categories', 'page' => 1));
1683         }
1684         $chelper->set_courses_display_options($coursedisplayoptions)->set_categories_display_options($catdisplayoptions);
1686         // Display course category tree
1687         $output .= $this->coursecat_tree($chelper, $coursecat);
1689         // Add course search form (if we are inside category it was already added to the navbar)
1690         if (!$coursecat->id) {
1691             $output .= $this->course_search_form();
1692         }
1694         // Add action buttons
1695         $output .= $this->container_start('buttons');
1696         $context = get_category_or_system_context($coursecat->id);
1697         if (has_capability('moodle/course:create', $context)) {
1698             // Print link to create a new course, for the 1st available category.
1699             if ($coursecat->id) {
1700                 $url = new moodle_url('/course/edit.php', array('category' => $coursecat->id, 'returnto' => 'category'));
1701             } else {
1702                 $url = new moodle_url('/course/edit.php', array('category' => $CFG->defaultrequestcategory, 'returnto' => 'topcat'));
1703             }
1704             $output .= $this->single_button($url, get_string('addnewcourse'), 'get');
1705         }
1706         ob_start();
1707         if (coursecat::count_all() == 1) {
1708             print_course_request_buttons(context_system::instance());
1709         } else {
1710             print_course_request_buttons($context);
1711         }
1712         $output .= ob_get_contents();
1713         ob_end_clean();
1714         $output .= $this->container_end();
1716         return $output;
1717     }
1719     /**
1720      * Serves requests to /course/category.ajax.php
1721      *
1722      * In this renderer implementation it may expand the category content or
1723      * course content.
1724      *
1725      * @return string
1726      * @throws coding_exception
1727      */
1728     public function coursecat_ajax() {
1729         global $DB, $CFG;
1730         require_once($CFG->libdir. '/coursecatlib.php');
1732         $type = required_param('type', PARAM_INT);
1734         if ($type === self::COURSECAT_TYPE_CATEGORY) {
1735             // This is a request for a category list of some kind.
1736             $categoryid = required_param('categoryid', PARAM_INT);
1737             $showcourses = required_param('showcourses', PARAM_INT);
1738             $depth = required_param('depth', PARAM_INT);
1740             $category = coursecat::get($categoryid);
1742             $chelper = new coursecat_helper();
1743             $baseurl = new moodle_url('/course/index.php', array('categoryid' => $categoryid));
1744             $coursedisplayoptions = array(
1745                 'limit' => $CFG->coursesperpage,
1746                 'viewmoreurl' => new moodle_url($baseurl, array('browse' => 'courses', 'page' => 1))
1747             );
1748             $catdisplayoptions = array(
1749                 'limit' => $CFG->coursesperpage,
1750                 'viewmoreurl' => new moodle_url($baseurl, array('browse' => 'categories', 'page' => 1))
1751             );
1752             $chelper->set_show_courses($showcourses)->
1753                     set_courses_display_options($coursedisplayoptions)->
1754                     set_categories_display_options($catdisplayoptions);
1756             return $this->coursecat_category_content($chelper, $category, $depth);
1757         } else if ($type === self::COURSECAT_TYPE_COURSE) {
1758             // This is a request for the course information.
1759             $courseid = required_param('courseid', PARAM_INT);
1761             $course = $DB->get_record('course', array('id' => $courseid), '*', MUST_EXIST);
1763             $chelper = new coursecat_helper();
1764             $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_EXPANDED);
1765             return $this->coursecat_coursebox_content($chelper, $course);
1766         } else {
1767             throw new coding_exception('Invalid request type');
1768         }
1769     }
1771     /**
1772      * Renders html to display search result page
1773      *
1774      * @param array $searchcriteria may contain elements: search, blocklist, modulelist, tagid
1775      * @return string
1776      */
1777     public function search_courses($searchcriteria) {
1778         global $CFG;
1779         $content = '';
1780         if (!empty($searchcriteria)) {
1781             // print search results
1782             require_once($CFG->libdir. '/coursecatlib.php');
1784             $displayoptions = array('sort' => array('displayname' => 1));
1785             // take the current page and number of results per page from query
1786             $perpage = optional_param('perpage', 0, PARAM_RAW);
1787             if ($perpage !== 'all') {
1788                 $displayoptions['limit'] = ((int)$perpage <= 0) ? $CFG->coursesperpage : (int)$perpage;
1789                 $page = optional_param('page', 0, PARAM_INT);
1790                 $displayoptions['offset'] = $displayoptions['limit'] * $page;
1791             }
1792             // options 'paginationurl' and 'paginationallowall' are only used in method coursecat_courses()
1793             $displayoptions['paginationurl'] = new moodle_url('/course/search.php', $searchcriteria);
1794             $displayoptions['paginationallowall'] = true; // allow adding link 'View all'
1796             $class = 'course-search-result';
1797             foreach ($searchcriteria as $key => $value) {
1798                 if (!empty($value)) {
1799                     $class .= ' course-search-result-'. $key;
1800                 }
1801             }
1802             $chelper = new coursecat_helper();
1803             $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_EXPANDED_WITH_CAT)->
1804                     set_courses_display_options($displayoptions)->
1805                     set_search_criteria($searchcriteria)->
1806                     set_attributes(array('class' => $class));
1808             $courses = coursecat::search_courses($searchcriteria, $chelper->get_courses_display_options());
1809             $totalcount = coursecat::search_courses_count($searchcriteria);
1810             $courseslist = $this->coursecat_courses($chelper, $courses, $totalcount);
1812             if (!$totalcount) {
1813                 if (!empty($searchcriteria['search'])) {
1814                     $content .= $this->heading(get_string('nocoursesfound', '', $searchcriteria['search']));
1815                 } else {
1816                     $content .= $this->heading(get_string('novalidcourses'));
1817                 }
1818             } else {
1819                 $content .= $this->heading(get_string('searchresults'). ": $totalcount");
1820                 $content .= $courseslist;
1821             }
1823             if (!empty($searchcriteria['search'])) {
1824                 // print search form only if there was a search by search string, otherwise it is confusing
1825                 $content .= $this->box_start('generalbox mdl-align');
1826                 $content .= $this->course_search_form($searchcriteria['search']);
1827                 $content .= $this->box_end();
1828             }
1829         } else {
1830             // just print search form
1831             $content .= $this->box_start('generalbox mdl-align');
1832             $content .= $this->course_search_form();
1833             $content .= html_writer::tag('div', get_string("searchhelp"), array('class' => 'searchhelp'));
1834             $content .= $this->box_end();
1835         }
1836         return $content;
1837     }
1839     /**
1840      * Renders html to print list of courses tagged with particular tag
1841      *
1842      * @param int $tagid id of the tag
1843      * @return string empty string if no courses are marked with this tag or rendered list of courses
1844      */
1845     public function tagged_courses($tagid) {
1846         global $CFG;
1847         require_once($CFG->libdir. '/coursecatlib.php');
1848         $displayoptions = array('limit' => $CFG->coursesperpage);
1849         $displayoptions['viewmoreurl'] = new moodle_url('/course/search.php',
1850                 array('tagid' => $tagid, 'page' => 1, 'perpage' => $CFG->coursesperpage));
1851         $displayoptions['viewmoretext'] = new lang_string('findmorecourses');
1852         $chelper = new coursecat_helper();
1853         $searchcriteria = array('tagid' => $tagid);
1854         $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_EXPANDED_WITH_CAT)->
1855                 set_search_criteria(array('tagid' => $tagid))->
1856                 set_courses_display_options($displayoptions)->
1857                 set_attributes(array('class' => 'course-search-result course-search-result-tagid'));
1858                 // (we set the same css class as in search results by tagid)
1859         $courses = coursecat::search_courses($searchcriteria, $chelper->get_courses_display_options());
1860         $totalcount = coursecat::search_courses_count($searchcriteria);
1861         $content = $this->coursecat_courses($chelper, $courses, $totalcount);
1862         if ($totalcount) {
1863             require_once $CFG->dirroot.'/tag/lib.php';
1864             $heading = get_string('courses') . ' ' . get_string('taggedwith', 'tag', tag_get_name($tagid)) .': '. $totalcount;
1865             return $this->heading($heading, 3). $content;
1866         }
1867         return '';
1868     }
1870     /**
1871      * Returns HTML to display one remote course
1872      *
1873      * @param stdClass $course remote course information, contains properties:
1874            id, remoteid, shortname, fullname, hostid, summary, summaryformat, cat_name, hostname
1875      * @return string
1876      */
1877     protected function frontpage_remote_course(stdClass $course) {
1878         $url = new moodle_url('/auth/mnet/jump.php', array(
1879             'hostid' => $course->hostid,
1880             'wantsurl' => '/course/view.php?id='. $course->remoteid
1881         ));
1883         $output = '';
1884         $output .= html_writer::start_tag('div', array('class' => 'coursebox remotecoursebox clearfix'));
1885         $output .= html_writer::start_tag('div', array('class' => 'info'));
1886         $output .= html_writer::start_tag('h3', array('class' => 'name'));
1887         $output .= html_writer::link($url, format_string($course->fullname), array('title' => get_string('entercourse')));
1888         $output .= html_writer::end_tag('h3'); // .name
1889         $output .= html_writer::tag('div', '', array('class' => 'moreinfo'));
1890         $output .= html_writer::end_tag('div'); // .info
1891         $output .= html_writer::start_tag('div', array('class' => 'content'));
1892         $output .= html_writer::start_tag('div', array('class' => 'summary'));
1893         $options = new stdClass();
1894         $options->noclean = true;
1895         $options->para = false;
1896         $options->overflowdiv = true;
1897         $output .= format_text($course->summary, $course->summaryformat, $options);
1898         $output .= html_writer::end_tag('div'); // .summary
1899         $addinfo = format_string($course->hostname) . ' : '
1900             . format_string($course->cat_name) . ' : '
1901             . format_string($course->shortname);
1902         $output .= html_writer::tag('div', $addinfo, array('class' => 'remotecourseinfo'));
1903         $output .= html_writer::end_tag('div'); // .content
1904         $output .= html_writer::end_tag('div'); // .coursebox
1905         return $output;
1906     }
1908     /**
1909      * Returns HTML to display one remote host
1910      *
1911      * @param array $host host information, contains properties: name, url, count
1912      * @return string
1913      */
1914     protected function frontpage_remote_host($host) {
1915         $output = '';
1916         $output .= html_writer::start_tag('div', array('class' => 'coursebox remotehost clearfix'));
1917         $output .= html_writer::start_tag('div', array('class' => 'info'));
1918         $output .= html_writer::start_tag('h3', array('class' => 'name'));
1919         $output .= html_writer::link($host['url'], s($host['name']), array('title' => s($host['name'])));
1920         $output .= html_writer::end_tag('h3'); // .name
1921         $output .= html_writer::tag('div', '', array('class' => 'moreinfo'));
1922         $output .= html_writer::end_tag('div'); // .info
1923         $output .= html_writer::start_tag('div', array('class' => 'content'));
1924         $output .= html_writer::start_tag('div', array('class' => 'summary'));
1925         $output .= $host['count'] . ' ' . get_string('courses');
1926         $output .= html_writer::end_tag('div'); // .content
1927         $output .= html_writer::end_tag('div'); // .coursebox
1928         return $output;
1929     }
1931     /**
1932      * Returns HTML to print list of courses user is enrolled to for the frontpage
1933      *
1934      * Also lists remote courses or remote hosts if MNET authorisation is used
1935      *
1936      * @return string
1937      */
1938     public function frontpage_my_courses() {
1939         global $USER, $CFG, $DB;
1941         if (!isloggedin() or isguestuser()) {
1942             return '';
1943         }
1945         $output = '';
1946         if (!empty($CFG->navsortmycoursessort)) {
1947             // sort courses the same as in navigation menu
1948             $sortorder = 'visible DESC,'. $CFG->navsortmycoursessort.' ASC';
1949         } else {
1950             $sortorder = 'visible DESC,sortorder ASC';
1951         }
1952         $courses  = enrol_get_my_courses('summary, summaryformat', $sortorder);
1953         $rhosts   = array();
1954         $rcourses = array();
1955         if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
1956             $rcourses = get_my_remotecourses($USER->id);
1957             $rhosts   = get_my_remotehosts();
1958         }
1960         if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
1962             $chelper = new coursecat_helper();
1963             if (count($courses) > $CFG->frontpagecourselimit) {
1964                 // There are more enrolled courses than we can display, display link to 'My courses'.
1965                 $totalcount = count($courses);
1966                 $courses = array_slice($courses, 0, $CFG->frontpagecourselimit, true);
1967                 $chelper->set_courses_display_options(array(
1968                         'viewmoreurl' => new moodle_url('/my/'),
1969                         'viewmoretext' => new lang_string('mycourses')
1970                     ));
1971             } else {
1972                 // All enrolled courses are displayed, display link to 'All courses' if there are more courses in system.
1973                 $chelper->set_courses_display_options(array(
1974                         'viewmoreurl' => new moodle_url('/course/index.php'),
1975                         'viewmoretext' => new lang_string('fulllistofcourses')
1976                     ));
1977                 $totalcount = $DB->count_records('course') - 1;
1978             }
1979             $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_EXPANDED)->
1980                     set_attributes(array('class' => 'frontpage-course-list-enrolled'));
1981             $output .= $this->coursecat_courses($chelper, $courses, $totalcount);
1983             // MNET
1984             if (!empty($rcourses)) {
1985                 // at the IDP, we know of all the remote courses
1986                 $output .= html_writer::start_tag('div', array('class' => 'courses'));
1987                 foreach ($rcourses as $course) {
1988                     $output .= $this->frontpage_remote_course($course);
1989                 }
1990                 $output .= html_writer::end_tag('div'); // .courses
1991             } elseif (!empty($rhosts)) {
1992                 // non-IDP, we know of all the remote servers, but not courses
1993                 $output .= html_writer::start_tag('div', array('class' => 'courses'));
1994                 foreach ($rhosts as $host) {
1995                     $output .= $this->frontpage_remote_host($host);
1996                 }
1997                 $output .= html_writer::end_tag('div'); // .courses
1998             }
1999         }
2000         return $output;
2001     }
2003     /**
2004      * Returns HTML to print list of available courses for the frontpage
2005      *
2006      * @return string
2007      */
2008     public function frontpage_available_courses() {
2009         global $CFG;
2010         require_once($CFG->libdir. '/coursecatlib.php');
2012         $chelper = new coursecat_helper();
2013         $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_EXPANDED)->
2014                 set_courses_display_options(array(
2015                     'recursive' => true,
2016                     'limit' => $CFG->frontpagecourselimit,
2017                     'viewmoreurl' => new moodle_url('/course/index.php'),
2018                     'viewmoretext' => new lang_string('fulllistofcourses')));
2020         $chelper->set_attributes(array('class' => 'frontpage-course-list-all'));
2021         $courses = coursecat::get(0)->get_courses($chelper->get_courses_display_options());
2022         $totalcount = coursecat::get(0)->get_courses_count($chelper->get_courses_display_options());
2023         if (!$totalcount && !$this->page->user_is_editing() && has_capability('moodle/course:create', context_system::instance())) {
2024             // Print link to create a new course, for the 1st available category.
2025             return $this->add_new_course_button();
2026         }
2027         return $this->coursecat_courses($chelper, $courses, $totalcount);
2028     }
2030     /**
2031      * Returns HTML to the "add new course" button for the page
2032      *
2033      * @return string
2034      */
2035     public function add_new_course_button() {
2036         global $CFG;
2037         // Print link to create a new course, for the 1st available category.
2038         $output = $this->container_start('buttons');
2039         $url = new moodle_url('/course/edit.php', array('category' => $CFG->defaultrequestcategory, 'returnto' => 'topcat'));
2040         $output .= $this->single_button($url, get_string('addnewcourse'), 'get');
2041         $output .= $this->container_end('buttons');
2042         return $output;
2043     }
2045     /**
2046      * Returns HTML to print tree with course categories and courses for the frontpage
2047      *
2048      * @return string
2049      */
2050     public function frontpage_combo_list() {
2051         global $CFG;
2052         require_once($CFG->libdir. '/coursecatlib.php');
2053         $chelper = new coursecat_helper();
2054         $chelper->set_subcat_depth($CFG->maxcategorydepth)->
2055             set_categories_display_options(array(
2056                 'limit' => $CFG->coursesperpage,
2057                 'viewmoreurl' => new moodle_url('/course/index.php',
2058                         array('browse' => 'categories', 'page' => 1))
2059             ))->
2060             set_courses_display_options(array(
2061                 'limit' => $CFG->coursesperpage,
2062                 'viewmoreurl' => new moodle_url('/course/index.php',
2063                         array('browse' => 'courses', 'page' => 1))
2064             ))->
2065             set_attributes(array('class' => 'frontpage-category-combo'));
2066         return $this->coursecat_tree($chelper, coursecat::get(0));
2067     }
2069     /**
2070      * Returns HTML to print tree of course categories (with number of courses) for the frontpage
2071      *
2072      * @return string
2073      */
2074     public function frontpage_categories_list() {
2075         global $CFG;
2076         require_once($CFG->libdir. '/coursecatlib.php');
2077         $chelper = new coursecat_helper();
2078         $chelper->set_subcat_depth($CFG->maxcategorydepth)->
2079                 set_show_courses(self::COURSECAT_SHOW_COURSES_COUNT)->
2080                 set_categories_display_options(array(
2081                     'limit' => $CFG->coursesperpage,
2082                     'viewmoreurl' => new moodle_url('/course/index.php',
2083                             array('browse' => 'categories', 'page' => 1))
2084                 ))->
2085                 set_attributes(array('class' => 'frontpage-category-names'));
2086         return $this->coursecat_tree($chelper, coursecat::get(0));
2087     }
2090 /**
2091  * Class storing display options and functions to help display course category and/or courses lists
2092  *
2093  * This is a wrapper for coursecat objects that also stores display options
2094  * and functions to retrieve sorted and paginated lists of categories/courses.
2095  *
2096  * If theme overrides methods in core_course_renderers that access this class
2097  * it may as well not use this class at all or extend it.
2098  *
2099  * @package   core
2100  * @copyright 2013 Marina Glancy
2101  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2102  */
2103 class coursecat_helper {
2104     /** @var string [none, collapsed, expanded] how (if) display courses list */
2105     protected $showcourses = 10; /* core_course_renderer::COURSECAT_SHOW_COURSES_COLLAPSED */
2106     /** @var int depth to expand subcategories in the tree (deeper subcategories will be loaded by AJAX or proceed to category page by clicking on category name) */
2107     protected $subcatdepth = 1;
2108     /** @var array options to display courses list */
2109     protected $coursesdisplayoptions = array();
2110     /** @var array options to display subcategories list */
2111     protected $categoriesdisplayoptions = array();
2112     /** @var array additional HTML attributes */
2113     protected $attributes = array();
2114     /** @var array search criteria if the list is a search result */
2115     protected $searchcriteria = null;
2117     /**
2118      * Sets how (if) to show the courses - none, collapsed, expanded, etc.
2119      *
2120      * @param int $showcourses SHOW_COURSES_NONE, SHOW_COURSES_COLLAPSED, SHOW_COURSES_EXPANDED, etc.
2121      * @return coursecat_helper
2122      */
2123     public function set_show_courses($showcourses) {
2124         $this->showcourses = $showcourses;
2125         // Automatically set the options to preload summary and coursecontacts for coursecat::get_courses() and coursecat::search_courses()
2126         $this->coursesdisplayoptions['summary'] = $showcourses >= core_course_renderer::COURSECAT_SHOW_COURSES_AUTO;
2127         $this->coursesdisplayoptions['coursecontacts'] = $showcourses >= core_course_renderer::COURSECAT_SHOW_COURSES_EXPANDED;
2128         return $this;
2129     }
2131     /**
2132      * Returns how (if) to show the courses - none, collapsed, expanded, etc.
2133      *
2134      * @return int - COURSECAT_SHOW_COURSES_NONE, COURSECAT_SHOW_COURSES_COLLAPSED, COURSECAT_SHOW_COURSES_EXPANDED, etc.
2135      */
2136     public function get_show_courses() {
2137         return $this->showcourses;
2138     }
2140     /**
2141      * Sets the maximum depth to expand subcategories in the tree
2142      *
2143      * deeper subcategories may be loaded by AJAX or proceed to category page by clicking on category name
2144      *
2145      * @param int $subcatdepth
2146      * @return coursecat_helper
2147      */
2148     public function set_subcat_depth($subcatdepth) {
2149         $this->subcatdepth = $subcatdepth;
2150         return $this;
2151     }
2153     /**
2154      * Returns the maximum depth to expand subcategories in the tree
2155      *
2156      * deeper subcategories may be loaded by AJAX or proceed to category page by clicking on category name
2157      *
2158      * @return int
2159      */
2160     public function get_subcat_depth() {
2161         return $this->subcatdepth;
2162     }
2164     /**
2165      * Sets options to display list of courses
2166      *
2167      * Options are later submitted as argument to coursecat::get_courses() and/or coursecat::search_courses()
2168      *
2169      * Options that coursecat::get_courses() accept:
2170      *    - recursive - return courses from subcategories as well. Use with care,
2171      *      this may be a huge list!
2172      *    - summary - preloads fields 'summary' and 'summaryformat'
2173      *    - coursecontacts - preloads course contacts
2174      *    - isenrolled - preloads indication whether this user is enrolled in the course
2175      *    - sort - list of fields to sort. Example
2176      *             array('idnumber' => 1, 'shortname' => 1, 'id' => -1)
2177      *             will sort by idnumber asc, shortname asc and id desc.
2178      *             Default: array('sortorder' => 1)
2179      *             Only cached fields may be used for sorting!
2180      *    - offset
2181      *    - limit - maximum number of children to return, 0 or null for no limit
2182      *
2183      * Options summary and coursecontacts are filled automatically in the set_show_courses()
2184      *
2185      * Also renderer can set here any additional options it wants to pass between renderer functions.
2186      *
2187      * @param array $options
2188      * @return coursecat_helper
2189      */
2190     public function set_courses_display_options($options) {
2191         $this->coursesdisplayoptions = $options;
2192         $this->set_show_courses($this->showcourses); // this will calculate special display options
2193         return $this;
2194     }
2196     /**
2197      * Sets one option to display list of courses
2198      *
2199      * @see coursecat_helper::set_courses_display_options()
2200      *
2201      * @param string $key
2202      * @param mixed $value
2203      * @return coursecat_helper
2204      */
2205     public function set_courses_display_option($key, $value) {
2206         $this->coursesdisplayoptions[$key] = $value;
2207         return $this;
2208     }
2210     /**
2211      * Return the specified option to display list of courses
2212      *
2213      * @param string $optionname option name
2214      * @param mixed $defaultvalue default value for option if it is not specified
2215      * @return mixed
2216      */
2217     public function get_courses_display_option($optionname, $defaultvalue = null) {
2218         if (array_key_exists($optionname, $this->coursesdisplayoptions)) {
2219             return $this->coursesdisplayoptions[$optionname];
2220         } else {
2221             return $defaultvalue;
2222         }
2223     }
2225     /**
2226      * Returns all options to display the courses
2227      *
2228      * This array is usually passed to {@link coursecat::get_courses()} or
2229      * {@link coursecat::search_courses()}
2230      *
2231      * @return array
2232      */
2233     public function get_courses_display_options() {
2234         return $this->coursesdisplayoptions;
2235     }
2237     /**
2238      * Sets options to display list of subcategories
2239      *
2240      * Options 'sort', 'offset' and 'limit' are passed to coursecat::get_children().
2241      * Any other options may be used by renderer functions
2242      *
2243      * @param array $options
2244      * @return coursecat_helper
2245      */
2246     public function set_categories_display_options($options) {
2247         $this->categoriesdisplayoptions = $options;
2248         return $this;
2249     }
2251     /**
2252      * Return the specified option to display list of subcategories
2253      *
2254      * @param string $optionname option name
2255      * @param mixed $defaultvalue default value for option if it is not specified
2256      * @return mixed
2257      */
2258     public function get_categories_display_option($optionname, $defaultvalue = null) {
2259         if (array_key_exists($optionname, $this->categoriesdisplayoptions)) {
2260             return $this->categoriesdisplayoptions[$optionname];
2261         } else {
2262             return $defaultvalue;
2263         }
2264     }
2266     /**
2267      * Returns all options to display list of subcategories
2268      *
2269      * This array is usually passed to {@link coursecat::get_children()}
2270      *
2271      * @return array
2272      */
2273     public function get_categories_display_options() {
2274         return $this->categoriesdisplayoptions;
2275     }
2277     /**
2278      * Sets additional general options to pass between renderer functions, usually HTML attributes
2279      *
2280      * @param array $attributes
2281      * @return coursecat_helper
2282      */
2283     public function set_attributes($attributes) {
2284         $this->attributes = $attributes;
2285         return $this;
2286     }
2288     /**
2289      * Return all attributes and erases them so they are not applied again
2290      *
2291      * @param string $classname adds additional class name to the beginning of $attributes['class']
2292      * @return array
2293      */
2294     public function get_and_erase_attributes($classname) {
2295         $attributes = $this->attributes;
2296         $this->attributes = array();
2297         if (empty($attributes['class'])) {
2298             $attributes['class'] = '';
2299         }
2300         $attributes['class'] = $classname . ' '. $attributes['class'];
2301         return $attributes;
2302     }
2304     /**
2305      * Sets the search criteria if the course is a search result
2306      *
2307      * Search string will be used to highlight terms in course name and description
2308      *
2309      * @param array $searchcriteria
2310      * @return coursecat_helper
2311      */
2312     public function set_search_criteria($searchcriteria) {
2313         $this->searchcriteria = $searchcriteria;
2314         return $this;
2315     }
2317     /**
2318      * Returns formatted and filtered description of the given category
2319      *
2320      * @param coursecat $coursecat category
2321      * @param stdClass|array $options format options, by default [noclean,overflowdiv],
2322      *     if context is not specified it will be added automatically
2323      * @return string|null
2324      */
2325     public function get_category_formatted_description($coursecat, $options = null) {
2326         if ($coursecat->id && !empty($coursecat->description)) {
2327             if (!isset($coursecat->descriptionformat)) {
2328                 $descriptionformat = FORMAT_MOODLE;
2329             } else {
2330                 $descriptionformat = $coursecat->descriptionformat;
2331             }
2332             if ($options === null) {
2333                 $options = array('noclean' => true, 'overflowdiv' => true);
2334             } else {
2335                 $options = (array)$options;
2336             }
2337             $context = context_coursecat::instance($coursecat->id);
2338             if (!isset($options['context'])) {
2339                 $options['context'] = $context;
2340             }
2341             $text = file_rewrite_pluginfile_urls($coursecat->description,
2342                     'pluginfile.php', $context->id, 'coursecat', 'description', null);
2343             return format_text($text, $descriptionformat, $options);
2344         }
2345         return null;
2346     }
2348     /**
2349      * Returns given course's summary with proper embedded files urls and formatted
2350      *
2351      * @param course_in_list $course
2352      * @param array|stdClass $options additional formatting options
2353      * @return string
2354      */
2355     public function get_course_formatted_summary($course, $options = array()) {
2356         global $CFG;
2357         require_once($CFG->libdir. '/filelib.php');
2358         if (!$course->has_summary()) {
2359             return '';
2360         }
2361         $options = (array)$options;
2362         $context = context_course::instance($course->id);
2363         if (!isset($options['context'])) {
2364             // TODO see MDL-38521
2365             // option 1 (current), page context - no code required
2366             // option 2, system context
2367             // $options['context'] = context_system::instance();
2368             // option 3, course context:
2369             // $options['context'] = $context;
2370             // option 4, course category context:
2371             // $options['context'] = $context->get_parent_context();
2372         }
2373         $summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', null);
2374         $summary = format_text($summary, $course->summaryformat, $options, $course->id);
2375         if (!empty($this->searchcriteria['search'])) {
2376             $summary = highlight($this->searchcriteria['search'], $summary);
2377         }
2378         return $summary;
2379     }
2381     /**
2382      * Returns course name as it is configured to appear in courses lists formatted to course context
2383      *
2384      * @param course_in_list $course
2385      * @param array|stdClass $options additional formatting options
2386      * @return string
2387      */
2388     public function get_course_formatted_name($course, $options = array()) {
2389         $options = (array)$options;
2390         if (!isset($options['context'])) {
2391             $options['context'] = context_course::instance($course->id);
2392         }
2393         $name = format_string(get_course_display_name_for_list($course), true, $options);
2394         if (!empty($this->searchcriteria['search'])) {
2395             $name = highlight($this->searchcriteria['search'], $name);
2396         }
2397         return $name;
2398     }