Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
<?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/>.

namespace theme_boost\output;

use moodle_url;
> use html_writer; > use get_string;
defined('MOODLE_INTERNAL') || die; /** * Renderers to align Moodle's HTML with that expected by Bootstrap * * @package theme_boost * @copyright 2012 Bas Brands, www.basbrands.nl * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class core_renderer extends \core_renderer {
< public function edit_button(moodle_url $url) {
> /** > * Returns HTML to display a "Turn editing on/off" button in a form. > * > * @param moodle_url $url The URL + params to send through when clicking the button > * @param string $method > * @return string HTML the button > */ > public function edit_button(moodle_url $url, string $method = 'post') { > if ($this->page->theme->haseditswitch) { > return; > }
$url->param('sesskey', sesskey()); if ($this->page->user_is_editing()) { $url->param('edit', 'off'); $editstring = get_string('turneditingoff'); } else { $url->param('edit', 'on'); $editstring = get_string('turneditingon'); }
< $button = new \single_button($url, $editstring, 'post', ['class' => 'btn btn-primary']);
> $button = new \single_button($url, $editstring, $method, \single_button::BUTTON_PRIMARY);
return $this->render_single_button($button); }
> /** } > * Renders the "breadcrumb" for all pages in boost. > * > * @return string the HTML for the navbar. > */ > public function navbar(): string { > $newnav = new \theme_boost\boostnavbar($this->page); > return $this->render_from_template('core/navbar', $newnav); > } > > /** > * Renders the context header for the page. > * > * @param array $headerinfo Heading information. > * @param int $headinglevel What 'h' level to make the heading. > * @return string A rendered context header. > */ > public function context_header($headerinfo = null, $headinglevel = 1): string { > global $DB, $USER, $CFG; > require_once($CFG->dirroot . '/user/lib.php'); > $context = $this->page->context; > $heading = null; > $imagedata = null; > $userbuttons = null; > > // Make sure to use the heading if it has been set. > if (isset($headerinfo['heading'])) { > $heading = $headerinfo['heading']; > } else { > $heading = $this->page->heading; > } > > // The user context currently has images and buttons. Other contexts may follow. > if ((isset($headerinfo['user']) || $context->contextlevel == CONTEXT_USER) && $this->page->pagetype !== 'my-index') { > if (isset($headerinfo['user'])) { > $user = $headerinfo['user']; > } else { > // Look up the user information if it is not supplied. > $user = $DB->get_record('user', array('id' => $context->instanceid)); > } > > // If the user context is set, then use that for capability checks. > if (isset($headerinfo['usercontext'])) { > $context = $headerinfo['usercontext']; > } > > // Only provide user information if the user is the current user, or a user which the current user can view. > // When checking user_can_view_profile(), either: > // If the page context is course, check the course context (from the page object) or; > // If page context is NOT course, then check across all courses. > $course = ($this->page->context->contextlevel == CONTEXT_COURSE) ? $this->page->course : null; > > if (user_can_view_profile($user, $course)) { > // Use the user's full name if the heading isn't set. > if (empty($heading)) { > $heading = fullname($user); > } > > $imagedata = $this->user_picture($user, array('size' => 100)); > > // Check to see if we should be displaying a message button. > if (!empty($CFG->messaging) && has_capability('moodle/site:sendmessage', $context)) { > $userbuttons = array( > 'messages' => array( > 'buttontype' => 'message', > 'title' => get_string('message', 'message'), > 'url' => new moodle_url('/message/index.php', array('id' => $user->id)), > 'image' => 'message', > 'linkattributes' => \core_message\helper::messageuser_link_params($user->id), > 'page' => $this->page > ) > ); > > if ($USER->id != $user->id) { > $iscontact = \core_message\api::is_contact($USER->id, $user->id); > $contacttitle = $iscontact ? 'removefromyourcontacts' : 'addtoyourcontacts'; > $contacturlaction = $iscontact ? 'removecontact' : 'addcontact'; > $contactimage = $iscontact ? 'removecontact' : 'addcontact'; > $userbuttons['togglecontact'] = array( > 'buttontype' => 'togglecontact', > 'title' => get_string($contacttitle, 'message'), > 'url' => new moodle_url('/message/index.php', array( > 'user1' => $USER->id, > 'user2' => $user->id, > $contacturlaction => $user->id, > 'sesskey' => sesskey()) > ), > 'image' => $contactimage, > 'linkattributes' => \core_message\helper::togglecontact_link_params($user, $iscontact), > 'page' => $this->page > ); > } > > $this->page->requires->string_for_js('changesmadereallygoaway', 'moodle'); > } > } else { > $heading = null; > } > } > > $prefix = null; > if ($context->contextlevel == CONTEXT_MODULE) { > if ($this->page->course->format === 'singleactivity') { > $heading = format_string($this->page->course->fullname, true, ['context' => $context]); > } else { > $heading = $this->page->cm->get_formatted_name(); > $iconurl = $this->page->cm->get_icon_url(); > $iconclass = $iconurl->get_param('filtericon') ? '' : 'nofilter'; > $iconattrs = [ > 'class' => "icon activityicon $iconclass", > 'aria-hidden' => 'true' > ]; > $imagedata = html_writer::img($iconurl->out(false), '', $iconattrs); > $purposeclass = plugin_supports('mod', $this->page->activityname, FEATURE_MOD_PURPOSE); > $purposeclass .= ' activityiconcontainer icon-size-6'; > $purposeclass .= ' modicon_' . $this->page->activityname; > $imagedata = html_writer::tag('div', $imagedata, ['class' => $purposeclass]); > if (!empty($USER->editing)) { > $prefix = get_string('modulename', $this->page->activityname); > } > } > } > > $contextheader = new \context_header($heading, $headinglevel, $imagedata, $userbuttons, $prefix); > return $this->render_context_header($contextheader); > } > > /** > * Renders the header bar. > * > * @param context_header $contextheader Header bar object. > * @return string HTML for the header bar. > */ > protected function render_context_header(\context_header $contextheader) { > > // Generate the heading first and before everything else as we might have to do an early return. > if (!isset($contextheader->heading)) { > $heading = $this->heading($this->page->heading, $contextheader->headinglevel, 'h2'); > } else { > $heading = $this->heading($contextheader->heading, $contextheader->headinglevel, 'h2'); > } > > // All the html stuff goes here. > $html = html_writer::start_div('page-context-header'); > > // Image data. > if (isset($contextheader->imagedata)) { > // Header specific image. > $html .= html_writer::div($contextheader->imagedata, 'page-header-image mr-2'); > } > > // Headings. > if (isset($contextheader->prefix)) { > $prefix = html_writer::div($contextheader->prefix, 'text-muted text-uppercase small line-height-3'); > $heading = $prefix . $heading; > } > $html .= html_writer::tag('div', $heading, array('class' => 'page-header-headings')); > > // Buttons. > if (isset($contextheader->additionalbuttons)) { > $html .= html_writer::start_div('btn-group header-button-group'); > foreach ($contextheader->additionalbuttons as $button) { > if (!isset($button->page)) { > // Include js for messaging. > if ($button['buttontype'] === 'togglecontact') { > \core_message\helper::togglecontact_requirejs(); > } > if ($button['buttontype'] === 'message') { > \core_message\helper::messageuser_requirejs(); > } > $image = $this->pix_icon($button['formattedimage'], $button['title'], 'moodle', array( > 'class' => 'iconsmall', > 'role' => 'presentation' > )); > $image .= html_writer::span($button['title'], 'header-button-title'); > } else { > $image = html_writer::empty_tag('img', array( > 'src' => $button['formattedimage'], > 'role' => 'presentation' > )); > } > $html .= html_writer::link($button['url'], html_writer::tag('span', $image), $button['linkattributes']); > } > $html .= html_writer::end_div(); > } > $html .= html_writer::end_div(); > > return $html; > } > > /** > * See if this is the first view of the current cm in the session if it has fake blocks. > * > * (We track up to 100 cms so as not to overflow the session.) > * This is done for drawer regions containing fake blocks so we can show blocks automatically. > * > * @return boolean true if the page has fakeblocks and this is the first visit. > */ > public function firstview_fakeblocks(): bool { > global $SESSION; > > $firstview = false; > if ($this->page->cm) { > if (!$this->page->blocks->region_has_fakeblocks('side-pre')) { > return false; > } > if (!property_exists($SESSION, 'firstview_fakeblocks')) { > $SESSION->firstview_fakeblocks = []; > } > if (array_key_exists($this->page->cm->id, $SESSION->firstview_fakeblocks)) { > $firstview = false; > } else { > $SESSION->firstview_fakeblocks[$this->page->cm->id] = true; > $firstview = true; > if (count($SESSION->firstview_fakeblocks) > 100) { > array_shift($SESSION->firstview_fakeblocks); > } > } > } > return $firstview; > }