Proyectos de Subversion Moodle

<?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 use with the course section and all the goodness that falls

 * within it.

 *

 * This renderer should contain methods useful to courses, and categories.

 *

 * @package   moodlecore

 * @copyright 2010 Sam Hemelryk

 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

 defined('MOODLE_INTERNAL') || die();

/**

 * The core course renderer

 *

 * Can be retrieved with the following:

 * $renderer = $PAGE->get_renderer('core','course');

 */

class core_course_renderer extends plugin_renderer_base {

    const COURSECAT_SHOW_COURSES_NONE = 0; /* do not show courses at all */

    const COURSECAT_SHOW_COURSES_COUNT = 5; /* do not show courses but show number of courses next to category name */

    const COURSECAT_SHOW_COURSES_COLLAPSED = 10;

    const COURSECAT_SHOW_COURSES_AUTO = 15; /* will choose between collapsed and expanded automatically */

    const COURSECAT_SHOW_COURSES_EXPANDED = 20;

    const COURSECAT_SHOW_COURSES_EXPANDED_WITH_CAT = 30;

    const COURSECAT_TYPE_CATEGORY = 0;

    const COURSECAT_TYPE_COURSE = 1;

    /**

     * A cache of strings

     * @var stdClass

     */

    protected $strings;

    /**

     * Whether a category content is being initially rendered with children. This is mainly used by the

     * core_course_renderer::corsecat_tree() to render the appropriate action for the Expand/Collapse all link on

     * page load.

     * @var bool

     */

    protected $categoryexpandedonload = false;

    /**

     * Override the constructor so that we can initialise the string cache

     *

     * @param moodle_page $page

     * @param string $target

     */

    public function __construct(moodle_page $page, $target) {

        $this->strings = new stdClass;

        $courseid = $page->course->id;

        parent::__construct($page, $target);

    }

    /**

     * @deprecated since 3.2

     */

    protected function add_modchoosertoggle() {

        throw new coding_exception('core_course_renderer::add_modchoosertoggle() can not be used anymore.');

    }

    /**

     * Renders course info box.

     *

     * @param stdClass $course

     * @return string

     */

    public function course_info_box(stdClass $course) {

        $content = '';

        $content .= $this->output->box_start('generalbox info');

        $chelper = new coursecat_helper();

        $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_EXPANDED);

        $content .= $this->coursecat_coursebox($chelper, $course);

        $content .= $this->output->box_end();

        return $content;

    }

    /**

     * Renderers a structured array of courses and categories into a nice XHTML tree structure.

     *

     * @deprecated since 2.5

     *

     * @param array $ignored argument ignored

     * @return string

     */

    final public function course_category_tree(array $ignored) {

        debugging('Function core_course_renderer::course_category_tree() is deprecated, please use frontpage_combo_list()', DEBUG_DEVELOPER);

        return $this->frontpage_combo_list();

    }

    /**

     * Renderers a category for use with course_category_tree

     *

     * @deprecated since 2.5

     *

     * @param array $category

     * @param int $depth

     * @return string

     */

    final protected function course_category_tree_category(stdClass $category, $depth=1) {

        debugging('Function core_course_renderer::course_category_tree_category() is deprecated', DEBUG_DEVELOPER);

        return '';

    }

    /**

     * Render a modchooser.

     *

     * @param renderable $modchooser The chooser.

     * @return string

     */

    public function render_modchooser(renderable $modchooser) {

        return $this->render_from_template('core_course/modchooser', $modchooser->export_for_template($this));

    }

    /**

     * @deprecated since 3.9

     */

    public function course_modchooser() {

        throw new coding_exception('course_modchooser() can not be used anymore, please use course_activitychooser() instead.');

    }

    /**

     * Build the HTML for the module chooser javascript popup.

     *

     * @param int $courseid The course id to fetch modules for.

     * @return string

     */

    public function course_activitychooser($courseid) {

        if (!$this->page->requires->should_create_one_time_item_now('core_course_modchooser')) {

            return '';

        }

        // Build an object of config settings that we can then hook into in the Activity Chooser.

        $chooserconfig = (object) [

            'tabmode' => get_config('core', 'activitychoosertabmode'),

        ];

        $this->page->requires->js_call_amd('core_course/activitychooser', 'init', [$courseid, $chooserconfig]);

        return '';

    }

    /**

     * Build the HTML for a specified set of modules

     *

     * @param array $modules A set of modules as used by the

     * course_modchooser_module function

     * @return string The composed HTML for the module

     */

    protected function course_modchooser_module_types($modules) {

        debugging('Method core_course_renderer::course_modchooser_module_types() is deprecated, ' .

            'see core_course_renderer::render_modchooser().', DEBUG_DEVELOPER);

        return '';

    }

    /**

     * Return the HTML for the specified module adding any required classes

     *

     * @param object $module An object containing the title, and link. An

     * icon, and help text may optionally be specified. If the module

     * contains subtypes in the types option, then these will also be

     * displayed.

     * @param array $classes Additional classes to add to the encompassing

     * div element

     * @return string The composed HTML for the module

     */

    protected function course_modchooser_module($module, $classes = array('option')) {

        debugging('Method core_course_renderer::course_modchooser_module() is deprecated, ' .

            'see core_course_renderer::render_modchooser().', DEBUG_DEVELOPER);

        return '';

    }

    protected function course_modchooser_title($title, $identifier = null) {

        debugging('Method core_course_renderer::course_modchooser_title() is deprecated, ' .

            'see core_course_renderer::render_modchooser().', DEBUG_DEVELOPER);

        return '';

    }

    /**

     * @deprecated since 4.0 - please do not use this function any more.

     */

    public function course_section_cm_edit_actions($actions, cm_info $mod = null, $displayoptions = array()) {

        throw new coding_exception(

            'course_section_cm_edit_actions can not be used any more. Please, use ' .

            'core_courseformat\\output\\local\\content\\cm\\controlmenu instead.'

        );

    }

    /**

     * Renders HTML for the menus to add activities and resources to the current course

     *

     * Renders the ajax control (the link which when clicked produces the activity chooser modal). No noscript fallback.

     *

     * @param stdClass $course

     * @param int $section relative section number (field course_sections.section)

     * @param int $sectionreturn The section to link back to

     * @param array $displayoptions additional display options, for example blocks add

     *     option 'inblock' => true, suggesting to display controls vertically

     * @return string

     */

    function course_section_add_cm_control($course, $section, $sectionreturn = null, $displayoptions = array()) {

        // Check to see if user can add menus.

        if (!has_capability('moodle/course:manageactivities', context_course::instance($course->id))

                || !$this->page->user_is_editing()) {

            return '';

        }

        $data = [

            'sectionid' => $section,

            'sectionreturn' => $sectionreturn

        ];

        $ajaxcontrol = $this->render_from_template('course/activitychooserbutton', $data);

        // Load the JS for the modal.

        $this->course_activitychooser($course->id);

        return $ajaxcontrol;

    }

    /**

     * Renders html to display a course search form

     *

     * @param string $value default value to populate the search field

     * @return string

     */

    public function course_search_form($value = '') {

        $data = [

            'action' => \core_search\manager::get_course_search_url(),

            'btnclass' => 'btn-primary',

            'inputname' => 'q',

            'searchstring' => get_string('searchcourses'),

            'hiddenfields' => (object) ['name' => 'areaids', 'value' => 'core_course-course'],

            'query' => $value

        ];

        return $this->render_from_template('core/search_input', $data);

    }

    /**

     * @deprecated since Moodle 3.11

     */

    public function course_section_cm_completion() {

        throw new coding_exception(__FUNCTION__ . ' is deprecated. Use the activity_completion output component instead.');

    }

    /**

     * @deprecated since 4.0 - please do not use this function any more.

     */

    public function is_cm_conditionally_hidden(cm_info $mod) {

        throw new coding_exception(

            'is_cm_conditionally_hidden can not be used any more. Please, use ' .

            '\core_availability\info_module::is_available_for_all instead'

        );

    }

    /**

     * @deprecated since 4.0 - please do not use this function any more.

     */

    public function course_section_cm_name(cm_info $mod, $displayoptions = array()) {

        throw new coding_exception(

            'course_section_cm_name can not be used any more. Please, use ' .

            'core_courseformat\\output\\local\\content\\cm\\cmname class instead.'

        );

    }

    /**

     * @deprecated since 4.0 - please do not use this function any more.

     */

    protected function course_section_cm_classes(cm_info $mod) {

        throw new coding_exception(

            'course_section_cm_classes can not be used any more. Now it is part of core_courseformat\\output\\local\\content\\cm'

        );

    }

    /**

     * @deprecated since 4.0 - please do not use this function any more.

     */

    public function course_section_cm_name_title(cm_info $mod, $displayoptions = array()) {

        throw new coding_exception(

            'course_section_cm_name_title can not be used any more. Please, use ' .

            'core_courseformat\\output\\local\\cm\\title class instead'

        );

    }

    /**

     * @deprecated since 4.0 - please do not use this function any more.

     */

    public function course_section_cm_text(cm_info $mod, $displayoptions = array()) {

        throw new coding_exception(

            'course_section_cm_text can not be used any more. Now it is part of core_courseformat\\output\\local\\content\\cm'

        );

    }

    /**

     * @deprecated since 4.0 - please do not use this function any more.

     */

    public function availability_info($text, $additionalclasses = '') {

        throw new coding_exception(

            'availability_info can not be used any more. Please, use ' .

            'core_courseformat\\output\\local\\content\\section\\availability instead'

        );

    }

    /**

     * @deprecated since 4.0 - please do not use this function any more.

     */

    public function course_section_cm_availability(cm_info $mod, $displayoptions = array()) {

        throw new coding_exception(

            'course_section_cm_availability can not be used any more. Please, use ' .

            'core_courseformat\\output\\local\\content\\cm\\availability instead'

        );

    }

    /**

     * @deprecated since 4.0 - use core_course output components or course_format::course_section_updated_cm_item instead.

     */

    public function course_section_cm_list_item($course, &$completioninfo, cm_info $mod, $sectionreturn, $displayoptions = []) {

        throw new coding_exception(

            'course_section_cm_list_item can not be used any more. Please, use renderer course_section_updated_cm_item instead'

        );

    }

    /**

     * @deprecated since 4.0 - use core_course output components instead.

     */

    public function course_section_cm($course, &$completioninfo, cm_info $mod, $sectionreturn, $displayoptions = []) {

        throw new coding_exception(

            'course_section_cm can not be used any more. Please, use core_courseformat\\output\\content\\cm output class instead'

        );

    }

    /**

     * Message displayed to the user when they try to access unavailable activity following URL

     *

     * This method is a very simplified version of {@link course_section_cm()} to be part of the error

     * notification only. It also does not check if module is visible on course page or not.

     *

     * The message will be displayed inside notification!

     *

     * @param cm_info $cm

     * @return string

     */

    public function course_section_cm_unavailable_error_message(cm_info $cm) {

        if ($cm->uservisible) {

            return null;

        }

        if (!$cm->availableinfo) {

            return get_string('activityiscurrentlyhidden');

        }

        $altname = get_accesshide(' ' . $cm->modfullname);

        $name = html_writer::empty_tag('img', array('src' => $cm->get_icon_url(),

                'class' => 'iconlarge activityicon', 'alt' => '')) .

            html_writer::tag('span', ' '.$cm->get_formatted_name() . $altname, array('class' => 'instancename'));

        $formattedinfo = \core_availability\info::format_info($cm->availableinfo, $cm->get_course());

        return html_writer::div($name, 'activityinstance-error') .

        html_writer::div($formattedinfo, 'availabilityinfo-error');

    }

    /**

     * @deprecated since 4.0 - use core_course output components instead.

     */

    public function course_section_cm_list($course, $section, $sectionreturn = null, $displayoptions = []) {

        throw new coding_exception(

            'course_section_cm_list can not be used any more. Please, use ' .

            'core_courseformat\\output\\local\\content\\section\\cmlist class instead'

        );

    }

    /**

     * Displays a custom list of courses with paging bar if necessary

     *

     * If $paginationurl is specified but $totalcount is not, the link 'View more'

     * appears under the list.

     *

     * If both $paginationurl and $totalcount are specified, and $totalcount is

     * bigger than count($courses), a paging bar is displayed above and under the

     * courses list.

     *

     * @param array $courses array of course records (or instances of core_course_list_element) to show on this page

     * @param bool $showcategoryname whether to add category name to the course description

     * @param string $additionalclasses additional CSS classes to add to the div.courses

     * @param moodle_url $paginationurl url to view more or url to form links to the other pages in paging bar

     * @param int $totalcount total number of courses on all pages, if omitted $paginationurl will be displayed as 'View more' link

     * @param int $page current page number (defaults to 0 referring to the first page)

     * @param int $perpage number of records per page (defaults to $CFG->coursesperpage)

     * @return string

     */

    public function courses_list($courses, $showcategoryname = false, $additionalclasses = null, $paginationurl = null, $totalcount = null, $page = 0, $perpage = null) {

        global $CFG;

        // create instance of coursecat_helper to pass display options to function rendering courses list

        $chelper = new coursecat_helper();

        if ($showcategoryname) {

            $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_EXPANDED_WITH_CAT);

        } else {

            $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_EXPANDED);

        }

        if ($totalcount !== null && $paginationurl !== null) {

            // add options to display pagination

            if ($perpage === null) {

                $perpage = $CFG->coursesperpage;

            }

            $chelper->set_courses_display_options(array(

                'limit' => $perpage,

                'offset' => ((int)$page) * $perpage,

                'paginationurl' => $paginationurl,

            ));

        } else if ($paginationurl !== null) {

            // add options to display 'View more' link

            $chelper->set_courses_display_options(array('viewmoreurl' => $paginationurl));

            $totalcount = count($courses) + 1; // has to be bigger than count($courses) otherwise link will not be displayed

        }

        $chelper->set_attributes(array('class' => $additionalclasses));

        $content = $this->coursecat_courses($chelper, $courses, $totalcount);

        return $content;

    }

    /**

     * Returns HTML to display course name.

     *

     * @param coursecat_helper $chelper

     * @param core_course_list_element $course

     * @return string

     */

    protected function course_name(coursecat_helper $chelper, core_course_list_element $course): string {

        $content = '';

        if ($chelper->get_show_courses() >= self::COURSECAT_SHOW_COURSES_EXPANDED) {

            $nametag = 'h3';

        } else {

            $nametag = 'div';

        }

        $coursename = $chelper->get_course_formatted_name($course);

        $coursenamelink = html_writer::link(new moodle_url('/course/view.php', ['id' => $course->id]),

            $coursename, ['class' => $course->visible ? 'aalink' : 'aalink dimmed']);

        $content .= html_writer::tag($nametag, $coursenamelink, ['class' => 'coursename']);

        // If we display course in collapsed form but the course has summary or course contacts, display the link to the info page.

        $content .= html_writer::start_tag('div', ['class' => 'moreinfo']);

        if ($chelper->get_show_courses() < self::COURSECAT_SHOW_COURSES_EXPANDED) {

            if ($course->has_summary() || $course->has_course_contacts() || $course->has_course_overviewfiles()

                || $course->has_custom_fields()) {

                $url = new moodle_url('/course/info.php', ['id' => $course->id]);

                $image = $this->output->pix_icon('i/info', $this->strings->summary);

                $content .= html_writer::link($url, $image, ['title' => $this->strings->summary]);

                // Make sure JS file to expand course content is included.

                $this->coursecat_include_js();

            }

        }

        $content .= html_writer::end_tag('div');

        return $content;

    }

    /**

     * Returns HTML to display course enrolment icons.

     *

     * @param core_course_list_element $course

     * @return string

     */

    protected function course_enrolment_icons(core_course_list_element $course): string {

        $content = '';

        if ($icons = enrol_get_course_info_icons($course)) {

            $content .= html_writer::start_tag('div', ['class' => 'enrolmenticons']);

            foreach ($icons as $icon) {

                $content .= $this->render($icon);

            }

            $content .= html_writer::end_tag('div');

        }

        return $content;

    }

    /**

     * Displays one course in the list of courses.

     *

     * This is an internal function, to display an information about just one course

     * please use {@link core_course_renderer::course_info_box()}

     *

     * @param coursecat_helper $chelper various display options

     * @param core_course_list_element|stdClass $course

     * @param string $additionalclasses additional classes to add to the main <div> tag (usually

     *    depend on the course position in list - first/last/even/odd)

     * @return string

     */

    protected function coursecat_coursebox(coursecat_helper $chelper, $course, $additionalclasses = '') {

        if (!isset($this->strings->summary)) {

            $this->strings->summary = get_string('summary');

        }

        if ($chelper->get_show_courses() <= self::COURSECAT_SHOW_COURSES_COUNT) {

            return '';

        }

        if ($course instanceof stdClass) {

            $course = new core_course_list_element($course);

        }

        $content = '';

        $classes = trim('coursebox clearfix '. $additionalclasses);

        if ($chelper->get_show_courses() < self::COURSECAT_SHOW_COURSES_EXPANDED) {

            $classes .= ' collapsed';

        }

        // .coursebox

        $content .= html_writer::start_tag('div', array(

            'class' => $classes,

            'data-courseid' => $course->id,

            'data-type' => self::COURSECAT_TYPE_COURSE,

        ));

        $content .= html_writer::start_tag('div', array('class' => 'info'));

        $content .= $this->course_name($chelper, $course);

        $content .= $this->course_enrolment_icons($course);

        $content .= html_writer::end_tag('div');

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

        $content .= $this->coursecat_coursebox_content($chelper, $course);

        $content .= html_writer::end_tag('div');

        $content .= html_writer::end_tag('div'); // .coursebox

        return $content;

    }

    /**

     * Returns HTML to display course summary.

     *

     * @param coursecat_helper $chelper

     * @param core_course_list_element $course

     * @return string

     */

    protected function course_summary(coursecat_helper $chelper, core_course_list_element $course): string {

        $content = '';

        if ($course->has_summary()) {

            $content .= html_writer::start_tag('div', ['class' => 'summary']);

            $content .= $chelper->get_course_formatted_summary($course,

                array('overflowdiv' => true, 'noclean' => true, 'para' => false));

            $content .= html_writer::end_tag('div');

        }

        return $content;

    }

    /**

     * Returns HTML to display course contacts.

     *

     * @param core_course_list_element $course

     * @return string

     */

    protected function course_contacts(core_course_list_element $course) {

        $content = '';

        if ($course->has_course_contacts()) {

            $content .= html_writer::start_tag('ul', ['class' => 'teachers']);

            foreach ($course->get_course_contacts() as $coursecontact) {

                $rolenames = array_map(function ($role) {

                    return $role->displayname;

                }, $coursecontact['roles']);

                $name = html_writer::tag('span', implode(", ", $rolenames).': ', ['class' => 'font-weight-bold']);

                $name .= html_writer::link(

                   \core_user::get_profile_url($coursecontact['user'], context_system::instance()),

                   $coursecontact['username']

                );

                $content .= html_writer::tag('li', $name);

            }

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

        }

        return $content;

    }

    /**

     * Returns HTML to display course overview files.

     *

     * @param core_course_list_element $course

     * @return string

     */

    protected function course_overview_files(core_course_list_element $course): string {

        global $CFG;

        $contentimages = $contentfiles = '';

        foreach ($course->get_course_overviewfiles() as $file) {

            $isimage = $file->is_valid_image();

            $url = moodle_url::make_file_url("$CFG->wwwroot/pluginfile.php",

                '/' . $file->get_contextid() . '/' . $file->get_component() . '/' .

                $file->get_filearea() . $file->get_filepath() . $file->get_filename(), !$isimage);

            if ($isimage) {

                $contentimages .= html_writer::tag('div',

                    html_writer::empty_tag('img', ['src' => $url, 'alt' => '']),

                    ['class' => 'courseimage']);

            } else {

                $image = $this->output->pix_icon(file_file_icon($file), $file->get_filename(), 'moodle');

                $filename = html_writer::tag('span', $image, ['class' => 'fp-icon']).

                    html_writer::tag('span', $file->get_filename(), ['class' => 'fp-filename']);

                $contentfiles .= html_writer::tag('span',

                    html_writer::link($url, $filename),

                    ['class' => 'coursefile fp-filename-icon text-break']);

            }

        }

        return $contentimages . $contentfiles;

    }

    /**

     * Returns HTML to display course category name.

     *

     * @param coursecat_helper $chelper

     * @param core_course_list_element $course

     * @return string

     */

    protected function course_category_name(coursecat_helper $chelper, core_course_list_element $course): string {

        $content = '';

        // Display course category if necessary (for example in search results).

        if ($chelper->get_show_courses() == self::COURSECAT_SHOW_COURSES_EXPANDED_WITH_CAT) {

            if ($cat = core_course_category::get($course->category, IGNORE_MISSING)) {

                $content .= html_writer::start_tag('div', ['class' => 'coursecat']);

                $content .= html_writer::tag('span', get_string('category').': ', ['class' => 'font-weight-bold']);

                $content .= html_writer::link(new moodle_url('/course/index.php', ['categoryid' => $cat->id]),

                        $cat->get_formatted_name(), ['class' => $cat->visible ? '' : 'dimmed']);

                $content .= html_writer::end_tag('div');

            }

        }

        return $content;

    }

    /**

     * Returns HTML to display course custom fields.

     *

     * @param core_course_list_element $course

     * @return string

     */

    protected function course_custom_fields(core_course_list_element $course): string {

        $content = '';

        if ($course->has_custom_fields()) {

            $handler = core_course\customfield\course_handler::create();

            $customfields = $handler->display_custom_fields_data($course->get_custom_fields());

            $content .= \html_writer::tag('div', $customfields, ['class' => 'customfields-container']);

        }

        return $content;

    }

    /**

     * Returns HTML to display course content (summary, course contacts and optionally category name)

     *

     * This method is called from coursecat_coursebox() and may be re-used in AJAX

     *

     * @param coursecat_helper $chelper various display options

     * @param stdClass|core_course_list_element $course

     * @return string

     */

    protected function coursecat_coursebox_content(coursecat_helper $chelper, $course) {

        if ($chelper->get_show_courses() < self::COURSECAT_SHOW_COURSES_EXPANDED) {

            return '';

        }

        if ($course instanceof stdClass) {

            $course = new core_course_list_element($course);

        }

        $content = \html_writer::start_tag('div', ['class' => 'd-flex']);

        $content .= $this->course_overview_files($course);

        $content .= \html_writer::start_tag('div', ['class' => 'flex-grow-1']);

        $content .= $this->course_summary($chelper, $course);

        $content .= $this->course_contacts($course);

        $content .= $this->course_category_name($chelper, $course);

        $content .= $this->course_custom_fields($course);

        $content .= \html_writer::end_tag('div');

        $content .= \html_writer::end_tag('div');

        return $content;

    }

    /**

     * Renders the list of courses

     *

     * This is internal function, please use {@link core_course_renderer::courses_list()} or another public

     * method from outside of the class

     *

     * If list of courses is specified in $courses; the argument $chelper is only used

     * to retrieve display options and attributes, only methods get_show_courses(),

     * get_courses_display_option() and get_and_erase_attributes() are called.

     *

     * @param coursecat_helper $chelper various display options

     * @param array $courses the list of courses to display

     * @param int|null $totalcount total number of courses (affects display mode if it is AUTO or pagination if applicable),

     *     defaulted to count($courses)

     * @return string

     */

    protected function coursecat_courses(coursecat_helper $chelper, $courses, $totalcount = null) {

        global $CFG;

        if ($totalcount === null) {

            $totalcount = count($courses);

        }

        if (!$totalcount) {

            // Courses count is cached during courses retrieval.

            return '';

        }

        if ($chelper->get_show_courses() == self::COURSECAT_SHOW_COURSES_AUTO) {

            // In 'auto' course display mode we analyse if number of courses is more or less than $CFG->courseswithsummarieslimit

            if ($totalcount <= $CFG->courseswithsummarieslimit) {

                $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_EXPANDED);

            } else {

                $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_COLLAPSED);

            }

        }

        // prepare content of paging bar if it is needed

        $paginationurl = $chelper->get_courses_display_option('paginationurl');

        $paginationallowall = $chelper->get_courses_display_option('paginationallowall');

        if ($totalcount > count($courses)) {

            // there are more results that can fit on one page

            if ($paginationurl) {

                // the option paginationurl was specified, display pagingbar

                $perpage = $chelper->get_courses_display_option('limit', $CFG->coursesperpage);

                $page = $chelper->get_courses_display_option('offset') / $perpage;

                $pagingbar = $this->paging_bar($totalcount, $page, $perpage,

                        $paginationurl->out(false, array('perpage' => $perpage)));

                if ($paginationallowall) {

                    $pagingbar .= html_writer::tag('div', html_writer::link($paginationurl->out(false, array('perpage' => 'all')),

                            get_string('showall', '', $totalcount)), array('class' => 'paging paging-showall'));

                }

            } else if ($viewmoreurl = $chelper->get_courses_display_option('viewmoreurl')) {

                // the option for 'View more' link was specified, display more link

                $viewmoretext = $chelper->get_courses_display_option('viewmoretext', new lang_string('viewmore'));

                $morelink = html_writer::tag(

                    'div',

                    html_writer::link($viewmoreurl, $viewmoretext, ['class' => 'btn btn-secondary']),

                    ['class' => 'paging paging-morelink']

                );

            }

        } else if (($totalcount > $CFG->coursesperpage) && $paginationurl && $paginationallowall) {

            // there are more than one page of results and we are in 'view all' mode, suggest to go back to paginated view mode

            $pagingbar = html_writer::tag('div', html_writer::link($paginationurl->out(false, array('perpage' => $CFG->coursesperpage)),

                get_string('showperpage', '', $CFG->coursesperpage)), array('class' => 'paging paging-showperpage'));

        }

        // display list of courses

        $attributes = $chelper->get_and_erase_attributes('courses');

        $content = html_writer::start_tag('div', $attributes);

        if (!empty($pagingbar)) {

            $content .= $pagingbar;

        }

        $coursecount = 0;

        foreach ($courses as $course) {

            $coursecount ++;

            $classes = ($coursecount%2) ? 'odd' : 'even';

            if ($coursecount == 1) {

                $classes .= ' first';

            }

            if ($coursecount >= count($courses)) {

                $classes .= ' last';

            }

            $content .= $this->coursecat_coursebox($chelper, $course, $classes);

        }

        if (!empty($pagingbar)) {

            $content .= $pagingbar;

        }

        if (!empty($morelink)) {

            $content .= $morelink;

        }

        $content .= html_writer::end_tag('div'); // .courses

        return $content;

    }

    /**

     * Renders the list of subcategories in a category

     *

     * @param coursecat_helper $chelper various display options

     * @param core_course_category $coursecat

     * @param int $depth depth of the category in the current tree

     * @return string

     */

    protected function coursecat_subcategories(coursecat_helper $chelper, $coursecat, $depth) {

        global $CFG;

        $subcategories = array();

        if (!$chelper->get_categories_display_option('nodisplay')) {

            $subcategories = $coursecat->get_children($chelper->get_categories_display_options());

        }

        $totalcount = $coursecat->get_children_count();

        if (!$totalcount) {

            // Note that we call core_course_category::get_children_count() AFTER core_course_category::get_children()

            // to avoid extra DB requests.

            // Categories count is cached during children categories retrieval.

            return '';

        }

        // prepare content of paging bar or more link if it is needed

        $paginationurl = $chelper->get_categories_display_option('paginationurl');

        $paginationallowall = $chelper->get_categories_display_option('paginationallowall');

        if ($totalcount > count($subcategories)) {

            if ($paginationurl) {

                // the option 'paginationurl was specified, display pagingbar

                $perpage = $chelper->get_categories_display_option('limit', $CFG->coursesperpage);

                $page = $chelper->get_categories_display_option('offset') / $perpage;

                $pagingbar = $this->paging_bar($totalcount, $page, $perpage,

                        $paginationurl->out(false, array('perpage' => $perpage)));

                if ($paginationallowall) {

                    $pagingbar .= html_writer::tag('div', html_writer::link($paginationurl->out(false, array('perpage' => 'all')),

                            get_string('showall', '', $totalcount)), array('class' => 'paging paging-showall'));

                }

            } else if ($viewmoreurl = $chelper->get_categories_display_option('viewmoreurl')) {

                // the option 'viewmoreurl' was specified, display more link (if it is link to category view page, add category id)

                if ($viewmoreurl->compare(new moodle_url('/course/index.php'), URL_MATCH_BASE)) {

                    $viewmoreurl->param('categoryid', $coursecat->id);

                }

                $viewmoretext = $chelper->get_categories_display_option('viewmoretext', new lang_string('viewmore'));

                $morelink = html_writer::tag('div', html_writer::link($viewmoreurl, $viewmoretext),

                        array('class' => 'paging paging-morelink'));

            }

        } else if (($totalcount > $CFG->coursesperpage) && $paginationurl && $paginationallowall) {

            // there are more than one page of results and we are in 'view all' mode, suggest to go back to paginated view mode

            $pagingbar = html_writer::tag('div', html_writer::link($paginationurl->out(false, array('perpage' => $CFG->coursesperpage)),

                get_string('showperpage', '', $CFG->coursesperpage)), array('class' => 'paging paging-showperpage'));

        }

        // display list of subcategories

        $content = html_writer::start_tag('div', array('class' => 'subcategories'));

        if (!empty($pagingbar)) {

            $content .= $pagingbar;

        }

        foreach ($subcategories as $subcategory) {

            $content .= $this->coursecat_category($chelper, $subcategory, $depth + 1);

        }

        if (!empty($pagingbar)) {

            $content .= $pagingbar;

        }

        if (!empty($morelink)) {

            $content .= $morelink;

        }

        $content .= html_writer::end_tag('div');

        return $content;

    }

    /**

     * Make sure that javascript file for AJAX expanding of courses and categories content is included

     */

    protected function coursecat_include_js() {

        if (!$this->page->requires->should_create_one_time_item_now('core_course_categoryexpanderjsinit')) {

            return;

        }

        // We must only load this module once.

        $this->page->requires->yui_module('moodle-course-categoryexpander',

                'Y.Moodle.course.categoryexpander.init');

    }

    /**

     * Returns HTML to display the subcategories and courses in the given category

     *

     * This method is re-used by AJAX to expand content of not loaded category

     *

     * @param coursecat_helper $chelper various display options

     * @param core_course_category $coursecat

     * @param int $depth depth of the category in the current tree

     * @return string

     */

    protected function coursecat_category_content(coursecat_helper $chelper, $coursecat, $depth) {

        $content = '';

        // Subcategories

        $content .= $this->coursecat_subcategories($chelper, $coursecat, $depth);

        // AUTO show courses: Courses will be shown expanded if this is not nested category,

        // and number of courses no bigger than $CFG->courseswithsummarieslimit.

        $showcoursesauto = $chelper->get_show_courses() == self::COURSECAT_SHOW_COURSES_AUTO;

        if ($showcoursesauto && $depth) {

            // this is definitely collapsed mode

            $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_COLLAPSED);

        }

        // Courses

        if ($chelper->get_show_courses() > core_course_renderer::COURSECAT_SHOW_COURSES_COUNT) {

            $courses = array();

            if (!$chelper->get_courses_display_option('nodisplay')) {

                $courses = $coursecat->get_courses($chelper->get_courses_display_options());

            }

            if ($viewmoreurl = $chelper->get_courses_display_option('viewmoreurl')) {

                // the option for 'View more' link was specified, display more link (if it is link to category view page, add category id)

                if ($viewmoreurl->compare(new moodle_url('/course/index.php'), URL_MATCH_BASE)) {

                    $chelper->set_courses_display_option('viewmoreurl', new moodle_url($viewmoreurl, array('categoryid' => $coursecat->id)));

                }

            }

            $content .= $this->coursecat_courses($chelper, $courses, $coursecat->get_courses_count());

        }

        if ($showcoursesauto) {

            // restore the show_courses back to AUTO

            $chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_AUTO);

        }

        return $content;

    }

    /**

     * Returns HTML to display a course category as a part of a tree

     *

     * This is an internal function, to display a particular category and all its contents

     * use {@link core_course_renderer::course_category()}

     *

     * @param coursecat_helper $chelper various display options

     * @param core_course_category $coursecat

     * @param int $depth depth of this category in the current tree

     * @return string

     */

    protected function coursecat_category(coursecat_helper $chelper, $coursecat, $depth) {

        // open category tag

        $classes = array('category');

        if (empty($coursecat->visible)) {

            $classes[] = 'dimmed_category';

        }

        if ($chelper->get_subcat_depth() > 0 && $depth >= $chelper->get_subcat_depth()) {

            // do not load content

            $categorycontent = '';

            $classes[] = 'notloaded';

            if ($coursecat->get_children_count() ||

                    ($chelper->get_show_courses() >= self::COURSECAT_SHOW_COURSES_COLLAPSED && $coursecat->get_courses_count())) {

                $classes[] = 'with_children';

                $classes[] = 'collapsed';

            }

        } else {

            // load category content

            $categorycontent = $this->coursecat_category_content($chelper, $coursecat, $depth);

            $classes[] = 'loaded';

            if (!empty($categorycontent)) {

                $classes[] = 'with_children';

                // Category content loaded with children.

                $this->categoryexpandedonload = true;

            }

        }

        // Make sure JS file to expand category content is included.

        $this->coursecat_include_js();

        $content = html_writer::start_tag('div', array(

            'class' => join(' ', $classes),

            'data-categoryid' => $coursecat->id,

            'data-depth' => $depth,

            'data-showcourses' => $chelper->get_show_courses(),

            'data-type' => self::COURSECAT_TYPE_CATEGORY,

        ));

        // category name

        $categoryname = $coursecat->get_formatted_name();

        $categoryname = html_writer::link(new moodle_url('/course/index.php',

                array('categoryid' => $coursecat->id)),

                $categoryname);

        if ($chelper->get_show_courses() == self::COURSECAT_SHOW_COURSES_COUNT

                && ($coursescount = $coursecat->get_courses_count())) {

            $categoryname .= html_writer::tag('span', ' ('. $coursescount.')',

                    array('title' => get_string('numberofcourses'), 'class' => 'numberofcourse'));

        }

        $content .= html_writer::start_tag('div', array('class' => 'info'));

        $content .= html_writer::tag(($depth > 1) ? 'h4' : 'h3', $categoryname, array('class' => 'categoryname aabtn'));

        $content .= html_writer::end_tag('div'); // .info

        // add category content to the output

        $content .= html_writer::tag('div', $categorycontent, array('class' => 'content'));

        $content .= html_writer::end_tag('div'); // .category

        // Return the course category tree HTML

        return $content;

    }

    /**

     * Returns HTML to display a tree of subcategories and courses in the given category

     *

     * @param coursecat_helper $chelper various display options

     * @param core_course_category $coursecat top category (this category's name and description will NOT be added to the tree)

     * @return string

     */

    protected function coursecat_tree(coursecat_helper $chelper, $coursecat) {

        // Reset the category expanded flag for this course category tree first.

        $this->categoryexpandedonload = false;

        $categorycontent = $this->coursecat_category_content($chelper, $coursecat, 0);

        if (empty($categorycontent)) {