Select Git revision
-
Thomas Marstrander authoredThomas Marstrander authored
core_renderer.php 20.54 KiB
<?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/>.
/**
* Renderers to align Moodle's HTML with that expected by Bootstrap
*
* @package theme_boost_campus
* @copyright 2017 Kathrin Osswald, Ulm University kathrin.osswald@uni-ulm.de
* copyright based on code from theme_boost by Bas Brands
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace theme_boost_campus\output;
use coding_exception;
use html_writer;
use tabobject;
use tabtree;
use custom_menu_item;
use custom_menu;
use block_contents;
use navigation_node;
use action_link;
use stdClass;
use moodle_url;
use preferences_groups;
use action_menu;
use help_icon;
use single_button;
use single_select;
use paging_bar;
use url_select;
use context_course;
use pix_icon;
defined('MOODLE_INTERNAL') || die;
/**
* Extending the core_renderer interface.
*
* @copyright 2017 Kathrin Osswald, Ulm University kathrin.osswald@uni-ulm.de
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @package theme_boost_campus
* @category output
*/
class core_renderer extends \core_renderer {
/**
* Override to display an edit button again by calling the parent function
* in core/core_renderer because theme_boost's function returns an empty
* string and therefore displays nothing.
*
* MODIFICATION: This renderer function is copied and modified from /theme/boost/classes/output/core_renderer.php
*
* @param moodle_url $url The current course url.
* @return \core_renderer::edit_button Moodle edit button. */
public function edit_button(moodle_url $url) {
// MODIFICATION START.
// If setting editbuttonincourseheader ist checked give out the edit on / off button in course header.
if (get_config('theme_boost_campus', 'courseeditbutton') == '1') {
return \core_renderer::edit_button($url);
}
// MODIFICATION END.
/* ORIGINAL START.
return '';
ORIGINAL END. */
}
/**
* Override to add additional class for the random login image to the body.
*
* Returns HTML attributes to use within the body tag. This includes an ID and classes.
*
* KIZ MODIFICATION: This renderer function is copied and modified from /lib/outputrenderers.php
*
* @since Moodle 2.5.1 2.6
* @param string|array $additionalclasses Any additional classes to give the body tag,
* @return string
*/
public function body_attributes($additionalclasses = array()) {
global $PAGE, $CFG;
require_once($CFG->dirroot . '/theme/boost_campus/locallib.php');
if (!is_array($additionalclasses)) {
$additionalclasses = explode(' ', $additionalclasses);
}
// MODIFICATION START.
// Only add classes for the login page.
if ($PAGE->bodyid == 'page-login-index') {
$additionalclasses[] = 'loginbackgroundimage';
// Generating a random class for displaying a random image for the login page.
$additionalclasses[] = theme_boost_campus_get_random_loginbackgroundimage_class();
}
// MODIFICATION END.
return ' id="'. $this->body_id().'" class="'.$this->body_css_classes($additionalclasses).'"';
}
/**
* Override to be able to use uploaded images from admin_setting as well.
*
* Returns the URL for the favicon.
*
* KIZ MODIFICATION: This renderer function is copied and modified from /lib/outputrenderers.php
*
* @since Moodle 2.5.1 2.6
* @return string The favicon URL
*/
public function favicon() {
global $PAGE;
// MODIFICATION START.
if (!empty($PAGE->theme->settings->favicon)) {
return $PAGE->theme->setting_file_url('favicon', 'favicon');
} else {
return $this->image_url('favicon', 'theme');
}
// MODIFICATION END.
/* ORIGINAL START.
return $this->image_url('favicon', 'theme');
ORIGINAL END. */
}
/** * Override to display switched role information beneath the course header instead of the user menu.
* We change this because the switch role function is course related and therefore it should be placed in the course context.
*
* MODIFICATION: This renderer function is copied and modified from /lib/outputrenderers.php
*
* Wrapper for header elements.
*
* @return string HTML to display the main header.
*/
public function full_header() {
// MODIFICATION START.
global $PAGE, $USER, $COURSE, $CFG;
// MODIFICATION END.
$header = new stdClass();
// MODIFICATION START.
// Show the context header settings menu on all pages except for the profile page as we replace
// it with an edit button there.
if ($PAGE->pagelayout != 'mypublic') {
$header->settingsmenu = $this->context_header_settings_menu();
}
// MODIFICATION END.
/* ORIGINAL START
$header->settingsmenu = $this->context_header_settings_menu();
ORIGINAL END. */
$header->contextheader = $this->context_header();
$header->hasnavbar = empty($PAGE->layout_options['nonavbar']);
$header->navbar = $this->navbar();
// MODIFICATION START.
// Show the page heading button on all pages except for the profile page.
// There we replace it with an edit profile button.
if ($PAGE->pagelayout != 'mypublic') {
$header->pageheadingbutton = $this->page_heading_button();
} else {
// Get the id of the user for whom the profile page is shown.
$userid = optional_param('id', $USER->id, PARAM_INT);
// Check if the shown and the operating user are identical.
$currentuser = $USER->id == $userid;
if (($currentuser || is_siteadmin($USER)) &&
has_capability('moodle/user:update', \context_system::instance())) {
$url = new moodle_url('/user/editadvanced.php', array('id' => $userid, 'course' => $COURSE->id,
'returnto' => 'profile'));
$header->pageheadingbutton = $this->single_button($url, get_string('editmyprofile', 'core'));
} else if ((has_capability('moodle/user:editprofile', \context_user::instance($userid)) &&
!is_siteadmin($USER)) || ($currentuser &&
has_capability('moodle/user:editownprofile', \context_system::instance()))) {
$url = new moodle_url('/user/edit.php', array('id' => $userid, 'course' => $COURSE->id,
'returnto' => 'profile'));
$header->pageheadingbutton = $this->single_button($url, get_string('editmyprofile', 'core'));
}
}
// MODIFICATION END.
/* ORIGINAL START
$header->pageheadingbutton = $this->page_heading_button();
ORIGINAL END. */
$header->courseheader = $this->course_header();
// MODIFICATION START:
// Change this to add the result in the html variable to be able to add further features below the header.
// Render from the own header template.
$html = $this->render_from_template('theme_boost_campus/full_header', $header);
// MODIFICATION END.
/* ORIGINAL START
return $this->render_from_template('core/full_header', $header);
ORIGINAL END. */
// MODIFICATION START:
// If the setting showhintcoursehidden is set, the visibility of the course is hidden and
// a hint for the visibility will be shown.
if (get_config('theme_boost_campus', 'showhintcoursehidden') == 'yes' && $COURSE->visible == false &&
$PAGE->has_set_url() && $PAGE->url->compare(new moodle_url('/course/view.php'), URL_MATCH_BASE)) { $html .= html_writer::start_tag('div', array('class' => 'course-hidden-infobox alert alert-warning'));
$html .= html_writer::tag('i', null, array('class' => 'fa fa-exclamation-circle fa-3x fa-pull-left'));
$html .= get_string('showhintcoursehiddengeneral', 'theme_boost_campus', $COURSE->id);
// If the user has the capability to change the course settings, an additional link to the course settings is shown.
if (has_capability('moodle/course:update', context_course::instance($COURSE->id))) {
$html .= html_writer::tag('div', get_string('showhintcoursehiddensettingslink',
'theme_boost_campus', array('url' => $CFG->wwwroot.'/course/edit.php?id='. $COURSE->id)));
}
$html .= html_writer::end_tag('div');
}
// MODIFICATION END.
// MODIFICATION START:
// If the setting showhintcourseguestaccess is set, a hint for users that view the course with guest access is shown.
// We also check that the user did not switch the role. This is a special case for roles that can fully access the course
// without being enrolled. A role switch would show the guest access hint additionally in that case and this is not
// intended.
if (get_config('theme_boost_campus', 'showhintcourseguestaccess') == 'yes'
&& is_guest(\context_course::instance($COURSE->id), $USER->id)
&& $PAGE->has_set_url()
&& $PAGE->url->compare(new moodle_url('/course/view.php'), URL_MATCH_BASE)
&& !is_role_switched($COURSE->id)) {
$html .= html_writer::start_tag('div', array('class' => 'course-guestaccess-infobox alert alert-warning'));
$html .= html_writer::tag('i', null, array('class' => 'fa fa-exclamation-circle fa-3x fa-pull-left'));
$html .= get_string('showhintcourseguestaccessgeneral', 'theme_boost_campus',
array('role' => role_get_name(get_guest_role())));
$html .= theme_boost_campus_get_course_guest_access_hint($COURSE->id);
$html .= html_writer::end_tag('div');
}
// MODIFICATION END.
// MODIFICATION START.
// Only use this if setting 'showswitchedroleincourse' is active.
if (get_config('theme_boost_campus', 'showswitchedroleincourse') === 'yes') {
// Check if the user did a role switch.
// If not, adding this section would make no sense and, even worse,
// user_get_user_navigation_info() will throw an exception due to the missing user object.
if (is_role_switched($COURSE->id)) {
// Get the role name switched to.
$opts = \user_get_user_navigation_info($USER, $this->page);
$role = $opts->metadata['rolename'];
// Get the URL to switch back (normal role).
$url = new moodle_url('/course/switchrole.php',
array('id' => $COURSE->id, 'sesskey' => sesskey(), 'switchrole' => 0,
'returnurl' => $this->page->url->out_as_local_url(false)));
$html .= html_writer::start_tag('div', array('class' => 'switched-role-infobox alert alert-info'));
$html .= html_writer::tag('i', null, array('class' => 'fa fa-user-circle fa-3x fa-pull-left'));
$html .= html_writer::start_tag('div');
$html .= get_string('switchedroleto', 'theme_boost_campus');
// Give this a span to be able to address via CSS.
$html .= html_writer::tag('span', $role, array('class' => 'switched-role'));
$html .= html_writer::end_tag('div');
// Return to normal role link.
$html .= html_writer::start_tag('div');
$html .= html_writer::tag('a', get_string('switchrolereturn', 'core'),
array('class' => 'switched-role-backlink', 'href' => $url));
$html .= html_writer::end_tag('div'); // Return to normal role link: end div.
$html .= html_writer::end_tag('div');
}
}
// MODIFICATION END.
return $html;
}
/**
* Override to display course settings on every course site for permanent access
*
* This is an optional menu that can be added to a layout by a theme. It contains the
* menu for the course administration, only on the course main page. *
* MODIFICATION: This renderer function is copied and modified from /lib/outputrenderers.php.
*
* @return string
*/
public function context_header_settings_menu() {
$context = $this->page->context;
$menu = new action_menu();
$items = $this->page->navbar->get_items();
$currentnode = end($items);
$showcoursemenu = false;
$showfrontpagemenu = false;
$showusermenu = false;
// MODIFICATION START.
// REASON: With the original code, the course settings icon will only appear on the course main page.
// Therefore the access to the course settings and related functions is not possible on other
// course pages as there is no omnipresent block anymore. We want these to be accessible
// on each course page.
if (($context->contextlevel == CONTEXT_COURSE || $context->contextlevel == CONTEXT_MODULE) && !empty($currentnode)) {
$showcoursemenu = true;
}
// MODIFICATION END.
// @codingStandardsIgnoreStart
/* ORIGINAL START.
if (($context->contextlevel == CONTEXT_COURSE) &&
!empty($currentnode) &&
($currentnode->type == navigation_node::TYPE_COURSE || $currentnode->type == navigation_node::TYPE_SECTION)) {
$showcoursemenu = true;
}
ORIGINAL END. */
// @codingStandardsIgnoreEnd
$courseformat = course_get_format($this->page->course);
// This is a single activity course format, always show the course menu on the activity main page.
if ($context->contextlevel == CONTEXT_MODULE &&
!$courseformat->has_view_page()) {
$this->page->navigation->initialise();
$activenode = $this->page->navigation->find_active_node();
// If the settings menu has been forced then show the menu.
if ($this->page->is_settings_menu_forced()) {
$showcoursemenu = true;
} else if (!empty($activenode) && ($activenode->type == navigation_node::TYPE_ACTIVITY ||
$activenode->type == navigation_node::TYPE_RESOURCE)) {
// We only want to show the menu on the first page of the activity. This means
// the breadcrumb has no additional nodes.
if ($currentnode && ($currentnode->key == $activenode->key && $currentnode->type == $activenode->type)) {
$showcoursemenu = true;
}
}
}
// This is the site front page.
if ($context->contextlevel == CONTEXT_COURSE &&
!empty($currentnode) &&
$currentnode->key === 'home') {
$showfrontpagemenu = true;
}
// This is the user profile page.
if ($context->contextlevel == CONTEXT_USER &&
!empty($currentnode) &&
($currentnode->key === 'myprofile')) {
$showusermenu = true;
}
if ($showfrontpagemenu) {
$settingsnode = $this->page->settingsnav->find('frontpage', navigation_node::TYPE_SETTING);
if ($settingsnode) {
// Build an action menu based on the visible nodes from this navigation tree.
$skipped = $this->build_action_menu_from_navigation($menu, $settingsnode, false, true);
// We only add a list to the full settings menu if we didn't include every node in the short menu.
if ($skipped) {
$text = get_string('morenavigationlinks');
$url = new moodle_url('/course/admin.php', array('courseid' => $this->page->course->id));
$link = new action_link($url, $text, null, null, new pix_icon('t/edit', $text));
$menu->add_secondary_action($link);
}
}
} else if ($showcoursemenu) {
$settingsnode = $this->page->settingsnav->find('courseadmin', navigation_node::TYPE_COURSE);
if ($settingsnode) {
// Build an action menu based on the visible nodes from this navigation tree.
$skipped = $this->build_action_menu_from_navigation($menu, $settingsnode, false, true);
// We only add a list to the full settings menu if we didn't include every node in the short menu.
if ($skipped) {
$text = get_string('morenavigationlinks');
$url = new moodle_url('/course/admin.php', array('courseid' => $this->page->course->id));
$link = new action_link($url, $text, null, null, new pix_icon('t/edit', $text));
$menu->add_secondary_action($link);
}
}
} else if ($showusermenu) {
// Get the course admin node from the settings navigation.
$settingsnode = $this->page->settingsnav->find('useraccount', navigation_node::TYPE_CONTAINER);
if ($settingsnode) {
// Build an action menu based on the visible nodes from this navigation tree.
$this->build_action_menu_from_navigation($menu, $settingsnode);
}
}
return $this->render($menu);
}
/**
* Override to use theme_boost_campus login template
* Renders the login form.
*
* MODIFICATION: This renderer function is copied and modified from /theme/boost/classes/output/core_renderer.php
*
* @param \core_auth\output\login $form The renderable.
* @return string
*/
public function render_login(\core_auth\output\login $form) {
global $CFG, $SITE;
$context = $form->export_for_template($this);
// Override because rendering is not supported in template yet.
if ($CFG->rememberusername == 0) {
$context->cookieshelpiconformatted = $this->help_icon('cookiesenabledonlysession');
} else {
$context->cookieshelpiconformatted = $this->help_icon('cookiesenabled');
}
$context->errorformatted = $this->error_text($context->error);
$url = $this->get_logo_url();
if ($url) {
$url = $url->out(false);
}
$context->logourl = $url;
$context->sitename = format_string($SITE->fullname, true,
['context' => context_course::instance(SITEID), "escape" => false]);
// MODIFICATION START.
// Only if setting "loginform" is checked, then call own login.mustache. if (get_config('theme_boost_campus', 'loginform') == 'yes') {
return $this->render_from_template('theme_boost_campus/loginform', $context);
} else {
return $this->render_from_template('core/loginform', $context);
}
// MODIFICATION END.
/* ORIGINAL START.
return $this->render_from_template('core/loginform', $context);
ORIGINAL END. */
}
/**
* Implementation of user image rendering.
*
* MODIFICATION: This renderer function is copied and modified from /theme/boost/classes/output/core_renderer.php
*
* @param help_icon $helpicon A help icon instance
* @return string HTML fragment
*/
protected function render_help_icon(help_icon $helpicon) {
$context = $helpicon->export_for_template($this);
// MODIFICATION START.
// ID needed for modal dialog.
$context->linkid = $helpicon->component.'-'.$helpicon->identifier;
// Fill body variable needed for modal mustache with text value.
$context->body = $context->text;
if (get_config('theme_boost_campus', 'helptextmodal') == 'yes') {
return $this->render_from_template('theme_boost_campus/help_icon', $context);
} else {
return $this->render_from_template('core/help_icon', $context);
}
// MODIFICATION END.
}
}