Merge branch 'MDL-64492-master' of git://github.com/damyon/moodle
[moodle.git] / course / renderer.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Renderer for use with the course section and all the goodness that falls
20  * within it.
21  *
22  * This renderer should contain methods useful to courses, and categories.
23  *
24  * @package   moodlecore
25  * @copyright 2010 Sam Hemelryk
26  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27  */
29 /**
30  * The core course renderer
31  *
32  * Can be retrieved with the following:
33  * $renderer = $PAGE->get_renderer('core','course');
34  */
35 class core_course_renderer extends plugin_renderer_base {
36     const COURSECAT_SHOW_COURSES_NONE = 0; /* do not show courses at all */
37     const COURSECAT_SHOW_COURSES_COUNT = 5; /* do not show courses but show number of courses next to category name */
38     const COURSECAT_SHOW_COURSES_COLLAPSED = 10;
39     const COURSECAT_SHOW_COURSES_AUTO = 15; /* will choose between collapsed and expanded automatically */
40     const COURSECAT_SHOW_COURSES_EXPANDED = 20;
41     const COURSECAT_SHOW_COURSES_EXPANDED_WITH_CAT = 30;
43     const COURSECAT_TYPE_CATEGORY = 0;
44     const COURSECAT_TYPE_COURSE = 1;
46     /**
47      * A cache of strings
48      * @var stdClass
49      */
50     protected $strings;
52     /**
53      * Whether a category content is being initially rendered with children. This is mainly used by the
54      * core_course_renderer::corsecat_tree() to render the appropriate action for the Expand/Collapse all link on
55      * page load.
56      * @var bool
57      */
58     protected $categoryexpandedonload = false;
60     /**
61      * Override the constructor so that we can initialise the string cache
62      *
63      * @param moodle_page $page
64      * @param string $target
65      */
66     public function __construct(moodle_page $page, $target) {
67         $this->strings = new stdClass;
68         parent::__construct($page, $target);
69     }
71     /**
72      * @deprecated since 3.2
73      */
74     protected function add_modchoosertoggle() {
75         throw new coding_exception('core_course_renderer::add_modchoosertoggle() can not be used anymore.');
76     }
78     /**
79      * Renders course info box.
80      *
81      * @param stdClass $course
82      * @return string
83      */
84     public function course_info_box(stdClass $course) {
85         $content = '';
86         $content .= $this->output->box_start('generalbox info');
87         $chelper = new coursecat_helper();
88         $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_EXPANDED);
89         $content .= $this->coursecat_coursebox($chelper, $course);
90         $content .= $this->output->box_end();
91         return $content;
92     }
94     /**
95      * Renderers a structured array of courses and categories into a nice XHTML tree structure.
96      *
97      * @deprecated since 2.5
98      *
99      * Please see http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
100      *
101      * @param array $ignored argument ignored
102      * @return string
103      */
104     public final function course_category_tree(array $ignored) {
105         debugging('Function core_course_renderer::course_category_tree() is deprecated, please use frontpage_combo_list()', DEBUG_DEVELOPER);
106         return $this->frontpage_combo_list();
107     }
109     /**
110      * Renderers a category for use with course_category_tree
111      *
112      * @deprecated since 2.5
113      *
114      * Please see http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
115      *
116      * @param array $category
117      * @param int $depth
118      * @return string
119      */
120     protected final function course_category_tree_category(stdClass $category, $depth=1) {
121         debugging('Function core_course_renderer::course_category_tree_category() is deprecated', DEBUG_DEVELOPER);
122         return '';
123     }
125     /**
126      * Render a modchooser.
127      *
128      * @param renderable $modchooser The chooser.
129      * @return string
130      */
131     public function render_modchooser(renderable $modchooser) {
132         return $this->render_from_template('core_course/modchooser', $modchooser->export_for_template($this));
133     }
135     /**
136      * Build the HTML for the module chooser javascript popup
137      *
138      * @param array $modules A set of modules as returned form @see
139      * get_module_metadata
140      * @param object $course The course that will be displayed
141      * @return string The composed HTML for the module
142      */
143     public function course_modchooser($modules, $course) {
144         if (!$this->page->requires->should_create_one_time_item_now('core_course_modchooser')) {
145             return '';
146         }
147         $modchooser = new \core_course\output\modchooser($course, $modules);
148         return $this->render($modchooser);
149     }
151     /**
152      * Build the HTML for a specified set of modules
153      *
154      * @param array $modules A set of modules as used by the
155      * course_modchooser_module function
156      * @return string The composed HTML for the module
157      */
158     protected function course_modchooser_module_types($modules) {
159         debugging('Method core_course_renderer::course_modchooser_module_types() is deprecated, ' .
160             'see core_course_renderer::render_modchooser().', DEBUG_DEVELOPER);
161         return '';
162     }
164     /**
165      * Return the HTML for the specified module adding any required classes
166      *
167      * @param object $module An object containing the title, and link. An
168      * icon, and help text may optionally be specified. If the module
169      * contains subtypes in the types option, then these will also be
170      * displayed.
171      * @param array $classes Additional classes to add to the encompassing
172      * div element
173      * @return string The composed HTML for the module
174      */
175     protected function course_modchooser_module($module, $classes = array('option')) {
176         debugging('Method core_course_renderer::course_modchooser_module() is deprecated, ' .
177             'see core_course_renderer::render_modchooser().', DEBUG_DEVELOPER);
178         return '';
179     }
181     protected function course_modchooser_title($title, $identifier = null) {
182         debugging('Method core_course_renderer::course_modchooser_title() is deprecated, ' .
183             'see core_course_renderer::render_modchooser().', DEBUG_DEVELOPER);
184         return '';
185     }
187     /**
188      * Renders HTML for displaying the sequence of course module editing buttons
189      *
190      * @see course_get_cm_edit_actions()
191      *
192      * @param action_link[] $actions Array of action_link objects
193      * @param cm_info $mod The module we are displaying actions for.
194      * @param array $displayoptions additional display options:
195      *     ownerselector => A JS/CSS selector that can be used to find an cm node.
196      *         If specified the owning node will be given the class 'action-menu-shown' when the action
197      *         menu is being displayed.
198      *     constraintselector => A JS/CSS selector that can be used to find the parent node for which to constrain
199      *         the action menu to when it is being displayed.
200      *     donotenhance => If set to true the action menu that gets displayed won't be enhanced by JS.
201      * @return string
202      */
203     public function course_section_cm_edit_actions($actions, cm_info $mod = null, $displayoptions = array()) {
204         global $CFG;
206         if (empty($actions)) {
207             return '';
208         }
210         if (isset($displayoptions['ownerselector'])) {
211             $ownerselector = $displayoptions['ownerselector'];
212         } else if ($mod) {
213             $ownerselector = '#module-'.$mod->id;
214         } else {
215             debugging('You should upgrade your call to '.__FUNCTION__.' and provide $mod', DEBUG_DEVELOPER);
216             $ownerselector = 'li.activity';
217         }
219         if (isset($displayoptions['constraintselector'])) {
220             $constraint = $displayoptions['constraintselector'];
221         } else {
222             $constraint = '.course-content';
223         }
225         $menu = new action_menu();
226         $menu->set_owner_selector($ownerselector);
227         $menu->set_constraint($constraint);
228         $menu->set_alignment(action_menu::TR, action_menu::BR);
229         $menu->set_menu_trigger(get_string('edit'));
231         foreach ($actions as $action) {
232             if ($action instanceof action_menu_link) {
233                 $action->add_class('cm-edit-action');
234             }
235             $menu->add($action);
236         }
237         $menu->attributes['class'] .= ' section-cm-edit-actions commands';
239         // Prioritise the menu ahead of all other actions.
240         $menu->prioritise = true;
242         return $this->render($menu);
243     }
245     /**
246      * Renders HTML for the menus to add activities and resources to the current course
247      *
248      * @param stdClass $course
249      * @param int $section relative section number (field course_sections.section)
250      * @param int $sectionreturn The section to link back to
251      * @param array $displayoptions additional display options, for example blocks add
252      *     option 'inblock' => true, suggesting to display controls vertically
253      * @return string
254      */
255     function course_section_add_cm_control($course, $section, $sectionreturn = null, $displayoptions = array()) {
256         global $CFG;
258         $vertical = !empty($displayoptions['inblock']);
260         // check to see if user can add menus and there are modules to add
261         if (!has_capability('moodle/course:manageactivities', context_course::instance($course->id))
262                 || !$this->page->user_is_editing()
263                 || !($modnames = get_module_types_names()) || empty($modnames)) {
264             return '';
265         }
267         // Retrieve all modules with associated metadata
268         $modules = get_module_metadata($course, $modnames, $sectionreturn);
269         $urlparams = array('section' => $section);
271         // We'll sort resources and activities into two lists
272         $activities = array(MOD_CLASS_ACTIVITY => array(), MOD_CLASS_RESOURCE => array());
274         foreach ($modules as $module) {
275             $activityclass = MOD_CLASS_ACTIVITY;
276             if ($module->archetype == MOD_ARCHETYPE_RESOURCE) {
277                 $activityclass = MOD_CLASS_RESOURCE;
278             } else if ($module->archetype === MOD_ARCHETYPE_SYSTEM) {
279                 // System modules cannot be added by user, do not add to dropdown.
280                 continue;
281             }
282             $link = $module->link->out(true, $urlparams);
283             $activities[$activityclass][$link] = $module->title;
284         }
286         $straddactivity = get_string('addactivity');
287         $straddresource = get_string('addresource');
288         $sectionname = get_section_name($course, $section);
289         $strresourcelabel = get_string('addresourcetosection', null, $sectionname);
290         $stractivitylabel = get_string('addactivitytosection', null, $sectionname);
292         $output = html_writer::start_tag('div', array('class' => 'section_add_menus', 'id' => 'add_menus-section-' . $section));
294         if (!$vertical) {
295             $output .= html_writer::start_tag('div', array('class' => 'horizontal'));
296         }
298         if (!empty($activities[MOD_CLASS_RESOURCE])) {
299             $select = new url_select($activities[MOD_CLASS_RESOURCE], '', array(''=>$straddresource), "ressection$section");
300             $select->set_help_icon('resources');
301             $select->set_label($strresourcelabel, array('class' => 'accesshide'));
302             $output .= $this->output->render($select);
303         }
305         if (!empty($activities[MOD_CLASS_ACTIVITY])) {
306             $select = new url_select($activities[MOD_CLASS_ACTIVITY], '', array(''=>$straddactivity), "section$section");
307             $select->set_help_icon('activities');
308             $select->set_label($stractivitylabel, array('class' => 'accesshide'));
309             $output .= $this->output->render($select);
310         }
312         if (!$vertical) {
313             $output .= html_writer::end_tag('div');
314         }
316         $output .= html_writer::end_tag('div');
318         if (course_ajax_enabled($course) && $course->id == $this->page->course->id) {
319             // modchooser can be added only for the current course set on the page!
320             $straddeither = get_string('addresourceoractivity');
321             // The module chooser link
322             $modchooser = html_writer::start_tag('div', array('class' => 'mdl-right'));
323             $modchooser.= html_writer::start_tag('div', array('class' => 'section-modchooser'));
324             $icon = $this->output->pix_icon('t/add', '');
325             $span = html_writer::tag('span', $straddeither, array('class' => 'section-modchooser-text'));
326             $modchooser .= html_writer::tag('span', $icon . $span, array('class' => 'section-modchooser-link'));
327             $modchooser.= html_writer::end_tag('div');
328             $modchooser.= html_writer::end_tag('div');
330             // Wrap the normal output in a noscript div
331             $usemodchooser = get_user_preferences('usemodchooser', $CFG->modchooserdefault);
332             if ($usemodchooser) {
333                 $output = html_writer::tag('div', $output, array('class' => 'hiddenifjs addresourcedropdown'));
334                 $modchooser = html_writer::tag('div', $modchooser, array('class' => 'visibleifjs addresourcemodchooser'));
335             } else {
336                 // If the module chooser is disabled, we need to ensure that the dropdowns are shown even if javascript is disabled
337                 $output = html_writer::tag('div', $output, array('class' => 'show addresourcedropdown'));
338                 $modchooser = html_writer::tag('div', $modchooser, array('class' => 'hide addresourcemodchooser'));
339             }
340             $output = $this->course_modchooser($modules, $course) . $modchooser . $output;
341         }
343         return $output;
344     }
346     /**
347      * Renders html to display a course search form.
348      *
349      * @param string $value default value to populate the search field
350      * @param string $format display format - 'plain' (default), 'short' or 'navbar'
351      * @return string
352      */
353     public function course_search_form($value = '', $format = 'plain') {
354         static $count = 0;
355         $formid = 'coursesearch';
356         if ((++$count) > 1) {
357             $formid .= $count;
358         }
360         switch ($format) {
361             case 'navbar' :
362                 $formid = 'coursesearchnavbar';
363                 $inputid = 'navsearchbox';
364                 $inputsize = 20;
365                 break;
366             case 'short' :
367                 $inputid = 'shortsearchbox';
368                 $inputsize = 12;
369                 break;
370             default :
371                 $inputid = 'coursesearchbox';
372                 $inputsize = 30;
373         }
375         $data = (object) [
376                 'searchurl' => (new moodle_url('/course/search.php'))->out(false),
377                 'id' => $formid,
378                 'inputid' => $inputid,
379                 'inputsize' => $inputsize,
380                 'value' => $value
381         ];
382         if ($format != 'navbar') {
383             $helpicon = new \help_icon('coursesearch', 'core');
384             $data->helpicon = $helpicon->export_for_template($this);
385         }
387         return $this->render_from_template('core_course/course_search_form', $data);
388     }
390     /**
391      * Renders html for completion box on course page
392      *
393      * If completion is disabled, returns empty string
394      * If completion is automatic, returns an icon of the current completion state
395      * If completion is manual, returns a form (with an icon inside) that allows user to
396      * toggle completion
397      *
398      * @param stdClass $course course object
399      * @param completion_info $completioninfo completion info for the course, it is recommended
400      *     to fetch once for all modules in course/section for performance
401      * @param cm_info $mod module to show completion for
402      * @param array $displayoptions display options, not used in core
403      * @return string
404      */
405     public function course_section_cm_completion($course, &$completioninfo, cm_info $mod, $displayoptions = array()) {
406         global $CFG, $DB;
407         $output = '';
408         if (!empty($displayoptions['hidecompletion']) || !isloggedin() || isguestuser() || !$mod->uservisible) {
409             return $output;
410         }
411         if ($completioninfo === null) {
412             $completioninfo = new completion_info($course);
413         }
414         $completion = $completioninfo->is_enabled($mod);
415         if ($completion == COMPLETION_TRACKING_NONE) {
416             if ($this->page->user_is_editing()) {
417                 $output .= html_writer::span('&nbsp;', 'filler');
418             }
419             return $output;
420         }
422         $completiondata = $completioninfo->get_data($mod, true);
423         $completionicon = '';
425         if ($this->page->user_is_editing()) {
426             switch ($completion) {
427                 case COMPLETION_TRACKING_MANUAL :
428                     $completionicon = 'manual-enabled'; break;
429                 case COMPLETION_TRACKING_AUTOMATIC :
430                     $completionicon = 'auto-enabled'; break;
431             }
432         } else if ($completion == COMPLETION_TRACKING_MANUAL) {
433             switch($completiondata->completionstate) {
434                 case COMPLETION_INCOMPLETE:
435                     $completionicon = 'manual-n' . ($completiondata->overrideby ? '-override' : '');
436                     break;
437                 case COMPLETION_COMPLETE:
438                     $completionicon = 'manual-y' . ($completiondata->overrideby ? '-override' : '');
439                     break;
440             }
441         } else { // Automatic
442             switch($completiondata->completionstate) {
443                 case COMPLETION_INCOMPLETE:
444                     $completionicon = 'auto-n' . ($completiondata->overrideby ? '-override' : '');
445                     break;
446                 case COMPLETION_COMPLETE:
447                     $completionicon = 'auto-y' . ($completiondata->overrideby ? '-override' : '');
448                     break;
449                 case COMPLETION_COMPLETE_PASS:
450                     $completionicon = 'auto-pass'; break;
451                 case COMPLETION_COMPLETE_FAIL:
452                     $completionicon = 'auto-fail'; break;
453             }
454         }
455         if ($completionicon) {
456             $formattedname = html_entity_decode($mod->get_formatted_name(), ENT_QUOTES, 'UTF-8');
457             if ($completiondata->overrideby) {
458                 $args = new stdClass();
459                 $args->modname = $formattedname;
460                 $overridebyuser = \core_user::get_user($completiondata->overrideby, '*', MUST_EXIST);
461                 $args->overrideuser = fullname($overridebyuser);
462                 $imgalt = get_string('completion-alt-' . $completionicon, 'completion', $args);
463             } else {
464                 $imgalt = get_string('completion-alt-' . $completionicon, 'completion', $formattedname);
465             }
467             if ($this->page->user_is_editing() || !has_capability('moodle/course:togglecompletion', $mod->context)) {
468                 // When editing, the icon is just an image.
469                 $completionpixicon = new pix_icon('i/completion-'.$completionicon, $imgalt, '',
470                         array('title' => $imgalt, 'class' => 'iconsmall'));
471                 $output .= html_writer::tag('span', $this->output->render($completionpixicon),
472                         array('class' => 'autocompletion'));
473             } else if ($completion == COMPLETION_TRACKING_MANUAL) {
474                 $newstate =
475                     $completiondata->completionstate == COMPLETION_COMPLETE
476                     ? COMPLETION_INCOMPLETE
477                     : COMPLETION_COMPLETE;
478                 // In manual mode the icon is a toggle form...
480                 // If this completion state is used by the
481                 // conditional activities system, we need to turn
482                 // off the JS.
483                 $extraclass = '';
484                 if (!empty($CFG->enableavailability) &&
485                         core_availability\info::completion_value_used($course, $mod->id)) {
486                     $extraclass = ' preventjs';
487                 }
488                 $output .= html_writer::start_tag('form', array('method' => 'post',
489                     'action' => new moodle_url('/course/togglecompletion.php'),
490                     'class' => 'togglecompletion'. $extraclass));
491                 $output .= html_writer::start_tag('div');
492                 $output .= html_writer::empty_tag('input', array(
493                     'type' => 'hidden', 'name' => 'id', 'value' => $mod->id));
494                 $output .= html_writer::empty_tag('input', array(
495                     'type' => 'hidden', 'name' => 'sesskey', 'value' => sesskey()));
496                 $output .= html_writer::empty_tag('input', array(
497                     'type' => 'hidden', 'name' => 'modulename', 'value' => $formattedname));
498                 $output .= html_writer::empty_tag('input', array(
499                     'type' => 'hidden', 'name' => 'completionstate', 'value' => $newstate));
500                 $output .= html_writer::tag('button',
501                     $this->output->pix_icon('i/completion-' . $completionicon, $imgalt),
502                         array('class' => 'btn btn-link', 'aria-live' => 'assertive'));
503                 $output .= html_writer::end_tag('div');
504                 $output .= html_writer::end_tag('form');
505             } else {
506                 // In auto mode, the icon is just an image.
507                 $completionpixicon = new pix_icon('i/completion-'.$completionicon, $imgalt, '',
508                         array('title' => $imgalt));
509                 $output .= html_writer::tag('span', $this->output->render($completionpixicon),
510                         array('class' => 'autocompletion'));
511             }
512         }
513         return $output;
514     }
516     /**
517      * Checks if course module has any conditions that may make it unavailable for
518      * all or some of the students
519      *
520      * This function is internal and is only used to create CSS classes for the module name/text
521      *
522      * @param cm_info $mod
523      * @return bool
524      */
525     protected function is_cm_conditionally_hidden(cm_info $mod) {
526         global $CFG;
527         $conditionalhidden = false;
528         if (!empty($CFG->enableavailability)) {
529             $info = new \core_availability\info_module($mod);
530             $conditionalhidden = !$info->is_available_for_all();
531         }
532         return $conditionalhidden;
533     }
535     /**
536      * Renders html to display a name with the link to the course module on a course page
537      *
538      * If module is unavailable for user but still needs to be displayed
539      * in the list, just the name is returned without a link
540      *
541      * Note, that for course modules that never have separate pages (i.e. labels)
542      * this function return an empty string
543      *
544      * @param cm_info $mod
545      * @param array $displayoptions
546      * @return string
547      */
548     public function course_section_cm_name(cm_info $mod, $displayoptions = array()) {
549         if (!$mod->is_visible_on_course_page() || !$mod->url) {
550             // Nothing to be displayed to the user.
551             return '';
552         }
554         list($linkclasses, $textclasses) = $this->course_section_cm_classes($mod);
555         $groupinglabel = $mod->get_grouping_label($textclasses);
557         // Render element that allows to edit activity name inline. It calls {@link course_section_cm_name_title()}
558         // to get the display title of the activity.
559         $tmpl = new \core_course\output\course_module_name($mod, $this->page->user_is_editing(), $displayoptions);
560         return $this->output->render_from_template('core/inplace_editable', $tmpl->export_for_template($this->output)) .
561             $groupinglabel;
562     }
564     /**
565      * Returns the CSS classes for the activity name/content
566      *
567      * For items which are hidden, unavailable or stealth but should be displayed
568      * to current user ($mod->is_visible_on_course_page()), we show those as dimmed.
569      * Students will also see as dimmed activities names that are not yet available
570      * but should still be displayed (without link) with availability info.
571      *
572      * @param cm_info $mod
573      * @return array array of two elements ($linkclasses, $textclasses)
574      */
575     protected function course_section_cm_classes(cm_info $mod) {
576         $linkclasses = '';
577         $textclasses = '';
578         if ($mod->uservisible) {
579             $conditionalhidden = $this->is_cm_conditionally_hidden($mod);
580             $accessiblebutdim = (!$mod->visible || $conditionalhidden) &&
581                 has_capability('moodle/course:viewhiddenactivities', $mod->context);
582             if ($accessiblebutdim) {
583                 $linkclasses .= ' dimmed';
584                 $textclasses .= ' dimmed_text';
585                 if ($conditionalhidden) {
586                     $linkclasses .= ' conditionalhidden';
587                     $textclasses .= ' conditionalhidden';
588                 }
589             }
590             if ($mod->is_stealth()) {
591                 // Stealth activity is the one that is not visible on course page.
592                 // It still may be displayed to the users who can manage it.
593                 $linkclasses .= ' stealth';
594                 $textclasses .= ' stealth';
595             }
596         } else {
597             $linkclasses .= ' dimmed';
598             $textclasses .= ' dimmed dimmed_text';
599         }
600         return array($linkclasses, $textclasses);
601     }
603     /**
604      * Renders html to display a name with the link to the course module on a course page
605      *
606      * If module is unavailable for user but still needs to be displayed
607      * in the list, just the name is returned without a link
608      *
609      * Note, that for course modules that never have separate pages (i.e. labels)
610      * this function return an empty string
611      *
612      * @param cm_info $mod
613      * @param array $displayoptions
614      * @return string
615      */
616     public function course_section_cm_name_title(cm_info $mod, $displayoptions = array()) {
617         $output = '';
618         $url = $mod->url;
619         if (!$mod->is_visible_on_course_page() || !$url) {
620             // Nothing to be displayed to the user.
621             return $output;
622         }
624         //Accessibility: for files get description via icon, this is very ugly hack!
625         $instancename = $mod->get_formatted_name();
626         $altname = $mod->modfullname;
627         // Avoid unnecessary duplication: if e.g. a forum name already
628         // includes the word forum (or Forum, etc) then it is unhelpful
629         // to include that in the accessible description that is added.
630         if (false !== strpos(core_text::strtolower($instancename),
631                 core_text::strtolower($altname))) {
632             $altname = '';
633         }
634         // File type after name, for alphabetic lists (screen reader).
635         if ($altname) {
636             $altname = get_accesshide(' '.$altname);
637         }
639         list($linkclasses, $textclasses) = $this->course_section_cm_classes($mod);
641         // Get on-click attribute value if specified and decode the onclick - it
642         // has already been encoded for display (puke).
643         $onclick = htmlspecialchars_decode($mod->onclick, ENT_QUOTES);
645         // Display link itself.
646         $activitylink = html_writer::empty_tag('img', array('src' => $mod->get_icon_url(),
647                 'class' => 'iconlarge activityicon', 'alt' => '', 'role' => 'presentation', 'aria-hidden' => 'true')) .
648                 html_writer::tag('span', $instancename . $altname, array('class' => 'instancename'));
649         if ($mod->uservisible) {
650             $output .= html_writer::link($url, $activitylink, array('class' => $linkclasses, 'onclick' => $onclick));
651         } else {
652             // We may be displaying this just in order to show information
653             // about visibility, without the actual link ($mod->is_visible_on_course_page()).
654             $output .= html_writer::tag('div', $activitylink, array('class' => $textclasses));
655         }
656         return $output;
657     }
659     /**
660      * Renders html to display the module content on the course page (i.e. text of the labels)
661      *
662      * @param cm_info $mod
663      * @param array $displayoptions
664      * @return string
665      */
666     public function course_section_cm_text(cm_info $mod, $displayoptions = array()) {
667         $output = '';
668         if (!$mod->is_visible_on_course_page()) {
669             // nothing to be displayed to the user
670             return $output;
671         }
672         $content = $mod->get_formatted_content(array('overflowdiv' => true, 'noclean' => true));
673         list($linkclasses, $textclasses) = $this->course_section_cm_classes($mod);
674         if ($mod->url && $mod->uservisible) {
675             if ($content) {
676                 // If specified, display extra content after link.
677                 $output = html_writer::tag('div', $content, array('class' =>
678                         trim('contentafterlink ' . $textclasses)));
679             }
680         } else {
681             $groupinglabel = $mod->get_grouping_label($textclasses);
683             // No link, so display only content.
684             $output = html_writer::tag('div', $content . $groupinglabel,
685                     array('class' => 'contentwithoutlink ' . $textclasses));
686         }
687         return $output;
688     }
690     /**
691      * Displays availability info for a course section or course module
692      *
693      * @param string $text
694      * @param string $additionalclasses
695      * @return string
696      */
697     public function availability_info($text, $additionalclasses = '') {
699         $data = ['text' => $text, 'classes' => $additionalclasses];
700         $additionalclasses = array_filter(explode(' ', $additionalclasses));
702         if (in_array('ishidden', $additionalclasses)) {
703             $data['ishidden'] = 1;
705         } else if (in_array('isstealth', $additionalclasses)) {
706             $data['isstealth'] = 1;
708         } else if (in_array('isrestricted', $additionalclasses)) {
709             $data['isrestricted'] = 1;
711             if (in_array('isfullinfo', $additionalclasses)) {
712                 $data['isfullinfo'] = 1;
713             }
714         }
716         return $this->render_from_template('core/availability_info', $data);
717     }
719     /**
720      * Renders HTML to show course module availability information (for someone who isn't allowed
721      * to see the activity itself, or for staff)
722      *
723      * @param cm_info $mod
724      * @param array $displayoptions
725      * @return string
726      */
727     public function course_section_cm_availability(cm_info $mod, $displayoptions = array()) {
728         global $CFG;
729         $output = '';
730         if (!$mod->is_visible_on_course_page()) {
731             return $output;
732         }
733         if (!$mod->uservisible) {
734             // this is a student who is not allowed to see the module but might be allowed
735             // to see availability info (i.e. "Available from ...")
736             if (!empty($mod->availableinfo)) {
737                 $formattedinfo = \core_availability\info::format_info(
738                         $mod->availableinfo, $mod->get_course());
739                 $output = $this->availability_info($formattedinfo, 'isrestricted');
740             }
741             return $output;
742         }
743         // this is a teacher who is allowed to see module but still should see the
744         // information that module is not available to all/some students
745         $modcontext = context_module::instance($mod->id);
746         $canviewhidden = has_capability('moodle/course:viewhiddenactivities', $modcontext);
747         if ($canviewhidden && !$mod->visible) {
748             // This module is hidden but current user has capability to see it.
749             // Do not display the availability info if the whole section is hidden.
750             if ($mod->get_section_info()->visible) {
751                 $output .= $this->availability_info(get_string('hiddenfromstudents'), 'ishidden');
752             }
753         } else if ($mod->is_stealth()) {
754             // This module is available but is normally not displayed on the course page
755             // (this user can see it because they can manage it).
756             $output .= $this->availability_info(get_string('hiddenoncoursepage'), 'isstealth');
757         }
758         if ($canviewhidden && !empty($CFG->enableavailability)) {
759             // Display information about conditional availability.
760             // Don't add availability information if user is not editing and activity is hidden.
761             if ($mod->visible || $this->page->user_is_editing()) {
762                 $hidinfoclass = 'isrestricted isfullinfo';
763                 if (!$mod->visible) {
764                     $hidinfoclass .= ' hide';
765                 }
766                 $ci = new \core_availability\info_module($mod);
767                 $fullinfo = $ci->get_full_information();
768                 if ($fullinfo) {
769                     $formattedinfo = \core_availability\info::format_info(
770                             $fullinfo, $mod->get_course());
771                     $output .= $this->availability_info($formattedinfo, $hidinfoclass);
772                 }
773             }
774         }
775         return $output;
776     }
778     /**
779      * Renders HTML to display one course module for display within a section.
780      *
781      * This function calls:
782      * {@link core_course_renderer::course_section_cm()}
783      *
784      * @param stdClass $course
785      * @param completion_info $completioninfo
786      * @param cm_info $mod
787      * @param int|null $sectionreturn
788      * @param array $displayoptions
789      * @return String
790      */
791     public function course_section_cm_list_item($course, &$completioninfo, cm_info $mod, $sectionreturn, $displayoptions = array()) {
792         $output = '';
793         if ($modulehtml = $this->course_section_cm($course, $completioninfo, $mod, $sectionreturn, $displayoptions)) {
794             $modclasses = 'activity ' . $mod->modname . ' modtype_' . $mod->modname . ' ' . $mod->extraclasses;
795             $output .= html_writer::tag('li', $modulehtml, array('class' => $modclasses, 'id' => 'module-' . $mod->id));
796         }
797         return $output;
798     }
800     /**
801      * Renders HTML to display one course module in a course section
802      *
803      * This includes link, content, availability, completion info and additional information
804      * that module type wants to display (i.e. number of unread forum posts)
805      *
806      * This function calls:
807      * {@link core_course_renderer::course_section_cm_name()}
808      * {@link core_course_renderer::course_section_cm_text()}
809      * {@link core_course_renderer::course_section_cm_availability()}
810      * {@link core_course_renderer::course_section_cm_completion()}
811      * {@link course_get_cm_edit_actions()}
812      * {@link core_course_renderer::course_section_cm_edit_actions()}
813      *
814      * @param stdClass $course
815      * @param completion_info $completioninfo
816      * @param cm_info $mod
817      * @param int|null $sectionreturn
818      * @param array $displayoptions
819      * @return string
820      */
821     public function course_section_cm($course, &$completioninfo, cm_info $mod, $sectionreturn, $displayoptions = array()) {
822         $output = '';
823         // We return empty string (because course module will not be displayed at all)
824         // if:
825         // 1) The activity is not visible to users
826         // and
827         // 2) The 'availableinfo' is empty, i.e. the activity was
828         //     hidden in a way that leaves no info, such as using the
829         //     eye icon.
830         if (!$mod->is_visible_on_course_page()) {
831             return $output;
832         }
834         $indentclasses = 'mod-indent';
835         if (!empty($mod->indent)) {
836             $indentclasses .= ' mod-indent-'.$mod->indent;
837             if ($mod->indent > 15) {
838                 $indentclasses .= ' mod-indent-huge';
839             }
840         }
842         $output .= html_writer::start_tag('div');
844         if ($this->page->user_is_editing()) {
845             $output .= course_get_cm_move($mod, $sectionreturn);
846         }
848         $output .= html_writer::start_tag('div', array('class' => 'mod-indent-outer'));
850         // This div is used to indent the content.
851         $output .= html_writer::div('', $indentclasses);
853         // Start a wrapper for the actual content to keep the indentation consistent
854         $output .= html_writer::start_tag('div');
856         // Display the link to the module (or do nothing if module has no url)
857         $cmname = $this->course_section_cm_name($mod, $displayoptions);
859         if (!empty($cmname)) {
860             // Start the div for the activity title, excluding the edit icons.
861             $output .= html_writer::start_tag('div', array('class' => 'activityinstance'));
862             $output .= $cmname;
865             // Module can put text after the link (e.g. forum unread)
866             $output .= $mod->afterlink;
868             // Closing the tag which contains everything but edit icons. Content part of the module should not be part of this.
869             $output .= html_writer::end_tag('div'); // .activityinstance
870         }
872         // If there is content but NO link (eg label), then display the
873         // content here (BEFORE any icons). In this case cons must be
874         // displayed after the content so that it makes more sense visually
875         // and for accessibility reasons, e.g. if you have a one-line label
876         // it should work similarly (at least in terms of ordering) to an
877         // activity.
878         $contentpart = $this->course_section_cm_text($mod, $displayoptions);
879         $url = $mod->url;
880         if (empty($url)) {
881             $output .= $contentpart;
882         }
884         $modicons = '';
885         if ($this->page->user_is_editing()) {
886             $editactions = course_get_cm_edit_actions($mod, $mod->indent, $sectionreturn);
887             $modicons .= ' '. $this->course_section_cm_edit_actions($editactions, $mod, $displayoptions);
888             $modicons .= $mod->afterediticons;
889         }
891         $modicons .= $this->course_section_cm_completion($course, $completioninfo, $mod, $displayoptions);
893         if (!empty($modicons)) {
894             $output .= html_writer::span($modicons, 'actions');
895         }
897         // Show availability info (if module is not available).
898         $output .= $this->course_section_cm_availability($mod, $displayoptions);
900         // If there is content AND a link, then display the content here
901         // (AFTER any icons). Otherwise it was displayed before
902         if (!empty($url)) {
903             $output .= $contentpart;
904         }
906         $output .= html_writer::end_tag('div'); // $indentclasses
908         // End of indentation div.
909         $output .= html_writer::end_tag('div');
911         $output .= html_writer::end_tag('div');
912         return $output;
913     }
915     /**
916      * Message displayed to the user when they try to access unavailable activity following URL
917      *
918      * This method is a very simplified version of {@link course_section_cm()} to be part of the error
919      * notification only. It also does not check if module is visible on course page or not.
920      *
921      * The message will be displayed inside notification!
922      *
923      * @param cm_info $cm
924      * @return string
925      */
926     public function course_section_cm_unavailable_error_message(cm_info $cm) {
927         if ($cm->uservisible) {
928             return null;
929         }
930         if (!$cm->availableinfo) {
931             return get_string('activityiscurrentlyhidden');
932         }
934         $altname = get_accesshide(' ' . $cm->modfullname);
935         $name = html_writer::empty_tag('img', array('src' => $cm->get_icon_url(),
936                 'class' => 'iconlarge activityicon', 'alt' => ' ', 'role' => 'presentation')) .
937             html_writer::tag('span', ' '.$cm->get_formatted_name() . $altname, array('class' => 'instancename'));
938         $formattedinfo = \core_availability\info::format_info($cm->availableinfo, $cm->get_course());
939         return html_writer::div($name, 'activityinstance-error') .
940         html_writer::div($formattedinfo, 'availabilityinfo-error');
941     }
943     /**
944      * Renders HTML to display a list of course modules in a course section
945      * Also displays "move here" controls in Javascript-disabled mode
946      *
947      * This function calls {@link core_course_renderer::course_section_cm()}
948      *
949      * @param stdClass $course course object
950      * @param int|stdClass|section_info $section relative section number or section object
951      * @param int $sectionreturn section number to return to
952      * @param int $displayoptions
953      * @return void
954      */
955     public function course_section_cm_list($course, $section, $sectionreturn = null, $displayoptions = array()) {
956         global $USER;
958         $output = '';
959         $modinfo = get_fast_modinfo($course);
960         if (is_object($section)) {
961             $section = $modinfo->get_section_info($section->section);
962         } else {
963             $section = $modinfo->get_section_info($section);
964         }
965         $completioninfo = new completion_info($course);
967         // check if we are currently in the process of moving a module with JavaScript disabled
968         $ismoving = $this->page->user_is_editing() && ismoving($course->id);
969         if ($ismoving) {
970             $movingpix = new pix_icon('movehere', get_string('movehere'), 'moodle', array('class' => 'movetarget'));
971             $strmovefull = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'"));
972         }
974         // Get the list of modules visible to user (excluding the module being moved if there is one)
975         $moduleshtml = array();
976         if (!empty($modinfo->sections[$section->section])) {
977             foreach ($modinfo->sections[$section->section] as $modnumber) {
978                 $mod = $modinfo->cms[$modnumber];
980                 if ($ismoving and $mod->id == $USER->activitycopy) {
981                     // do not display moving mod
982                     continue;
983                 }
985                 if ($modulehtml = $this->course_section_cm_list_item($course,
986                         $completioninfo, $mod, $sectionreturn, $displayoptions)) {
987                     $moduleshtml[$modnumber] = $modulehtml;
988                 }
989             }
990         }
992         $sectionoutput = '';
993         if (!empty($moduleshtml) || $ismoving) {
994             foreach ($moduleshtml as $modnumber => $modulehtml) {
995                 if ($ismoving) {
996                     $movingurl = new moodle_url('/course/mod.php', array('moveto' => $modnumber, 'sesskey' => sesskey()));
997                     $sectionoutput .= html_writer::tag('li',
998                             html_writer::link($movingurl, $this->output->render($movingpix), array('title' => $strmovefull)),
999                             array('class' => 'movehere'));
1000                 }
1002                 $sectionoutput .= $modulehtml;
1003             }
1005             if ($ismoving) {
1006                 $movingurl = new moodle_url('/course/mod.php', array('movetosection' => $section->id, 'sesskey' => sesskey()));
1007                 $sectionoutput .= html_writer::tag('li',
1008                         html_writer::link($movingurl, $this->output->render($movingpix), array('title' => $strmovefull)),
1009                         array('class' => 'movehere'));
1010             }
1011         }
1013         // Always output the section module list.
1014         $output .= html_writer::tag('ul', $sectionoutput, array('class' => 'section img-text'));
1016         return $output;
1017     }
1019     /**
1020      * Displays a custom list of courses with paging bar if necessary
1021      *
1022      * If $paginationurl is specified but $totalcount is not, the link 'View more'
1023      * appears under the list.
1024      *
1025      * If both $paginationurl and $totalcount are specified, and $totalcount is
1026      * bigger than count($courses), a paging bar is displayed above and under the
1027      * courses list.
1028      *
1029      * @param array $courses array of course records (or instances of core_course_list_element) to show on this page
1030      * @param bool $showcategoryname whether to add category name to the course description
1031      * @param string $additionalclasses additional CSS classes to add to the div.courses
1032      * @param moodle_url $paginationurl url to view more or url to form links to the other pages in paging bar
1033      * @param int $totalcount total number of courses on all pages, if omitted $paginationurl will be displayed as 'View more' link
1034      * @param int $page current page number (defaults to 0 referring to the first page)
1035      * @param int $perpage number of records per page (defaults to $CFG->coursesperpage)
1036      * @return string
1037      */
1038     public function courses_list($courses, $showcategoryname = false, $additionalclasses = null, $paginationurl = null, $totalcount = null, $page = 0, $perpage = null) {
1039         global $CFG;
1040         // create instance of coursecat_helper to pass display options to function rendering courses list
1041         $chelper = new coursecat_helper();
1042         if ($showcategoryname) {
1043             $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_EXPANDED_WITH_CAT);
1044         } else {
1045             $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_EXPANDED);
1046         }
1047         if ($totalcount !== null && $paginationurl !== null) {
1048             // add options to display pagination
1049             if ($perpage === null) {
1050                 $perpage = $CFG->coursesperpage;
1051             }
1052             $chelper->set_courses_display_options(array(
1053                 'limit' => $perpage,
1054                 'offset' => ((int)$page) * $perpage,
1055                 'paginationurl' => $paginationurl,
1056             ));
1057         } else if ($paginationurl !== null) {
1058             // add options to display 'View more' link
1059             $chelper->set_courses_display_options(array('viewmoreurl' => $paginationurl));
1060             $totalcount = count($courses) + 1; // has to be bigger than count($courses) otherwise link will not be displayed
1061         }
1062         $chelper->set_attributes(array('class' => $additionalclasses));
1063         $content = $this->coursecat_courses($chelper, $courses, $totalcount);
1064         return $content;
1065     }
1067     /**
1068      * Displays one course in the list of courses.
1069      *
1070      * This is an internal function, to display an information about just one course
1071      * please use {@link core_course_renderer::course_info_box()}
1072      *
1073      * @param coursecat_helper $chelper various display options
1074      * @param core_course_list_element|stdClass $course
1075      * @param string $additionalclasses additional classes to add to the main <div> tag (usually
1076      *    depend on the course position in list - first/last/even/odd)
1077      * @return string
1078      */
1079     protected function coursecat_coursebox(coursecat_helper $chelper, $course, $additionalclasses = '') {
1080         if (!isset($this->strings->summary)) {
1081             $this->strings->summary = get_string('summary');
1082         }
1083         if ($chelper->get_show_courses() <= self::COURSECAT_SHOW_COURSES_COUNT) {
1084             return '';
1085         }
1086         if ($course instanceof stdClass) {
1087             $course = new core_course_list_element($course);
1088         }
1089         $content = '';
1090         $classes = trim('coursebox clearfix '. $additionalclasses);
1091         if ($chelper->get_show_courses() >= self::COURSECAT_SHOW_COURSES_EXPANDED) {
1092             $nametag = 'h3';
1093         } else {
1094             $classes .= ' collapsed';
1095             $nametag = 'div';
1096         }
1098         // .coursebox
1099         $content .= html_writer::start_tag('div', array(
1100             'class' => $classes,
1101             'data-courseid' => $course->id,
1102             'data-type' => self::COURSECAT_TYPE_COURSE,
1103         ));
1105         $content .= html_writer::start_tag('div', array('class' => 'info'));
1107         // course name
1108         $coursename = $chelper->get_course_formatted_name($course);
1109         $coursenamelink = html_writer::link(new moodle_url('/course/view.php', array('id' => $course->id)),
1110                                             $coursename, array('class' => $course->visible ? '' : 'dimmed'));
1111         $content .= html_writer::tag($nametag, $coursenamelink, array('class' => 'coursename'));
1112         // If we display course in collapsed form but the course has summary or course contacts, display the link to the info page.
1113         $content .= html_writer::start_tag('div', array('class' => 'moreinfo'));
1114         if ($chelper->get_show_courses() < self::COURSECAT_SHOW_COURSES_EXPANDED) {
1115             if ($course->has_summary() || $course->has_course_contacts() || $course->has_course_overviewfiles()
1116                     || $course->has_custom_fields()) {
1117                 $url = new moodle_url('/course/info.php', array('id' => $course->id));
1118                 $image = $this->output->pix_icon('i/info', $this->strings->summary);
1119                 $content .= html_writer::link($url, $image, array('title' => $this->strings->summary));
1120                 // Make sure JS file to expand course content is included.
1121                 $this->coursecat_include_js();
1122             }
1123         }
1124         $content .= html_writer::end_tag('div'); // .moreinfo
1126         // print enrolmenticons
1127         if ($icons = enrol_get_course_info_icons($course)) {
1128             $content .= html_writer::start_tag('div', array('class' => 'enrolmenticons'));
1129             foreach ($icons as $pix_icon) {
1130                 $content .= $this->render($pix_icon);
1131             }
1132             $content .= html_writer::end_tag('div'); // .enrolmenticons
1133         }
1135         $content .= html_writer::end_tag('div'); // .info
1137         $content .= html_writer::start_tag('div', array('class' => 'content'));
1138         $content .= $this->coursecat_coursebox_content($chelper, $course);
1139         $content .= html_writer::end_tag('div'); // .content
1141         $content .= html_writer::end_tag('div'); // .coursebox
1142         return $content;
1143     }
1145     /**
1146      * Returns HTML to display course content (summary, course contacts and optionally category name)
1147      *
1148      * This method is called from coursecat_coursebox() and may be re-used in AJAX
1149      *
1150      * @param coursecat_helper $chelper various display options
1151      * @param stdClass|core_course_list_element $course
1152      * @return string
1153      */
1154     protected function coursecat_coursebox_content(coursecat_helper $chelper, $course) {
1155         global $CFG;
1156         if ($chelper->get_show_courses() < self::COURSECAT_SHOW_COURSES_EXPANDED) {
1157             return '';
1158         }
1159         if ($course instanceof stdClass) {
1160             $course = new core_course_list_element($course);
1161         }
1162         $content = '';
1164         // display course summary
1165         if ($course->has_summary()) {
1166             $content .= html_writer::start_tag('div', array('class' => 'summary'));
1167             $content .= $chelper->get_course_formatted_summary($course,
1168                     array('overflowdiv' => true, 'noclean' => true, 'para' => false));
1169             $content .= html_writer::end_tag('div'); // .summary
1170         }
1172         // display course overview files
1173         $contentimages = $contentfiles = '';
1174         foreach ($course->get_course_overviewfiles() as $file) {
1175             $isimage = $file->is_valid_image();
1176             $url = file_encode_url("$CFG->wwwroot/pluginfile.php",
1177                     '/'. $file->get_contextid(). '/'. $file->get_component(). '/'.
1178                     $file->get_filearea(). $file->get_filepath(). $file->get_filename(), !$isimage);
1179             if ($isimage) {
1180                 $contentimages .= html_writer::tag('div',
1181                         html_writer::empty_tag('img', array('src' => $url)),
1182                         array('class' => 'courseimage'));
1183             } else {
1184                 $image = $this->output->pix_icon(file_file_icon($file, 24), $file->get_filename(), 'moodle');
1185                 $filename = html_writer::tag('span', $image, array('class' => 'fp-icon')).
1186                         html_writer::tag('span', $file->get_filename(), array('class' => 'fp-filename'));
1187                 $contentfiles .= html_writer::tag('span',
1188                         html_writer::link($url, $filename),
1189                         array('class' => 'coursefile fp-filename-icon'));
1190             }
1191         }
1192         $content .= $contentimages. $contentfiles;
1194         // Display course contacts. See core_course_list_element::get_course_contacts().
1195         if ($course->has_course_contacts()) {
1196             $content .= html_writer::start_tag('ul', array('class' => 'teachers'));
1197             foreach ($course->get_course_contacts() as $coursecontact) {
1198                 $rolenames = array_map(function ($role) {
1199                     return $role->displayname;
1200                 }, $coursecontact['roles']);
1201                 $name = implode(", ", $rolenames).': '.
1202                         html_writer::link(new moodle_url('/user/view.php',
1203                                 array('id' => $coursecontact['user']->id, 'course' => SITEID)),
1204                             $coursecontact['username']);
1205                 $content .= html_writer::tag('li', $name);
1206             }
1207             $content .= html_writer::end_tag('ul'); // .teachers
1208         }
1210         // display course category if necessary (for example in search results)
1211         if ($chelper->get_show_courses() == self::COURSECAT_SHOW_COURSES_EXPANDED_WITH_CAT) {
1212             if ($cat = core_course_category::get($course->category, IGNORE_MISSING)) {
1213                 $content .= html_writer::start_tag('div', array('class' => 'coursecat'));
1214                 $content .= get_string('category').': '.
1215                         html_writer::link(new moodle_url('/course/index.php', array('categoryid' => $cat->id)),
1216                                 $cat->get_formatted_name(), array('class' => $cat->visible ? '' : 'dimmed'));
1217                 $content .= html_writer::end_tag('div'); // .coursecat
1218             }
1219         }
1221         // Display custom fields.
1222         if ($course->has_custom_fields()) {
1223             $handler = core_course\customfield\course_handler::create();
1224             $customfields = $handler->display_custom_fields_data($course->get_custom_fields());
1225             $content .= \html_writer::tag('div', $customfields, ['class' => 'customfields-container']);
1226         }
1228         return $content;
1229     }
1231     /**
1232      * Renders the list of courses
1233      *
1234      * This is internal function, please use {@link core_course_renderer::courses_list()} or another public
1235      * method from outside of the class
1236      *
1237      * If list of courses is specified in $courses; the argument $chelper is only used
1238      * to retrieve display options and attributes, only methods get_show_courses(),
1239      * get_courses_display_option() and get_and_erase_attributes() are called.
1240      *
1241      * @param coursecat_helper $chelper various display options
1242      * @param array $courses the list of courses to display
1243      * @param int|null $totalcount total number of courses (affects display mode if it is AUTO or pagination if applicable),
1244      *     defaulted to count($courses)
1245      * @return string
1246      */
1247     protected function coursecat_courses(coursecat_helper $chelper, $courses, $totalcount = null) {
1248         global $CFG;
1249         if ($totalcount === null) {
1250             $totalcount = count($courses);
1251         }
1252         if (!$totalcount) {
1253             // Courses count is cached during courses retrieval.
1254             return '';
1255         }
1257         if ($chelper->get_show_courses() == self::COURSECAT_SHOW_COURSES_AUTO) {
1258             // In 'auto' course display mode we analyse if number of courses is more or less than $CFG->courseswithsummarieslimit
1259             if ($totalcount <= $CFG->courseswithsummarieslimit) {
1260                 $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_EXPANDED);
1261             } else {
1262                 $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_COLLAPSED);
1263             }
1264         }
1266         // prepare content of paging bar if it is needed
1267         $paginationurl = $chelper->get_courses_display_option('paginationurl');
1268         $paginationallowall = $chelper->get_courses_display_option('paginationallowall');
1269         if ($totalcount > count($courses)) {
1270             // there are more results that can fit on one page
1271             if ($paginationurl) {
1272                 // the option paginationurl was specified, display pagingbar
1273                 $perpage = $chelper->get_courses_display_option('limit', $CFG->coursesperpage);
1274                 $page = $chelper->get_courses_display_option('offset') / $perpage;
1275                 $pagingbar = $this->paging_bar($totalcount, $page, $perpage,
1276                         $paginationurl->out(false, array('perpage' => $perpage)));
1277                 if ($paginationallowall) {
1278                     $pagingbar .= html_writer::tag('div', html_writer::link($paginationurl->out(false, array('perpage' => 'all')),
1279                             get_string('showall', '', $totalcount)), array('class' => 'paging paging-showall'));
1280                 }
1281             } else if ($viewmoreurl = $chelper->get_courses_display_option('viewmoreurl')) {
1282                 // the option for 'View more' link was specified, display more link
1283                 $viewmoretext = $chelper->get_courses_display_option('viewmoretext', new lang_string('viewmore'));
1284                 $morelink = html_writer::tag('div', html_writer::link($viewmoreurl, $viewmoretext),
1285                         array('class' => 'paging paging-morelink'));
1286             }
1287         } else if (($totalcount > $CFG->coursesperpage) && $paginationurl && $paginationallowall) {
1288             // there are more than one page of results and we are in 'view all' mode, suggest to go back to paginated view mode
1289             $pagingbar = html_writer::tag('div', html_writer::link($paginationurl->out(false, array('perpage' => $CFG->coursesperpage)),
1290                 get_string('showperpage', '', $CFG->coursesperpage)), array('class' => 'paging paging-showperpage'));
1291         }
1293         // display list of courses
1294         $attributes = $chelper->get_and_erase_attributes('courses');
1295         $content = html_writer::start_tag('div', $attributes);
1297         if (!empty($pagingbar)) {
1298             $content .= $pagingbar;
1299         }
1301         $coursecount = 0;
1302         foreach ($courses as $course) {
1303             $coursecount ++;
1304             $classes = ($coursecount%2) ? 'odd' : 'even';
1305             if ($coursecount == 1) {
1306                 $classes .= ' first';
1307             }
1308             if ($coursecount >= count($courses)) {
1309                 $classes .= ' last';
1310             }
1311             $content .= $this->coursecat_coursebox($chelper, $course, $classes);
1312         }
1314         if (!empty($pagingbar)) {
1315             $content .= $pagingbar;
1316         }
1317         if (!empty($morelink)) {
1318             $content .= $morelink;
1319         }
1321         $content .= html_writer::end_tag('div'); // .courses
1322         return $content;
1323     }
1325     /**
1326      * Renders the list of subcategories in a category
1327      *
1328      * @param coursecat_helper $chelper various display options
1329      * @param core_course_category $coursecat
1330      * @param int $depth depth of the category in the current tree
1331      * @return string
1332      */
1333     protected function coursecat_subcategories(coursecat_helper $chelper, $coursecat, $depth) {
1334         global $CFG;
1335         $subcategories = array();
1336         if (!$chelper->get_categories_display_option('nodisplay')) {
1337             $subcategories = $coursecat->get_children($chelper->get_categories_display_options());
1338         }
1339         $totalcount = $coursecat->get_children_count();
1340         if (!$totalcount) {
1341             // Note that we call core_course_category::get_children_count() AFTER core_course_category::get_children()
1342             // to avoid extra DB requests.
1343             // Categories count is cached during children categories retrieval.
1344             return '';
1345         }
1347         // prepare content of paging bar or more link if it is needed
1348         $paginationurl = $chelper->get_categories_display_option('paginationurl');
1349         $paginationallowall = $chelper->get_categories_display_option('paginationallowall');
1350         if ($totalcount > count($subcategories)) {
1351             if ($paginationurl) {
1352                 // the option 'paginationurl was specified, display pagingbar
1353                 $perpage = $chelper->get_categories_display_option('limit', $CFG->coursesperpage);
1354                 $page = $chelper->get_categories_display_option('offset') / $perpage;
1355                 $pagingbar = $this->paging_bar($totalcount, $page, $perpage,
1356                         $paginationurl->out(false, array('perpage' => $perpage)));
1357                 if ($paginationallowall) {
1358                     $pagingbar .= html_writer::tag('div', html_writer::link($paginationurl->out(false, array('perpage' => 'all')),
1359                             get_string('showall', '', $totalcount)), array('class' => 'paging paging-showall'));
1360                 }
1361             } else if ($viewmoreurl = $chelper->get_categories_display_option('viewmoreurl')) {
1362                 // the option 'viewmoreurl' was specified, display more link (if it is link to category view page, add category id)
1363                 if ($viewmoreurl->compare(new moodle_url('/course/index.php'), URL_MATCH_BASE)) {
1364                     $viewmoreurl->param('categoryid', $coursecat->id);
1365                 }
1366                 $viewmoretext = $chelper->get_categories_display_option('viewmoretext', new lang_string('viewmore'));
1367                 $morelink = html_writer::tag('div', html_writer::link($viewmoreurl, $viewmoretext),
1368                         array('class' => 'paging paging-morelink'));
1369             }
1370         } else if (($totalcount > $CFG->coursesperpage) && $paginationurl && $paginationallowall) {
1371             // there are more than one page of results and we are in 'view all' mode, suggest to go back to paginated view mode
1372             $pagingbar = html_writer::tag('div', html_writer::link($paginationurl->out(false, array('perpage' => $CFG->coursesperpage)),
1373                 get_string('showperpage', '', $CFG->coursesperpage)), array('class' => 'paging paging-showperpage'));
1374         }
1376         // display list of subcategories
1377         $content = html_writer::start_tag('div', array('class' => 'subcategories'));
1379         if (!empty($pagingbar)) {
1380             $content .= $pagingbar;
1381         }
1383         foreach ($subcategories as $subcategory) {
1384             $content .= $this->coursecat_category($chelper, $subcategory, $depth + 1);
1385         }
1387         if (!empty($pagingbar)) {
1388             $content .= $pagingbar;
1389         }
1390         if (!empty($morelink)) {
1391             $content .= $morelink;
1392         }
1394         $content .= html_writer::end_tag('div');
1395         return $content;
1396     }
1398     /**
1399      * Make sure that javascript file for AJAX expanding of courses and categories content is included
1400      */
1401     protected function coursecat_include_js() {
1402         if (!$this->page->requires->should_create_one_time_item_now('core_course_categoryexpanderjsinit')) {
1403             return;
1404         }
1406         // We must only load this module once.
1407         $this->page->requires->yui_module('moodle-course-categoryexpander',
1408                 'Y.Moodle.course.categoryexpander.init');
1409     }
1411     /**
1412      * Returns HTML to display the subcategories and courses in the given category
1413      *
1414      * This method is re-used by AJAX to expand content of not loaded category
1415      *
1416      * @param coursecat_helper $chelper various display options
1417      * @param core_course_category $coursecat
1418      * @param int $depth depth of the category in the current tree
1419      * @return string
1420      */
1421     protected function coursecat_category_content(coursecat_helper $chelper, $coursecat, $depth) {
1422         $content = '';
1423         // Subcategories
1424         $content .= $this->coursecat_subcategories($chelper, $coursecat, $depth);
1426         // AUTO show courses: Courses will be shown expanded if this is not nested category,
1427         // and number of courses no bigger than $CFG->courseswithsummarieslimit.
1428         $showcoursesauto = $chelper->get_show_courses() == self::COURSECAT_SHOW_COURSES_AUTO;
1429         if ($showcoursesauto && $depth) {
1430             // this is definitely collapsed mode
1431             $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_COLLAPSED);
1432         }
1434         // Courses
1435         if ($chelper->get_show_courses() > core_course_renderer::COURSECAT_SHOW_COURSES_COUNT) {
1436             $courses = array();
1437             if (!$chelper->get_courses_display_option('nodisplay')) {
1438                 $courses = $coursecat->get_courses($chelper->get_courses_display_options());
1439             }
1440             if ($viewmoreurl = $chelper->get_courses_display_option('viewmoreurl')) {
1441                 // the option for 'View more' link was specified, display more link (if it is link to category view page, add category id)
1442                 if ($viewmoreurl->compare(new moodle_url('/course/index.php'), URL_MATCH_BASE)) {
1443                     $chelper->set_courses_display_option('viewmoreurl', new moodle_url($viewmoreurl, array('categoryid' => $coursecat->id)));
1444                 }
1445             }
1446             $content .= $this->coursecat_courses($chelper, $courses, $coursecat->get_courses_count());
1447         }
1449         if ($showcoursesauto) {
1450             // restore the show_courses back to AUTO
1451             $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_AUTO);
1452         }
1454         return $content;
1455     }
1457     /**
1458      * Returns HTML to display a course category as a part of a tree
1459      *
1460      * This is an internal function, to display a particular category and all its contents
1461      * use {@link core_course_renderer::course_category()}
1462      *
1463      * @param coursecat_helper $chelper various display options
1464      * @param core_course_category $coursecat
1465      * @param int $depth depth of this category in the current tree
1466      * @return string
1467      */
1468     protected function coursecat_category(coursecat_helper $chelper, $coursecat, $depth) {
1469         // open category tag
1470         $classes = array('category');
1471         if (empty($coursecat->visible)) {
1472             $classes[] = 'dimmed_category';
1473         }
1474         if ($chelper->get_subcat_depth() > 0 && $depth >= $chelper->get_subcat_depth()) {
1475             // do not load content
1476             $categorycontent = '';
1477             $classes[] = 'notloaded';
1478             if ($coursecat->get_children_count() ||
1479                     ($chelper->get_show_courses() >= self::COURSECAT_SHOW_COURSES_COLLAPSED && $coursecat->get_courses_count())) {
1480                 $classes[] = 'with_children';
1481                 $classes[] = 'collapsed';
1482             }
1483         } else {
1484             // load category content
1485             $categorycontent = $this->coursecat_category_content($chelper, $coursecat, $depth);
1486             $classes[] = 'loaded';
1487             if (!empty($categorycontent)) {
1488                 $classes[] = 'with_children';
1489                 // Category content loaded with children.
1490                 $this->categoryexpandedonload = true;
1491             }
1492         }
1494         // Make sure JS file to expand category content is included.
1495         $this->coursecat_include_js();
1497         $content = html_writer::start_tag('div', array(
1498             'class' => join(' ', $classes),
1499             'data-categoryid' => $coursecat->id,
1500             'data-depth' => $depth,
1501             'data-showcourses' => $chelper->get_show_courses(),
1502             'data-type' => self::COURSECAT_TYPE_CATEGORY,
1503         ));
1505         // category name
1506         $categoryname = $coursecat->get_formatted_name();
1507         $categoryname = html_writer::link(new moodle_url('/course/index.php',
1508                 array('categoryid' => $coursecat->id)),
1509                 $categoryname);
1510         if ($chelper->get_show_courses() == self::COURSECAT_SHOW_COURSES_COUNT
1511                 && ($coursescount = $coursecat->get_courses_count())) {
1512             $categoryname .= html_writer::tag('span', ' ('. $coursescount.')',
1513                     array('title' => get_string('numberofcourses'), 'class' => 'numberofcourse'));
1514         }
1515         $content .= html_writer::start_tag('div', array('class' => 'info'));
1517         $content .= html_writer::tag(($depth > 1) ? 'h4' : 'h3', $categoryname, array('class' => 'categoryname'));
1518         $content .= html_writer::end_tag('div'); // .info
1520         // add category content to the output
1521         $content .= html_writer::tag('div', $categorycontent, array('class' => 'content'));
1523         $content .= html_writer::end_tag('div'); // .category
1525         // Return the course category tree HTML
1526         return $content;
1527     }
1529     /**
1530      * Returns HTML to display a tree of subcategories and courses in the given category
1531      *
1532      * @param coursecat_helper $chelper various display options
1533      * @param core_course_category $coursecat top category (this category's name and description will NOT be added to the tree)
1534      * @return string
1535      */
1536     protected function coursecat_tree(coursecat_helper $chelper, $coursecat) {
1537         // Reset the category expanded flag for this course category tree first.
1538         $this->categoryexpandedonload = false;
1539         $categorycontent = $this->coursecat_category_content($chelper, $coursecat, 0);
1540         if (empty($categorycontent)) {
1541             return '';
1542         }
1544         // Start content generation
1545         $content = '';
1546         $attributes = $chelper->get_and_erase_attributes('course_category_tree clearfix');
1547         $content .= html_writer::start_tag('div', $attributes);
1549         if ($coursecat->get_children_count()) {
1550             $classes = array(
1551                 'collapseexpand',
1552             );
1554             // Check if the category content contains subcategories with children's content loaded.
1555             if ($this->categoryexpandedonload) {
1556                 $classes[] = 'collapse-all';
1557                 $linkname = get_string('collapseall');
1558             } else {
1559                 $linkname = get_string('expandall');
1560             }
1562             // Only show the collapse/expand if there are children to expand.
1563             $content .= html_writer::start_tag('div', array('class' => 'collapsible-actions'));
1564             $content .= html_writer::link('#', $linkname, array('class' => implode(' ', $classes)));
1565             $content .= html_writer::end_tag('div');
1566             $this->page->requires->strings_for_js(array('collapseall', 'expandall'), 'moodle');
1567         }
1569         $content .= html_writer::tag('div', $categorycontent, array('class' => 'content'));
1571         $content .= html_writer::end_tag('div'); // .course_category_tree
1573         return $content;
1574     }
1576     /**
1577      * Renders HTML to display particular course category - list of it's subcategories and courses
1578      *
1579      * Invoked from /course/index.php
1580      *
1581      * @param int|stdClass|core_course_category $category
1582      */
1583     public function course_category($category) {
1584         global $CFG;
1585         $coursecat = core_course_category::get(is_object($category) ? $category->id : $category);
1586         $site = get_site();
1587         $output = '';
1589         if (can_edit_in_category($coursecat->id)) {
1590             // Add 'Manage' button if user has permissions to edit this category.
1591             $managebutton = $this->single_button(new moodle_url('/course/management.php',
1592                 array('categoryid' => $coursecat->id)), get_string('managecourses'), 'get');
1593             $this->page->set_button($managebutton);
1594         }
1595         if (!$coursecat->id) {
1596             if (core_course_category::count_all() == 1) {
1597                 // There exists only one category in the system, do not display link to it
1598                 $coursecat = core_course_category::get_default();
1599                 $strfulllistofcourses = get_string('fulllistofcourses');
1600                 $this->page->set_title("$site->shortname: $strfulllistofcourses");
1601             } else {
1602                 $strcategories = get_string('categories');
1603                 $this->page->set_title("$site->shortname: $strcategories");
1604             }
1605         } else {
1606             $title = $site->shortname;
1607             if (core_course_category::count_all() > 1) {
1608                 $title .= ": ". $coursecat->get_formatted_name();
1609             }
1610             $this->page->set_title($title);
1612             // Print the category selector
1613             if (core_course_category::count_all() > 1) {
1614                 $output .= html_writer::start_tag('div', array('class' => 'categorypicker'));
1615                 $select = new single_select(new moodle_url('/course/index.php'), 'categoryid',
1616                         core_course_category::make_categories_list(), $coursecat->id, null, 'switchcategory');
1617                 $select->set_label(get_string('categories').':');
1618                 $output .= $this->render($select);
1619                 $output .= html_writer::end_tag('div'); // .categorypicker
1620             }
1621         }
1623         // Print current category description
1624         $chelper = new coursecat_helper();
1625         if ($description = $chelper->get_category_formatted_description($coursecat)) {
1626             $output .= $this->box($description, array('class' => 'generalbox info'));
1627         }
1629         // Prepare parameters for courses and categories lists in the tree
1630         $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_AUTO)
1631                 ->set_attributes(array('class' => 'category-browse category-browse-'.$coursecat->id));
1633         $coursedisplayoptions = array();
1634         $catdisplayoptions = array();
1635         $browse = optional_param('browse', null, PARAM_ALPHA);
1636         $perpage = optional_param('perpage', $CFG->coursesperpage, PARAM_INT);
1637         $page = optional_param('page', 0, PARAM_INT);
1638         $baseurl = new moodle_url('/course/index.php');
1639         if ($coursecat->id) {
1640             $baseurl->param('categoryid', $coursecat->id);
1641         }
1642         if ($perpage != $CFG->coursesperpage) {
1643             $baseurl->param('perpage', $perpage);
1644         }
1645         $coursedisplayoptions['limit'] = $perpage;
1646         $catdisplayoptions['limit'] = $perpage;
1647         if ($browse === 'courses' || !$coursecat->has_children()) {
1648             $coursedisplayoptions['offset'] = $page * $perpage;
1649             $coursedisplayoptions['paginationurl'] = new moodle_url($baseurl, array('browse' => 'courses'));
1650             $catdisplayoptions['nodisplay'] = true;
1651             $catdisplayoptions['viewmoreurl'] = new moodle_url($baseurl, array('browse' => 'categories'));
1652             $catdisplayoptions['viewmoretext'] = new lang_string('viewallsubcategories');
1653         } else if ($browse === 'categories' || !$coursecat->has_courses()) {
1654             $coursedisplayoptions['nodisplay'] = true;
1655             $catdisplayoptions['offset'] = $page * $perpage;
1656             $catdisplayoptions['paginationurl'] = new moodle_url($baseurl, array('browse' => 'categories'));
1657             $coursedisplayoptions['viewmoreurl'] = new moodle_url($baseurl, array('browse' => 'courses'));
1658             $coursedisplayoptions['viewmoretext'] = new lang_string('viewallcourses');
1659         } else {
1660             // we have a category that has both subcategories and courses, display pagination separately
1661             $coursedisplayoptions['viewmoreurl'] = new moodle_url($baseurl, array('browse' => 'courses', 'page' => 1));
1662             $catdisplayoptions['viewmoreurl'] = new moodle_url($baseurl, array('browse' => 'categories', 'page' => 1));
1663         }
1664         $chelper->set_courses_display_options($coursedisplayoptions)->set_categories_display_options($catdisplayoptions);
1665         // Add course search form.
1666         $output .= $this->course_search_form();
1668         // Display course category tree.
1669         $output .= $this->coursecat_tree($chelper, $coursecat);
1671         // Add action buttons
1672         $output .= $this->container_start('buttons');
1673         $context = get_category_or_system_context($coursecat->id);
1674         if (has_capability('moodle/course:create', $context)) {
1675             // Print link to create a new course, for the 1st available category.
1676             if ($coursecat->id) {
1677                 $url = new moodle_url('/course/edit.php', array('category' => $coursecat->id, 'returnto' => 'category'));
1678             } else {
1679                 $url = new moodle_url('/course/edit.php', array('category' => $CFG->defaultrequestcategory, 'returnto' => 'topcat'));
1680             }
1681             $output .= $this->single_button($url, get_string('addnewcourse'), 'get');
1682         }
1683         ob_start();
1684         if (core_course_category::count_all() == 1) {
1685             print_course_request_buttons(context_system::instance());
1686         } else {
1687             print_course_request_buttons($context);
1688         }
1689         $output .= ob_get_contents();
1690         ob_end_clean();
1691         $output .= $this->container_end();
1693         return $output;
1694     }
1696     /**
1697      * Serves requests to /course/category.ajax.php
1698      *
1699      * In this renderer implementation it may expand the category content or
1700      * course content.
1701      *
1702      * @return string
1703      * @throws coding_exception
1704      */
1705     public function coursecat_ajax() {
1706         global $DB, $CFG;
1708         $type = required_param('type', PARAM_INT);
1710         if ($type === self::COURSECAT_TYPE_CATEGORY) {
1711             // This is a request for a category list of some kind.
1712             $categoryid = required_param('categoryid', PARAM_INT);
1713             $showcourses = required_param('showcourses', PARAM_INT);
1714             $depth = required_param('depth', PARAM_INT);
1716             $category = core_course_category::get($categoryid);
1718             $chelper = new coursecat_helper();
1719             $baseurl = new moodle_url('/course/index.php', array('categoryid' => $categoryid));
1720             $coursedisplayoptions = array(
1721                 'limit' => $CFG->coursesperpage,
1722                 'viewmoreurl' => new moodle_url($baseurl, array('browse' => 'courses', 'page' => 1))
1723             );
1724             $catdisplayoptions = array(
1725                 'limit' => $CFG->coursesperpage,
1726                 'viewmoreurl' => new moodle_url($baseurl, array('browse' => 'categories', 'page' => 1))
1727             );
1728             $chelper->set_show_courses($showcourses)->
1729                     set_courses_display_options($coursedisplayoptions)->
1730                     set_categories_display_options($catdisplayoptions);
1732             return $this->coursecat_category_content($chelper, $category, $depth);
1733         } else if ($type === self::COURSECAT_TYPE_COURSE) {
1734             // This is a request for the course information.
1735             $courseid = required_param('courseid', PARAM_INT);
1737             $course = $DB->get_record('course', array('id' => $courseid), '*', MUST_EXIST);
1739             $chelper = new coursecat_helper();
1740             $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_EXPANDED);
1741             return $this->coursecat_coursebox_content($chelper, $course);
1742         } else {
1743             throw new coding_exception('Invalid request type');
1744         }
1745     }
1747     /**
1748      * Renders html to display search result page
1749      *
1750      * @param array $searchcriteria may contain elements: search, blocklist, modulelist, tagid
1751      * @return string
1752      */
1753     public function search_courses($searchcriteria) {
1754         global $CFG;
1755         $content = '';
1756         if (!empty($searchcriteria)) {
1757             // print search results
1759             $displayoptions = array('sort' => array('displayname' => 1));
1760             // take the current page and number of results per page from query
1761             $perpage = optional_param('perpage', 0, PARAM_RAW);
1762             if ($perpage !== 'all') {
1763                 $displayoptions['limit'] = ((int)$perpage <= 0) ? $CFG->coursesperpage : (int)$perpage;
1764                 $page = optional_param('page', 0, PARAM_INT);
1765                 $displayoptions['offset'] = $displayoptions['limit'] * $page;
1766             }
1767             // options 'paginationurl' and 'paginationallowall' are only used in method coursecat_courses()
1768             $displayoptions['paginationurl'] = new moodle_url('/course/search.php', $searchcriteria);
1769             $displayoptions['paginationallowall'] = true; // allow adding link 'View all'
1771             $class = 'course-search-result';
1772             foreach ($searchcriteria as $key => $value) {
1773                 if (!empty($value)) {
1774                     $class .= ' course-search-result-'. $key;
1775                 }
1776             }
1777             $chelper = new coursecat_helper();
1778             $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_EXPANDED_WITH_CAT)->
1779                     set_courses_display_options($displayoptions)->
1780                     set_search_criteria($searchcriteria)->
1781                     set_attributes(array('class' => $class));
1783             $courses = core_course_category::search_courses($searchcriteria, $chelper->get_courses_display_options());
1784             $totalcount = core_course_category::search_courses_count($searchcriteria);
1785             $courseslist = $this->coursecat_courses($chelper, $courses, $totalcount);
1787             if (!$totalcount) {
1788                 if (!empty($searchcriteria['search'])) {
1789                     $content .= $this->heading(get_string('nocoursesfound', '', $searchcriteria['search']));
1790                 } else {
1791                     $content .= $this->heading(get_string('novalidcourses'));
1792                 }
1793             } else {
1794                 $content .= $this->heading(get_string('searchresults'). ": $totalcount");
1795                 $content .= $courseslist;
1796             }
1798             if (!empty($searchcriteria['search'])) {
1799                 // print search form only if there was a search by search string, otherwise it is confusing
1800                 $content .= $this->box_start('generalbox mdl-align');
1801                 $content .= $this->course_search_form($searchcriteria['search']);
1802                 $content .= $this->box_end();
1803             }
1804         } else {
1805             // just print search form
1806             $content .= $this->box_start('generalbox mdl-align');
1807             $content .= $this->course_search_form();
1808             $content .= $this->box_end();
1809         }
1810         return $content;
1811     }
1813     /**
1814      * Renders html to print list of courses tagged with particular tag
1815      *
1816      * @param int $tagid id of the tag
1817      * @param bool $exclusivemode if set to true it means that no other entities tagged with this tag
1818      *             are displayed on the page and the per-page limit may be bigger
1819      * @param int $fromctx context id where the link was displayed, may be used by callbacks
1820      *            to display items in the same context first
1821      * @param int $ctx context id where to search for records
1822      * @param bool $rec search in subcontexts as well
1823      * @param array $displayoptions
1824      * @return string empty string if no courses are marked with this tag or rendered list of courses
1825      */
1826     public function tagged_courses($tagid, $exclusivemode = true, $ctx = 0, $rec = true, $displayoptions = null) {
1827         global $CFG;
1828         if (empty($displayoptions)) {
1829             $displayoptions = array();
1830         }
1831         $showcategories = core_course_category::count_all() > 1;
1832         $displayoptions += array('limit' => $CFG->coursesperpage, 'offset' => 0);
1833         $chelper = new coursecat_helper();
1834         $searchcriteria = array('tagid' => $tagid, 'ctx' => $ctx, 'rec' => $rec);
1835         $chelper->set_show_courses($showcategories ? self::COURSECAT_SHOW_COURSES_EXPANDED_WITH_CAT :
1836                     self::COURSECAT_SHOW_COURSES_EXPANDED)->
1837                 set_search_criteria($searchcriteria)->
1838                 set_courses_display_options($displayoptions)->
1839                 set_attributes(array('class' => 'course-search-result course-search-result-tagid'));
1840                 // (we set the same css class as in search results by tagid)
1841         if ($totalcount = core_course_category::search_courses_count($searchcriteria)) {
1842             $courses = core_course_category::search_courses($searchcriteria, $chelper->get_courses_display_options());
1843             if ($exclusivemode) {
1844                 return $this->coursecat_courses($chelper, $courses, $totalcount);
1845             } else {
1846                 $tagfeed = new core_tag\output\tagfeed();
1847                 $img = $this->output->pix_icon('i/course', '');
1848                 foreach ($courses as $course) {
1849                     $url = course_get_url($course);
1850                     $imgwithlink = html_writer::link($url, $img);
1851                     $coursename = html_writer::link($url, $course->get_formatted_name());
1852                     $details = '';
1853                     if ($showcategories && ($cat = core_course_category::get($course->category, IGNORE_MISSING))) {
1854                         $details = get_string('category').': '.
1855                                 html_writer::link(new moodle_url('/course/index.php', array('categoryid' => $cat->id)),
1856                                         $cat->get_formatted_name(), array('class' => $cat->visible ? '' : 'dimmed'));
1857                     }
1858                     $tagfeed->add($imgwithlink, $coursename, $details);
1859                 }
1860                 return $this->output->render_from_template('core_tag/tagfeed', $tagfeed->export_for_template($this->output));
1861             }
1862         }
1863         return '';
1864     }
1866     /**
1867      * Returns HTML to display one remote course
1868      *
1869      * @param stdClass $course remote course information, contains properties:
1870            id, remoteid, shortname, fullname, hostid, summary, summaryformat, cat_name, hostname
1871      * @return string
1872      */
1873     protected function frontpage_remote_course(stdClass $course) {
1874         $url = new moodle_url('/auth/mnet/jump.php', array(
1875             'hostid' => $course->hostid,
1876             'wantsurl' => '/course/view.php?id='. $course->remoteid
1877         ));
1879         $output = '';
1880         $output .= html_writer::start_tag('div', array('class' => 'coursebox remotecoursebox clearfix'));
1881         $output .= html_writer::start_tag('div', array('class' => 'info'));
1882         $output .= html_writer::start_tag('h3', array('class' => 'name'));
1883         $output .= html_writer::link($url, format_string($course->fullname), array('title' => get_string('entercourse')));
1884         $output .= html_writer::end_tag('h3'); // .name
1885         $output .= html_writer::tag('div', '', array('class' => 'moreinfo'));
1886         $output .= html_writer::end_tag('div'); // .info
1887         $output .= html_writer::start_tag('div', array('class' => 'content'));
1888         $output .= html_writer::start_tag('div', array('class' => 'summary'));
1889         $options = new stdClass();
1890         $options->noclean = true;
1891         $options->para = false;
1892         $options->overflowdiv = true;
1893         $output .= format_text($course->summary, $course->summaryformat, $options);
1894         $output .= html_writer::end_tag('div'); // .summary
1895         $addinfo = format_string($course->hostname) . ' : '
1896             . format_string($course->cat_name) . ' : '
1897             . format_string($course->shortname);
1898         $output .= html_writer::tag('div', $addinfo, array('class' => 'remotecourseinfo'));
1899         $output .= html_writer::end_tag('div'); // .content
1900         $output .= html_writer::end_tag('div'); // .coursebox
1901         return $output;
1902     }
1904     /**
1905      * Returns HTML to display one remote host
1906      *
1907      * @param array $host host information, contains properties: name, url, count
1908      * @return string
1909      */
1910     protected function frontpage_remote_host($host) {
1911         $output = '';
1912         $output .= html_writer::start_tag('div', array('class' => 'coursebox remotehost clearfix'));
1913         $output .= html_writer::start_tag('div', array('class' => 'info'));
1914         $output .= html_writer::start_tag('h3', array('class' => 'name'));
1915         $output .= html_writer::link($host['url'], s($host['name']), array('title' => s($host['name'])));
1916         $output .= html_writer::end_tag('h3'); // .name
1917         $output .= html_writer::tag('div', '', array('class' => 'moreinfo'));
1918         $output .= html_writer::end_tag('div'); // .info
1919         $output .= html_writer::start_tag('div', array('class' => 'content'));
1920         $output .= html_writer::start_tag('div', array('class' => 'summary'));
1921         $output .= $host['count'] . ' ' . get_string('courses');
1922         $output .= html_writer::end_tag('div'); // .content
1923         $output .= html_writer::end_tag('div'); // .coursebox
1924         return $output;
1925     }
1927     /**
1928      * Returns HTML to print list of courses user is enrolled to for the frontpage
1929      *
1930      * Also lists remote courses or remote hosts if MNET authorisation is used
1931      *
1932      * @return string
1933      */
1934     public function frontpage_my_courses() {
1935         global $USER, $CFG, $DB;
1937         if (!isloggedin() or isguestuser()) {
1938             return '';
1939         }
1941         $output = '';
1942         $courses  = enrol_get_my_courses('summary, summaryformat');
1943         $rhosts   = array();
1944         $rcourses = array();
1945         if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
1946             $rcourses = get_my_remotecourses($USER->id);
1947             $rhosts   = get_my_remotehosts();
1948         }
1950         if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
1952             $chelper = new coursecat_helper();
1953             if (count($courses) > $CFG->frontpagecourselimit) {
1954                 // There are more enrolled courses than we can display, display link to 'My courses'.
1955                 $totalcount = count($courses);
1956                 $courses = array_slice($courses, 0, $CFG->frontpagecourselimit, true);
1957                 $chelper->set_courses_display_options(array(
1958                         'viewmoreurl' => new moodle_url('/my/'),
1959                         'viewmoretext' => new lang_string('mycourses')
1960                     ));
1961             } else {
1962                 // All enrolled courses are displayed, display link to 'All courses' if there are more courses in system.
1963                 $chelper->set_courses_display_options(array(
1964                         'viewmoreurl' => new moodle_url('/course/index.php'),
1965                         'viewmoretext' => new lang_string('fulllistofcourses')
1966                     ));
1967                 $totalcount = $DB->count_records('course') - 1;
1968             }
1969             $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_EXPANDED)->
1970                     set_attributes(array('class' => 'frontpage-course-list-enrolled'));
1971             $output .= $this->coursecat_courses($chelper, $courses, $totalcount);
1973             // MNET
1974             if (!empty($rcourses)) {
1975                 // at the IDP, we know of all the remote courses
1976                 $output .= html_writer::start_tag('div', array('class' => 'courses'));
1977                 foreach ($rcourses as $course) {
1978                     $output .= $this->frontpage_remote_course($course);
1979                 }
1980                 $output .= html_writer::end_tag('div'); // .courses
1981             } elseif (!empty($rhosts)) {
1982                 // non-IDP, we know of all the remote servers, but not courses
1983                 $output .= html_writer::start_tag('div', array('class' => 'courses'));
1984                 foreach ($rhosts as $host) {
1985                     $output .= $this->frontpage_remote_host($host);
1986                 }
1987                 $output .= html_writer::end_tag('div'); // .courses
1988             }
1989         }
1990         return $output;
1991     }
1993     /**
1994      * Returns HTML to print list of available courses for the frontpage
1995      *
1996      * @return string
1997      */
1998     public function frontpage_available_courses() {
1999         global $CFG;
2001         $chelper = new coursecat_helper();
2002         $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_EXPANDED)->
2003                 set_courses_display_options(array(
2004                     'recursive' => true,
2005                     'limit' => $CFG->frontpagecourselimit,
2006                     'viewmoreurl' => new moodle_url('/course/index.php'),
2007                     'viewmoretext' => new lang_string('fulllistofcourses')));
2009         $chelper->set_attributes(array('class' => 'frontpage-course-list-all'));
2010         $courses = core_course_category::get(0)->get_courses($chelper->get_courses_display_options());
2011         $totalcount = core_course_category::get(0)->get_courses_count($chelper->get_courses_display_options());
2012         if (!$totalcount && !$this->page->user_is_editing() && has_capability('moodle/course:create', context_system::instance())) {
2013             // Print link to create a new course, for the 1st available category.
2014             return $this->add_new_course_button();
2015         }
2016         return $this->coursecat_courses($chelper, $courses, $totalcount);
2017     }
2019     /**
2020      * Returns HTML to the "add new course" button for the page
2021      *
2022      * @return string
2023      */
2024     public function add_new_course_button() {
2025         global $CFG;
2026         // Print link to create a new course, for the 1st available category.
2027         $output = $this->container_start('buttons');
2028         $url = new moodle_url('/course/edit.php', array('category' => $CFG->defaultrequestcategory, 'returnto' => 'topcat'));
2029         $output .= $this->single_button($url, get_string('addnewcourse'), 'get');
2030         $output .= $this->container_end('buttons');
2031         return $output;
2032     }
2034     /**
2035      * Returns HTML to print tree with course categories and courses for the frontpage
2036      *
2037      * @return string
2038      */
2039     public function frontpage_combo_list() {
2040         global $CFG;
2041         $chelper = new coursecat_helper();
2042         $chelper->set_subcat_depth($CFG->maxcategorydepth)->
2043             set_categories_display_options(array(
2044                 'limit' => $CFG->coursesperpage,
2045                 'viewmoreurl' => new moodle_url('/course/index.php',
2046                         array('browse' => 'categories', 'page' => 1))
2047             ))->
2048             set_courses_display_options(array(
2049                 'limit' => $CFG->coursesperpage,
2050                 'viewmoreurl' => new moodle_url('/course/index.php',
2051                         array('browse' => 'courses', 'page' => 1))
2052             ))->
2053             set_attributes(array('class' => 'frontpage-category-combo'));
2054         return $this->coursecat_tree($chelper, core_course_category::get(0));
2055     }
2057     /**
2058      * Returns HTML to print tree of course categories (with number of courses) for the frontpage
2059      *
2060      * @return string
2061      */
2062     public function frontpage_categories_list() {
2063         global $CFG;
2064         $chelper = new coursecat_helper();
2065         $chelper->set_subcat_depth($CFG->maxcategorydepth)->
2066                 set_show_courses(self::COURSECAT_SHOW_COURSES_COUNT)->
2067                 set_categories_display_options(array(
2068                     'limit' => $CFG->coursesperpage,
2069                     'viewmoreurl' => new moodle_url('/course/index.php',
2070                             array('browse' => 'categories', 'page' => 1))
2071                 ))->
2072                 set_attributes(array('class' => 'frontpage-category-names'));
2073         return $this->coursecat_tree($chelper, core_course_category::get(0));
2074     }
2076     /**
2077      * Renders the activity navigation.
2078      *
2079      * Defer to template.
2080      *
2081      * @param \core_course\output\activity_navigation $page
2082      * @return string html for the page
2083      */
2084     public function render_activity_navigation(\core_course\output\activity_navigation $page) {
2085         $data = $page->export_for_template($this->output);
2086         return $this->output->render_from_template('core_course/activity_navigation', $data);
2087     }
2089     /**
2090      * Display the selector to advertise or publish a course
2091      * @param int $courseid
2092      */
2093     public function publicationselector($courseid) {
2094         $text = '';
2096         $advertiseurl = new moodle_url("/course/publish/metadata.php",
2097             array('sesskey' => sesskey(), 'id' => $courseid, 'advertise' => true));
2098         $advertisebutton = new single_button($advertiseurl, get_string('advertise', 'hub'));
2099         $text .= $this->output->render($advertisebutton);
2100         $text .= html_writer::tag('div', get_string('advertisepublication_help', 'hub'),
2101             array('class' => 'publishhelp'));
2103         $text .= html_writer::empty_tag('br');  // TODO Delete.
2105         $uploadurl = new moodle_url("/course/publish/metadata.php",
2106             array('sesskey' => sesskey(), 'id' => $courseid, 'share' => true));
2107         $uploadbutton = new single_button($uploadurl, get_string('share', 'hub'));
2108         $text .= $this->output->render($uploadbutton);
2109         $text .= html_writer::tag('div', get_string('sharepublication_help', 'hub'),
2110             array('class' => 'publishhelp'));
2112         return $text;
2113     }
2115     /**
2116      * Display the listing of hub where a course is registered on
2117      * @param int $courseid
2118      * @param array $publications
2119      */
2120     public function registeredonhublisting($courseid, $publications) {
2121         global $CFG;
2122         $table = new html_table();
2123         $table->head = array(get_string('type', 'hub'),
2124             get_string('date'), get_string('status', 'hub'), get_string('operation', 'hub'));
2125         $table->size = array('20%', '30%', '%20', '%25');
2127         $brtag = html_writer::empty_tag('br');
2129         foreach ($publications as $publication) {
2131             $params = array('id' => $publication->courseid, 'publicationid' => $publication->id);
2132             $cancelurl = new moodle_url("/course/publish/index.php", $params);
2133             $cancelbutton = new single_button($cancelurl, get_string('removefromhub', 'hub'));
2134             $cancelbutton->class = 'centeredbutton';
2135             $cancelbuttonhtml = $this->output->render($cancelbutton);
2137             if ($publication->enrollable) {
2138                 $params = array('sesskey' => sesskey(), 'id' => $publication->courseid, 'publicationid' => $publication->id);
2139                 $updateurl = new moodle_url("/course/publish/metadata.php", $params);
2140                 $updatebutton = new single_button($updateurl, get_string('update', 'hub'));
2141                 $updatebutton->class = 'centeredbutton';
2142                 $updatebuttonhtml = $this->output->render($updatebutton);
2144                 $operations = $updatebuttonhtml . $brtag . $cancelbuttonhtml;
2145             } else {
2146                 $operations = $cancelbuttonhtml;
2147             }
2149             // If the publication check time if bigger than May 2010, it has been checked.
2150             if ($publication->timechecked > 1273127954) {
2151                 if ($publication->status == 0) {
2152                     $status = get_string('statusunpublished', 'hub');
2153                 } else {
2154                     $status = get_string('statuspublished', 'hub');
2155                     if (!empty($publication->link)) {
2156                         $status = html_writer::link($publication->link, $status);
2157                     }
2158                 }
2160                 $status .= $brtag . html_writer::tag('a', get_string('updatestatus', 'hub'),
2161                         array('href' => $CFG->wwwroot . '/course/publish/index.php?id='
2162                             . $courseid . "&updatestatusid=" . $publication->id
2163                             . "&sesskey=" . sesskey())) .
2164                     $brtag . get_string('lasttimechecked', 'hub') . ": "
2165                     . format_time(time() - $publication->timechecked);
2166             } else {
2167                 $status = get_string('neverchecked', 'hub') . $brtag
2168                     . html_writer::tag('a', get_string('updatestatus', 'hub'),
2169                         array('href' => $CFG->wwwroot . '/course/publish/index.php?id='
2170                             . $courseid . "&updatestatusid=" . $publication->id
2171                             . "&sesskey=" . sesskey()));
2172             }
2173             // Add button cells.
2174             $cells = array($publication->enrollable ?
2175                 get_string('advertised', 'hub') : get_string('shared', 'hub'),
2176                 userdate($publication->timepublished,
2177                     get_string('strftimedatetimeshort')), $status, $operations);
2178             $row = new html_table_row($cells);
2179             $table->data[] = $row;
2180         }
2182         $contenthtml = html_writer::table($table);
2184         return $contenthtml;
2185     }
2187     /**
2188      * Display unpublishing confirmation page
2189      * @param stdClass $publication
2190      *      $publication->courseshortname
2191      *      $publication->courseid
2192      *      $publication->hubname
2193      *      $publication->huburl
2194      *      $publication->id
2195      */
2196     public function confirmunpublishing($publication) {
2197         $optionsyes = array('sesskey' => sesskey(), 'id' => $publication->courseid,
2198             'hubcourseid' => $publication->hubcourseid,
2199             'cancel' => true, 'publicationid' => $publication->id, 'confirm' => true);
2200         $optionsno = array('sesskey' => sesskey(), 'id' => $publication->courseid);
2201         $publication->hubname = html_writer::tag('a', 'Moodle.net',
2202             array('href' => HUB_MOODLEORGHUBURL));
2203         $formcontinue = new single_button(new moodle_url("/course/publish/index.php",
2204             $optionsyes), get_string('unpublish', 'hub'), 'post');
2205         $formcancel = new single_button(new moodle_url("/course/publish/index.php",
2206             $optionsno), get_string('cancel'), 'get');
2207         return $this->output->confirm(get_string('unpublishconfirmation', 'hub', $publication),
2208             $formcontinue, $formcancel);
2209     }
2211     /**
2212      * Display waiting information about backup size during uploading backup process
2213      * @param object $backupfile the backup stored_file
2214      * @return $html string
2215      */
2216     public function sendingbackupinfo($backupfile) {
2217         $sizeinfo = new stdClass();
2218         $sizeinfo->total = number_format($backupfile->get_filesize() / 1000000, 2);
2219         $html = html_writer::tag('div', get_string('sendingsize', 'hub', $sizeinfo),
2220             array('class' => 'courseuploadtextinfo'));
2221         return $html;
2222     }
2224     /**
2225      * Display upload successfull message and a button to the publish index page
2226      * @param int $id the course id
2227      * @return $html string
2228      */
2229     public function sentbackupinfo($id) {
2230         $html = html_writer::tag('div', get_string('sent', 'hub'),
2231             array('class' => 'courseuploadtextinfo'));
2232         $publishindexurl = new moodle_url('/course/publish/index.php',
2233             array('sesskey' => sesskey(), 'id' => $id,
2234                 'published' => true));
2235         $continue = $this->output->render(
2236             new single_button($publishindexurl, get_string('continue')));
2237         $html .= html_writer::tag('div', $continue, array('class' => 'sharecoursecontinue'));
2238         return $html;
2239     }
2241     /**
2242      * Hub information (logo - name - description - link)
2243      * @param object $hubinfo
2244      * @return string html code
2245      */
2246     public function hubinfo($hubinfo) {
2247         $screenshothtml = html_writer::empty_tag('img',
2248             array('src' => $hubinfo['imgurl'], 'alt' => $hubinfo['name']));
2249         $hubdescription = html_writer::tag('div', $screenshothtml,
2250             array('class' => 'hubscreenshot'));
2252         $hubdescription .= html_writer::tag('a', $hubinfo['name'],
2253             array('class' => 'hublink', 'href' => $hubinfo['url'],
2254                 'onclick' => 'this.target="_blank"'));
2256         $hubdescription .= html_writer::tag('div', format_text($hubinfo['description'], FORMAT_PLAIN),
2257             array('class' => 'hubdescription'));
2258         $hubdescription = html_writer::tag('div', $hubdescription, array('class' => 'hubinfo clearfix'));
2260         return $hubdescription;
2261     }
2263     /**
2264      * Output frontpage summary text and frontpage modules (stored as section 1 in site course)
2265      *
2266      * This may be disabled in settings
2267      *
2268      * @return string
2269      */
2270     public function frontpage_section1() {
2271         global $SITE, $USER;
2273         $output = '';
2274         $editing = $this->page->user_is_editing();
2276         if ($editing) {
2277             // Make sure section with number 1 exists.
2278             course_create_sections_if_missing($SITE, 1);
2279         }
2281         $modinfo = get_fast_modinfo($SITE);
2282         $section = $modinfo->get_section_info(1);
2283         if (($section && (!empty($modinfo->sections[1]) or !empty($section->summary))) or $editing) {
2284             $output .= $this->box_start('generalbox sitetopic');
2286             // If currently moving a file then show the current clipboard.
2287             if (ismoving($SITE->id)) {
2288                 $stractivityclipboard = strip_tags(get_string('activityclipboard', '', $USER->activitycopyname));
2289                 $output .= '<p><font size="2">';
2290                 $cancelcopyurl = new moodle_url('/course/mod.php', ['cancelcopy' => 'true', 'sesskey' => sesskey()]);
2291                 $output .= "$stractivityclipboard&nbsp;&nbsp;(" . html_writer::link($cancelcopyurl, get_string('cancel')) .')';
2292                 $output .= '</font></p>';
2293             }
2295             $context = context_course::instance(SITEID);
2297             // If the section name is set we show it.
2298             if (trim($section->name) !== '') {
2299                 $output .= $this->heading(
2300                     format_string($section->name, true, array('context' => $context)),
2301                     2,
2302                     'sectionname'
2303                 );
2304             }
2306             $summarytext = file_rewrite_pluginfile_urls($section->summary,
2307                 'pluginfile.php',
2308                 $context->id,
2309                 'course',
2310                 'section',
2311                 $section->id);
2312             $summaryformatoptions = new stdClass();
2313             $summaryformatoptions->noclean = true;
2314             $summaryformatoptions->overflowdiv = true;
2316             $output .= format_text($summarytext, $section->summaryformat, $summaryformatoptions);
2318             if ($editing && has_capability('moodle/course:update', $context)) {
2319                 $streditsummary = get_string('editsummary');
2320                 $editsectionurl = new moodle_url('/course/editsection.php', ['id' => $section->id]);
2321                 $output .= html_writer::link($editsectionurl, $this->pix_icon('t/edit', $streditsummary)) .
2322                     "<br /><br />";
2323             }
2325             $output .= $this->course_section_cm_list($SITE, $section);
2327             $output .= $this->course_section_add_cm_control($SITE, $section->section);
2328             $output .= $this->box_end();
2329         }
2331         return $output;
2332     }
2334     /**
2335      * Output news for the frontpage (extract from site-wide news forum)
2336      *
2337      * @param stdClass $forum record from db table 'forum' that represents the site news forum
2338      * @return string
2339      */
2340     protected function frontpage_news($forum) {
2341         global $CFG, $SITE, $SESSION, $USER;
2342         require_once($CFG->dirroot .'/mod/forum/lib.php');
2344         $output = '';
2346         if (isloggedin()) {
2347             $SESSION->fromdiscussion = $CFG->wwwroot;
2348             $subtext = '';
2349             if (\mod_forum\subscriptions::is_subscribed($USER->id, $forum)) {
2350                 if (!\mod_forum\subscriptions::is_forcesubscribed($forum)) {
2351                     $subtext = get_string('unsubscribe', 'forum');
2352                 }
2353             } else {
2354                 $subtext = get_string('subscribe', 'forum');
2355             }
2356             $suburl = new moodle_url('/mod/forum/subscribe.php', array('id' => $forum->id, 'sesskey' => sesskey()));
2357             $output .= html_writer::tag('div', html_writer::link($suburl, $subtext), array('class' => 'subscribelink'));
2358         }
2360         $coursemodule = get_coursemodule_from_instance('forum', $forum->id);
2361         $context = context_module::instance($coursemodule->id);
2363         $entityfactory = mod_forum\local\container::get_entity_factory();
2364         $forumentity = $entityfactory->get_forum_from_stdclass($forum, $context, $coursemodule, $SITE);
2366         $rendererfactory = mod_forum\local\container::get_renderer_factory();
2367         $discussionsrenderer = $rendererfactory->get_frontpage_news_discussion_list_renderer($forumentity);
2368         $cm = \cm_info::create($coursemodule);
2369         return $output . $discussionsrenderer->render($USER, $cm, null, null, 0, $SITE->newsitems);
2370     }
2372     /**
2373      * Renders part of frontpage with a skip link (i.e. "My courses", "Site news", etc.)
2374      *
2375      * @param string $skipdivid
2376      * @param string $contentsdivid
2377      * @param string $header Header of the part
2378      * @param string $contents Contents of the part
2379      * @return string
2380      */
2381     protected function frontpage_part($skipdivid, $contentsdivid, $header, $contents) {
2382         $output = html_writer::link('#' . $skipdivid,
2383             get_string('skipa', 'access', core_text::strtolower(strip_tags($header))),
2384             array('class' => 'skip-block skip'));
2386         // Wrap frontpage part in div container.
2387         $output .= html_writer::start_tag('div', array('id' => $contentsdivid));
2388         $output .= $this->heading($header);
2390         $output .= $contents;
2392         // End frontpage part div container.
2393         $output .= html_writer::end_tag('div');
2395         $output .= html_writer::tag('span', '', array('class' => 'skip-block-to', 'id' => $skipdivid));
2396         return $output;
2397     }
2399     /**
2400      * Outputs contents for frontpage as configured in $CFG->frontpage or $CFG->frontpageloggedin
2401      *
2402      * @return string
2403      */
2404     public function frontpage() {
2405         global $CFG, $SITE;
2407         $output = '';
2409         if (isloggedin() and !isguestuser() and isset($CFG->frontpageloggedin)) {
2410             $frontpagelayout = $CFG->frontpageloggedin;
2411         } else {
2412             $frontpagelayout = $CFG->frontpage;
2413         }
2415         foreach (explode(',', $frontpagelayout) as $v) {
2416             switch ($v) {
2417                 // Display the main part of the front page.
2418                 case FRONTPAGENEWS:
2419                     if ($SITE->newsitems) {
2420                         // Print forums only when needed.
2421                         require_once($CFG->dirroot .'/mod/forum/lib.php');
2422                         if (($newsforum = forum_get_course_forum($SITE->id, 'news')) &&
2423                                 ($forumcontents = $this->frontpage_news($newsforum))) {
2424                             $newsforumcm = get_fast_modinfo($SITE)->instances['forum'][$newsforum->id];
2425                             $output .= $this->frontpage_part('skipsitenews', 'site-news-forum',
2426                                 $newsforumcm->get_formatted_name(), $forumcontents);
2427                         }
2428                     }
2429                     break;
2431                 case FRONTPAGEENROLLEDCOURSELIST:
2432                     $mycourseshtml = $this->frontpage_my_courses();
2433                     if (!empty($mycourseshtml)) {
2434                         $output .= $this->frontpage_part('skipmycourses', 'frontpage-course-list',
2435                             get_string('mycourses'), $mycourseshtml);
2436                     }
2437                     break;
2439                 case FRONTPAGEALLCOURSELIST:
2440                     $availablecourseshtml = $this->frontpage_available_courses();
2441                     if (!empty($availablecourseshtml)) {
2442                         $output .= $this->frontpage_part('skipavailablecourses', 'frontpage-available-course-list',
2443                             get_string('availablecourses'), $availablecourseshtml);
2444                     }
2445                     break;
2447                 case FRONTPAGECATEGORYNAMES:
2448                     $output .= $this->frontpage_part('skipcategories', 'frontpage-category-names',
2449                         get_string('categories'), $this->frontpage_categories_list());
2450                     break;
2452                 case FRONTPAGECATEGORYCOMBO:
2453                     $output .= $this->frontpage_part('skipcourses', 'frontpage-category-combo',
2454                         get_string('courses'), $this->frontpage_combo_list());
2455                     break;
2457                 case FRONTPAGECOURSESEARCH:
2458                     $output .= $this->box($this->course_search_form('', 'short'), 'mdl-align');
2459                     break;
2461             }
2462             $output .= '<br />';
2463         }
2465         return $output;
2466     }
2469 /**
2470  * Class storing display options and functions to help display course category and/or courses lists
2471  *
2472  * This is a wrapper for core_course_category objects that also stores display options
2473  * and functions to retrieve sorted and paginated lists of categories/courses.
2474  *
2475  * If theme overrides methods in core_course_renderers that access this class
2476  * it may as well not use this class at all or extend it.
2477  *
2478  * @package   core
2479  * @copyright 2013 Marina Glancy
2480  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2481  */
2482 class coursecat_helper {
2483     /** @var string [none, collapsed, expanded] how (if) display courses list */
2484     protected $showcourses = 10; /* core_course_renderer::COURSECAT_SHOW_COURSES_COLLAPSED */
2485     /** @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) */
2486     protected $subcatdepth = 1;
2487     /** @var array options to display courses list */
2488     protected $coursesdisplayoptions = array();
2489     /** @var array options to display subcategories list */
2490     protected $categoriesdisplayoptions = array();
2491     /** @var array additional HTML attributes */
2492     protected $attributes = array();
2493     /** @var array search criteria if the list is a search result */
2494     protected $searchcriteria = null;
2496     /**
2497      * Sets how (if) to show the courses - none, collapsed, expanded, etc.
2498      *
2499      * @param int $showcourses SHOW_COURSES_NONE, SHOW_COURSES_COLLAPSED, SHOW_COURSES_EXPANDED, etc.
2500      * @return coursecat_helper
2501      */
2502     public function set_show_courses($showcourses) {
2503         $this->showcourses = $showcourses;
2504         // Automatically set the options to preload summary and coursecontacts for core_course_category::get_courses()
2505         // and core_course_category::search_courses().
2506         $this->coursesdisplayoptions['summary'] = $showcourses >= core_course_renderer::COURSECAT_SHOW_COURSES_AUTO;
2507         $this->coursesdisplayoptions['coursecontacts'] = $showcourses >= core_course_renderer::COURSECAT_SHOW_COURSES_EXPANDED;
2508         $this->coursesdisplayoptions['customfields'] = $showcourses >= core_course_renderer::COURSECAT_SHOW_COURSES_COLLAPSED;
2509         return $this;
2510     }
2512     /**
2513      * Returns how (if) to show the courses - none, collapsed, expanded, etc.
2514      *
2515      * @return int - COURSECAT_SHOW_COURSES_NONE, COURSECAT_SHOW_COURSES_COLLAPSED, COURSECAT_SHOW_COURSES_EXPANDED, etc.
2516      */
2517     public function get_show_courses() {
2518         return $this->showcourses;
2519     }
2521     /**
2522      * Sets the maximum depth to expand subcategories in the tree
2523      *
2524      * deeper subcategories may be loaded by AJAX or proceed to category page by clicking on category name
2525      *
2526      * @param int $subcatdepth
2527      * @return coursecat_helper
2528      */
2529     public function set_subcat_depth($subcatdepth) {
2530         $this->subcatdepth = $subcatdepth;
2531         return $this;
2532     }
2534     /**
2535      * Returns the maximum depth to expand subcategories in the tree
2536      *
2537      * deeper subcategories may be loaded by AJAX or proceed to category page by clicking on category name
2538      *
2539      * @return int
2540      */
2541     public function get_subcat_depth() {
2542         return $this->subcatdepth;
2543     }
2545     /**
2546      * Sets options to display list of courses
2547      *
2548      * Options are later submitted as argument to core_course_category::get_courses() and/or core_course_category::search_courses()
2549      *
2550      * Options that core_course_category::get_courses() accept:
2551      *    - recursive - return courses from subcategories as well. Use with care,
2552      *      this may be a huge list!
2553      *    - summary - preloads fields 'summary' and 'summaryformat'
2554      *    - coursecontacts - preloads course contacts
2555      *    - customfields - preloads custom fields data
2556      *    - isenrolled - preloads indication whether this user is enrolled in the course
2557      *    - sort - list of fields to sort. Example
2558      *             array('idnumber' => 1, 'shortname' => 1, 'id' => -1)
2559      *             will sort by idnumber asc, shortname asc and id desc.
2560      *             Default: array('sortorder' => 1)
2561      *             Only cached fields may be used for sorting!
2562      *    - offset
2563      *    - limit - maximum number of children to return, 0 or null for no limit
2564      *
2565      * Options summary and coursecontacts are filled automatically in the set_show_courses()
2566      *
2567      * Also renderer can set here any additional options it wants to pass between renderer functions.
2568      *
2569      * @param array $options
2570      * @return coursecat_helper
2571      */
2572     public function set_courses_display_options($options) {
2573         $this->coursesdisplayoptions = $options;
2574         $this->set_show_courses($this->showcourses); // this will calculate special display options
2575         return $this;
2576     }
2578     /**
2579      * Sets one option to display list of courses
2580      *
2581      * @see coursecat_helper::set_courses_display_options()
2582      *
2583      * @param string $key
2584      * @param mixed $value
2585      * @return coursecat_helper
2586      */
2587     public function set_courses_display_option($key, $value) {
2588         $this->coursesdisplayoptions[$key] = $value;
2589         return $this;
2590     }
2592     /**
2593      * Return the specified option to display list of courses
2594      *
2595      * @param string $optionname option name
2596      * @param mixed $defaultvalue default value for option if it is not specified
2597      * @return mixed
2598      */
2599     public function get_courses_display_option($optionname, $defaultvalue = null) {
2600         if (array_key_exists($optionname, $this->coursesdisplayoptions)) {
2601             return $this->coursesdisplayoptions[$optionname];
2602         } else {
2603             return $defaultvalue;
2604         }
2605     }
2607     /**
2608      * Returns all options to display the courses
2609      *
2610      * This array is usually passed to {@link core_course_category::get_courses()} or
2611      * {@link core_course_category::search_courses()}
2612      *
2613      * @return array
2614      */
2615     public function get_courses_display_options() {
2616         return $this->coursesdisplayoptions;
2617     }
2619     /**
2620      * Sets options to display list of subcategories
2621      *
2622      * Options 'sort', 'offset' and 'limit' are passed to core_course_category::get_children().
2623      * Any other options may be used by renderer functions
2624      *
2625      * @param array $options
2626      * @return coursecat_helper
2627      */
2628     public function set_categories_display_options($options) {
2629         $this->categoriesdisplayoptions = $options;
2630         return $this;
2631     }
2633     /**
2634      * Return the specified option to display list of subcategories
2635      *
2636      * @param string $optionname option name
2637      * @param mixed $defaultvalue default value for option if it is not specified
2638      * @return mixed
2639      */
2640     public function get_categories_display_option($optionname, $defaultvalue = null) {
2641         if (array_key_exists($optionname, $this->categoriesdisplayoptions)) {
2642             return $this->categoriesdisplayoptions[$optionname];
2643         } else {
2644             return $defaultvalue;
2645         }
2646     }
2648     /**
2649      * Returns all options to display list of subcategories
2650      *
2651      * This array is usually passed to {@link core_course_category::get_children()}
2652      *
2653      * @return array
2654      */
2655     public function get_categories_display_options() {
2656         return $this->categoriesdisplayoptions;
2657     }
2659     /**
2660      * Sets additional general options to pass between renderer functions, usually HTML attributes
2661      *
2662      * @param array $attributes
2663      * @return coursecat_helper
2664      */
2665     public function set_attributes($attributes) {
2666         $this->attributes = $attributes;
2667         return $this;
2668     }
2670     /**
2671      * Return all attributes and erases them so they are not applied again
2672      *
2673      * @param string $classname adds additional class name to the beginning of $attributes['class']
2674      * @return array
2675      */
2676     public function get_and_erase_attributes($classname) {
2677         $attributes = $this->attributes;
2678         $this->attributes = array();
2679         if (empty($attributes['class'])) {
2680             $attributes['class'] = '';
2681         }
2682         $attributes['class'] = $classname . ' '. $attributes['class'];
2683         return $attributes;
2684     }
2686     /**
2687      * Sets the search criteria if the course is a search result
2688      *
2689      * Search string will be used to highlight terms in course name and description
2690      *
2691      * @param array $searchcriteria
2692      * @return coursecat_helper
2693      */
2694     public function set_search_criteria($searchcriteria) {
2695         $this->searchcriteria = $searchcriteria;
2696         return $this;
2697     }
2699     /**
2700      * Returns formatted and filtered description of the given category
2701      *
2702      * @param core_course_category $coursecat category
2703      * @param stdClass|array $options format options, by default [noclean,overflowdiv],
2704      *     if context is not specified it will be added automatically
2705      * @return string|null
2706      */
2707     public function get_category_formatted_description($coursecat, $options = null) {
2708         if ($coursecat->id && !empty($coursecat->description)) {
2709             if (!isset($coursecat->descriptionformat)) {
2710                 $descriptionformat = FORMAT_MOODLE;
2711             } else {
2712                 $descriptionformat = $coursecat->descriptionformat;
2713             }
2714             if ($options === null) {
2715                 $options = array('noclean' => true, 'overflowdiv' => true);
2716             } else {
2717                 $options = (array)$options;
2718             }
2719             $context = context_coursecat::instance($coursecat->id);
2720             if (!isset($options['context'])) {
2721                 $options['context'] = $context;
2722             }
2723             $text = file_rewrite_pluginfile_urls($coursecat->description,
2724                     'pluginfile.php', $context->id, 'coursecat', 'description', null);
2725             return format_text($text, $descriptionformat, $options);
2726         }
2727         return null;
2728     }
2730     /**
2731      * Returns given course's summary with proper embedded files urls and formatted
2732      *
2733      * @param core_course_list_element $course
2734      * @param array|stdClass $options additional formatting options
2735      * @return string
2736      */
2737     public function get_course_formatted_summary($course, $options = array()) {
2738         global $CFG;
2739         require_once($CFG->libdir. '/filelib.php');
2740         if (!$course->has_summary()) {
2741             return '';
2742         }
2743         $options = (array)$options;
2744         $context = context_course::instance($course->id);
2745         if (!isset($options['context'])) {
2746             // TODO see MDL-38521
2747             // option 1 (current), page context - no code required
2748             // option 2, system context
2749             // $options['context'] = context_system::instance();
2750             // option 3, course context:
2751             // $options['context'] = $context;
2752             // option 4, course category context:
2753             // $options['context'] = $context->get_parent_context();
2754         }
2755         $summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', null);
2756         $summary = format_text($summary, $course->summaryformat, $options, $course->id);
2757         if (!empty($this->searchcriteria['search'])) {
2758             $summary = highlight($this->searchcriteria['search'], $summary);
2759         }
2760         return $summary;
2761     }
2763     /**
2764      * Returns course name as it is configured to appear in courses lists formatted to course context
2765      *
2766      * @param core_course_list_element $course
2767      * @param array|stdClass $options additional formatting options
2768      * @return string
2769      */
2770     public function get_course_formatted_name($course, $options = array()) {
2771         $options = (array)$options;
2772         if (!isset($options['context'])) {
2773             $options['context'] = context_course::instance($course->id);
2774         }
2775         $name = format_string(get_course_display_name_for_list($course), true, $options);
2776         if (!empty($this->searchcriteria['search'])) {
2777             $name = highlight($this->searchcriteria['search'], $name);
2778         }
2779         return $name;
2780     }