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

/**
 * This file contains a renderer for various parts of the Diary module.
 *
 * @package   mod_diary
 * @copyright 2019 onwards AL Rachels drachels@drachels.com
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
defined('MOODLE_INTERNAL') || die(); // phpcs:ignore

/**
 * A custom renderer class that extends the plugin_renderer_base and is used by the diary module.
 *
 * @package mod_diary
 * @copyright 2019 onwards AL Rachels drachels@drachels.com
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class mod_diary_renderer extends plugin_renderer_base {

    /**
     * Rendering diary files.
     *
     * @var int $diary
     */
    private $diary;

    /**
     * Initialize internal objects.
     *
     * @var int $cm
     */
    protected $cm;

    /**
     * Return introduction box and content for the page generated by view.php file.
     *
     * @param int $diary Diary activity this description is for.
     * @param int $cm Course module this description is for.
     * @return $output Return a box with the description in it.
     */
    public function introduction($diary, $cm) {
        $output = '';

        if (trim($diary->intro)) {
            $output .= $this->box_start('generalbox boxaligncenter', 'intro');
            $output .= format_module_intro('diary', $diary, $cm->id);
            $output .= $this->box_end();
        }
        return $output;
    }

    /**
     * Print the toolbar above the entries on the page generated by view.php.
     *
     * @param int $firstkey Id of the entry for the current sort order.
     * @return $output Return all the buttons that are part of the toolbar.
     */
    public function toolbar($firstkey, $cm) {
        // 20201003 Changed toolbar code to $output instead of html_writer::alist.
        $options = [];
        // 20250110 Changed this option for all tools used on the toolbar.
        $options['id'] = $cm['id'];
        $output = ' ';

        // Print export to .csv file toolbutton.
        $options['action'] = 'download';
        $url = new moodle_url('/mod/diary/view.php', $options);
        $output .= html_writer::link($url, $this->pix_icon('i/export', get_string('csvexport', 'diary')),
            [
            'class' => 'toolbutton',
            ]
        );

        // Print reload toolbutton.
        $options['action'] = 'reload';
        $url = new moodle_url('/mod/diary/view.php', $options);
        $output .= html_writer::link($url, $this->pix_icon('t/reload', get_string('reload', 'diary')),
            [
                'class' => 'toolbutton',
            ]
        );

        // Print edit entry toolbutton.
        // 20250110 Changed option for firstkey.
        // 20250113 Added option to include promptid.
        $options['action'] = 'editentry';
        $options['firstkey'] = $cm['firstkey'];
        $options['promptid'] = $cm['promptid'];
        $url = new moodle_url('/mod/diary/edit.php', $options);
        $output .= html_writer::link($url, $this->pix_icon('i/edit', get_string('edittopoflist', 'diary')),
            [
                'class' => 'toolbutton',
            ]
        );

        // Print sort to first entry toolbutton.
        // 20250110 Changed option for firstkey.
        $options['action'] = 'sortfirstentry';
        $options['firstkey'] = $cm['firstkey'];
        $url = new moodle_url('/mod/diary/view.php', $options);
        $output .= html_writer::link($url, $this->pix_icon('t/left', get_string('sortfirstentry', 'diary')),
            [
                'class' => 'toolbutton',
            ]
        );

        // Print lowest grade entry toolbutton.
        // 20250110 Changed option for firstkey.
        $options['action'] = 'lowestgradeentry';
        $options['firstkey'] = $cm['firstkey'];
        $url = new moodle_url('/mod/diary/view.php', $options);
        $output .= html_writer::link($url, $this->pix_icon('t/down', get_string('lowestgradeentry', 'diary')),
            [
                'class' => 'toolbutton',
            ]
        );

        // Print highest grade entry toolbutton.
        // 20250110 Changed option for firstkey.
        $options['action'] = 'highestgradeentry';
        $options['firstkey'] = $cm['firstkey'];
        $url = new moodle_url('/mod/diary/view.php', $options);
        $output .= html_writer::link($url, $this->pix_icon('t/up', get_string('highestgradeentry', 'diary')),
            [
                'class' => 'toolbutton',
            ]
        );

        // Print latest modified entry toolbutton.
        // 20250110 Changed option for firstkey.
        $options['action'] = 'latestmodifiedentry';
        $options['firstkey'] = $cm['firstkey'];
        $url = new moodle_url('/mod/diary/view.php', $options);
        $output .= html_writer::link($url, $this->pix_icon('t/right', get_string('latestmodifiedentry', 'diary')),
            [
                'class' => 'toolbutton',
            ]
        );

        $firstkey = '';
        // Return all available toolbuttons.
        return $output;
    }

    /**
     * Returns HTML for a diary inaccessible message.
     * Added 20161002
     *
     * @param string $message
     * @return <type>
     */
    public function diary_inaccessible($message) {
        global $CFG;
        $output = $this->output->box_start('generalbox boxaligncenter');
        $output .= $this->output->box_start('center');
        $output .= (get_string('notavailable', 'diary'));
        $output .= $message;
        $output .= $this->output->box('<a href="'
            .$CFG->wwwroot.'/course/view.php?id='
            .$this->page->course->id.'">'
            .get_string('returnto', 'diary', format_string($this->page->course->fullname, true))
            .'</a>', 'diarybutton standardbutton');
        $output .= $this->output->box_end();
        $output .= $this->output->box_end();
        return $output;
    }
}