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/>.

/**
 * This file contains the renderers for the calendar within Moodle
 *
 * @copyright 2010 Sam Hemelryk
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 * @package calendar
 */

if (!defined('MOODLE_INTERNAL')) {
    die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
}

/**
 * The primary renderer for the calendar.
 */
class core_calendar_renderer extends plugin_renderer_base {

    /**
     * Starts the standard layout for the page
     *
     * @return string
     */
    public function start_layout() {
        return html_writer::start_tag('div', ['data-region' => 'calendar', 'class' => 'maincalendar']);
    }

    /**
     * Creates the remainder of the layout
     *
     * @return string
     */
    public function complete_layout() {
        return html_writer::end_tag('div');
    }

    /**
     * Adds a pretent calendar block
     *
     * @param block_contents $bc
     * @param mixed $pos BLOCK_POS_RIGHT | BLOCK_POS_LEFT
     */
    public function add_pretend_calendar_block(block_contents $bc, $pos=BLOCK_POS_RIGHT) {
        $this->page->blocks->add_fake_block($bc, $pos);
    }

    /**
     * Creates a button to add a new event.
     *
     * @param int $courseid
     * @param int $unused1
     * @param int $unused2
     * @param int $unused3
     * @param int $unused4
     * @return string
     */
    public function add_event_button($courseid, $unused1 = null, $unused2 = null, $unused3 = null, $unused4 = null) {
        $data = [
            'contextid' => (\context_course::instance($courseid))->id,
        ];
        return $this->render_from_template('core_calendar/add_event_button', $data);
    }

    /**
     * @deprecated 3.9
     */
    #[\core\attribute\deprecated(
        replacement: 'event no longer used',
        since: '3.9',
        mdl: 'MDL-58866',
        final: true,
    )]
    public function event() {
        \core\deprecation::emit_deprecation(__FUNCTION__);
    }

    /**
     * Displays a course filter selector
     *
     * @param moodle_url $returnurl The URL that the user should be taken too upon selecting a course.
     * @param string $label The label to use for the course select.
     * @param int $courseid The id of the course to be selected.
     * @param int|null $calendarinstanceid The instance ID of the calendar we're generating this course filter for.
     * @return string
     */
    public function course_filter_selector(moodle_url $returnurl, $label = null, $courseid = null, ?int $calendarinstanceid = null) {
        global $CFG, $DB;

        if (!isloggedin() or isguestuser()) {
            return '';
        }

        $contextrecords = [];
        $courses = calendar_get_default_courses($courseid, 'id, shortname, fullname');

        if (!empty($courses) && count($courses) > CONTEXT_CACHE_MAX_SIZE) {
            // We need to pull the context records from the DB to preload them
            // below. The calendar_get_default_courses code will actually preload
            // the contexts itself however the context cache is capped to a certain
            // amount before it starts recycling. Unfortunately that starts to happen
            // quite a bit if a user has access to a large number of courses (e.g. admin).
            // So in order to avoid hitting the DB for each context as we loop below we
            // can load all of the context records and add them to the cache just in time.
            $courseids = array_map(function($c) {
                return $c->id;
            }, $courses);
            list($insql, $params) = $DB->get_in_or_equal($courseids);
            $contextsql = "SELECT ctx.instanceid, " . context_helper::get_preload_record_columns_sql('ctx') .
                          " FROM {context} ctx WHERE ctx.contextlevel = ? AND ctx.instanceid $insql";
            array_unshift($params, CONTEXT_COURSE);
            $contextrecords = $DB->get_records_sql($contextsql, $params);
        }

        unset($courses[SITEID]);

        $courseoptions = array();
        $courseoptions[SITEID] = get_string('fulllistofcourses');
        foreach ($courses as $course) {
            if (isset($contextrecords[$course->id])) {
                context_helper::preload_from_record($contextrecords[$course->id]);
            }

            // Limit the displayed course name to prevent the dropdown from getting too wide.
            $coursename = format_string(get_course_display_name_for_list($course), true, [
                'context' => \core\context\course::instance($course->id),
            ]);
            $courseoptions[$course->id] = shorten_text($coursename, 50, true);
        }

        if ($courseid) {
            $selected = $courseid;
        } else if ($this->page->course->id !== SITEID) {
            $selected = $this->page->course->id;
        } else {
            $selected = '';
        }
        $courseurl = new moodle_url($returnurl);
        $courseurl->remove_params('course');

        $labelattributes = [];
        if (empty($label)) {
            $label = get_string('listofcourses');
            $labelattributes['class'] = 'visually-hidden';
        }

        $filterid = 'calendar-course-filter';
        if ($calendarinstanceid) {
            $filterid .= "-$calendarinstanceid";
        }
        $select = html_writer::label($label, $filterid, false, $labelattributes);
        $select .= html_writer::select($courseoptions, 'course', $selected, false,
                ['class' => 'cal_courses_flt ms-1 me-auto me-2 mb-2', 'id' => $filterid]);

        return $select;
    }

    /**
     * Render the subscriptions header
     *
     * @return string
     */
    public function render_subscriptions_header(): string {
        $importcalendarbutton = new single_button(new moodle_url('/calendar/import.php', calendar_get_export_import_link_params()),
                get_string('importcalendar', 'calendar'), 'get', single_button::BUTTON_PRIMARY);
        $importcalendarbutton->class .= ' float-sm-end float-end';
        $exportcalendarbutton = new single_button(new moodle_url('/calendar/export.php', calendar_get_export_import_link_params()),
                get_string('exportcalendar', 'calendar'), 'get', single_button::BUTTON_PRIMARY);
        $exportcalendarbutton->class .= ' float-sm-end float-end';
        $output = $this->output->heading(get_string('managesubscriptions', 'calendar'));
        $output .= html_writer::start_div('header d-flex flex-wrap mt-5');
        $headerattr = [
            'class' => 'me-auto',
            'aria-describedby' => 'subscription_details_table',
        ];
        $output .= html_writer::tag('h3', get_string('yoursubscriptions', 'calendar'), $headerattr);
        $output .= $this->output->render($importcalendarbutton);
        $output .= $this->output->render($exportcalendarbutton);
        $output .= html_writer::end_div();

        return $output;
    }

    /**
     * Render the subscriptions blank state appearance
     *
     * @return string
     */
    public function render_no_calendar_subscriptions(): string {
        $output = html_writer::start_div('mt-5');
        $importlink = (new moodle_url('/calendar/import.php', calendar_get_export_import_link_params()))->out();
        $output .= get_string('nocalendarsubscriptionsimportexternal', 'core_calendar', $importlink);
        $output .= html_writer::end_div();

        return $output;
    }

    /**
     * Renders a table containing information about calendar subscriptions.
     *
     * @param int $unused
     * @param array $subscriptions
     * @param string $unused2
     * @return string
     */
    public function subscription_details($unused, $subscriptions, $unused2 = '') {
        $table = new html_table();
        $table->head  = array(
            get_string('colcalendar', 'calendar'),
            get_string('collastupdated', 'calendar'),
            get_string('eventkind', 'calendar'),
            get_string('colpoll', 'calendar'),
            get_string('colactions', 'calendar')
        );
        $table->data  = array();
        $table->id = 'subscription_details_table';

        if (empty($subscriptions)) {
            $importlink = (new moodle_url('/calendar/import.php', calendar_get_export_import_link_params()))->out();
            $cell = new html_table_cell(get_string('nocalendarsubscriptionsimportexternal', 'core_calendar', $importlink));
            $cell->colspan = 5;
            $table->data[] = new html_table_row(array($cell));
        }
        $strnever = new lang_string('never', 'calendar');
        foreach ($subscriptions as $sub) {
            $label = $sub->name;
            if (!empty($sub->url)) {
                $label = html_writer::link($sub->url, $label);
            }
            if (empty($sub->lastupdated)) {
                $lastupdated = $strnever->out();
            } else {
                $lastupdated = userdate($sub->lastupdated, get_string('strftimedatetimeshort', 'langconfig'));
            }

            $type = $sub->eventtype . 'events';
            $calendarname = new html_table_cell($label);
            $calendarname->header = true;

            $tablerow = new html_table_row(array(
                $calendarname,
                new html_table_cell($lastupdated),
                new html_table_cell(get_string($type, 'calendar')),
                new html_table_cell($this->render_subscription_update_interval($sub)),
                new html_table_cell($this->subscription_action_links())
            ));
            $tablerow->attributes += [
                'data-subid' => $sub->id,
                'data-subname' => $sub->name
            ];
            $table->data[] = $tablerow;
        }

        $out  = $this->output->box_start('generalbox calendarsubs');

        $out .= html_writer::table($table);
        $out .= $this->output->box_end();

        $this->page->requires->js_call_amd('core_calendar/manage_subscriptions', 'init');
        return $out;
    }

    /**
     * Render subscription update interval form.
     *
     * @param stdClass $subscription
     * @return string
     */
    protected function render_subscription_update_interval(stdClass $subscription): string {
        if (empty($subscription->url)) {
            return '';
        }

        $tmpl = new \core_calendar\output\refreshintervalcollection($subscription);
        return $this->output->render_from_template('core/inplace_editable', $tmpl->export_for_template($this->output));
    }

    /**
     * Creates a form to perform actions on a given subscription.
     *
     * @return string
     */
    protected function subscription_action_links(): string {
        $html = html_writer::start_tag('div', array('class' => 'btn-group float-start'));
        $html .= html_writer::span(html_writer::link('#', get_string('delete'),
            ['data-action' => 'delete-subscription']), '');
        $html .= html_writer::end_tag('div');
        return $html;
    }

    /**
     * Render the event filter region.
     *
     * @return  string
     */
    public function event_filter() {
        $data = [
            'eventtypes' => calendar_get_filter_types(),
        ];
        return $this->render_from_template('core_calendar/event_filter', $data);
    }

    /**
     * Render the calendar import result.
     *
     * @param array $result Import result
     * @return string|null
     */
    public function render_import_result(array $result): ?string {
        $data = [
            'eventsimported' => $result['eventsimported'],
            'eventsskipped' => $result['eventsskipped'],
            'eventsupdated' => $result['eventsupdated'],
            'eventsdeleted' => $result['eventsdeleted'],
            'haserror' => $result['haserror'],
            'errors' => $result['errors']
        ];

        return $this->render_from_template('core_calendar/subscription_update_result', $data);
    }
}