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