MDL-67264 core_course: Activity chooser new feature
[moodle.git] / course / format / renderer.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Base renderer for outputting course formats.
19  *
20  * @package core
21  * @copyright 2012 Dan Poltawski
22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  * @since Moodle 2.3
24  */
26 defined('MOODLE_INTERNAL') || die();
29 /**
30  * This is a convenience renderer which can be used by section based formats
31  * to reduce code duplication. It is not necessary for all course formats to
32  * use this and its likely to change in future releases.
33  *
34  * @package core
35  * @copyright 2012 Dan Poltawski
36  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37  * @since Moodle 2.3
38  */
39 abstract class format_section_renderer_base extends plugin_renderer_base {
41     /** @var core_course_renderer contains instance of core course renderer */
42     protected $courserenderer;
44     /**
45      * Constructor method, calls the parent constructor
46      *
47      * @param moodle_page $page
48      * @param string $target one of rendering target constants
49      */
50     public function __construct(moodle_page $page, $target) {
51         parent::__construct($page, $target);
52         $this->courserenderer = $this->page->get_renderer('core', 'course');
53     }
55     /**
56      * Generate the starting container html for a list of sections
57      * @return string HTML to output.
58      */
59     abstract protected function start_section_list();
61     /**
62      * Generate the closing container html for a list of sections
63      * @return string HTML to output.
64      */
65     abstract protected function end_section_list();
67     /**
68      * Generate the title for this section page
69      * @return string the page title
70      */
71     abstract protected function page_title();
73     /**
74      * Generate the section title, wraps it in a link to the section page if page is to be displayed on a separate page
75      *
76      * @param stdClass $section The course_section entry from DB
77      * @param stdClass $course The course entry from DB
78      * @return string HTML to output.
79      */
80     public function section_title($section, $course) {
81         $title = get_section_name($course, $section);
82         $url = course_get_url($course, $section->section, array('navigation' => true));
83         if ($url) {
84             $title = html_writer::link($url, $title);
85         }
86         return $title;
87     }
89     /**
90      * Generate the section title to be displayed on the section page, without a link
91      *
92      * @param stdClass $section The course_section entry from DB
93      * @param stdClass $course The course entry from DB
94      * @return string HTML to output.
95      */
96     public function section_title_without_link($section, $course) {
97         return get_section_name($course, $section);
98     }
100     /**
101      * Generate the edit control action menu
102      *
103      * @param array $controls The edit control items from section_edit_control_items
104      * @param stdClass $course The course entry from DB
105      * @param stdClass $section The course_section entry from DB
106      * @return string HTML to output.
107      */
108     protected function section_edit_control_menu($controls, $course, $section) {
109         $o = "";
110         if (!empty($controls)) {
111             $menu = new action_menu();
112             $menu->set_menu_trigger(get_string('edit'));
113             $menu->attributes['class'] .= ' section-actions';
114             foreach ($controls as $value) {
115                 $url = empty($value['url']) ? '' : $value['url'];
116                 $icon = empty($value['icon']) ? '' : $value['icon'];
117                 $name = empty($value['name']) ? '' : $value['name'];
118                 $attr = empty($value['attr']) ? array() : $value['attr'];
119                 $class = empty($value['pixattr']['class']) ? '' : $value['pixattr']['class'];
120                 $al = new action_menu_link_secondary(
121                     new moodle_url($url),
122                     new pix_icon($icon, '', null, array('class' => "smallicon " . $class)),
123                     $name,
124                     $attr
125                 );
126                 $menu->add($al);
127             }
129             $o .= html_writer::div($this->render($menu), 'section_action_menu',
130                 array('data-sectionid' => $section->id));
131         }
133         return $o;
134     }
136     /**
137      * Generate the content to displayed on the right part of a section
138      * before course modules are included
139      *
140      * @param stdClass $section The course_section entry from DB
141      * @param stdClass $course The course entry from DB
142      * @param bool $onsectionpage true if being printed on a section page
143      * @return string HTML to output.
144      */
145     protected function section_right_content($section, $course, $onsectionpage) {
146         $o = $this->output->spacer();
148         $controls = $this->section_edit_control_items($course, $section, $onsectionpage);
149         $o .= $this->section_edit_control_menu($controls, $course, $section);
151         return $o;
152     }
154     /**
155      * Generate the content to displayed on the left part of a section
156      * before course modules are included
157      *
158      * @param stdClass $section The course_section entry from DB
159      * @param stdClass $course The course entry from DB
160      * @param bool $onsectionpage true if being printed on a section page
161      * @return string HTML to output.
162      */
163     protected function section_left_content($section, $course, $onsectionpage) {
164         $o = '';
166         if ($section->section != 0) {
167             // Only in the non-general sections.
168             if (course_get_format($course)->is_section_current($section)) {
169                 $o = get_accesshide(get_string('currentsection', 'format_'.$course->format));
170             }
171         }
173         return $o;
174     }
176     /**
177      * Generate the display of the header part of a section before
178      * course modules are included
179      *
180      * @param stdClass $section The course_section entry from DB
181      * @param stdClass $course The course entry from DB
182      * @param bool $onsectionpage true if being printed on a single-section page
183      * @param int $sectionreturn The section to return to after an action
184      * @return string HTML to output.
185      */
186     protected function section_header($section, $course, $onsectionpage, $sectionreturn=null) {
187         global $PAGE;
189         $o = '';
190         $currenttext = '';
191         $sectionstyle = '';
193         if ($section->section != 0) {
194             // Only in the non-general sections.
195             if (!$section->visible) {
196                 $sectionstyle = ' hidden';
197             }
198             if (course_get_format($course)->is_section_current($section)) {
199                 $sectionstyle = ' current';
200             }
201         }
203         $o.= html_writer::start_tag('li', array('id' => 'section-'.$section->section,
204             'class' => 'section main clearfix'.$sectionstyle, 'role'=>'region',
205             'aria-label'=> get_section_name($course, $section)));
207         // Create a span that contains the section title to be used to create the keyboard section move menu.
208         $o .= html_writer::tag('span', get_section_name($course, $section), array('class' => 'hidden sectionname'));
210         $leftcontent = $this->section_left_content($section, $course, $onsectionpage);
211         $o.= html_writer::tag('div', $leftcontent, array('class' => 'left side'));
213         $rightcontent = $this->section_right_content($section, $course, $onsectionpage);
214         $o.= html_writer::tag('div', $rightcontent, array('class' => 'right side'));
215         $o.= html_writer::start_tag('div', array('class' => 'content'));
217         // When not on a section page, we display the section titles except the general section if null
218         $hasnamenotsecpg = (!$onsectionpage && ($section->section != 0 || !is_null($section->name)));
220         // When on a section page, we only display the general section title, if title is not the default one
221         $hasnamesecpg = ($onsectionpage && ($section->section == 0 && !is_null($section->name)));
223         $classes = ' accesshide';
224         if ($hasnamenotsecpg || $hasnamesecpg) {
225             $classes = '';
226         }
227         $sectionname = html_writer::tag('span', $this->section_title($section, $course));
228         $o.= $this->output->heading($sectionname, 3, 'sectionname' . $classes);
230         $o .= $this->section_availability($section);
232         $o .= html_writer::start_tag('div', array('class' => 'summary'));
233         if ($section->uservisible || $section->visible) {
234             // Show summary if section is available or has availability restriction information.
235             // Do not show summary if section is hidden but we still display it because of course setting
236             // "Hidden sections are shown in collapsed form".
237             $o .= $this->format_summary_text($section);
238         }
239         $o .= html_writer::end_tag('div');
241         return $o;
242     }
244     /**
245      * Generate the display of the footer part of a section
246      *
247      * @return string HTML to output.
248      */
249     protected function section_footer() {
250         $o = html_writer::end_tag('div');
251         $o.= html_writer::end_tag('li');
253         return $o;
254     }
256     /**
257      * @deprecated since Moodle 3.0 MDL-48947 - Use format_section_renderer_base::section_edit_control_items() instead
258      */
259     protected function section_edit_controls() {
260         throw new coding_exception('section_edit_controls() can not be used anymore. Please use ' .
261             'section_edit_control_items() instead.');
262     }
264     /**
265      * Generate the edit control items of a section
266      *
267      * @param stdClass $course The course entry from DB
268      * @param stdClass $section The course_section entry from DB
269      * @param bool $onsectionpage true if being printed on a section page
270      * @return array of edit control items
271      */
272     protected function section_edit_control_items($course, $section, $onsectionpage = false) {
273         global $PAGE;
275         if (!$PAGE->user_is_editing()) {
276             return array();
277         }
279         $sectionreturn = $onsectionpage ? $section->section : null;
281         $coursecontext = context_course::instance($course->id);
282         $numsections = course_get_format($course)->get_last_section_number();
283         $isstealth = $section->section > $numsections;
285         $baseurl = course_get_url($course, $sectionreturn);
286         $baseurl->param('sesskey', sesskey());
288         $controls = array();
290         if (!$isstealth && has_capability('moodle/course:update', $coursecontext)) {
291             if ($section->section > 0
292                 && get_string_manager()->string_exists('editsection', 'format_'.$course->format)) {
293                 $streditsection = get_string('editsection', 'format_'.$course->format);
294             } else {
295                 $streditsection = get_string('editsection');
296             }
298             $controls['edit'] = array(
299                 'url'   => new moodle_url('/course/editsection.php', array('id' => $section->id, 'sr' => $sectionreturn)),
300                 'icon' => 'i/settings',
301                 'name' => $streditsection,
302                 'pixattr' => array('class' => ''),
303                 'attr' => array('class' => 'icon edit'));
304         }
306         if ($section->section) {
307             $url = clone($baseurl);
308             if (!$isstealth) {
309                 if (has_capability('moodle/course:sectionvisibility', $coursecontext)) {
310                     if ($section->visible) { // Show the hide/show eye.
311                         $strhidefromothers = get_string('hidefromothers', 'format_'.$course->format);
312                         $url->param('hide', $section->section);
313                         $controls['visiblity'] = array(
314                             'url' => $url,
315                             'icon' => 'i/hide',
316                             'name' => $strhidefromothers,
317                             'pixattr' => array('class' => ''),
318                             'attr' => array('class' => 'icon editing_showhide',
319                                 'data-sectionreturn' => $sectionreturn, 'data-action' => 'hide'));
320                     } else {
321                         $strshowfromothers = get_string('showfromothers', 'format_'.$course->format);
322                         $url->param('show',  $section->section);
323                         $controls['visiblity'] = array(
324                             'url' => $url,
325                             'icon' => 'i/show',
326                             'name' => $strshowfromothers,
327                             'pixattr' => array('class' => ''),
328                             'attr' => array('class' => 'icon editing_showhide',
329                                 'data-sectionreturn' => $sectionreturn, 'data-action' => 'show'));
330                     }
331                 }
333                 if (!$onsectionpage) {
334                     if (has_capability('moodle/course:movesections', $coursecontext)) {
335                         $url = clone($baseurl);
336                         if ($section->section > 1) { // Add a arrow to move section up.
337                             $url->param('section', $section->section);
338                             $url->param('move', -1);
339                             $strmoveup = get_string('moveup');
340                             $controls['moveup'] = array(
341                                 'url' => $url,
342                                 'icon' => 'i/up',
343                                 'name' => $strmoveup,
344                                 'pixattr' => array('class' => ''),
345                                 'attr' => array('class' => 'icon moveup'));
346                         }
348                         $url = clone($baseurl);
349                         if ($section->section < $numsections) { // Add a arrow to move section down.
350                             $url->param('section', $section->section);
351                             $url->param('move', 1);
352                             $strmovedown = get_string('movedown');
353                             $controls['movedown'] = array(
354                                 'url' => $url,
355                                 'icon' => 'i/down',
356                                 'name' => $strmovedown,
357                                 'pixattr' => array('class' => ''),
358                                 'attr' => array('class' => 'icon movedown'));
359                         }
360                     }
361                 }
362             }
364             if (course_can_delete_section($course, $section)) {
365                 if (get_string_manager()->string_exists('deletesection', 'format_'.$course->format)) {
366                     $strdelete = get_string('deletesection', 'format_'.$course->format);
367                 } else {
368                     $strdelete = get_string('deletesection');
369                 }
370                 $url = new moodle_url('/course/editsection.php', array(
371                     'id' => $section->id,
372                     'sr' => $sectionreturn,
373                     'delete' => 1,
374                     'sesskey' => sesskey()));
375                 $controls['delete'] = array(
376                     'url' => $url,
377                     'icon' => 'i/delete',
378                     'name' => $strdelete,
379                     'pixattr' => array('class' => ''),
380                     'attr' => array('class' => 'icon editing_delete'));
381             }
382         }
384         return $controls;
385     }
387     /**
388      * Generate a summary of a section for display on the 'course index page'
389      *
390      * @param stdClass $section The course_section entry from DB
391      * @param stdClass $course The course entry from DB
392      * @param array    $mods (argument not used)
393      * @return string HTML to output.
394      */
395     protected function section_summary($section, $course, $mods) {
396         $classattr = 'section main section-summary clearfix';
397         $linkclasses = '';
399         // If section is hidden then display grey section link
400         if (!$section->visible) {
401             $classattr .= ' hidden';
402             $linkclasses .= ' dimmed_text';
403         } else if (course_get_format($course)->is_section_current($section)) {
404             $classattr .= ' current';
405         }
407         $title = get_section_name($course, $section);
408         $o = '';
409         $o .= html_writer::start_tag('li', array('id' => 'section-'.$section->section,
410             'class' => $classattr, 'role'=>'region', 'aria-label'=> $title));
412         $o .= html_writer::tag('div', '', array('class' => 'left side'));
413         $o .= html_writer::tag('div', '', array('class' => 'right side'));
414         $o .= html_writer::start_tag('div', array('class' => 'content'));
416         if ($section->uservisible) {
417             $title = html_writer::tag('a', $title,
418                     array('href' => course_get_url($course, $section->section), 'class' => $linkclasses));
419         }
420         $o .= $this->output->heading($title, 3, 'section-title');
422         $o .= $this->section_availability($section);
423         $o.= html_writer::start_tag('div', array('class' => 'summarytext'));
425         if ($section->uservisible || $section->visible) {
426             // Show summary if section is available or has availability restriction information.
427             // Do not show summary if section is hidden but we still display it because of course setting
428             // "Hidden sections are shown in collapsed form".
429             $o .= $this->format_summary_text($section);
430         }
431         $o.= html_writer::end_tag('div');
432         $o.= $this->section_activity_summary($section, $course, null);
434         $o .= html_writer::end_tag('div');
435         $o .= html_writer::end_tag('li');
437         return $o;
438     }
440     /**
441      * Generate a summary of the activites in a section
442      *
443      * @param stdClass $section The course_section entry from DB
444      * @param stdClass $course the course record from DB
445      * @param array    $mods (argument not used)
446      * @return string HTML to output.
447      */
448     protected function section_activity_summary($section, $course, $mods) {
449         $modinfo = get_fast_modinfo($course);
450         if (empty($modinfo->sections[$section->section])) {
451             return '';
452         }
454         // Generate array with count of activities in this section:
455         $sectionmods = array();
456         $total = 0;
457         $complete = 0;
458         $cancomplete = isloggedin() && !isguestuser();
459         $completioninfo = new completion_info($course);
460         foreach ($modinfo->sections[$section->section] as $cmid) {
461             $thismod = $modinfo->cms[$cmid];
463             if ($thismod->uservisible) {
464                 if (isset($sectionmods[$thismod->modname])) {
465                     $sectionmods[$thismod->modname]['name'] = $thismod->modplural;
466                     $sectionmods[$thismod->modname]['count']++;
467                 } else {
468                     $sectionmods[$thismod->modname]['name'] = $thismod->modfullname;
469                     $sectionmods[$thismod->modname]['count'] = 1;
470                 }
471                 if ($cancomplete && $completioninfo->is_enabled($thismod) != COMPLETION_TRACKING_NONE) {
472                     $total++;
473                     $completiondata = $completioninfo->get_data($thismod, true);
474                     if ($completiondata->completionstate == COMPLETION_COMPLETE ||
475                             $completiondata->completionstate == COMPLETION_COMPLETE_PASS) {
476                         $complete++;
477                     }
478                 }
479             }
480         }
482         if (empty($sectionmods)) {
483             // No sections
484             return '';
485         }
487         // Output section activities summary:
488         $o = '';
489         $o.= html_writer::start_tag('div', array('class' => 'section-summary-activities pr-2 mdl-right'));
490         foreach ($sectionmods as $mod) {
491             $o.= html_writer::start_tag('span', array('class' => 'activity-count'));
492             $o.= $mod['name'].': '.$mod['count'];
493             $o.= html_writer::end_tag('span');
494         }
495         $o.= html_writer::end_tag('div');
497         // Output section completion data
498         if ($total > 0) {
499             $a = new stdClass;
500             $a->complete = $complete;
501             $a->total = $total;
503             $o.= html_writer::start_tag('div', array('class' => 'section-summary-activities pr-2 mdl-right'));
504             $o.= html_writer::tag('span', get_string('progresstotal', 'completion', $a), array('class' => 'activity-count'));
505             $o.= html_writer::end_tag('div');
506         }
508         return $o;
509     }
511     /**
512      * If section is not visible, display the message about that ('Not available
513      * until...', that sort of thing). Otherwise, returns blank.
514      *
515      * For users with the ability to view hidden sections, it shows the
516      * information even though you can view the section and also may include
517      * slightly fuller information (so that teachers can tell when sections
518      * are going to be unavailable etc). This logic is the same as for
519      * activities.
520      *
521      * @param section_info $section The course_section entry from DB
522      * @param bool $canviewhidden True if user can view hidden sections
523      * @return string HTML to output
524      */
525     protected function section_availability_message($section, $canviewhidden) {
526         global $CFG;
527         $o = '';
528         if (!$section->visible) {
529             if ($canviewhidden) {
530                 $o .= $this->courserenderer->availability_info(get_string('hiddenfromstudents'), 'ishidden');
531             } else {
532                 // We are here because of the setting "Hidden sections are shown in collapsed form".
533                 // Student can not see the section contents but can see its name.
534                 $o .= $this->courserenderer->availability_info(get_string('notavailable'), 'ishidden');
535             }
536         } else if (!$section->uservisible) {
537             if ($section->availableinfo) {
538                 // Note: We only get to this function if availableinfo is non-empty,
539                 // so there is definitely something to print.
540                 $formattedinfo = \core_availability\info::format_info(
541                         $section->availableinfo, $section->course);
542                 $o .= $this->courserenderer->availability_info($formattedinfo, 'isrestricted');
543             }
544         } else if ($canviewhidden && !empty($CFG->enableavailability)) {
545             // Check if there is an availability restriction.
546             $ci = new \core_availability\info_section($section);
547             $fullinfo = $ci->get_full_information();
548             if ($fullinfo) {
549                 $formattedinfo = \core_availability\info::format_info(
550                         $fullinfo, $section->course);
551                 $o .= $this->courserenderer->availability_info($formattedinfo, 'isrestricted isfullinfo');
552             }
553         }
554         return $o;
555     }
557     /**
558      * Displays availability information for the section (hidden, not available unles, etc.)
559      *
560      * @param section_info $section
561      * @return string
562      */
563     public function section_availability($section) {
564         $context = context_course::instance($section->course);
565         $canviewhidden = has_capability('moodle/course:viewhiddensections', $context);
566         return html_writer::div($this->section_availability_message($section, $canviewhidden), 'section_availability');
567     }
569     /**
570      * Show if something is on on the course clipboard (moving around)
571      *
572      * @param stdClass $course The course entry from DB
573      * @param int $sectionno The section number in the course which is being displayed
574      * @return string HTML to output.
575      */
576     protected function course_activity_clipboard($course, $sectionno = null) {
577         global $USER;
579         $o = '';
580         // If currently moving a file then show the current clipboard.
581         if (ismoving($course->id)) {
582             $url = new moodle_url('/course/mod.php',
583                 array('sesskey' => sesskey(),
584                       'cancelcopy' => true,
585                       'sr' => $sectionno,
586                 )
587             );
589             $o.= html_writer::start_tag('div', array('class' => 'clipboard'));
590             $o.= strip_tags(get_string('activityclipboard', '', $USER->activitycopyname));
591             $o.= ' ('.html_writer::link($url, get_string('cancel')).')';
592             $o.= html_writer::end_tag('div');
593         }
595         return $o;
596     }
598     /**
599      * Generate next/previous section links for naviation
600      *
601      * @param stdClass $course The course entry from DB
602      * @param array $sections The course_sections entries from the DB
603      * @param int $sectionno The section number in the course which is being displayed
604      * @return array associative array with previous and next section link
605      */
606     protected function get_nav_links($course, $sections, $sectionno) {
607         // FIXME: This is really evil and should by using the navigation API.
608         $course = course_get_format($course)->get_course();
609         $canviewhidden = has_capability('moodle/course:viewhiddensections', context_course::instance($course->id))
610             or !$course->hiddensections;
612         $links = array('previous' => '', 'next' => '');
613         $back = $sectionno - 1;
614         while ($back > 0 and empty($links['previous'])) {
615             if ($canviewhidden || $sections[$back]->uservisible) {
616                 $params = array();
617                 if (!$sections[$back]->visible) {
618                     $params = array('class' => 'dimmed_text');
619                 }
620                 $previouslink = html_writer::tag('span', $this->output->larrow(), array('class' => 'larrow'));
621                 $previouslink .= get_section_name($course, $sections[$back]);
622                 $links['previous'] = html_writer::link(course_get_url($course, $back), $previouslink, $params);
623             }
624             $back--;
625         }
627         $forward = $sectionno + 1;
628         $numsections = course_get_format($course)->get_last_section_number();
629         while ($forward <= $numsections and empty($links['next'])) {
630             if ($canviewhidden || $sections[$forward]->uservisible) {
631                 $params = array();
632                 if (!$sections[$forward]->visible) {
633                     $params = array('class' => 'dimmed_text');
634                 }
635                 $nextlink = get_section_name($course, $sections[$forward]);
636                 $nextlink .= html_writer::tag('span', $this->output->rarrow(), array('class' => 'rarrow'));
637                 $links['next'] = html_writer::link(course_get_url($course, $forward), $nextlink, $params);
638             }
639             $forward++;
640         }
642         return $links;
643     }
645     /**
646      * Generate the header html of a stealth section
647      *
648      * @param int $sectionno The section number in the course which is being displayed
649      * @return string HTML to output.
650      */
651     protected function stealth_section_header($sectionno) {
652         $o = '';
653         $o.= html_writer::start_tag('li', array('id' => 'section-'.$sectionno, 'class' => 'section main clearfix orphaned hidden'));
654         $o.= html_writer::tag('div', '', array('class' => 'left side'));
655         $course = course_get_format($this->page->course)->get_course();
656         $section = course_get_format($this->page->course)->get_section($sectionno);
657         $rightcontent = $this->section_right_content($section, $course, false);
658         $o.= html_writer::tag('div', $rightcontent, array('class' => 'right side'));
659         $o.= html_writer::start_tag('div', array('class' => 'content'));
660         $o.= $this->output->heading(get_string('orphanedactivitiesinsectionno', '', $sectionno), 3, 'sectionname');
661         return $o;
662     }
664     /**
665      * Generate footer html of a stealth section
666      *
667      * @return string HTML to output.
668      */
669     protected function stealth_section_footer() {
670         $o = html_writer::end_tag('div');
671         $o.= html_writer::end_tag('li');
672         return $o;
673     }
675     /**
676      * Generate the html for a hidden section
677      *
678      * @param int $sectionno The section number in the course which is being displayed
679      * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
680      * @return string HTML to output.
681      */
682     protected function section_hidden($sectionno, $courseorid = null) {
683         if ($courseorid) {
684             $sectionname = get_section_name($courseorid, $sectionno);
685             $strnotavailable = get_string('notavailablecourse', '', $sectionname);
686         } else {
687             $strnotavailable = get_string('notavailable');
688         }
690         $o = '';
691         $o.= html_writer::start_tag('li', array('id' => 'section-'.$sectionno, 'class' => 'section main clearfix hidden'));
692         $o.= html_writer::tag('div', '', array('class' => 'left side'));
693         $o.= html_writer::tag('div', '', array('class' => 'right side'));
694         $o.= html_writer::start_tag('div', array('class' => 'content'));
695         $o.= html_writer::tag('div', $strnotavailable);
696         $o.= html_writer::end_tag('div');
697         $o.= html_writer::end_tag('li');
698         return $o;
699     }
701     /**
702      * Generate the html for the 'Jump to' menu on a single section page.
703      *
704      * @param stdClass $course The course entry from DB
705      * @param array $sections The course_sections entries from the DB
706      * @param $displaysection the current displayed section number.
707      *
708      * @return string HTML to output.
709      */
710     protected function section_nav_selection($course, $sections, $displaysection) {
711         global $CFG;
712         $o = '';
713         $sectionmenu = array();
714         $sectionmenu[course_get_url($course)->out(false)] = get_string('maincoursepage');
715         $modinfo = get_fast_modinfo($course);
716         $section = 1;
717         $numsections = course_get_format($course)->get_last_section_number();
718         while ($section <= $numsections) {
719             $thissection = $modinfo->get_section_info($section);
720             $showsection = $thissection->uservisible or !$course->hiddensections;
721             if (($showsection) && ($section != $displaysection) && ($url = course_get_url($course, $section))) {
722                 $sectionmenu[$url->out(false)] = get_section_name($course, $section);
723             }
724             $section++;
725         }
727         $select = new url_select($sectionmenu, '', array('' => get_string('jumpto')));
728         $select->class = 'jumpmenu';
729         $select->formid = 'sectionmenu';
730         $o .= $this->output->render($select);
732         return $o;
733     }
735     /**
736      * Output the html for a single section page .
737      *
738      * @param stdClass $course The course entry from DB
739      * @param array $sections (argument not used)
740      * @param array $mods (argument not used)
741      * @param array $modnames (argument not used)
742      * @param array $modnamesused (argument not used)
743      * @param int $displaysection The section number in the course which is being displayed
744      */
745     public function print_single_section_page($course, $sections, $mods, $modnames, $modnamesused, $displaysection) {
746         global $PAGE;
748         $modinfo = get_fast_modinfo($course);
749         $course = course_get_format($course)->get_course();
751         // Can we view the section in question?
752         if (!($sectioninfo = $modinfo->get_section_info($displaysection)) || !$sectioninfo->uservisible) {
753             // This section doesn't exist or is not available for the user.
754             // We actually already check this in course/view.php but just in case exit from this function as well.
755             print_error('unknowncoursesection', 'error', course_get_url($course),
756                 format_string($course->fullname));
757         }
759         // Copy activity clipboard..
760         echo $this->course_activity_clipboard($course, $displaysection);
761         $thissection = $modinfo->get_section_info(0);
762         if ($thissection->summary or !empty($modinfo->sections[0]) or $PAGE->user_is_editing()) {
763             echo $this->start_section_list();
764             echo $this->section_header($thissection, $course, true, $displaysection);
765             echo $this->courserenderer->course_section_cm_list($course, $thissection, $displaysection);
766             echo $this->courserenderer->course_section_add_cm_control($course, 0, $displaysection);
767             echo $this->section_footer();
768             echo $this->end_section_list();
769         }
771         // Start single-section div
772         echo html_writer::start_tag('div', array('class' => 'single-section'));
774         // The requested section page.
775         $thissection = $modinfo->get_section_info($displaysection);
777         // Title with section navigation links.
778         $sectionnavlinks = $this->get_nav_links($course, $modinfo->get_section_info_all(), $displaysection);
779         $sectiontitle = '';
780         $sectiontitle .= html_writer::start_tag('div', array('class' => 'section-navigation navigationtitle'));
781         $sectiontitle .= html_writer::tag('span', $sectionnavlinks['previous'], array('class' => 'mdl-left'));
782         $sectiontitle .= html_writer::tag('span', $sectionnavlinks['next'], array('class' => 'mdl-right'));
783         // Title attributes
784         $classes = 'sectionname';
785         if (!$thissection->visible) {
786             $classes .= ' dimmed_text';
787         }
788         $sectionname = html_writer::tag('span', $this->section_title_without_link($thissection, $course));
789         $sectiontitle .= $this->output->heading($sectionname, 3, $classes);
791         $sectiontitle .= html_writer::end_tag('div');
792         echo $sectiontitle;
794         // Now the list of sections..
795         echo $this->start_section_list();
797         echo $this->section_header($thissection, $course, true, $displaysection);
798         // Show completion help icon.
799         $completioninfo = new completion_info($course);
800         echo $completioninfo->display_help_icon();
802         echo $this->courserenderer->course_section_cm_list($course, $thissection, $displaysection);
803         echo $this->courserenderer->course_section_add_cm_control($course, $displaysection, $displaysection);
804         echo $this->section_footer();
805         echo $this->end_section_list();
807         // Display section bottom navigation.
808         $sectionbottomnav = '';
809         $sectionbottomnav .= html_writer::start_tag('div', array('class' => 'section-navigation mdl-bottom'));
810         $sectionbottomnav .= html_writer::tag('span', $sectionnavlinks['previous'], array('class' => 'mdl-left'));
811         $sectionbottomnav .= html_writer::tag('span', $sectionnavlinks['next'], array('class' => 'mdl-right'));
812         $sectionbottomnav .= html_writer::tag('div', $this->section_nav_selection($course, $sections, $displaysection),
813             array('class' => 'mdl-align'));
814         $sectionbottomnav .= html_writer::end_tag('div');
815         echo $sectionbottomnav;
817         // Close single-section div.
818         echo html_writer::end_tag('div');
819     }
821     /**
822      * Output the html for a multiple section page
823      *
824      * @param stdClass $course The course entry from DB
825      * @param array $sections (argument not used)
826      * @param array $mods (argument not used)
827      * @param array $modnames (argument not used)
828      * @param array $modnamesused (argument not used)
829      */
830     public function print_multiple_section_page($course, $sections, $mods, $modnames, $modnamesused) {
831         global $PAGE;
833         $modinfo = get_fast_modinfo($course);
834         $course = course_get_format($course)->get_course();
836         $context = context_course::instance($course->id);
837         // Title with completion help icon.
838         $completioninfo = new completion_info($course);
839         echo $completioninfo->display_help_icon();
840         echo $this->output->heading($this->page_title(), 2, 'accesshide');
842         // Copy activity clipboard..
843         echo $this->course_activity_clipboard($course, 0);
845         // Now the list of sections..
846         echo $this->start_section_list();
847         $numsections = course_get_format($course)->get_last_section_number();
849         foreach ($modinfo->get_section_info_all() as $section => $thissection) {
850             if ($section == 0) {
851                 // 0-section is displayed a little different then the others
852                 if ($thissection->summary or !empty($modinfo->sections[0]) or $PAGE->user_is_editing()) {
853                     echo $this->section_header($thissection, $course, false, 0);
854                     echo $this->courserenderer->course_section_cm_list($course, $thissection, 0);
855                     echo $this->courserenderer->course_section_add_cm_control($course, 0, 0);
856                     echo $this->section_footer();
857                 }
858                 continue;
859             }
860             if ($section > $numsections) {
861                 // activities inside this section are 'orphaned', this section will be printed as 'stealth' below
862                 continue;
863             }
864             // Show the section if the user is permitted to access it, OR if it's not available
865             // but there is some available info text which explains the reason & should display,
866             // OR it is hidden but the course has a setting to display hidden sections as unavilable.
867             $showsection = $thissection->uservisible ||
868                     ($thissection->visible && !$thissection->available && !empty($thissection->availableinfo)) ||
869                     (!$thissection->visible && !$course->hiddensections);
870             if (!$showsection) {
871                 continue;
872             }
874             if (!$PAGE->user_is_editing() && $course->coursedisplay == COURSE_DISPLAY_MULTIPAGE) {
875                 // Display section summary only.
876                 echo $this->section_summary($thissection, $course, null);
877             } else {
878                 echo $this->section_header($thissection, $course, false, 0);
879                 if ($thissection->uservisible) {
880                     echo $this->courserenderer->course_section_cm_list($course, $thissection, 0);
881                     echo $this->courserenderer->course_section_add_cm_control($course, $section, 0);
882                 }
883                 echo $this->section_footer();
884             }
885         }
887         if ($PAGE->user_is_editing() and has_capability('moodle/course:update', $context)) {
888             // Print stealth sections if present.
889             foreach ($modinfo->get_section_info_all() as $section => $thissection) {
890                 if ($section <= $numsections or empty($modinfo->sections[$section])) {
891                     // this is not stealth section or it is empty
892                     continue;
893                 }
894                 echo $this->stealth_section_header($section);
895                 echo $this->courserenderer->course_section_cm_list($course, $thissection, 0);
896                 echo $this->stealth_section_footer();
897             }
899             echo $this->end_section_list();
901             echo $this->change_number_sections($course, 0);
902         } else {
903             echo $this->end_section_list();
904         }
906     }
908     /**
909      * Returns controls in the bottom of the page to increase/decrease number of sections
910      *
911      * @param stdClass $course
912      * @param int|null $sectionreturn
913      * @return string
914      */
915     protected function change_number_sections($course, $sectionreturn = null) {
916         $coursecontext = context_course::instance($course->id);
917         if (!has_capability('moodle/course:update', $coursecontext)) {
918             return '';
919         }
921         $format = course_get_format($course);
922         $options = $format->get_format_options();
923         $maxsections = $format->get_max_sections();
924         $lastsection = $format->get_last_section_number();
925         $supportsnumsections = array_key_exists('numsections', $options);
927         if ($supportsnumsections) {
928             // Current course format has 'numsections' option, which is very confusing and we suggest course format
929             // developers to get rid of it (see MDL-57769 on how to do it).
930             // Display "Increase section" / "Decrease section" links.
932             echo html_writer::start_tag('div', array('id' => 'changenumsections', 'class' => 'mdl-right'));
934             // Increase number of sections.
935             if ($lastsection < $maxsections) {
936                 $straddsection = get_string('increasesections', 'moodle');
937                 $url = new moodle_url('/course/changenumsections.php',
938                     array('courseid' => $course->id,
939                           'increase' => true,
940                           'sesskey' => sesskey()));
941                 $icon = $this->output->pix_icon('t/switch_plus', $straddsection);
942                 echo html_writer::link($url, $icon.get_accesshide($straddsection), array('class' => 'increase-sections'));
943             }
945             if ($course->numsections > 0) {
946                 // Reduce number of sections sections.
947                 $strremovesection = get_string('reducesections', 'moodle');
948                 $url = new moodle_url('/course/changenumsections.php',
949                     array('courseid' => $course->id,
950                           'increase' => false,
951                           'sesskey' => sesskey()));
952                 $icon = $this->output->pix_icon('t/switch_minus', $strremovesection);
953                 echo html_writer::link($url, $icon.get_accesshide($strremovesection), array('class' => 'reduce-sections'));
954             }
956             echo html_writer::end_tag('div');
958         } else if (course_get_format($course)->uses_sections()) {
959             if ($lastsection >= $maxsections) {
960                 // Don't allow more sections if we already hit the limit.
961                 return;
962             }
963             // Current course format does not have 'numsections' option but it has multiple sections suppport.
964             // Display the "Add section" link that will insert a section in the end.
965             // Note to course format developers: inserting sections in the other positions should check both
966             // capabilities 'moodle/course:update' and 'moodle/course:movesections'.
967             echo html_writer::start_tag('div', array('id' => 'changenumsections', 'class' => 'mdl-right'));
968             if (get_string_manager()->string_exists('addsections', 'format_'.$course->format)) {
969                 $straddsections = get_string('addsections', 'format_'.$course->format);
970             } else {
971                 $straddsections = get_string('addsections');
972             }
973             $url = new moodle_url('/course/changenumsections.php',
974                 ['courseid' => $course->id, 'insertsection' => 0, 'sesskey' => sesskey()]);
975             if ($sectionreturn !== null) {
976                 $url->param('sectionreturn', $sectionreturn);
977             }
978             $icon = $this->output->pix_icon('t/add', '');
979             $newsections = $maxsections - $lastsection;
980             echo html_writer::link($url, $icon . $straddsections,
981                 array('class' => 'add-sections', 'data-add-sections' => $straddsections, 'new-sections' => $newsections));
982             echo html_writer::end_tag('div');
983         }
984     }
986     /**
987      * Generate html for a section summary text
988      *
989      * @param stdClass $section The course_section entry from DB
990      * @return string HTML to output.
991      */
992     protected function format_summary_text($section) {
993         $context = context_course::instance($section->course);
994         $summarytext = file_rewrite_pluginfile_urls($section->summary, 'pluginfile.php',
995             $context->id, 'course', 'section', $section->id);
997         $options = new stdClass();
998         $options->noclean = true;
999         $options->overflowdiv = true;
1000         return format_text($summarytext, $section->summaryformat, $options);
1001     }