renderer.php

<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * Renderer for outputting the topics2 course format.
 *
 * @package format_topics2
 * @copyright 2018-2020 Matthias Opitz
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 * @since Moodle 2.3
 */
defined('MOODLE_INTERNAL') || die();
require_once($CFG->dirroot.'/course/format/topics/renderer.php');

/**
 * Basic renderer for topics2 format with added tab-ability.
 *
 * @copyright 2018 Matthias Opitz
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class format_topics2_renderer extends format_topics_renderer {

    /**
     * Generate the starting container html for a list of sections.
     * @return string HTML to output.
     */
    protected function start_section_list() {
        return html_writer::start_tag('ul', array('class' => 'topics topics2'));
    }

    /**
     * Output the html for a multiple section page
     *
     * @param stdClass $course The course entry from DB
     * @param array $sections (argument not used)
     * @param array $mods (argument not used)
     * @param array $modnames (argument not used)
     * @param array $modnamesused (argument not used)
     */
    public function print_multiple_section_page($course, $sections, $mods, $modnames, $modnamesused) {
        global $DB;

        // Include the required JS files.
        $this->require_js();

        $this->toggleseq = $this->get_toggle_seq($course); // The toggle sequence for this user and course.

        $modinfo = get_fast_modinfo($course);
        $course = course_get_format($course)->get_course();
        $options = $DB->get_records('course_format_options', array('courseid' => $course->id));
        $formatoptions = array();
        foreach ($options as $option) {
            $formatoptions[$option->name] = $option->value;
        }

        $context = context_course::instance($course->id);
        // Title with completion help icon.
        $completioninfo = new completion_info($course);
        echo $completioninfo->display_help_icon();
        echo $this->output->heading($this->page_title(), 2, 'accesshide');

        // Copy activity clipboard..
        echo $this->course_activity_clipboard($course, 0);

        // Now on to the main stage..
        $numsections = course_get_format($course)->get_last_section_number();
        $sections = $modinfo->get_section_info_all();

        // An invisible tag with the name of the course format to be used in jQuery.
        echo html_writer::div($course->format, 'course_format_name', array('style' => 'display:none;'));

        // Add an invisible div that carries the course ID to be used by JS.
        // Add class 'single_section_tabs' when option is set so JS can play accordingly.
        $class = (isset($formatoptions['single_section_tabs']) &&
        $formatoptions['single_section_tabs'] ? 'single_section_tabs' : '');

        // The Sections.
        echo $this->start_section_list();

        // An invisible tag with the value of the tab name limit to be used in jQuery.
        if (isset($formatoptions['limittabname']) && $formatoptions['limittabname'] > 0) {
            echo html_writer::tag('div', '',
                array(
                    'class' => 'limittabname',
                    'value' => $formatoptions['limittabname'],
                    'style' => 'display: hidden;'
            ));
        }

        echo html_writer::start_tag('div', array('id' => 'courseid', 'courseid' => $course->id, 'class' => $class));
        echo html_writer::end_tag('div');

        // Display section-0 on top of tabs if option is checked.
        echo $this->render_section0_ontop($course, $sections, $formatoptions, $modinfo);

        // The tab navigation.
        $this->prepare_tabs($course, $formatoptions, $sections);

        // Rendering the tab navigation.
        $rentabs = $this->render_tabs($formatoptions);
        echo $rentabs;

        // Render the sections.
        echo $this->render_sections($course, $sections, $formatoptions, $modinfo, $numsections);

        // Show hidden sections to users with update abilities only.
        echo $this->render_hidden_sections($course, $sections, $context, $modinfo, $numsections);

        echo $this->end_section_list();
    }

    /**
     * Require the jQuery files for this class.
     */
    public function require_js() {
        $this->page->requires->js_call_amd('format_topics2/tabs', 'init', array());
        $this->page->requires->js_call_amd('format_topics2/toggle', 'init', array());
    }

    /**
     * Get the toggle sequence of a given course for the current user.
     *
     * @param array|stdClass $course
     * @return array
     * @throws dml_exception
     */
    public function get_toggle_seq($course) {
        global $DB, $USER;

        $record = $DB->get_record('user_preferences', array('userid' => $USER->id, 'name' => 'toggle_seq_'.$course->id));
        if (!isset($record->value)) {
            return array();
        }
        // Prepare the toggle sequence.
        $toggleseq = (array) json_decode($record->value);

        // Weird rearranging the array due to error with PHP below version 7.2.
        // NO idea why this is needed - but it works.
        if (version_compare(PHP_VERSION, '7.2.0') < 0) {
            $toggleseq2 = array();
            foreach ($toggleseq as $key => $value) {
                $toggleseq2[$key] = $value;
            }
            $toggleseq = $toggleseq2;
        }

        return $toggleseq;
    }

    /**
     * Prepare the tabs for rendering.
     *
     * @param array|stdClass $course
     * @param array|stdClass $formatoptions
     * @param array|stdClass $sections
     * @return array
     * @throws coding_exception
     * @throws dml_exception
     */
    public function prepare_tabs($course, $formatoptions, $sections) {
        global $CFG, $DB;

        $maxtabs = ((isset($formatoptions['maxtabs']) &&
            $formatoptions['maxtabs'] > 0) ? $formatoptions['maxtabs'] : (isset($CFG->max_tabs) ? $CFG->max_tabs : 9));
        $tabs = array();

        // Get the section IDs along with their section numbers.
        $sectionids = array();
        foreach ($sections as $section) {
            $sectionids[$section->section] = $section->id;
        }

        // Preparing the tabs.
        for ($i = 0; $i <= $maxtabs; $i++) {
            $tabsections = '';
            $tabsectionnums = '';

            // Check section IDs and section numbers for tabs other than tab0.
            if ($i > 0) {
                if (isset($formatoptions['tab' . $i])) {
                    $tabsections = str_replace(' ', '', $formatoptions['tab' . $i]);
                } else {
                    $tabsections = '';
                }
                if (isset($formatoptions['tab' . $i. '_sectionnums'])) {
                    $tabsectionnums = str_replace(' ', '', $formatoptions['tab' . $i. '_sectionnums']);
                } else {
                    $tabsectionnums = '';
                }
                $tabsections = $this->check_tab_section_ids($course->id, $sectionids, $tabsections, $tabsectionnums, $i);
            }

            $tab = (object) new stdClass();
            if (isset($tab)) {
                $tab->id = "tab" . $i;
                $tab->name = "tab" . $i;
                $tab->generic_title = ($i === 0 ? get_string('tab0_generic_name', 'format_topics2') : 'Tab '.$i);
                $tab->title = (isset($formatoptions['tab' . $i . '_title']) &&
                    $formatoptions['tab' . $i . '_title'] != '' ? $formatoptions['tab' . $i . '_title'] : $tab->generic_title);
                $tab->sections = $tabsections;
                $tab->section_nums = $tabsectionnums;
                $tabs[$tab->id] = $tab;
            }
        }
        $this->tabs = $tabs;

        // Check for abandoned tab format_options and get rid of them.
        while (isset($formatoptions['tab'.$i.'_title'])) {
            $sql = "DELETE FROM {course_format_options} WHERE courseid = $course->id and name like 'tab$i%'";
            $DB->execute($sql);
            $i++;
        }

        return $tabs;
    }

    /**
     * Render the tabs in sequence order if present or ascending otherwise.
     *
     * @param array|stdClass $formatoptions
     * @return string
     */
    public function render_tabs($formatoptions) {
        $o = html_writer::start_tag('ul', array('class' => 'tabs nav nav-tabs row'));

        $tabseq = array();
        if ($formatoptions['tab_seq']) {
            $tabseq = explode(',', $formatoptions['tab_seq']);
        }

        // Show the tabs in the sequence.
        foreach ($tabseq as $tabid) {
            if (isset($this->tabs[$tabid]) && $tab = $this->tabs[$tabid]) {
                $o .= $this->render_tab($tab);
            }
        }
        // Check if there are tabs that are not in the sequence (yet) - and if so display them now.
        // We need to compare the sequence with the keys of the tabs array.
        if ($seqdiff = array_diff(array_keys($this->tabs), $tabseq)) {
            foreach ($seqdiff as $tabid) {
                if (isset($this->tabs[$tabid]) && $tab = $this->tabs[$tabid]) {
                    $o .= $this->render_tab($tab);
                }
            }
        }

        $o .= html_writer::end_tag('ul');

        return $o;
    }

    /**
     * Render a standard tab.
     *
     * @param array|stdClass $tab
     * @return bool|string
     * @throws coding_exception
     * @throws dml_exception
     */
    public function render_tab($tab) {
        global $DB;

        if (!isset($tab)) {
            return false;
        }

        $o = '';
        if ($tab->sections == '') {
            $o .= html_writer::start_tag('li', array('class' => 'tabitem nav-item', 'style' => 'display:none;'));
        } else {
            $o .= html_writer::start_tag('li', array('class' => 'tabitem nav-item'));
        }

        $sectionsarray = explode(',', str_replace(' ', '', $tab->sections));
        if ($sectionsarray[0]) {
            while ($sectionsarray[0] == "0") { // Remove any occurences of section-0.
                array_shift($sectionsarray);
            }
        }

        if ($this->page->user_is_editing()) {
            // Get the format option record for the given tab - we need the id.
            // If the record does not exist, create it first.
            if (!$DB->record_exists('course_format_options',
                array('courseid' => $this->page->course->id, 'name' => $tab->id.'_title'))) {
                $format = course_get_format($this->page->course);
                $format = $format->get_format();

                $record = new stdClass();
                $record->courseid = $this->page->course->id;
                $record->format = $format;
                $record->section = 0;
                $record->name = $tab->id.'_title';
                $record->value = ($tab->id == 'tab0'
                    ? get_string('tabzero_title', 'format_topics2')
                    : 'Tab '.substr($tab->id, 3)
                );
                $DB->insert_record('course_format_options', $record);
            }

            $formatoptiontab = $DB->get_record('course_format_options', array('courseid' => $this->page->course->id,
                'name' => $tab->id.'_title'
            ));
            $itemid = $formatoptiontab->id;
        } else {
            $itemid = false;
        }

        $tabindex = 0;
        if ($tab->id == 'tab0') {
            $o .= '<span
                data-toggle="tab" id="'.$tab->id.'"
                sections="'.$tab->sections.'"
                section_nums="'.$tab->section_nums.'"
                class="tablink nav-link "
                tab_title="'.$tab->title.'",
                generic_title = "'.$tab->generic_title.'"
                tabindex = "'.$tabindex.'"
                >';
        } else {
            $o .= '<span
                data-toggle="tab" id="'.$tab->id.'"
                sections="'.$tab->sections.'"
                section_nums="'.$tab->section_nums.'"
                class="tablink topictab nav-link "
                tab_title="'.$tab->title.'"
                generic_title = "'.$tab->generic_title.'"
                tabindex = "'.$tabindex.'"
                style="'.($this->page->user_is_editing() ? 'cursor: move;' : '').'">';
        }
        // Render the tab name as inplace_editable.
        $tmpl = new \core\output\inplace_editable('format_topics2', 'tabname', $itemid,
            $this->page->user_is_editing(),
            format_string($tab->title), $tab->title,
            get_string('tabtitle_edithint', 'format_topics2'),
            get_string('tabtitle_editlabel', 'format_topics2', format_string($tab->title)));
        $o .= $this->output->render($tmpl);
        $o .= "</span>";
        $o .= html_writer::end_tag('li');
        return $o;
    }

    /**
     * Check section IDs used in tabs and repair them if they have changed - most probably because a course was imported.
     *
     * @param int $courseid
     * @param array|stdClass $sectionids
     * @param array|stdClass $tabsectionids
     * @param array|stdClass $tabsectionnums
     * @param int $i
     * @return array|string
     * @throws dml_exception
     */
    protected function check_tab_section_ids($courseid, $sectionids, $tabsectionids, $tabsectionnums, $i) {
        global $DB;
        $idhaschanged = false;

        $newtabsectionids = array();
        $newtabsectionnums = array();
        $tabformatrecordids = $DB->get_record('course_format_options', array('courseid' => $courseid, 'name' => 'tab'.$i));
        $tabformatrecordnums = $DB->get_record('course_format_options',
            array('courseid' => $courseid, 'name' => 'tab'.$i.'_sectionnums')
        );

        if ($tabsectionids != "") {
            $tabsectionids = explode(',', $tabsectionids);
        } else {
            $tabsectionids = array();
        }

        if ($tabsectionnums != "") {
            $tabsectionnums = explode(',', $tabsectionnums);
        } else {
            $tabsectionnums = array();
        }

        foreach ($tabsectionids as $key => $tabsectionid) {
            if (!in_array($tabsectionid, $sectionids) && isset($tabsectionnums[$key]) &&
                isset($sectionids[$tabsectionnums[$key]])) {
                // The tab_section_id is not among the (new) section ids of that course.
                // This is most likely because the course has been restored - so use the sectionnums to determine the new id.
                $newtabsectionids[] = $sectionids[$tabsectionnums[$key]];
                $idhaschanged = true;
                // Preserve the backup sequence of sectionnums.
                $newtabsectionnums[] = $tabsectionnums[$key];
            } else {
                // The tab_section_id IS part of the section ids of that course and will be preserved.
                $newtabsectionids[] = $tabsectionid;
                // Create a backup sequence of sectionnums from section IDs to use it in the correction scheme above after a backup.
                $newtabsectionnums[] = array_search($tabsectionid, $sectionids);
            }
        }

        $tabsectionids = implode(',', $newtabsectionids);
        $tabsectionnums = implode(',', $newtabsectionnums);
        if ($idhaschanged) {
            $DB->update_record('course_format_options', array('id' => $tabformatrecordids->id, 'value' => $tabsectionids));
        }
        if ($tabformatrecordnums && $tabsectionnums != $tabformatrecordnums->value) {
            // If the tab nums of that tab have changed update them.
            $DB->update_record('course_format_options', array('id' => $tabformatrecordnums->id, 'value' => $tabsectionnums));
        }

        return $tabsectionids;
    }

    /**
     * Display section-0 on top of tabs if option has been checked.
     *
     * @param array|stdClass $course
     * @param array|stdClass $sections
     * @param array|stdClass $formatoptions
     * @param array|stdClass $modinfo
     * @return string
     */
    public function render_section0_ontop($course, $sections, $formatoptions, $modinfo) {
        $o = '';
        if ($formatoptions['section0_ontop']) {
            $thissection = $sections[0];
            $o .= html_writer::start_tag('div', array('id' => 'ontop_area', 'class' => 'section0_ontop'));
            $o .= html_writer::start_tag('ul', array('id' => 'ontop_area', 'class' => 'topics2'));
            $o .= $this->render_section($course, $thissection, $formatoptions);
        } else {
            $o .= html_writer::start_tag('div', array('id' => 'ontop_area'));
            $o .= html_writer::start_tag('ul', array('id' => 'ontop_area', 'class' => 'topics2'));
        }

        $o .= html_writer::end_tag('div');
        return $o;
    }

    /**
     * Render the sections of a course.
     *
     * @param array|stdClass $course
     * @param array|stdClass $sections
     * @param array|stdClass $formatoptions
     * @param array|stdClass $modinfo
     * @param int $numsections
     * @return string
     */
    public function render_sections($course, $sections, $formatoptions, $modinfo, $numsections) {
        $o = '';

        foreach ($sections as $section => $thissection) {
            if ($section == 0) {
                $o .= html_writer::start_tag('div', array('id' => 'inline_area'));
                if ($formatoptions['section0_ontop']) { // Section-0 is already shown on top.
                    $o .= html_writer::end_tag('div');
                    continue;
                }
                $o .= $this->render_section($course, $thissection, $formatoptions);
                $o .= html_writer::end_tag('div');
                continue;
            }
            if ($section > $numsections) {
                // Activities inside this section are 'orphaned', this section will be printed as 'stealth' below.
                continue;
            }
            /*
             * Show the section if the user is permitted to access it, OR if it's not available
             * but there is some available info text which explains the reason & should display,
             * OR it is hidden but the course has a setting to display hidden sections as unavilable.
             */
            $showsection = $thissection->uservisible ||
                ($thissection->visible && !$thissection->available && !empty($thissection->availableinfo)) ||
                (!$thissection->visible && !$course->hiddensections);
            if (!$showsection) {
                continue;
            }

            $o .= $this->render_section($course, $thissection, $formatoptions);
        }
        return $o;
    }

    /**
     * Render a single section of a course
     * @param array|stdClass $course
     * @param array|stdClass $section
     * @param array|stdClass $formatoptions
     * @return string
     */
    public function render_section($course, $section, $formatoptions) {
        $o = '';
        if (!$this->page->user_is_editing() && $course->coursedisplay == COURSE_DISPLAY_MULTIPAGE) {
            // Display section summary only.
            $o .= $this->section_summary($section, $course, null);
        } else {
            if ($section->uservisible) {
                $o .= $this->section_header($section, $course, false, 0);

                // Now the course modules for this section.
                $o .= $this->courserenderer->course_section_cm_list($course, $section, 0);
                $o .= $this->courserenderer->course_section_add_cm_control($course, $section->section, 0);
                $o .= $this->section_footer();
            }
        }
        return $o;
    }

    /**
     * Generate the display of the header part of a section before
     * course modules are included
     *
     * @param stdClass $section The course_section entry from DB
     * @param stdClass $course The course entry from DB
     * @param bool $onsectionpage true if being printed on a single-section page
     * @param int $sectionreturn The section to return to after an action
     * @return string HTML to output.
     */
    protected function section_header($section, $course, $onsectionpage, $sectionreturn=null) {
        $o = '';
        $sectionstyle = '';

        if ($section->section != 0) {
            // Only in the non-general sections.
            if (!$section->visible) {
                $sectionstyle = ' hidden';
            }
            if (course_get_format($course)->is_section_current($section)) {
                $sectionstyle = ' current';
            }
        }

        // When rendering section-0 check if it is on top and adjust classes.
        if ($section->section === 0 && $course->section0_ontop) {
            $classes = 'section clearfix'; // On top is not main.
        } else {
            $classes = 'section main clearfix';
        }

        // Start the section.
        $o .= html_writer::start_tag('li', array(
            'id' => 'section-'.$section->section,
            'section-id' => $section->id,
            'class' => $classes.$sectionstyle,
            'role' => 'region',
            'aria-label' => get_section_name($course, $section),
            'tabindex' => '0'
        ));

        // The left and right elements.
        $leftcontent = $this->section_left_content($section, $course, $onsectionpage);
        $o .= html_writer::tag('div', $leftcontent, array('class' => 'left side'));

        $rightcontent = $this->section_right_content($section, $course, $onsectionpage);
        $o .= html_writer::tag('div', $rightcontent, array('class' => 'right side'));

        // Start the content.
        $o .= html_writer::start_tag('div', array('class' => 'content'));

        // The sectionhead.
        if (($section->section !== 0 || ($section->name !== '' && $section->name !== null)) && !$onsectionpage) {
            // The sectionname.
            if (($section->section !== 0 || $section->name != '')) {
                $o .= html_writer::tag('h' . 3, $this->section_title($section, $course),
                    array('class' => renderer_base::prepare_classes('sectionname')));
            }
            $o .= $this->section_availability($section);
        }

        // The sectionbody.
        $o .= $this->section_body($section, $course);

        return $o;
    }

    /**
     * Section title either with toggle or straight.
     *
     * @param stdClass $section
     * @param stdClass $course
     * @return string
     * @throws coding_exception
     */
    public function section_title($section, $course) {
        if ($course->coursedisplay == COURSE_DISPLAY_SINGLEPAGE &&
            (!isset($course->defaultcollapse) || $course->defaultcollapse != 2)) {

            $togglestate = (isset($this->toggleseq[$section->id]) ? $this->toggleseq[$section->id] : 0);
            $tooltipopen = get_string('tooltip_open', 'format_topics2');
            $tooltipclosed = get_string('tooltip_closed', 'format_topics2');

            if ($togglestate ||
                (!count($this->toggleseq) && isset($course->defaultcollapse) && $course->defaultcollapse)) {
                $toggler = '<i class="toggler toggler_open fa fa-angle-down" title="'.$tooltipopen
                    .'" style="cursor: pointer;"></i>';
                $toggler .= '<i class="toggler toggler_closed fa fa-angle-right" title="'
                    .$tooltipclosed.'" style="cursor: pointer; display: none;"></i>';
            } else {
                $toggler = '<i class="toggler toggler_open fa fa-angle-down" title="'.$tooltipopen
                    .'" style="cursor: pointer; display: none;"></i>';
                $toggler .= '<i class="toggler toggler_closed fa fa-angle-right" title="'.$tooltipclosed
                    .'" style="cursor: pointer;"></i>';
            }

            $toggler .= ' ';
        } else {
            $toggler = '';
        }

        return $toggler.$this->render(course_get_format($course)->inplace_editable_render_section_name($section));
    }

    /**
     * Render the body of a section
     *
     * @param array|stdClass $section
     * @param array|stdClass $course
     * @return string
     */
    protected function section_body($section, $course) {
        $o = '';
        $togglestate = (isset($this->toggleseq[$section->id]) ? $this->toggleseq[$section->id] : 0);

        if ($course->defaultcollapse == 2 || // Collapsing has been switched off.
            ($course->coursedisplay == COURSE_DISPLAY_SINGLEPAGE && $togglestate) ||
            ($course->coursedisplay != COURSE_DISPLAY_SINGLEPAGE) ||
            ($section->section == 0 && $section->name == '') ||
            (!count($this->toggleseq) && isset($course->defaultcollapse) && $course->defaultcollapse)
        ) {
            $o .= html_writer::start_tag('div', array('class' => 'sectionbody summary toggle_area showing'));
        } else {
            $o .= html_writer::start_tag('div',
                array('class' => 'sectionbody summary toggle_area hidden', 'style' => 'display: none;'));
        }
        if ($section->uservisible || $section->visible) {
            // Show summary if section is available or has availability restriction information.
            // Do not show summary if section is hidden but we still display it because of course setting.
            $o .= $this->format_summary_text($section);
        }
        return $o;

    }

    /**
     * Render hidden sections for course editors only.
     *
     * @param array|stdClass $course
     * @param array|stdClass $sections
     * @param array|stdClass $context
     * @param array|stdClass $modinfo
     * @param int $numsections
     * @return string
     * @throws coding_exception
     */
    public function render_hidden_sections($course, $sections, $context, $modinfo, $numsections) {
        $o = '<div class="testing"></div>';
        if ($this->page->user_is_editing() and has_capability('moodle/course:update', $context)) {
            // Print stealth sections if present.
            foreach ($sections as $section => $thissection) {
                if ($section <= $numsections or empty($modinfo->sections[$section])) {
                    // This is not stealth section or it is empty.
                    continue;
                }
                $o .= $this->stealth_section_header($section);
                $o .= $this->courserenderer->course_section_cm_list($course, $thissection, 0);
                $o .= $this->stealth_section_footer();
            }
            $o .= $this->change_number_sections($course, 0);
        }
        return $o;
    }

    /**
     * Convert all numbers found in a given string into words
     * @param string $string
     * @return mixed
     */
    public function numbers2words($string) {
        $numwords = array(
            0 => 'zero',
            1 => 'one',
            2 => 'two',
            3 => 'three',
            4 => 'four',
            5 => 'five',
            6 => 'six',
            7 => 'seven',
            8 => 'eight',
            9 => 'nine'
        );
        for ($i = 0; $i < 10; $i++) {
            $string = str_replace($i, $numwords[$i], $string);
        }
        return $string;
    }

    /**
     * Generate the edit control items of a section
     *
     * @param stdClass $course The course entry from DB
     * @param stdClass $section The course_section entry from DB
     * @param bool $onsectionpage true if being printed on a section page
     * @return array of edit control items
     */
    protected function section_edit_control_items($course, $section, $onsectionpage = false) {
        global $DB, $CFG;

        if (!$this->page->user_is_editing()) {
            return array();
        }

        $options = $DB->get_records('course_format_options', array('courseid' => $course->id));
        $formatoptions = array();
        foreach ($options as $option) {
            $formatoptions[$option->name] = $option->value;
        }

        if (isset($formatoptions['maxtabs'])) {
            $maxtabs = $formatoptions['maxtabs'];
        } else {
            // Allow up to 5 tabs  by default if nothing else is set in the config file.
            $maxtabs = (isset($CFG->max_tabs) ? $CFG->max_tabs : 5);
        }
        $coursecontext = context_course::instance($course->id);

        if ($onsectionpage) {
            $url = course_get_url($course, $section->section);
        } else {
            $url = course_get_url($course);
        }
        $url->param('sesskey', sesskey());

        $controls = array();

        // Add move to/from top for section0 only.
        if ($section->section === 0) {
            $controls['ontop'] = array(
                "icon" => 't/up',
                'name' => 'Show always on top',

                'attr' => array(
                    'tabnr' => 0,
                    'class' => 'ontop_mover',
                    'title' => 'Show always on top',
                    'data-action' => 'sectionzeroontop'
                )
            );
            $controls['inline'] = array(
                "icon" => 't/down',
                'name' => 'Show inline',

                'attr' => array(
                    'tabnr' => 0,
                    'class' => 'inline_mover',
                    'title' => 'Show inline',
                    'data-action' => 'sectionzeroinline'
                )
            );
        }

        // Insert tab moving menu items.
        $controls['no_tab'] = array(
            "icon" => 't/left',
            'name' => 'Remove from Tabs',

            'attr' => array(
                'tabnr' => 0,
                'class' => 'tab_mover',
                'title' => 'Remove from Tabs',
                'data-action' => 'removefromtabs'
            )
        );

        $itemtitle = get_string('movetotab', 'format_topics2');

        for ($i = 1; $i <= $maxtabs; $i++) {
            $tabname = 'tab'.$i.'_title';
            $itemname = get_string('totab', 'format_topics2').(isset($course->$tabname) && $course->$tabname != ''
                && $course->$tabname != 'Tab '.$i ? '"'.$course->$tabname.'"' : $i);

            $controls['to_tab'.$i] = array(
                "icon" => 't/right',
                'name' => $itemname,

                'attr' => array(
                    'tabnr' => $i,
                    'class' => 'tab_mover',
                    'title' => $itemtitle,
                    'data-action' => $this->numbers2words("movetotab$i")
                )
            );
        }

        if ($section->section && has_capability('moodle/course:setcurrentsection', $coursecontext)) {
            if ($course->marker == $section->section) {  // Show the "light globe" on/off.
                $url->param('marker', 0);
                $markedthistopic = get_string('markedthistopic');
                $highlightoff = get_string('highlightoff');
                $controls['highlight'] = array('url' => $url, "icon" => 'i/marked',
                    'name' => $highlightoff,
                    'pixattr' => array('class' => '', 'alt' => $markedthistopic),
                    'attr' => array('class' => 'editing_highlight', 'title' => $markedthistopic,
                        'data-action' => 'removemarker'));
            } else {
                $url->param('marker', $section->section);
                $markthistopic = get_string('markthistopic');
                $highlight = get_string('highlight');
                $controls['highlight'] = array('url' => $url, "icon" => 'i/marker',
                    'name' => $highlight,
                    'pixattr' => array('class' => '', 'alt' => $markthistopic),
                    'attr' => array('class' => 'editing_highlight', 'title' => $markthistopic,
                        'data-action' => 'setmarker'));
            }
        }

        $parentcontrols = parent::section_edit_control_items($course, $section, $onsectionpage);

        // If the edit key exists, we are going to insert our controls after it.
        if (array_key_exists("edit", $parentcontrols)) {
            $merged = array();
            // We can't use splice because we are using associative arrays.
            // Step through the array and merge the arrays.
            foreach ($parentcontrols as $key => $action) {
                $merged[$key] = $action;
                if ($key == "edit") {
                    // If we have come to the edit key, merge these controls here.
                    $merged = array_merge($merged, $controls);
                }
            }

            return $merged;
        } else {
            return array_merge($controls, $parentcontrols);
        }
    }

    /**
     * print the section footer
     * @return string
     */
    protected function section_footer() {
        $o = html_writer::end_tag('div'); // Ending the sectionbody.
        $o .= html_writer::end_tag('div'); // Ending the content.
        $o .= html_writer::end_tag('li'); // Ending the section.

        return $o;
    }
}