Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is 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/>.

/**
 * Admin Bookmarks Block page.
 *
 * @package    block_admin_bookmarks
 * @copyright  2011 Moodle
 * @author     2006 vinkmar
 *             2011 Rossiani Wijaya (updated)
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

/**
 * The admin bookmarks block class
 */
class block_admin_bookmarks extends block_base {

    /** @var string */
    public $blockname = null;

< /** @var bool */ < protected $contentgenerated = false;
/** @var bool|null */ protected $docked = null; /** * Set the initial properties for the block */ function init() { $this->blockname = get_class($this); $this->title = get_string('pluginname', $this->blockname); } /** * All multiple instances of this block * @return bool Returns false */ function instance_allow_multiple() { return false; } /** * Set the applicable formats for this block to all * @return array */ function applicable_formats() { if (has_capability('moodle/site:config', context_system::instance())) { return array('all' => true); } else { return array('site' => true); } } /** * Gets the content for this block */ function get_content() { global $CFG; // First check if we have already generated, don't waste cycles
< if ($this->contentgenerated === true) {
> if ($this->content !== null) {
return $this->content; }
>
$this->content = new stdClass(); if (get_user_preferences('admin_bookmarks')) { require_once($CFG->libdir.'/adminlib.php'); $adminroot = admin_get_root(false, false); // settings not required - only pages $bookmarks = explode(',', get_user_preferences('admin_bookmarks')); /// Accessibility: markup as a list. $contents = array(); foreach($bookmarks as $bookmark) { $temp = $adminroot->locate($bookmark); if ($temp instanceof admin_settingpage) { $contenturl = new moodle_url('/admin/settings.php', array('section'=>$bookmark)); $contentlink = html_writer::link($contenturl, $temp->visiblename); $contents[] = html_writer::tag('li', $contentlink); } else if ($temp instanceof admin_externalpage) { $contenturl = new moodle_url($temp->url); $contentlink = html_writer::link($contenturl, $temp->visiblename); $contents[] = html_writer::tag('li', $contentlink); } else if ($temp instanceof admin_category) { $contenturl = new moodle_url('/admin/category.php', array('category' => $bookmark)); $contentlink = html_writer::link($contenturl, $temp->visiblename); $contents[] = html_writer::tag('li', $contentlink); } } $this->content->text = html_writer::tag('ol', implode('', $contents), array('class' => 'list')); } else { $bookmarks = array(); } $this->content->footer = ''; $this->page->settingsnav->initialise(); $node = $this->page->settingsnav->get('root', navigation_node::TYPE_SITE_ADMIN); if (!$node || !$node->contains_active_node()) { return $this->content; } $section = $node->find_active_node()->key; if ($section == 'search' || empty($section)){ // the search page can't be properly bookmarked at present $this->content->footer = ''; } else if (in_array($section, $bookmarks)) { $deleteurl = new moodle_url('/blocks/admin_bookmarks/delete.php', array('section'=>$section, 'sesskey'=>sesskey())); $this->content->footer = html_writer::link($deleteurl, get_string('unbookmarkthispage','admin')); } else { $createurl = new moodle_url('/blocks/admin_bookmarks/create.php', array('section'=>$section, 'sesskey'=>sesskey())); $this->content->footer = html_writer::link($createurl, get_string('bookmarkthispage','admin')); } return $this->content; } /** * Returns the role that best describes the admin bookmarks block. * * @return string */ public function get_aria_role() { return 'navigation'; } }