3 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
19 * Renderer for use with the course section and all the goodness that falls
22 * This renderer should contain methods useful to courses, and categories.
25 * @copyright 2010 Sam Hemelryk
26 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
30 * The core course renderer
32 * Can be retrieved with the following:
33 * $renderer = $PAGE->get_renderer('core','course');
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;
53 * Override the constructor so that we can initialise the string cache
55 * @param moodle_page $page
56 * @param string $target
58 public function __construct(moodle_page
$page, $target) {
59 $this->strings
= new stdClass
;
60 parent
::__construct($page, $target);
61 $this->add_modchoosertoggle();
65 * Adds the item in course settings navigation to toggle modchooser
67 * Theme can overwrite as an empty function to exclude it (for example if theme does not
68 * use modchooser at all)
70 protected function add_modchoosertoggle() {
73 // Only needs to be done once per page.
74 if (!$this->page
->requires
->should_create_one_time_item_now('core_course_modchoosertoggle')) {
78 if ($this->page
->state
> moodle_page
::STATE_PRINTING_HEADER ||
79 $this->page
->course
->id
== SITEID ||
80 !$this->page
->user_is_editing() ||
81 !($context = context_course
::instance($this->page
->course
->id
)) ||
82 !has_capability('moodle/course:manageactivities', $context) ||
83 !course_ajax_enabled($this->page
->course
) ||
84 !($coursenode = $this->page
->settingsnav
->find('courseadmin', navigation_node
::TYPE_COURSE
)) ||
85 !($turneditingnode = $coursenode->get('turneditingonoff'))) {
86 // Too late, or we are on site page, or we could not find the
87 // adjacent nodes in course settings menu, or we are not allowed to edit.
91 if ($this->page
->url
->compare(new moodle_url('/course/view.php'), URL_MATCH_BASE
)) {
92 // We are on the course page, retain the current page params e.g. section.
93 $modchoosertoggleurl = clone($this->page
->url
);
95 // Edit on the main course page.
96 $modchoosertoggleurl = new moodle_url('/course/view.php', array('id' => $this->page
->course
->id
,
97 'return' => $this->page
->url
->out_as_local_url(false)));
99 $modchoosertoggleurl->param('sesskey', sesskey());
100 if ($usemodchooser = get_user_preferences('usemodchooser', $CFG->modchooserdefault
)) {
101 $modchoosertogglestring = get_string('modchooserdisable', 'moodle');
102 $modchoosertoggleurl->param('modchooser', 'off');
104 $modchoosertogglestring = get_string('modchooserenable', 'moodle');
105 $modchoosertoggleurl->param('modchooser', 'on');
107 $modchoosertoggle = navigation_node
::create($modchoosertogglestring, $modchoosertoggleurl, navigation_node
::TYPE_SETTING
, null, 'modchoosertoggle');
109 // Insert the modchoosertoggle after the settings node 'turneditingonoff' (navigation_node only has function to insert before, so we insert before and then swap).
110 $coursenode->add_node($modchoosertoggle, 'turneditingonoff');
111 $turneditingnode->remove();
112 $coursenode->add_node($turneditingnode, 'modchoosertoggle');
114 $modchoosertoggle->add_class('modchoosertoggle');
115 $modchoosertoggle->add_class('visibleifjs');
116 user_preference_allow_ajax_update('usemodchooser', PARAM_BOOL
);
120 * Renders course info box.
122 * @param stdClass|course_in_list $course
125 public function course_info_box(stdClass
$course) {
127 $content .= $this->output
->box_start('generalbox info');
128 $chelper = new coursecat_helper();
129 $chelper->set_show_courses(self
::COURSECAT_SHOW_COURSES_EXPANDED
);
130 $content .= $this->coursecat_coursebox($chelper, $course);
131 $content .= $this->output
->box_end();
136 * Renderers a structured array of courses and categories into a nice XHTML tree structure.
138 * @deprecated since 2.5
140 * Please see http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
142 * @param array $ignored argument ignored
145 public final function course_category_tree(array $ignored) {
146 debugging('Function core_course_renderer::course_category_tree() is deprecated, please use frontpage_combo_list()', DEBUG_DEVELOPER
);
147 return $this->frontpage_combo_list();
151 * Renderers a category for use with course_category_tree
153 * @deprecated since 2.5
155 * Please see http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
157 * @param array $category
161 protected final function course_category_tree_category(stdClass
$category, $depth=1) {
162 debugging('Function core_course_renderer::course_category_tree_category() is deprecated', DEBUG_DEVELOPER
);
167 * Build the HTML for the module chooser javascript popup
169 * @param array $modules A set of modules as returned form @see
170 * get_module_metadata
171 * @param object $course The course that will be displayed
172 * @return string The composed HTML for the module
174 public function course_modchooser($modules, $course) {
175 if (!$this->page
->requires
->should_create_one_time_item_now('core_course_modchooser')) {
179 // Add the module chooser
180 $this->page
->requires
->yui_module('moodle-course-modchooser',
181 'M.course.init_chooser',
182 array(array('courseid' => $course->id
, 'closeButtonTitle' => get_string('close', 'editor')))
184 $this->page
->requires
->strings_for_js(array(
185 'addresourceoractivity',
191 $header = html_writer
::tag('div', get_string('addresourceoractivity', 'moodle'),
192 array('class' => 'hd choosertitle'));
194 $formcontent = html_writer
::start_tag('form', array('action' => new moodle_url('/course/jumpto.php'),
195 'id' => 'chooserform', 'method' => 'post'));
196 $formcontent .= html_writer
::start_tag('div', array('id' => 'typeformdiv'));
197 $formcontent .= html_writer
::tag('input', '', array('type' => 'hidden', 'id' => 'course',
198 'name' => 'course', 'value' => $course->id
));
199 $formcontent .= html_writer
::tag('input', '', array('type' => 'hidden', 'name' => 'sesskey',
200 'value' => sesskey()));
201 $formcontent .= html_writer
::end_tag('div');
203 // Put everything into one tag 'options'
204 $formcontent .= html_writer
::start_tag('div', array('class' => 'options'));
205 $formcontent .= html_writer
::tag('div', get_string('selectmoduletoviewhelp', 'moodle'),
206 array('class' => 'instruction'));
207 // Put all options into one tag 'alloptions' to allow us to handle scrolling
208 $formcontent .= html_writer
::start_tag('div', array('class' => 'alloptions'));
211 $activities = array_filter($modules, create_function('$mod', 'return ($mod->archetype !== MOD_ARCHETYPE_RESOURCE && $mod->archetype !== MOD_ARCHETYPE_SYSTEM);'));
212 if (count($activities)) {
213 $formcontent .= $this->course_modchooser_title('activities');
214 $formcontent .= $this->course_modchooser_module_types($activities);
218 $resources = array_filter($modules, create_function('$mod', 'return ($mod->archetype === MOD_ARCHETYPE_RESOURCE);'));
219 if (count($resources)) {
220 $formcontent .= $this->course_modchooser_title('resources');
221 $formcontent .= $this->course_modchooser_module_types($resources);
224 $formcontent .= html_writer
::end_tag('div'); // modoptions
225 $formcontent .= html_writer
::end_tag('div'); // types
227 $formcontent .= html_writer
::start_tag('div', array('class' => 'submitbuttons'));
228 $formcontent .= html_writer
::tag('input', '',
229 array('type' => 'submit', 'name' => 'submitbutton', 'class' => 'submitbutton', 'value' => get_string('add')));
230 $formcontent .= html_writer
::tag('input', '',
231 array('type' => 'submit', 'name' => 'addcancel', 'class' => 'addcancel', 'value' => get_string('cancel')));
232 $formcontent .= html_writer
::end_tag('div');
233 $formcontent .= html_writer
::end_tag('form');
235 // Wrap the whole form in a div
236 $formcontent = html_writer
::tag('div', $formcontent, array('id' => 'chooseform'));
238 // Put all of the content together
239 $content = $formcontent;
241 $content = html_writer
::tag('div', $content, array('class' => 'choosercontainer'));
242 return $header . html_writer
::tag('div', $content, array('class' => 'chooserdialoguebody'));
246 * Build the HTML for a specified set of modules
248 * @param array $modules A set of modules as used by the
249 * course_modchooser_module function
250 * @return string The composed HTML for the module
252 protected function course_modchooser_module_types($modules) {
254 foreach ($modules as $module) {
255 if (!isset($module->types
)) {
256 $return .= $this->course_modchooser_module($module);
258 $return .= $this->course_modchooser_module($module, array('nonoption'));
259 foreach ($module->types
as $type) {
260 $return .= $this->course_modchooser_module($type, array('option', 'subtype'));
268 * Return the HTML for the specified module adding any required classes
270 * @param object $module An object containing the title, and link. An
271 * icon, and help text may optionally be specified. If the module
272 * contains subtypes in the types option, then these will also be
274 * @param array $classes Additional classes to add to the encompassing
276 * @return string The composed HTML for the module
278 protected function course_modchooser_module($module, $classes = array('option')) {
280 $output .= html_writer
::start_tag('div', array('class' => implode(' ', $classes)));
281 $output .= html_writer
::start_tag('label', array('for' => 'module_' . $module->name
));
282 if (!isset($module->types
)) {
283 $output .= html_writer
::tag('input', '', array('type' => 'radio',
284 'name' => 'jumplink', 'id' => 'module_' . $module->name
, 'value' => $module->link
));
287 $output .= html_writer
::start_tag('span', array('class' => 'modicon'));
288 if (isset($module->icon
)) {
289 // Add an icon if we have one
290 $output .= $module->icon
;
292 $output .= html_writer
::end_tag('span');
294 $output .= html_writer
::tag('span', $module->title
, array('class' => 'typename'));
295 if (!isset($module->help
)) {
297 $module->help
= get_string('nohelpforactivityorresource', 'moodle');
300 // Format the help text using markdown with the following options
301 $options = new stdClass();
302 $options->trusted
= false;
303 $options->noclean
= false;
304 $options->smiley
= false;
305 $options->filter
= false;
306 $options->para
= true;
307 $options->newlines
= false;
308 $options->overflowdiv
= false;
309 $module->help
= format_text($module->help
, FORMAT_MARKDOWN
, $options);
310 $output .= html_writer
::tag('span', $module->help
, array('class' => 'typesummary'));
311 $output .= html_writer
::end_tag('label');
312 $output .= html_writer
::end_tag('div');
317 protected function course_modchooser_title($title, $identifier = null) {
318 $module = new stdClass();
319 $module->name
= $title;
320 $module->types
= array();
321 $module->title
= get_string($title, $identifier);
323 return $this->course_modchooser_module($module, array('moduletypetitle'));
327 * Renders HTML for displaying the sequence of course module editing buttons
329 * @see course_get_cm_edit_actions()
331 * @param action_link[] $actions Array of action_link objects
332 * @param cm_info $mod The module we are displaying actions for.
333 * @param array $displayoptions additional display options:
334 * ownerselector => A JS/CSS selector that can be used to find an cm node.
335 * If specified the owning node will be given the class 'action-menu-shown' when the action
336 * menu is being displayed.
337 * constraintselector => A JS/CSS selector that can be used to find the parent node for which to constrain
338 * the action menu to when it is being displayed.
339 * donotenhance => If set to true the action menu that gets displayed won't be enhanced by JS.
342 public function course_section_cm_edit_actions($actions, cm_info
$mod = null, $displayoptions = array()) {
345 if (empty($actions)) {
349 if (isset($displayoptions['ownerselector'])) {
350 $ownerselector = $displayoptions['ownerselector'];
352 $ownerselector = '#module-'.$mod->id
;
354 debugging('You should upgrade your call to '.__FUNCTION__
.' and provide $mod', DEBUG_DEVELOPER
);
355 $ownerselector = 'li.activity';
358 if (isset($displayoptions['constraintselector'])) {
359 $constraint = $displayoptions['constraintselector'];
361 $constraint = '.course-content';
364 $menu = new action_menu();
365 $menu->set_owner_selector($ownerselector);
366 $menu->set_constraint($constraint);
367 $menu->set_alignment(action_menu
::TR
, action_menu
::BR
);
368 $menu->set_menu_trigger(get_string('edit'));
369 if (isset($CFG->modeditingmenu
) && !$CFG->modeditingmenu ||
!empty($displayoptions['donotenhance'])) {
370 $menu->do_not_enhance();
372 // Swap the left/right icons.
373 // Normally we have have right, then left but this does not
374 // make sense when modactionmenu is disabled.
377 foreach ($actions as $key => $value) {
378 if ($key === 'moveright') {
380 // Save moveright for later.
382 } else if ($moveright) {
384 // This assumes that the order was moveright, moveleft.
385 // If we have a moveright, then we should place it immediately after the current value.
386 $_actions[$key] = $value;
387 $_actions['moveright'] = $moveright;
389 // Clear the value to prevent it being used multiple times.
393 $_actions[$key] = $value;
396 $actions = $_actions;
399 foreach ($actions as $action) {
400 if ($action instanceof action_menu_link
) {
401 $action->add_class('cm-edit-action');
405 $menu->attributes
['class'] .= ' section-cm-edit-actions commands';
407 // Prioritise the menu ahead of all other actions.
408 $menu->prioritise
= true;
410 return $this->render($menu);
414 * Renders HTML for the menus to add activities and resources to the current course
416 * Note, if theme overwrites this function and it does not use modchooser,
417 * see also {@link core_course_renderer::add_modchoosertoggle()}
419 * @param stdClass $course
420 * @param int $section relative section number (field course_sections.section)
421 * @param int $sectionreturn The section to link back to
422 * @param array $displayoptions additional display options, for example blocks add
423 * option 'inblock' => true, suggesting to display controls vertically
426 function course_section_add_cm_control($course, $section, $sectionreturn = null, $displayoptions = array()) {
429 $vertical = !empty($displayoptions['inblock']);
431 // check to see if user can add menus and there are modules to add
432 if (!has_capability('moodle/course:manageactivities', context_course
::instance($course->id
))
433 ||
!$this->page
->user_is_editing()
434 ||
!($modnames = get_module_types_names()) ||
empty($modnames)) {
438 // Retrieve all modules with associated metadata
439 $modules = get_module_metadata($course, $modnames, $sectionreturn);
440 $urlparams = array('section' => $section);
442 // We'll sort resources and activities into two lists
443 $activities = array(MOD_CLASS_ACTIVITY
=> array(), MOD_CLASS_RESOURCE
=> array());
445 foreach ($modules as $module) {
446 if (isset($module->types
)) {
447 // This module has a subtype
448 // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
450 foreach ($module->types
as $subtype) {
451 $link = $subtype->link
->out(true, $urlparams);
452 $subtypes[$link] = $subtype->title
;
455 // Sort module subtypes into the list
456 $activityclass = MOD_CLASS_ACTIVITY
;
457 if ($module->archetype
== MOD_CLASS_RESOURCE
) {
458 $activityclass = MOD_CLASS_RESOURCE
;
460 if (!empty($module->title
)) {
461 // This grouping has a name
462 $activities[$activityclass][] = array($module->title
=> $subtypes);
464 // This grouping does not have a name
465 $activities[$activityclass] = array_merge($activities[$activityclass], $subtypes);
468 // This module has no subtypes
469 $activityclass = MOD_CLASS_ACTIVITY
;
470 if ($module->archetype
== MOD_ARCHETYPE_RESOURCE
) {
471 $activityclass = MOD_CLASS_RESOURCE
;
472 } else if ($module->archetype
=== MOD_ARCHETYPE_SYSTEM
) {
473 // System modules cannot be added by user, do not add to dropdown
476 $link = $module->link
->out(true, $urlparams);
477 $activities[$activityclass][$link] = $module->title
;
481 $straddactivity = get_string('addactivity');
482 $straddresource = get_string('addresource');
483 $sectionname = get_section_name($course, $section);
484 $strresourcelabel = get_string('addresourcetosection', null, $sectionname);
485 $stractivitylabel = get_string('addactivitytosection', null, $sectionname);
487 $output = html_writer
::start_tag('div', array('class' => 'section_add_menus', 'id' => 'add_menus-section-' . $section));
490 $output .= html_writer
::start_tag('div', array('class' => 'horizontal'));
493 if (!empty($activities[MOD_CLASS_RESOURCE
])) {
494 $select = new url_select($activities[MOD_CLASS_RESOURCE
], '', array(''=>$straddresource), "ressection$section");
495 $select->set_help_icon('resources');
496 $select->set_label($strresourcelabel, array('class' => 'accesshide'));
497 $output .= $this->output
->render($select);
500 if (!empty($activities[MOD_CLASS_ACTIVITY
])) {
501 $select = new url_select($activities[MOD_CLASS_ACTIVITY
], '', array(''=>$straddactivity), "section$section");
502 $select->set_help_icon('activities');
503 $select->set_label($stractivitylabel, array('class' => 'accesshide'));
504 $output .= $this->output
->render($select);
508 $output .= html_writer
::end_tag('div');
511 $output .= html_writer
::end_tag('div');
513 if (course_ajax_enabled($course) && $course->id
== $this->page
->course
->id
) {
514 // modchooser can be added only for the current course set on the page!
515 $straddeither = get_string('addresourceoractivity');
516 // The module chooser link
517 $modchooser = html_writer
::start_tag('div', array('class' => 'mdl-right'));
518 $modchooser.= html_writer
::start_tag('div', array('class' => 'section-modchooser'));
519 $icon = $this->output
->pix_icon('t/add', '');
520 $span = html_writer
::tag('span', $straddeither, array('class' => 'section-modchooser-text'));
521 $modchooser .= html_writer
::tag('span', $icon . $span, array('class' => 'section-modchooser-link'));
522 $modchooser.= html_writer
::end_tag('div');
523 $modchooser.= html_writer
::end_tag('div');
525 // Wrap the normal output in a noscript div
526 $usemodchooser = get_user_preferences('usemodchooser', $CFG->modchooserdefault
);
527 if ($usemodchooser) {
528 $output = html_writer
::tag('div', $output, array('class' => 'hiddenifjs addresourcedropdown'));
529 $modchooser = html_writer
::tag('div', $modchooser, array('class' => 'visibleifjs addresourcemodchooser'));
531 // If the module chooser is disabled, we need to ensure that the dropdowns are shown even if javascript is disabled
532 $output = html_writer
::tag('div', $output, array('class' => 'show addresourcedropdown'));
533 $modchooser = html_writer
::tag('div', $modchooser, array('class' => 'hide addresourcemodchooser'));
535 $output = $this->course_modchooser($modules, $course) . $modchooser . $output;
542 * Renders html to display a course search form
544 * @param string $value default value to populate the search field
545 * @param string $format display format - 'plain' (default), 'short' or 'navbar'
548 function course_search_form($value = '', $format = 'plain') {
550 $formid = 'coursesearch';
551 if ((++
$count) > 1) {
557 $formid = 'coursesearchnavbar';
558 $inputid = 'navsearchbox';
562 $inputid = 'shortsearchbox';
566 $inputid = 'coursesearchbox';
570 $strsearchcourses= get_string("searchcourses");
571 $searchurl = new moodle_url('/course/search.php');
573 $output = html_writer
::start_tag('form', array('id' => $formid, 'action' => $searchurl, 'method' => 'get'));
574 $output .= html_writer
::start_tag('fieldset', array('class' => 'coursesearchbox invisiblefieldset'));
575 $output .= html_writer
::tag('label', $strsearchcourses.': ', array('for' => $inputid));
576 $output .= html_writer
::empty_tag('input', array('type' => 'text', 'id' => $inputid,
577 'size' => $inputsize, 'name' => 'search', 'value' => s($value)));
578 $output .= html_writer
::empty_tag('input', array('type' => 'submit',
579 'value' => get_string('go')));
580 $output .= html_writer
::end_tag('fieldset');
581 $output .= html_writer
::end_tag('form');
587 * Renders html for completion box on course page
589 * If completion is disabled, returns empty string
590 * If completion is automatic, returns an icon of the current completion state
591 * If completion is manual, returns a form (with an icon inside) that allows user to
594 * @param stdClass $course course object
595 * @param completion_info $completioninfo completion info for the course, it is recommended
596 * to fetch once for all modules in course/section for performance
597 * @param cm_info $mod module to show completion for
598 * @param array $displayoptions display options, not used in core
601 public function course_section_cm_completion($course, &$completioninfo, cm_info
$mod, $displayoptions = array()) {
604 if (!empty($displayoptions['hidecompletion']) ||
!isloggedin() ||
isguestuser() ||
!$mod->uservisible
) {
607 if ($completioninfo === null) {
608 $completioninfo = new completion_info($course);
610 $completion = $completioninfo->is_enabled($mod);
611 if ($completion == COMPLETION_TRACKING_NONE
) {
612 if ($this->page
->user_is_editing()) {
613 $output .= html_writer
::span(' ', 'filler');
618 $completiondata = $completioninfo->get_data($mod, true);
619 $completionicon = '';
621 if ($this->page
->user_is_editing()) {
622 switch ($completion) {
623 case COMPLETION_TRACKING_MANUAL
:
624 $completionicon = 'manual-enabled'; break;
625 case COMPLETION_TRACKING_AUTOMATIC
:
626 $completionicon = 'auto-enabled'; break;
628 } else if ($completion == COMPLETION_TRACKING_MANUAL
) {
629 switch($completiondata->completionstate
) {
630 case COMPLETION_INCOMPLETE
:
631 $completionicon = 'manual-n'; break;
632 case COMPLETION_COMPLETE
:
633 $completionicon = 'manual-y'; break;
635 } else { // Automatic
636 switch($completiondata->completionstate
) {
637 case COMPLETION_INCOMPLETE
:
638 $completionicon = 'auto-n'; break;
639 case COMPLETION_COMPLETE
:
640 $completionicon = 'auto-y'; break;
641 case COMPLETION_COMPLETE_PASS
:
642 $completionicon = 'auto-pass'; break;
643 case COMPLETION_COMPLETE_FAIL
:
644 $completionicon = 'auto-fail'; break;
647 if ($completionicon) {
648 $formattedname = $mod->get_formatted_name();
649 $imgalt = get_string('completion-alt-' . $completionicon, 'completion', $formattedname);
651 if ($this->page
->user_is_editing()) {
652 // When editing, the icon is just an image.
653 $completionpixicon = new pix_icon('i/completion-'.$completionicon, $imgalt, '',
654 array('title' => $imgalt, 'class' => 'iconsmall'));
655 $output .= html_writer
::tag('span', $this->output
->render($completionpixicon),
656 array('class' => 'autocompletion'));
657 } else if ($completion == COMPLETION_TRACKING_MANUAL
) {
658 $imgtitle = get_string('completion-title-' . $completionicon, 'completion', $formattedname);
660 $completiondata->completionstate
== COMPLETION_COMPLETE
661 ? COMPLETION_INCOMPLETE
662 : COMPLETION_COMPLETE
;
663 // In manual mode the icon is a toggle form...
665 // If this completion state is used by the
666 // conditional activities system, we need to turn
669 if (!empty($CFG->enableavailability
) &&
670 core_availability\info
::completion_value_used($course, $mod->id
)) {
671 $extraclass = ' preventjs';
673 $output .= html_writer
::start_tag('form', array('method' => 'post',
674 'action' => new moodle_url('/course/togglecompletion.php'),
675 'class' => 'togglecompletion'. $extraclass));
676 $output .= html_writer
::start_tag('div');
677 $output .= html_writer
::empty_tag('input', array(
678 'type' => 'hidden', 'name' => 'id', 'value' => $mod->id
));
679 $output .= html_writer
::empty_tag('input', array(
680 'type' => 'hidden', 'name' => 'sesskey', 'value' => sesskey()));
681 $output .= html_writer
::empty_tag('input', array(
682 'type' => 'hidden', 'name' => 'modulename', 'value' => $mod->name
));
683 $output .= html_writer
::empty_tag('input', array(
684 'type' => 'hidden', 'name' => 'completionstate', 'value' => $newstate));
685 $output .= html_writer
::empty_tag('input', array(
687 'src' => $this->output
->pix_url('i/completion-'.$completionicon),
688 'alt' => $imgalt, 'title' => $imgtitle,
689 'aria-live' => 'polite'));
690 $output .= html_writer
::end_tag('div');
691 $output .= html_writer
::end_tag('form');
693 // In auto mode, the icon is just an image.
694 $completionpixicon = new pix_icon('i/completion-'.$completionicon, $imgalt, '',
695 array('title' => $imgalt));
696 $output .= html_writer
::tag('span', $this->output
->render($completionpixicon),
697 array('class' => 'autocompletion'));
704 * Checks if course module has any conditions that may make it unavailable for
705 * all or some of the students
707 * This function is internal and is only used to create CSS classes for the module name/text
709 * @param cm_info $mod
712 protected function is_cm_conditionally_hidden(cm_info
$mod) {
714 $conditionalhidden = false;
715 if (!empty($CFG->enableavailability
)) {
716 $info = new \core_availability\
info_module($mod);
717 $conditionalhidden = !$info->is_available_for_all();
719 return $conditionalhidden;
723 * Renders html to display a name with the link to the course module on a course page
725 * If module is unavailable for user but still needs to be displayed
726 * in the list, just the name is returned without a link
728 * Note, that for course modules that never have separate pages (i.e. labels)
729 * this function return an empty string
731 * @param cm_info $mod
732 * @param array $displayoptions
735 public function course_section_cm_name(cm_info
$mod, $displayoptions = array()) {
738 if (!$mod->uservisible
&& empty($mod->availableinfo
)) {
739 // nothing to be displayed to the user
747 //Accessibility: for files get description via icon, this is very ugly hack!
748 $instancename = $mod->get_formatted_name();
749 $altname = $mod->modfullname
;
750 // Avoid unnecessary duplication: if e.g. a forum name already
751 // includes the word forum (or Forum, etc) then it is unhelpful
752 // to include that in the accessible description that is added.
753 if (false !== strpos(core_text
::strtolower($instancename),
754 core_text
::strtolower($altname))) {
757 // File type after name, for alphabetic lists (screen reader).
759 $altname = get_accesshide(' '.$altname);
762 // For items which are hidden but available to current user
763 // ($mod->uservisible), we show those as dimmed only if the user has
764 // viewhiddenactivities, so that teachers see 'items which might not
765 // be available to some students' dimmed but students do not see 'item
766 // which is actually available to current student' dimmed.
770 if ($mod->uservisible
) {
771 $conditionalhidden = $this->is_cm_conditionally_hidden($mod);
772 $accessiblebutdim = (!$mod->visible ||
$conditionalhidden) &&
773 has_capability('moodle/course:viewhiddenactivities',
774 context_course
::instance($mod->course
));
775 if ($accessiblebutdim) {
776 $linkclasses .= ' dimmed';
777 $textclasses .= ' dimmed_text';
778 if ($conditionalhidden) {
779 $linkclasses .= ' conditionalhidden';
780 $textclasses .= ' conditionalhidden';
782 // Show accessibility note only if user can access the module himself.
783 $accesstext = get_accesshide(get_string('hiddenfromstudents').':'. $mod->modfullname
);
786 $linkclasses .= ' dimmed';
787 $textclasses .= ' dimmed_text';
790 // Get on-click attribute value if specified and decode the onclick - it
791 // has already been encoded for display (puke).
792 $onclick = htmlspecialchars_decode($mod->onclick
, ENT_QUOTES
);
794 $groupinglabel = $mod->get_grouping_label($textclasses);
796 // Display link itself.
797 $activitylink = html_writer
::empty_tag('img', array('src' => $mod->get_icon_url(),
798 'class' => 'iconlarge activityicon', 'alt' => ' ', 'role' => 'presentation')) . $accesstext .
799 html_writer
::tag('span', $instancename . $altname, array('class' => 'instancename'));
800 if ($mod->uservisible
) {
801 $output .= html_writer
::link($url, $activitylink, array('class' => $linkclasses, 'onclick' => $onclick)) .
804 // We may be displaying this just in order to show information
805 // about visibility, without the actual link ($mod->uservisible)
806 $output .= html_writer
::tag('div', $activitylink, array('class' => $textclasses)) .
813 * Renders html to display the module content on the course page (i.e. text of the labels)
815 * @param cm_info $mod
816 * @param array $displayoptions
819 public function course_section_cm_text(cm_info
$mod, $displayoptions = array()) {
821 if (!$mod->uservisible
&& empty($mod->availableinfo
)) {
822 // nothing to be displayed to the user
825 $content = $mod->get_formatted_content(array('overflowdiv' => true, 'noclean' => true));
828 if ($mod->uservisible
) {
829 $conditionalhidden = $this->is_cm_conditionally_hidden($mod);
830 $accessiblebutdim = (!$mod->visible ||
$conditionalhidden) &&
831 has_capability('moodle/course:viewhiddenactivities',
832 context_course
::instance($mod->course
));
833 if ($accessiblebutdim) {
834 $textclasses .= ' dimmed_text';
835 if ($conditionalhidden) {
836 $textclasses .= ' conditionalhidden';
838 // Show accessibility note only if user can access the module himself.
839 $accesstext = get_accesshide(get_string('hiddenfromstudents').':'. $mod->modfullname
);
842 $textclasses .= ' dimmed_text';
846 // If specified, display extra content after link.
847 $output = html_writer
::tag('div', $content, array('class' =>
848 trim('contentafterlink ' . $textclasses)));
851 $groupinglabel = $mod->get_grouping_label($textclasses);
853 // No link, so display only content.
854 $output = html_writer
::tag('div', $accesstext . $content . $groupinglabel,
855 array('class' => 'contentwithoutlink ' . $textclasses));
861 * Renders HTML to show course module availability information (for someone who isn't allowed
862 * to see the activity itself, or for staff)
864 * @param cm_info $mod
865 * @param array $displayoptions
868 public function course_section_cm_availability(cm_info
$mod, $displayoptions = array()) {
870 if (!$mod->uservisible
) {
871 // this is a student who is not allowed to see the module but might be allowed
872 // to see availability info (i.e. "Available from ...")
873 if (!empty($mod->availableinfo
)) {
874 $formattedinfo = \core_availability\info
::format_info(
875 $mod->availableinfo
, $mod->get_course());
876 $output = html_writer
::tag('div', $formattedinfo, array('class' => 'availabilityinfo'));
880 // this is a teacher who is allowed to see module but still should see the
881 // information that module is not available to all/some students
882 $modcontext = context_module
::instance($mod->id
);
883 $canviewhidden = has_capability('moodle/course:viewhiddenactivities', $modcontext);
884 if ($canviewhidden && !empty($CFG->enableavailability
)) {
885 // Don't add availability information if user is not editing and activity is hidden.
886 if ($mod->visible ||
$this->page
->user_is_editing()) {
888 if (!$mod->visible
) {
889 $hidinfoclass = 'hide';
891 $ci = new \core_availability\
info_module($mod);
892 $fullinfo = $ci->get_full_information();
894 $formattedinfo = \core_availability\info
::format_info(
895 $fullinfo, $mod->get_course());
896 return html_writer
::div($formattedinfo, 'availabilityinfo ' . $hidinfoclass);
904 * Renders HTML to display one course module for display within a section.
906 * This function calls:
907 * {@link core_course_renderer::course_section_cm()}
909 * @param stdClass $course
910 * @param completion_info $completioninfo
911 * @param cm_info $mod
912 * @param int|null $sectionreturn
913 * @param array $displayoptions
916 public function course_section_cm_list_item($course, &$completioninfo, cm_info
$mod, $sectionreturn, $displayoptions = array()) {
918 if ($modulehtml = $this->course_section_cm($course, $completioninfo, $mod, $sectionreturn, $displayoptions)) {
919 $modclasses = 'activity ' . $mod->modname
. ' modtype_' . $mod->modname
. ' ' . $mod->extraclasses
;
920 $output .= html_writer
::tag('li', $modulehtml, array('class' => $modclasses, 'id' => 'module-' . $mod->id
));
926 * Renders HTML to display one course module in a course section
928 * This includes link, content, availability, completion info and additional information
929 * that module type wants to display (i.e. number of unread forum posts)
931 * This function calls:
932 * {@link core_course_renderer::course_section_cm_name()}
933 * {@link core_course_renderer::course_section_cm_text()}
934 * {@link core_course_renderer::course_section_cm_availability()}
935 * {@link core_course_renderer::course_section_cm_completion()}
936 * {@link course_get_cm_edit_actions()}
937 * {@link core_course_renderer::course_section_cm_edit_actions()}
939 * @param stdClass $course
940 * @param completion_info $completioninfo
941 * @param cm_info $mod
942 * @param int|null $sectionreturn
943 * @param array $displayoptions
946 public function course_section_cm($course, &$completioninfo, cm_info
$mod, $sectionreturn, $displayoptions = array()) {
948 // We return empty string (because course module will not be displayed at all)
950 // 1) The activity is not visible to users
952 // 2) The 'availableinfo' is empty, i.e. the activity was
953 // hidden in a way that leaves no info, such as using the
955 if (!$mod->uservisible
&& empty($mod->availableinfo
)) {
959 $indentclasses = 'mod-indent';
960 if (!empty($mod->indent
)) {
961 $indentclasses .= ' mod-indent-'.$mod->indent
;
962 if ($mod->indent
> 15) {
963 $indentclasses .= ' mod-indent-huge';
967 $output .= html_writer
::start_tag('div');
969 if ($this->page
->user_is_editing()) {
970 $output .= course_get_cm_move($mod, $sectionreturn);
973 $output .= html_writer
::start_tag('div', array('class' => 'mod-indent-outer'));
975 // This div is used to indent the content.
976 $output .= html_writer
::div('', $indentclasses);
978 // Start a wrapper for the actual content to keep the indentation consistent
979 $output .= html_writer
::start_tag('div');
981 // Display the link to the module (or do nothing if module has no url)
982 $cmname = $this->course_section_cm_name($mod, $displayoptions);
984 if (!empty($cmname)) {
985 // Start the div for the activity title, excluding the edit icons.
986 $output .= html_writer
::start_tag('div', array('class' => 'activityinstance'));
990 if ($this->page
->user_is_editing()) {
991 $output .= ' ' . course_get_cm_rename_action($mod, $sectionreturn);
994 // Module can put text after the link (e.g. forum unread)
995 $output .= $mod->afterlink
;
997 // Closing the tag which contains everything but edit icons. Content part of the module should not be part of this.
998 $output .= html_writer
::end_tag('div'); // .activityinstance
1001 // If there is content but NO link (eg label), then display the
1002 // content here (BEFORE any icons). In this case cons must be
1003 // displayed after the content so that it makes more sense visually
1004 // and for accessibility reasons, e.g. if you have a one-line label
1005 // it should work similarly (at least in terms of ordering) to an
1007 $contentpart = $this->course_section_cm_text($mod, $displayoptions);
1010 $output .= $contentpart;
1014 if ($this->page
->user_is_editing()) {
1015 $editactions = course_get_cm_edit_actions($mod, $mod->indent
, $sectionreturn);
1016 $modicons .= ' '. $this->course_section_cm_edit_actions($editactions, $mod, $displayoptions);
1017 $modicons .= $mod->afterediticons
;
1020 $modicons .= $this->course_section_cm_completion($course, $completioninfo, $mod, $displayoptions);
1022 if (!empty($modicons)) {
1023 $output .= html_writer
::span($modicons, 'actions');
1026 // If there is content AND a link, then display the content here
1027 // (AFTER any icons). Otherwise it was displayed before
1029 $output .= $contentpart;
1032 // show availability info (if module is not available)
1033 $output .= $this->course_section_cm_availability($mod, $displayoptions);
1035 $output .= html_writer
::end_tag('div'); // $indentclasses
1037 // End of indentation div.
1038 $output .= html_writer
::end_tag('div');
1040 $output .= html_writer
::end_tag('div');
1045 * Renders HTML to display a list of course modules in a course section
1046 * Also displays "move here" controls in Javascript-disabled mode
1048 * This function calls {@link core_course_renderer::course_section_cm()}
1050 * @param stdClass $course course object
1051 * @param int|stdClass|section_info $section relative section number or section object
1052 * @param int $sectionreturn section number to return to
1053 * @param int $displayoptions
1056 public function course_section_cm_list($course, $section, $sectionreturn = null, $displayoptions = array()) {
1060 $modinfo = get_fast_modinfo($course);
1061 if (is_object($section)) {
1062 $section = $modinfo->get_section_info($section->section
);
1064 $section = $modinfo->get_section_info($section);
1066 $completioninfo = new completion_info($course);
1068 // check if we are currently in the process of moving a module with JavaScript disabled
1069 $ismoving = $this->page
->user_is_editing() && ismoving($course->id
);
1071 $movingpix = new pix_icon('movehere', get_string('movehere'), 'moodle', array('class' => 'movetarget'));
1072 $strmovefull = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'"));
1075 // Get the list of modules visible to user (excluding the module being moved if there is one)
1076 $moduleshtml = array();
1077 if (!empty($modinfo->sections
[$section->section
])) {
1078 foreach ($modinfo->sections
[$section->section
] as $modnumber) {
1079 $mod = $modinfo->cms
[$modnumber];
1081 if ($ismoving and $mod->id
== $USER->activitycopy
) {
1082 // do not display moving mod
1086 if ($modulehtml = $this->course_section_cm_list_item($course,
1087 $completioninfo, $mod, $sectionreturn, $displayoptions)) {
1088 $moduleshtml[$modnumber] = $modulehtml;
1093 $sectionoutput = '';
1094 if (!empty($moduleshtml) ||
$ismoving) {
1095 foreach ($moduleshtml as $modnumber => $modulehtml) {
1097 $movingurl = new moodle_url('/course/mod.php', array('moveto' => $modnumber, 'sesskey' => sesskey()));
1098 $sectionoutput .= html_writer
::tag('li',
1099 html_writer
::link($movingurl, $this->output
->render($movingpix), array('title' => $strmovefull)),
1100 array('class' => 'movehere'));
1103 $sectionoutput .= $modulehtml;
1107 $movingurl = new moodle_url('/course/mod.php', array('movetosection' => $section->id
, 'sesskey' => sesskey()));
1108 $sectionoutput .= html_writer
::tag('li',
1109 html_writer
::link($movingurl, $this->output
->render($movingpix), array('title' => $strmovefull)),
1110 array('class' => 'movehere'));
1114 // Always output the section module list.
1115 $output .= html_writer
::tag('ul', $sectionoutput, array('class' => 'section img-text'));
1121 * Displays a custom list of courses with paging bar if necessary
1123 * If $paginationurl is specified but $totalcount is not, the link 'View more'
1124 * appears under the list.
1126 * If both $paginationurl and $totalcount are specified, and $totalcount is
1127 * bigger than count($courses), a paging bar is displayed above and under the
1130 * @param array $courses array of course records (or instances of course_in_list) to show on this page
1131 * @param bool $showcategoryname whether to add category name to the course description
1132 * @param string $additionalclasses additional CSS classes to add to the div.courses
1133 * @param moodle_url $paginationurl url to view more or url to form links to the other pages in paging bar
1134 * @param int $totalcount total number of courses on all pages, if omitted $paginationurl will be displayed as 'View more' link
1135 * @param int $page current page number (defaults to 0 referring to the first page)
1136 * @param int $perpage number of records per page (defaults to $CFG->coursesperpage)
1139 public function courses_list($courses, $showcategoryname = false, $additionalclasses = null, $paginationurl = null, $totalcount = null, $page = 0, $perpage = null) {
1141 // create instance of coursecat_helper to pass display options to function rendering courses list
1142 $chelper = new coursecat_helper();
1143 if ($showcategoryname) {
1144 $chelper->set_show_courses(self
::COURSECAT_SHOW_COURSES_EXPANDED_WITH_CAT
);
1146 $chelper->set_show_courses(self
::COURSECAT_SHOW_COURSES_EXPANDED
);
1148 if ($totalcount !== null && $paginationurl !== null) {
1149 // add options to display pagination
1150 if ($perpage === null) {
1151 $perpage = $CFG->coursesperpage
;
1153 $chelper->set_courses_display_options(array(
1154 'limit' => $perpage,
1155 'offset' => ((int)$page) * $perpage,
1156 'paginationurl' => $paginationurl,
1158 } else if ($paginationurl !== null) {
1159 // add options to display 'View more' link
1160 $chelper->set_courses_display_options(array('viewmoreurl' => $paginationurl));
1161 $totalcount = count($courses) +
1; // has to be bigger than count($courses) otherwise link will not be displayed
1163 $chelper->set_attributes(array('class' => $additionalclasses));
1164 $content = $this->coursecat_courses($chelper, $courses, $totalcount);
1169 * Displays one course in the list of courses.
1171 * This is an internal function, to display an information about just one course
1172 * please use {@link core_course_renderer::course_info_box()}
1174 * @param coursecat_helper $chelper various display options
1175 * @param course_in_list|stdClass $course
1176 * @param string $additionalclasses additional classes to add to the main <div> tag (usually
1177 * depend on the course position in list - first/last/even/odd)
1180 protected function coursecat_coursebox(coursecat_helper
$chelper, $course, $additionalclasses = '') {
1182 if (!isset($this->strings
->summary
)) {
1183 $this->strings
->summary
= get_string('summary');
1185 if ($chelper->get_show_courses() <= self
::COURSECAT_SHOW_COURSES_COUNT
) {
1188 if ($course instanceof stdClass
) {
1189 require_once($CFG->libdir
. '/coursecatlib.php');
1190 $course = new course_in_list($course);
1193 $classes = trim('coursebox clearfix '. $additionalclasses);
1194 if ($chelper->get_show_courses() >= self
::COURSECAT_SHOW_COURSES_EXPANDED
) {
1197 $classes .= ' collapsed';
1202 $content .= html_writer
::start_tag('div', array(
1203 'class' => $classes,
1204 'data-courseid' => $course->id
,
1205 'data-type' => self
::COURSECAT_TYPE_COURSE
,
1208 $content .= html_writer
::start_tag('div', array('class' => 'info'));
1211 $coursename = $chelper->get_course_formatted_name($course);
1212 $coursenamelink = html_writer
::link(new moodle_url('/course/view.php', array('id' => $course->id
)),
1213 $coursename, array('class' => $course->visible ?
'' : 'dimmed'));
1214 $content .= html_writer
::tag($nametag, $coursenamelink, array('class' => 'coursename'));
1215 // If we display course in collapsed form but the course has summary or course contacts, display the link to the info page.
1216 $content .= html_writer
::start_tag('div', array('class' => 'moreinfo'));
1217 if ($chelper->get_show_courses() < self
::COURSECAT_SHOW_COURSES_EXPANDED
) {
1218 if ($course->has_summary() ||
$course->has_course_contacts() ||
$course->has_course_overviewfiles()) {
1219 $url = new moodle_url('/course/info.php', array('id' => $course->id
));
1220 $image = html_writer
::empty_tag('img', array('src' => $this->output
->pix_url('i/info'),
1221 'alt' => $this->strings
->summary
));
1222 $content .= html_writer
::link($url, $image, array('title' => $this->strings
->summary
));
1223 // Make sure JS file to expand course content is included.
1224 $this->coursecat_include_js();
1227 $content .= html_writer
::end_tag('div'); // .moreinfo
1229 // print enrolmenticons
1230 if ($icons = enrol_get_course_info_icons($course)) {
1231 $content .= html_writer
::start_tag('div', array('class' => 'enrolmenticons'));
1232 foreach ($icons as $pix_icon) {
1233 $content .= $this->render($pix_icon);
1235 $content .= html_writer
::end_tag('div'); // .enrolmenticons
1238 $content .= html_writer
::end_tag('div'); // .info
1240 $content .= html_writer
::start_tag('div', array('class' => 'content'));
1241 $content .= $this->coursecat_coursebox_content($chelper, $course);
1242 $content .= html_writer
::end_tag('div'); // .content
1244 $content .= html_writer
::end_tag('div'); // .coursebox
1249 * Returns HTML to display course content (summary, course contacts and optionally category name)
1251 * This method is called from coursecat_coursebox() and may be re-used in AJAX
1253 * @param coursecat_helper $chelper various display options
1254 * @param stdClass|course_in_list $course
1257 protected function coursecat_coursebox_content(coursecat_helper
$chelper, $course) {
1259 if ($chelper->get_show_courses() < self
::COURSECAT_SHOW_COURSES_EXPANDED
) {
1262 if ($course instanceof stdClass
) {
1263 require_once($CFG->libdir
. '/coursecatlib.php');
1264 $course = new course_in_list($course);
1268 // display course summary
1269 if ($course->has_summary()) {
1270 $content .= html_writer
::start_tag('div', array('class' => 'summary'));
1271 $content .= $chelper->get_course_formatted_summary($course,
1272 array('overflowdiv' => true, 'noclean' => true, 'para' => false));
1273 $content .= html_writer
::end_tag('div'); // .summary
1276 // display course overview files
1277 $contentimages = $contentfiles = '';
1278 foreach ($course->get_course_overviewfiles() as $file) {
1279 $isimage = $file->is_valid_image();
1280 $url = file_encode_url("$CFG->wwwroot/pluginfile.php",
1281 '/'. $file->get_contextid(). '/'. $file->get_component(). '/'.
1282 $file->get_filearea(). $file->get_filepath(). $file->get_filename(), !$isimage);
1284 $contentimages .= html_writer
::tag('div',
1285 html_writer
::empty_tag('img', array('src' => $url)),
1286 array('class' => 'courseimage'));
1288 $image = $this->output
->pix_icon(file_file_icon($file, 24), $file->get_filename(), 'moodle');
1289 $filename = html_writer
::tag('span', $image, array('class' => 'fp-icon')).
1290 html_writer
::tag('span', $file->get_filename(), array('class' => 'fp-filename'));
1291 $contentfiles .= html_writer
::tag('span',
1292 html_writer
::link($url, $filename),
1293 array('class' => 'coursefile fp-filename-icon'));
1296 $content .= $contentimages. $contentfiles;
1298 // display course contacts. See course_in_list::get_course_contacts()
1299 if ($course->has_course_contacts()) {
1300 $content .= html_writer
::start_tag('ul', array('class' => 'teachers'));
1301 foreach ($course->get_course_contacts() as $userid => $coursecontact) {
1302 $name = $coursecontact['rolename'].': '.
1303 html_writer
::link(new moodle_url('/user/view.php',
1304 array('id' => $userid, 'course' => SITEID
)),
1305 $coursecontact['username']);
1306 $content .= html_writer
::tag('li', $name);
1308 $content .= html_writer
::end_tag('ul'); // .teachers
1311 // display course category if necessary (for example in search results)
1312 if ($chelper->get_show_courses() == self
::COURSECAT_SHOW_COURSES_EXPANDED_WITH_CAT
) {
1313 require_once($CFG->libdir
. '/coursecatlib.php');
1314 if ($cat = coursecat
::get($course->category
, IGNORE_MISSING
)) {
1315 $content .= html_writer
::start_tag('div', array('class' => 'coursecat'));
1316 $content .= get_string('category').': '.
1317 html_writer
::link(new moodle_url('/course/index.php', array('categoryid' => $cat->id
)),
1318 $cat->get_formatted_name(), array('class' => $cat->visible ?
'' : 'dimmed'));
1319 $content .= html_writer
::end_tag('div'); // .coursecat
1327 * Renders the list of courses
1329 * This is internal function, please use {@link core_course_renderer::courses_list()} or another public
1330 * method from outside of the class
1332 * If list of courses is specified in $courses; the argument $chelper is only used
1333 * to retrieve display options and attributes, only methods get_show_courses(),
1334 * get_courses_display_option() and get_and_erase_attributes() are called.
1336 * @param coursecat_helper $chelper various display options
1337 * @param array $courses the list of courses to display
1338 * @param int|null $totalcount total number of courses (affects display mode if it is AUTO or pagination if applicable),
1339 * defaulted to count($courses)
1342 protected function coursecat_courses(coursecat_helper
$chelper, $courses, $totalcount = null) {
1344 if ($totalcount === null) {
1345 $totalcount = count($courses);
1348 // Courses count is cached during courses retrieval.
1352 if ($chelper->get_show_courses() == self
::COURSECAT_SHOW_COURSES_AUTO
) {
1353 // In 'auto' course display mode we analyse if number of courses is more or less than $CFG->courseswithsummarieslimit
1354 if ($totalcount <= $CFG->courseswithsummarieslimit
) {
1355 $chelper->set_show_courses(self
::COURSECAT_SHOW_COURSES_EXPANDED
);
1357 $chelper->set_show_courses(self
::COURSECAT_SHOW_COURSES_COLLAPSED
);
1361 // prepare content of paging bar if it is needed
1362 $paginationurl = $chelper->get_courses_display_option('paginationurl');
1363 $paginationallowall = $chelper->get_courses_display_option('paginationallowall');
1364 if ($totalcount > count($courses)) {
1365 // there are more results that can fit on one page
1366 if ($paginationurl) {
1367 // the option paginationurl was specified, display pagingbar
1368 $perpage = $chelper->get_courses_display_option('limit', $CFG->coursesperpage
);
1369 $page = $chelper->get_courses_display_option('offset') / $perpage;
1370 $pagingbar = $this->paging_bar($totalcount, $page, $perpage,
1371 $paginationurl->out(false, array('perpage' => $perpage)));
1372 if ($paginationallowall) {
1373 $pagingbar .= html_writer
::tag('div', html_writer
::link($paginationurl->out(false, array('perpage' => 'all')),
1374 get_string('showall', '', $totalcount)), array('class' => 'paging paging-showall'));
1376 } else if ($viewmoreurl = $chelper->get_courses_display_option('viewmoreurl')) {
1377 // the option for 'View more' link was specified, display more link
1378 $viewmoretext = $chelper->get_courses_display_option('viewmoretext', new lang_string('viewmore'));
1379 $morelink = html_writer
::tag('div', html_writer
::link($viewmoreurl, $viewmoretext),
1380 array('class' => 'paging paging-morelink'));
1382 } else if (($totalcount > $CFG->coursesperpage
) && $paginationurl && $paginationallowall) {
1383 // there are more than one page of results and we are in 'view all' mode, suggest to go back to paginated view mode
1384 $pagingbar = html_writer
::tag('div', html_writer
::link($paginationurl->out(false, array('perpage' => $CFG->coursesperpage
)),
1385 get_string('showperpage', '', $CFG->coursesperpage
)), array('class' => 'paging paging-showperpage'));
1388 // display list of courses
1389 $attributes = $chelper->get_and_erase_attributes('courses');
1390 $content = html_writer
::start_tag('div', $attributes);
1392 if (!empty($pagingbar)) {
1393 $content .= $pagingbar;
1397 foreach ($courses as $course) {
1399 $classes = ($coursecount%2
) ?
'odd' : 'even';
1400 if ($coursecount == 1) {
1401 $classes .= ' first';
1403 if ($coursecount >= count($courses)) {
1404 $classes .= ' last';
1406 $content .= $this->coursecat_coursebox($chelper, $course, $classes);
1409 if (!empty($pagingbar)) {
1410 $content .= $pagingbar;
1412 if (!empty($morelink)) {
1413 $content .= $morelink;
1416 $content .= html_writer
::end_tag('div'); // .courses
1421 * Renders the list of subcategories in a category
1423 * @param coursecat_helper $chelper various display options
1424 * @param coursecat $coursecat
1425 * @param int $depth depth of the category in the current tree
1428 protected function coursecat_subcategories(coursecat_helper
$chelper, $coursecat, $depth) {
1430 $subcategories = array();
1431 if (!$chelper->get_categories_display_option('nodisplay')) {
1432 $subcategories = $coursecat->get_children($chelper->get_categories_display_options());
1434 $totalcount = $coursecat->get_children_count();
1436 // Note that we call get_child_categories_count() AFTER get_child_categories() to avoid extra DB requests.
1437 // Categories count is cached during children categories retrieval.
1441 // prepare content of paging bar or more link if it is needed
1442 $paginationurl = $chelper->get_categories_display_option('paginationurl');
1443 $paginationallowall = $chelper->get_categories_display_option('paginationallowall');
1444 if ($totalcount > count($subcategories)) {
1445 if ($paginationurl) {
1446 // the option 'paginationurl was specified, display pagingbar
1447 $perpage = $chelper->get_categories_display_option('limit', $CFG->coursesperpage
);
1448 $page = $chelper->get_categories_display_option('offset') / $perpage;
1449 $pagingbar = $this->paging_bar($totalcount, $page, $perpage,
1450 $paginationurl->out(false, array('perpage' => $perpage)));
1451 if ($paginationallowall) {
1452 $pagingbar .= html_writer
::tag('div', html_writer
::link($paginationurl->out(false, array('perpage' => 'all')),
1453 get_string('showall', '', $totalcount)), array('class' => 'paging paging-showall'));
1455 } else if ($viewmoreurl = $chelper->get_categories_display_option('viewmoreurl')) {
1456 // the option 'viewmoreurl' was specified, display more link (if it is link to category view page, add category id)
1457 if ($viewmoreurl->compare(new moodle_url('/course/index.php'), URL_MATCH_BASE
)) {
1458 $viewmoreurl->param('categoryid', $coursecat->id
);
1460 $viewmoretext = $chelper->get_categories_display_option('viewmoretext', new lang_string('viewmore'));
1461 $morelink = html_writer
::tag('div', html_writer
::link($viewmoreurl, $viewmoretext),
1462 array('class' => 'paging paging-morelink'));
1464 } else if (($totalcount > $CFG->coursesperpage
) && $paginationurl && $paginationallowall) {
1465 // there are more than one page of results and we are in 'view all' mode, suggest to go back to paginated view mode
1466 $pagingbar = html_writer
::tag('div', html_writer
::link($paginationurl->out(false, array('perpage' => $CFG->coursesperpage
)),
1467 get_string('showperpage', '', $CFG->coursesperpage
)), array('class' => 'paging paging-showperpage'));
1470 // display list of subcategories
1471 $content = html_writer
::start_tag('div', array('class' => 'subcategories'));
1473 if (!empty($pagingbar)) {
1474 $content .= $pagingbar;
1477 foreach ($subcategories as $subcategory) {
1478 $content .= $this->coursecat_category($chelper, $subcategory, $depth +
1);
1481 if (!empty($pagingbar)) {
1482 $content .= $pagingbar;
1484 if (!empty($morelink)) {
1485 $content .= $morelink;
1488 $content .= html_writer
::end_tag('div');
1493 * Make sure that javascript file for AJAX expanding of courses and categories content is included
1495 protected function coursecat_include_js() {
1496 if (!$this->page
->requires
->should_create_one_time_item_now('core_course_categoryexpanderjsinit')) {
1500 // We must only load this module once.
1501 $this->page
->requires
->yui_module('moodle-course-categoryexpander',
1502 'Y.Moodle.course.categoryexpander.init');
1506 * Returns HTML to display the subcategories and courses in the given category
1508 * This method is re-used by AJAX to expand content of not loaded category
1510 * @param coursecat_helper $chelper various display options
1511 * @param coursecat $coursecat
1512 * @param int $depth depth of the category in the current tree
1515 protected function coursecat_category_content(coursecat_helper
$chelper, $coursecat, $depth) {
1518 $content .= $this->coursecat_subcategories($chelper, $coursecat, $depth);
1520 // AUTO show courses: Courses will be shown expanded if this is not nested category,
1521 // and number of courses no bigger than $CFG->courseswithsummarieslimit.
1522 $showcoursesauto = $chelper->get_show_courses() == self
::COURSECAT_SHOW_COURSES_AUTO
;
1523 if ($showcoursesauto && $depth) {
1524 // this is definitely collapsed mode
1525 $chelper->set_show_courses(self
::COURSECAT_SHOW_COURSES_COLLAPSED
);
1529 if ($chelper->get_show_courses() > core_course_renderer
::COURSECAT_SHOW_COURSES_COUNT
) {
1531 if (!$chelper->get_courses_display_option('nodisplay')) {
1532 $courses = $coursecat->get_courses($chelper->get_courses_display_options());
1534 if ($viewmoreurl = $chelper->get_courses_display_option('viewmoreurl')) {
1535 // the option for 'View more' link was specified, display more link (if it is link to category view page, add category id)
1536 if ($viewmoreurl->compare(new moodle_url('/course/index.php'), URL_MATCH_BASE
)) {
1537 $chelper->set_courses_display_option('viewmoreurl', new moodle_url($viewmoreurl, array('categoryid' => $coursecat->id
)));
1540 $content .= $this->coursecat_courses($chelper, $courses, $coursecat->get_courses_count());
1543 if ($showcoursesauto) {
1544 // restore the show_courses back to AUTO
1545 $chelper->set_show_courses(self
::COURSECAT_SHOW_COURSES_AUTO
);
1552 * Returns HTML to display a course category as a part of a tree
1554 * This is an internal function, to display a particular category and all its contents
1555 * use {@link core_course_renderer::course_category()}
1557 * @param coursecat_helper $chelper various display options
1558 * @param coursecat $coursecat
1559 * @param int $depth depth of this category in the current tree
1562 protected function coursecat_category(coursecat_helper
$chelper, $coursecat, $depth) {
1563 // open category tag
1564 $classes = array('category');
1565 if (empty($coursecat->visible
)) {
1566 $classes[] = 'dimmed_category';
1568 if ($chelper->get_subcat_depth() > 0 && $depth >= $chelper->get_subcat_depth()) {
1569 // do not load content
1570 $categorycontent = '';
1571 $classes[] = 'notloaded';
1572 if ($coursecat->get_children_count() ||
1573 ($chelper->get_show_courses() >= self
::COURSECAT_SHOW_COURSES_COLLAPSED
&& $coursecat->get_courses_count())) {
1574 $classes[] = 'with_children';
1575 $classes[] = 'collapsed';
1578 // load category content
1579 $categorycontent = $this->coursecat_category_content($chelper, $coursecat, $depth);
1580 $classes[] = 'loaded';
1581 if (!empty($categorycontent)) {
1582 $classes[] = 'with_children';
1586 // Make sure JS file to expand category content is included.
1587 $this->coursecat_include_js();
1589 $content = html_writer
::start_tag('div', array(
1590 'class' => join(' ', $classes),
1591 'data-categoryid' => $coursecat->id
,
1592 'data-depth' => $depth,
1593 'data-showcourses' => $chelper->get_show_courses(),
1594 'data-type' => self
::COURSECAT_TYPE_CATEGORY
,
1598 $categoryname = $coursecat->get_formatted_name();
1599 $categoryname = html_writer
::link(new moodle_url('/course/index.php',
1600 array('categoryid' => $coursecat->id
)),
1602 if ($chelper->get_show_courses() == self
::COURSECAT_SHOW_COURSES_COUNT
1603 && ($coursescount = $coursecat->get_courses_count())) {
1604 $categoryname .= html_writer
::tag('span', ' ('. $coursescount.')',
1605 array('title' => get_string('numberofcourses'), 'class' => 'numberofcourse'));
1607 $content .= html_writer
::start_tag('div', array('class' => 'info'));
1609 $content .= html_writer
::tag(($depth > 1) ?
'h4' : 'h3', $categoryname, array('class' => 'categoryname'));
1610 $content .= html_writer
::end_tag('div'); // .info
1612 // add category content to the output
1613 $content .= html_writer
::tag('div', $categorycontent, array('class' => 'content'));
1615 $content .= html_writer
::end_tag('div'); // .category
1617 // Return the course category tree HTML
1622 * Returns HTML to display a tree of subcategories and courses in the given category
1624 * @param coursecat_helper $chelper various display options
1625 * @param coursecat $coursecat top category (this category's name and description will NOT be added to the tree)
1628 protected function coursecat_tree(coursecat_helper
$chelper, $coursecat) {
1629 $categorycontent = $this->coursecat_category_content($chelper, $coursecat, 0);
1630 if (empty($categorycontent)) {
1634 // Start content generation
1636 $attributes = $chelper->get_and_erase_attributes('course_category_tree clearfix');
1637 $content .= html_writer
::start_tag('div', $attributes);
1639 if ($coursecat->get_children_count()) {
1644 if ($chelper->get_subcat_depth() == 1) {
1645 $classes[] = 'disabled';
1647 // Only show the collapse/expand if there are children to expand.
1648 $content .= html_writer
::start_tag('div', array('class' => 'collapsible-actions'));
1649 $content .= html_writer
::link('#', get_string('collapseall'),
1650 array('class' => implode(' ', $classes)));
1651 $content .= html_writer
::end_tag('div');
1652 $this->page
->requires
->strings_for_js(array('collapseall', 'expandall'), 'moodle');
1655 $content .= html_writer
::tag('div', $categorycontent, array('class' => 'content'));
1657 $content .= html_writer
::end_tag('div'); // .course_category_tree
1663 * Renders HTML to display particular course category - list of it's subcategories and courses
1665 * Invoked from /course/index.php
1667 * @param int|stdClass|coursecat $category
1669 public function course_category($category) {
1671 require_once($CFG->libdir
. '/coursecatlib.php');
1672 $coursecat = coursecat
::get(is_object($category) ?
$category->id
: $category);
1676 if (can_edit_in_category($category)) {
1677 // Add 'Manage' button if user has permissions to edit this category.
1678 $managebutton = $this->single_button(new moodle_url('/course/management.php'), get_string('managecourses'), 'get');
1679 $this->page
->set_button($managebutton);
1681 if (!$coursecat->id
) {
1682 if (coursecat
::count_all() == 1) {
1683 // There exists only one category in the system, do not display link to it
1684 $coursecat = coursecat
::get_default();
1685 $strfulllistofcourses = get_string('fulllistofcourses');
1686 $this->page
->set_title("$site->shortname: $strfulllistofcourses");
1688 $strcategories = get_string('categories');
1689 $this->page
->set_title("$site->shortname: $strcategories");
1692 $this->page
->set_title("$site->shortname: ". $coursecat->get_formatted_name());
1694 // Print the category selector
1695 $output .= html_writer
::start_tag('div', array('class' => 'categorypicker'));
1696 $select = new single_select(new moodle_url('/course/index.php'), 'categoryid',
1697 coursecat
::make_categories_list(), $coursecat->id
, null, 'switchcategory');
1698 $select->set_label(get_string('categories').':');
1699 $output .= $this->render($select);
1700 $output .= html_writer
::end_tag('div'); // .categorypicker
1703 // Print current category description
1704 $chelper = new coursecat_helper();
1705 if ($description = $chelper->get_category_formatted_description($coursecat)) {
1706 $output .= $this->box($description, array('class' => 'generalbox info'));
1709 // Prepare parameters for courses and categories lists in the tree
1710 $chelper->set_show_courses(self
::COURSECAT_SHOW_COURSES_AUTO
)
1711 ->set_attributes(array('class' => 'category-browse category-browse-'.$coursecat->id
));
1713 $coursedisplayoptions = array();
1714 $catdisplayoptions = array();
1715 $browse = optional_param('browse', null, PARAM_ALPHA
);
1716 $perpage = optional_param('perpage', $CFG->coursesperpage
, PARAM_INT
);
1717 $page = optional_param('page', 0, PARAM_INT
);
1718 $baseurl = new moodle_url('/course/index.php');
1719 if ($coursecat->id
) {
1720 $baseurl->param('categoryid', $coursecat->id
);
1722 if ($perpage != $CFG->coursesperpage
) {
1723 $baseurl->param('perpage', $perpage);
1725 $coursedisplayoptions['limit'] = $perpage;
1726 $catdisplayoptions['limit'] = $perpage;
1727 if ($browse === 'courses' ||
!$coursecat->has_children()) {
1728 $coursedisplayoptions['offset'] = $page * $perpage;
1729 $coursedisplayoptions['paginationurl'] = new moodle_url($baseurl, array('browse' => 'courses'));
1730 $catdisplayoptions['nodisplay'] = true;
1731 $catdisplayoptions['viewmoreurl'] = new moodle_url($baseurl, array('browse' => 'categories'));
1732 $catdisplayoptions['viewmoretext'] = new lang_string('viewallsubcategories');
1733 } else if ($browse === 'categories' ||
!$coursecat->has_courses()) {
1734 $coursedisplayoptions['nodisplay'] = true;
1735 $catdisplayoptions['offset'] = $page * $perpage;
1736 $catdisplayoptions['paginationurl'] = new moodle_url($baseurl, array('browse' => 'categories'));
1737 $coursedisplayoptions['viewmoreurl'] = new moodle_url($baseurl, array('browse' => 'courses'));
1738 $coursedisplayoptions['viewmoretext'] = new lang_string('viewallcourses');
1740 // we have a category that has both subcategories and courses, display pagination separately
1741 $coursedisplayoptions['viewmoreurl'] = new moodle_url($baseurl, array('browse' => 'courses', 'page' => 1));
1742 $catdisplayoptions['viewmoreurl'] = new moodle_url($baseurl, array('browse' => 'categories', 'page' => 1));
1744 $chelper->set_courses_display_options($coursedisplayoptions)->set_categories_display_options($catdisplayoptions);
1745 // Add course search form.
1746 $output .= $this->course_search_form();
1748 // Display course category tree.
1749 $output .= $this->coursecat_tree($chelper, $coursecat);
1751 // Add action buttons
1752 $output .= $this->container_start('buttons');
1753 $context = get_category_or_system_context($coursecat->id
);
1754 if (has_capability('moodle/course:create', $context)) {
1755 // Print link to create a new course, for the 1st available category.
1756 if ($coursecat->id
) {
1757 $url = new moodle_url('/course/edit.php', array('category' => $coursecat->id
, 'returnto' => 'category'));
1759 $url = new moodle_url('/course/edit.php', array('category' => $CFG->defaultrequestcategory
, 'returnto' => 'topcat'));
1761 $output .= $this->single_button($url, get_string('addnewcourse'), 'get');
1764 if (coursecat
::count_all() == 1) {
1765 print_course_request_buttons(context_system
::instance());
1767 print_course_request_buttons($context);
1769 $output .= ob_get_contents();
1771 $output .= $this->container_end();
1777 * Serves requests to /course/category.ajax.php
1779 * In this renderer implementation it may expand the category content or
1783 * @throws coding_exception
1785 public function coursecat_ajax() {
1787 require_once($CFG->libdir
. '/coursecatlib.php');
1789 $type = required_param('type', PARAM_INT
);
1791 if ($type === self
::COURSECAT_TYPE_CATEGORY
) {
1792 // This is a request for a category list of some kind.
1793 $categoryid = required_param('categoryid', PARAM_INT
);
1794 $showcourses = required_param('showcourses', PARAM_INT
);
1795 $depth = required_param('depth', PARAM_INT
);
1797 $category = coursecat
::get($categoryid);
1799 $chelper = new coursecat_helper();
1800 $baseurl = new moodle_url('/course/index.php', array('categoryid' => $categoryid));
1801 $coursedisplayoptions = array(
1802 'limit' => $CFG->coursesperpage
,
1803 'viewmoreurl' => new moodle_url($baseurl, array('browse' => 'courses', 'page' => 1))
1805 $catdisplayoptions = array(
1806 'limit' => $CFG->coursesperpage
,
1807 'viewmoreurl' => new moodle_url($baseurl, array('browse' => 'categories', 'page' => 1))
1809 $chelper->set_show_courses($showcourses)->
1810 set_courses_display_options($coursedisplayoptions)->
1811 set_categories_display_options($catdisplayoptions);
1813 return $this->coursecat_category_content($chelper, $category, $depth);
1814 } else if ($type === self
::COURSECAT_TYPE_COURSE
) {
1815 // This is a request for the course information.
1816 $courseid = required_param('courseid', PARAM_INT
);
1818 $course = $DB->get_record('course', array('id' => $courseid), '*', MUST_EXIST
);
1820 $chelper = new coursecat_helper();
1821 $chelper->set_show_courses(self
::COURSECAT_SHOW_COURSES_EXPANDED
);
1822 return $this->coursecat_coursebox_content($chelper, $course);
1824 throw new coding_exception('Invalid request type');
1829 * Renders html to display search result page
1831 * @param array $searchcriteria may contain elements: search, blocklist, modulelist, tagid
1834 public function search_courses($searchcriteria) {
1837 if (!empty($searchcriteria)) {
1838 // print search results
1839 require_once($CFG->libdir
. '/coursecatlib.php');
1841 $displayoptions = array('sort' => array('displayname' => 1));
1842 // take the current page and number of results per page from query
1843 $perpage = optional_param('perpage', 0, PARAM_RAW
);
1844 if ($perpage !== 'all') {
1845 $displayoptions['limit'] = ((int)$perpage <= 0) ?
$CFG->coursesperpage
: (int)$perpage;
1846 $page = optional_param('page', 0, PARAM_INT
);
1847 $displayoptions['offset'] = $displayoptions['limit'] * $page;
1849 // options 'paginationurl' and 'paginationallowall' are only used in method coursecat_courses()
1850 $displayoptions['paginationurl'] = new moodle_url('/course/search.php', $searchcriteria);
1851 $displayoptions['paginationallowall'] = true; // allow adding link 'View all'
1853 $class = 'course-search-result';
1854 foreach ($searchcriteria as $key => $value) {
1855 if (!empty($value)) {
1856 $class .= ' course-search-result-'. $key;
1859 $chelper = new coursecat_helper();
1860 $chelper->set_show_courses(self
::COURSECAT_SHOW_COURSES_EXPANDED_WITH_CAT
)->
1861 set_courses_display_options($displayoptions)->
1862 set_search_criteria($searchcriteria)->
1863 set_attributes(array('class' => $class));
1865 $courses = coursecat
::search_courses($searchcriteria, $chelper->get_courses_display_options());
1866 $totalcount = coursecat
::search_courses_count($searchcriteria);
1867 $courseslist = $this->coursecat_courses($chelper, $courses, $totalcount);
1870 if (!empty($searchcriteria['search'])) {
1871 $content .= $this->heading(get_string('nocoursesfound', '', $searchcriteria['search']));
1873 $content .= $this->heading(get_string('novalidcourses'));
1876 $content .= $this->heading(get_string('searchresults'). ": $totalcount");
1877 $content .= $courseslist;
1880 if (!empty($searchcriteria['search'])) {
1881 // print search form only if there was a search by search string, otherwise it is confusing
1882 $content .= $this->box_start('generalbox mdl-align');
1883 $content .= $this->course_search_form($searchcriteria['search']);
1884 $content .= $this->box_end();
1887 // just print search form
1888 $content .= $this->box_start('generalbox mdl-align');
1889 $content .= $this->course_search_form();
1890 $content .= html_writer
::tag('div', get_string("searchhelp"), array('class' => 'searchhelp'));
1891 $content .= $this->box_end();
1897 * Renders html to print list of courses tagged with particular tag
1899 * @param int $tagid id of the tag
1900 * @return string empty string if no courses are marked with this tag or rendered list of courses
1902 public function tagged_courses($tagid) {
1904 require_once($CFG->libdir
. '/coursecatlib.php');
1905 $displayoptions = array('limit' => $CFG->coursesperpage
);
1906 $displayoptions['viewmoreurl'] = new moodle_url('/course/search.php',
1907 array('tagid' => $tagid, 'page' => 1, 'perpage' => $CFG->coursesperpage
));
1908 $displayoptions['viewmoretext'] = new lang_string('findmorecourses');
1909 $chelper = new coursecat_helper();
1910 $searchcriteria = array('tagid' => $tagid);
1911 $chelper->set_show_courses(self
::COURSECAT_SHOW_COURSES_EXPANDED_WITH_CAT
)->
1912 set_search_criteria(array('tagid' => $tagid))->
1913 set_courses_display_options($displayoptions)->
1914 set_attributes(array('class' => 'course-search-result course-search-result-tagid'));
1915 // (we set the same css class as in search results by tagid)
1916 $courses = coursecat
::search_courses($searchcriteria, $chelper->get_courses_display_options());
1917 $totalcount = coursecat
::search_courses_count($searchcriteria);
1918 $content = $this->coursecat_courses($chelper, $courses, $totalcount);
1920 require_once $CFG->dirroot
.'/tag/lib.php';
1921 $heading = get_string('courses') . ' ' . get_string('taggedwith', 'tag', tag_get_name($tagid)) .': '. $totalcount;
1922 return $this->heading($heading, 3). $content;
1928 * Returns HTML to display one remote course
1930 * @param stdClass $course remote course information, contains properties:
1931 id, remoteid, shortname, fullname, hostid, summary, summaryformat, cat_name, hostname
1934 protected function frontpage_remote_course(stdClass
$course) {
1935 $url = new moodle_url('/auth/mnet/jump.php', array(
1936 'hostid' => $course->hostid
,
1937 'wantsurl' => '/course/view.php?id='. $course->remoteid
1941 $output .= html_writer
::start_tag('div', array('class' => 'coursebox remotecoursebox clearfix'));
1942 $output .= html_writer
::start_tag('div', array('class' => 'info'));
1943 $output .= html_writer
::start_tag('h3', array('class' => 'name'));
1944 $output .= html_writer
::link($url, format_string($course->fullname
), array('title' => get_string('entercourse')));
1945 $output .= html_writer
::end_tag('h3'); // .name
1946 $output .= html_writer
::tag('div', '', array('class' => 'moreinfo'));
1947 $output .= html_writer
::end_tag('div'); // .info
1948 $output .= html_writer
::start_tag('div', array('class' => 'content'));
1949 $output .= html_writer
::start_tag('div', array('class' => 'summary'));
1950 $options = new stdClass();
1951 $options->noclean
= true;
1952 $options->para
= false;
1953 $options->overflowdiv
= true;
1954 $output .= format_text($course->summary
, $course->summaryformat
, $options);
1955 $output .= html_writer
::end_tag('div'); // .summary
1956 $addinfo = format_string($course->hostname
) . ' : '
1957 . format_string($course->cat_name
) . ' : '
1958 . format_string($course->shortname
);
1959 $output .= html_writer
::tag('div', $addinfo, array('class' => 'remotecourseinfo'));
1960 $output .= html_writer
::end_tag('div'); // .content
1961 $output .= html_writer
::end_tag('div'); // .coursebox
1966 * Returns HTML to display one remote host
1968 * @param array $host host information, contains properties: name, url, count
1971 protected function frontpage_remote_host($host) {
1973 $output .= html_writer
::start_tag('div', array('class' => 'coursebox remotehost clearfix'));
1974 $output .= html_writer
::start_tag('div', array('class' => 'info'));
1975 $output .= html_writer
::start_tag('h3', array('class' => 'name'));
1976 $output .= html_writer
::link($host['url'], s($host['name']), array('title' => s($host['name'])));
1977 $output .= html_writer
::end_tag('h3'); // .name
1978 $output .= html_writer
::tag('div', '', array('class' => 'moreinfo'));
1979 $output .= html_writer
::end_tag('div'); // .info
1980 $output .= html_writer
::start_tag('div', array('class' => 'content'));
1981 $output .= html_writer
::start_tag('div', array('class' => 'summary'));
1982 $output .= $host['count'] . ' ' . get_string('courses');
1983 $output .= html_writer
::end_tag('div'); // .content
1984 $output .= html_writer
::end_tag('div'); // .coursebox
1989 * Returns HTML to print list of courses user is enrolled to for the frontpage
1991 * Also lists remote courses or remote hosts if MNET authorisation is used
1995 public function frontpage_my_courses() {
1996 global $USER, $CFG, $DB;
1998 if (!isloggedin() or isguestuser()) {
2003 if (!empty($CFG->navsortmycoursessort
)) {
2004 // sort courses the same as in navigation menu
2005 $sortorder = 'visible DESC,'. $CFG->navsortmycoursessort
.' ASC';
2007 $sortorder = 'visible DESC,sortorder ASC';
2009 $courses = enrol_get_my_courses('summary, summaryformat', $sortorder);
2011 $rcourses = array();
2012 if (!empty($CFG->mnet_dispatcher_mode
) && $CFG->mnet_dispatcher_mode
==='strict') {
2013 $rcourses = get_my_remotecourses($USER->id
);
2014 $rhosts = get_my_remotehosts();
2017 if (!empty($courses) ||
!empty($rcourses) ||
!empty($rhosts)) {
2019 $chelper = new coursecat_helper();
2020 if (count($courses) > $CFG->frontpagecourselimit
) {
2021 // There are more enrolled courses than we can display, display link to 'My courses'.
2022 $totalcount = count($courses);
2023 $courses = array_slice($courses, 0, $CFG->frontpagecourselimit
, true);
2024 $chelper->set_courses_display_options(array(
2025 'viewmoreurl' => new moodle_url('/my/'),
2026 'viewmoretext' => new lang_string('mycourses')
2029 // All enrolled courses are displayed, display link to 'All courses' if there are more courses in system.
2030 $chelper->set_courses_display_options(array(
2031 'viewmoreurl' => new moodle_url('/course/index.php'),
2032 'viewmoretext' => new lang_string('fulllistofcourses')
2034 $totalcount = $DB->count_records('course') - 1;
2036 $chelper->set_show_courses(self
::COURSECAT_SHOW_COURSES_EXPANDED
)->
2037 set_attributes(array('class' => 'frontpage-course-list-enrolled'));
2038 $output .= $this->coursecat_courses($chelper, $courses, $totalcount);
2041 if (!empty($rcourses)) {
2042 // at the IDP, we know of all the remote courses
2043 $output .= html_writer
::start_tag('div', array('class' => 'courses'));
2044 foreach ($rcourses as $course) {
2045 $output .= $this->frontpage_remote_course($course);
2047 $output .= html_writer
::end_tag('div'); // .courses
2048 } elseif (!empty($rhosts)) {
2049 // non-IDP, we know of all the remote servers, but not courses
2050 $output .= html_writer
::start_tag('div', array('class' => 'courses'));
2051 foreach ($rhosts as $host) {
2052 $output .= $this->frontpage_remote_host($host);
2054 $output .= html_writer
::end_tag('div'); // .courses
2061 * Returns HTML to print list of available courses for the frontpage
2065 public function frontpage_available_courses() {
2067 require_once($CFG->libdir
. '/coursecatlib.php');
2069 $chelper = new coursecat_helper();
2070 $chelper->set_show_courses(self
::COURSECAT_SHOW_COURSES_EXPANDED
)->
2071 set_courses_display_options(array(
2072 'recursive' => true,
2073 'limit' => $CFG->frontpagecourselimit
,
2074 'viewmoreurl' => new moodle_url('/course/index.php'),
2075 'viewmoretext' => new lang_string('fulllistofcourses')));
2077 $chelper->set_attributes(array('class' => 'frontpage-course-list-all'));
2078 $courses = coursecat
::get(0)->get_courses($chelper->get_courses_display_options());
2079 $totalcount = coursecat
::get(0)->get_courses_count($chelper->get_courses_display_options());
2080 if (!$totalcount && !$this->page
->user_is_editing() && has_capability('moodle/course:create', context_system
::instance())) {
2081 // Print link to create a new course, for the 1st available category.
2082 return $this->add_new_course_button();
2084 return $this->coursecat_courses($chelper, $courses, $totalcount);
2088 * Returns HTML to the "add new course" button for the page
2092 public function add_new_course_button() {
2094 // Print link to create a new course, for the 1st available category.
2095 $output = $this->container_start('buttons');
2096 $url = new moodle_url('/course/edit.php', array('category' => $CFG->defaultrequestcategory
, 'returnto' => 'topcat'));
2097 $output .= $this->single_button($url, get_string('addnewcourse'), 'get');
2098 $output .= $this->container_end('buttons');
2103 * Returns HTML to print tree with course categories and courses for the frontpage
2107 public function frontpage_combo_list() {
2109 require_once($CFG->libdir
. '/coursecatlib.php');
2110 $chelper = new coursecat_helper();
2111 $chelper->set_subcat_depth($CFG->maxcategorydepth
)->
2112 set_categories_display_options(array(
2113 'limit' => $CFG->coursesperpage
,
2114 'viewmoreurl' => new moodle_url('/course/index.php',
2115 array('browse' => 'categories', 'page' => 1))
2117 set_courses_display_options(array(
2118 'limit' => $CFG->coursesperpage
,
2119 'viewmoreurl' => new moodle_url('/course/index.php',
2120 array('browse' => 'courses', 'page' => 1))
2122 set_attributes(array('class' => 'frontpage-category-combo'));
2123 return $this->coursecat_tree($chelper, coursecat
::get(0));
2127 * Returns HTML to print tree of course categories (with number of courses) for the frontpage
2131 public function frontpage_categories_list() {
2133 require_once($CFG->libdir
. '/coursecatlib.php');
2134 $chelper = new coursecat_helper();
2135 $chelper->set_subcat_depth($CFG->maxcategorydepth
)->
2136 set_show_courses(self
::COURSECAT_SHOW_COURSES_COUNT
)->
2137 set_categories_display_options(array(
2138 'limit' => $CFG->coursesperpage
,
2139 'viewmoreurl' => new moodle_url('/course/index.php',
2140 array('browse' => 'categories', 'page' => 1))
2142 set_attributes(array('class' => 'frontpage-category-names'));
2143 return $this->coursecat_tree($chelper, coursecat
::get(0));
2148 * Class storing display options and functions to help display course category and/or courses lists
2150 * This is a wrapper for coursecat objects that also stores display options
2151 * and functions to retrieve sorted and paginated lists of categories/courses.
2153 * If theme overrides methods in core_course_renderers that access this class
2154 * it may as well not use this class at all or extend it.
2157 * @copyright 2013 Marina Glancy
2158 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2160 class coursecat_helper
{
2161 /** @var string [none, collapsed, expanded] how (if) display courses list */
2162 protected $showcourses = 10; /* core_course_renderer::COURSECAT_SHOW_COURSES_COLLAPSED */
2163 /** @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) */
2164 protected $subcatdepth = 1;
2165 /** @var array options to display courses list */
2166 protected $coursesdisplayoptions = array();
2167 /** @var array options to display subcategories list */
2168 protected $categoriesdisplayoptions = array();
2169 /** @var array additional HTML attributes */
2170 protected $attributes = array();
2171 /** @var array search criteria if the list is a search result */
2172 protected $searchcriteria = null;
2175 * Sets how (if) to show the courses - none, collapsed, expanded, etc.
2177 * @param int $showcourses SHOW_COURSES_NONE, SHOW_COURSES_COLLAPSED, SHOW_COURSES_EXPANDED, etc.
2178 * @return coursecat_helper
2180 public function set_show_courses($showcourses) {
2181 $this->showcourses
= $showcourses;
2182 // Automatically set the options to preload summary and coursecontacts for coursecat::get_courses() and coursecat::search_courses()
2183 $this->coursesdisplayoptions
['summary'] = $showcourses >= core_course_renderer
::COURSECAT_SHOW_COURSES_AUTO
;
2184 $this->coursesdisplayoptions
['coursecontacts'] = $showcourses >= core_course_renderer
::COURSECAT_SHOW_COURSES_EXPANDED
;
2189 * Returns how (if) to show the courses - none, collapsed, expanded, etc.
2191 * @return int - COURSECAT_SHOW_COURSES_NONE, COURSECAT_SHOW_COURSES_COLLAPSED, COURSECAT_SHOW_COURSES_EXPANDED, etc.
2193 public function get_show_courses() {
2194 return $this->showcourses
;
2198 * Sets the maximum depth to expand subcategories in the tree
2200 * deeper subcategories may be loaded by AJAX or proceed to category page by clicking on category name
2202 * @param int $subcatdepth
2203 * @return coursecat_helper
2205 public function set_subcat_depth($subcatdepth) {
2206 $this->subcatdepth
= $subcatdepth;
2211 * Returns the maximum depth to expand subcategories in the tree
2213 * deeper subcategories may be loaded by AJAX or proceed to category page by clicking on category name
2217 public function get_subcat_depth() {
2218 return $this->subcatdepth
;
2222 * Sets options to display list of courses
2224 * Options are later submitted as argument to coursecat::get_courses() and/or coursecat::search_courses()
2226 * Options that coursecat::get_courses() accept:
2227 * - recursive - return courses from subcategories as well. Use with care,
2228 * this may be a huge list!
2229 * - summary - preloads fields 'summary' and 'summaryformat'
2230 * - coursecontacts - preloads course contacts
2231 * - isenrolled - preloads indication whether this user is enrolled in the course
2232 * - sort - list of fields to sort. Example
2233 * array('idnumber' => 1, 'shortname' => 1, 'id' => -1)
2234 * will sort by idnumber asc, shortname asc and id desc.
2235 * Default: array('sortorder' => 1)
2236 * Only cached fields may be used for sorting!
2238 * - limit - maximum number of children to return, 0 or null for no limit
2240 * Options summary and coursecontacts are filled automatically in the set_show_courses()
2242 * Also renderer can set here any additional options it wants to pass between renderer functions.
2244 * @param array $options
2245 * @return coursecat_helper
2247 public function set_courses_display_options($options) {
2248 $this->coursesdisplayoptions
= $options;
2249 $this->set_show_courses($this->showcourses
); // this will calculate special display options
2254 * Sets one option to display list of courses
2256 * @see coursecat_helper::set_courses_display_options()
2258 * @param string $key
2259 * @param mixed $value
2260 * @return coursecat_helper
2262 public function set_courses_display_option($key, $value) {
2263 $this->coursesdisplayoptions
[$key] = $value;
2268 * Return the specified option to display list of courses
2270 * @param string $optionname option name
2271 * @param mixed $defaultvalue default value for option if it is not specified
2274 public function get_courses_display_option($optionname, $defaultvalue = null) {
2275 if (array_key_exists($optionname, $this->coursesdisplayoptions
)) {
2276 return $this->coursesdisplayoptions
[$optionname];
2278 return $defaultvalue;
2283 * Returns all options to display the courses
2285 * This array is usually passed to {@link coursecat::get_courses()} or
2286 * {@link coursecat::search_courses()}
2290 public function get_courses_display_options() {
2291 return $this->coursesdisplayoptions
;
2295 * Sets options to display list of subcategories
2297 * Options 'sort', 'offset' and 'limit' are passed to coursecat::get_children().
2298 * Any other options may be used by renderer functions
2300 * @param array $options
2301 * @return coursecat_helper
2303 public function set_categories_display_options($options) {
2304 $this->categoriesdisplayoptions
= $options;
2309 * Return the specified option to display list of subcategories
2311 * @param string $optionname option name
2312 * @param mixed $defaultvalue default value for option if it is not specified
2315 public function get_categories_display_option($optionname, $defaultvalue = null) {
2316 if (array_key_exists($optionname, $this->categoriesdisplayoptions
)) {
2317 return $this->categoriesdisplayoptions
[$optionname];
2319 return $defaultvalue;
2324 * Returns all options to display list of subcategories
2326 * This array is usually passed to {@link coursecat::get_children()}
2330 public function get_categories_display_options() {
2331 return $this->categoriesdisplayoptions
;
2335 * Sets additional general options to pass between renderer functions, usually HTML attributes
2337 * @param array $attributes
2338 * @return coursecat_helper
2340 public function set_attributes($attributes) {
2341 $this->attributes
= $attributes;
2346 * Return all attributes and erases them so they are not applied again
2348 * @param string $classname adds additional class name to the beginning of $attributes['class']
2351 public function get_and_erase_attributes($classname) {
2352 $attributes = $this->attributes
;
2353 $this->attributes
= array();
2354 if (empty($attributes['class'])) {
2355 $attributes['class'] = '';
2357 $attributes['class'] = $classname . ' '. $attributes['class'];
2362 * Sets the search criteria if the course is a search result
2364 * Search string will be used to highlight terms in course name and description
2366 * @param array $searchcriteria
2367 * @return coursecat_helper
2369 public function set_search_criteria($searchcriteria) {
2370 $this->searchcriteria
= $searchcriteria;
2375 * Returns formatted and filtered description of the given category
2377 * @param coursecat $coursecat category
2378 * @param stdClass|array $options format options, by default [noclean,overflowdiv],
2379 * if context is not specified it will be added automatically
2380 * @return string|null
2382 public function get_category_formatted_description($coursecat, $options = null) {
2383 if ($coursecat->id
&& !empty($coursecat->description
)) {
2384 if (!isset($coursecat->descriptionformat
)) {
2385 $descriptionformat = FORMAT_MOODLE
;
2387 $descriptionformat = $coursecat->descriptionformat
;
2389 if ($options === null) {
2390 $options = array('noclean' => true, 'overflowdiv' => true);
2392 $options = (array)$options;
2394 $context = context_coursecat
::instance($coursecat->id
);
2395 if (!isset($options['context'])) {
2396 $options['context'] = $context;
2398 $text = file_rewrite_pluginfile_urls($coursecat->description
,
2399 'pluginfile.php', $context->id
, 'coursecat', 'description', null);
2400 return format_text($text, $descriptionformat, $options);
2406 * Returns given course's summary with proper embedded files urls and formatted
2408 * @param course_in_list $course
2409 * @param array|stdClass $options additional formatting options
2412 public function get_course_formatted_summary($course, $options = array()) {
2414 require_once($CFG->libdir
. '/filelib.php');
2415 if (!$course->has_summary()) {
2418 $options = (array)$options;
2419 $context = context_course
::instance($course->id
);
2420 if (!isset($options['context'])) {
2421 // TODO see MDL-38521
2422 // option 1 (current), page context - no code required
2423 // option 2, system context
2424 // $options['context'] = context_system::instance();
2425 // option 3, course context:
2426 // $options['context'] = $context;
2427 // option 4, course category context:
2428 // $options['context'] = $context->get_parent_context();
2430 $summary = file_rewrite_pluginfile_urls($course->summary
, 'pluginfile.php', $context->id
, 'course', 'summary', null);
2431 $summary = format_text($summary, $course->summaryformat
, $options, $course->id
);
2432 if (!empty($this->searchcriteria
['search'])) {
2433 $summary = highlight($this->searchcriteria
['search'], $summary);
2439 * Returns course name as it is configured to appear in courses lists formatted to course context
2441 * @param course_in_list $course
2442 * @param array|stdClass $options additional formatting options
2445 public function get_course_formatted_name($course, $options = array()) {
2446 $options = (array)$options;
2447 if (!isset($options['context'])) {
2448 $options['context'] = context_course
::instance($course->id
);
2450 $name = format_string(get_course_display_name_for_list($course), true, $options);
2451 if (!empty($this->searchcriteria
['search'])) {
2452 $name = highlight($this->searchcriteria
['search'], $name);