Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
  • Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 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.
/admin/ -> category.php (source)
<?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 is used to display a categories sub categories, external pages, and settings.
 *
 * @since      Moodle 2.3
 * @package    admin
 * @copyright  2011 Sam Hemelryk
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

require_once('../config.php');
require_once($CFG->libdir.'/adminlib.php');

$category = required_param('category', PARAM_SAFEDIR);
$return = optional_param('return','', PARAM_ALPHA);
$adminediting = optional_param('adminedit', -1, PARAM_BOOL);

require_login(0, false);
$PAGE->set_context(context_system::instance());
$PAGE->set_url('/admin/category.php', array('category' => $category));
$PAGE->set_pagetype('admin-setting-' . $category);
$PAGE->set_pagelayout('admin');
$PAGE->navigation->clear_cache();

$adminroot = admin_get_root(); // need all settings
$settingspage = $adminroot->locate($category, true);

if (empty($settingspage) or !($settingspage instanceof admin_category)) {
< print_error('categoryerror', 'admin', "$CFG->wwwroot/$CFG->admin/");
> throw new \moodle_exception('categoryerror', 'error', "$CFG->wwwroot/$CFG->admin/");
} if (!($settingspage->check_access())) {
< print_error('accessdenied', 'admin');
> throw new \moodle_exception('accessdenied', 'admin');
}
> $hassiteconfig = has_capability('moodle/site:config', $PAGE->context); > if ($hassiteconfig) { $statusmsg = ''; > $PAGE->add_header_action($OUTPUT->render_from_template('core_admin/header_search_input', [ $errormsg = ''; > 'action' => new moodle_url('/admin/search.php'), > ])); if ($data = data_submitted() and confirm_sesskey()) { > }
$count = admin_write_settings($data); if (empty($adminroot->errors)) { // No errors. Did we change any setting? If so, then indicate success. if ($count) { $statusmsg = get_string('changessaved'); } else { switch ($return) { case 'site': redirect("$CFG->wwwroot/"); case 'admin': redirect("$CFG->wwwroot/$CFG->admin/"); } } } else { $errormsg = get_string('errorwithsettings', 'admin'); $firsterror = reset($adminroot->errors); } $settingspage = $adminroot->locate($category, true); } if ($PAGE->user_allowed_editing() && $adminediting != -1) { $USER->editing = $adminediting; } $buttons = null;
< if ($PAGE->user_allowed_editing()) {
> if ($PAGE->user_allowed_editing() && !$PAGE->theme->haseditswitch) {
$url = clone($PAGE->url); if ($PAGE->user_is_editing()) { $caption = get_string('blockseditoff'); $url->param('adminedit', 'off'); } else { $caption = get_string('blocksediton'); $url->param('adminedit', 'on'); } $buttons = $OUTPUT->single_button($url, $caption, 'get'); } $savebutton = false; $outputhtml = ''; foreach ($settingspage->children as $childpage) { if ($childpage->is_hidden() || !$childpage->check_access()) { continue; } if ($childpage instanceof admin_externalpage) { $outputhtml .= $OUTPUT->heading(html_writer::link($childpage->url, $childpage->visiblename), 3); } else if ($childpage instanceof admin_settingpage) { $outputhtml .= $OUTPUT->heading(html_writer::link(new moodle_url('/'.$CFG->admin.'/settings.php', array('section' => $childpage->name)), $childpage->visiblename), 3); // If its a settings page and has settings lets display them. if (!empty($childpage->settings)) { $outputhtml .= html_writer::start_tag('fieldset', array('class' => 'adminsettings')); foreach ($childpage->settings as $setting) { if (empty($setting->nosave)) { $savebutton = true; } $fullname = $setting->get_full_name(); if (array_key_exists($fullname, $adminroot->errors)) { $data = $adminroot->errors[$fullname]->data; } else { $data = $setting->get_setting(); } $outputhtml .= html_writer::tag('div', '<!-- -->', array('class' => 'clearer')); $outputhtml .= $setting->output_html($data); } $outputhtml .= html_writer::end_tag('fieldset'); } } else if ($childpage instanceof admin_category) { $outputhtml .= $OUTPUT->heading(html_writer::link(new moodle_url('/'.$CFG->admin.'/category.php', array('category' => $childpage->name)), get_string('admincategory', 'admin', $childpage->visiblename)), 3); } } if ($savebutton) { $outputhtml .= html_writer::start_tag('div', array('class' => 'form-buttons')); $outputhtml .= html_writer::empty_tag('input', array('class' => 'btn btn-primary form-submit', 'type' => 'submit', 'value' => get_string('savechanges','admin'))); $outputhtml .= html_writer::end_tag('div'); }
< $visiblepathtosection = array_reverse($settingspage->visiblepath); < $PAGE->set_title("$SITE->shortname: " . implode(": ",$visiblepathtosection));
> $PAGE->set_title(implode(moodle_page::TITLE_SEPARATOR, $settingspage->visiblepath));
$PAGE->set_heading($SITE->fullname); if ($buttons) { $PAGE->set_button($buttons); } echo $OUTPUT->header(); if ($errormsg !== '') { echo $OUTPUT->notification($errormsg); } else if ($statusmsg !== '') { echo $OUTPUT->notification($statusmsg, 'notifysuccess'); }
< $path = array_reverse($settingspage->visiblepath); < if (is_array($path)) { < $visiblename = join(' / ', $path); < } else { < $visiblename = $path; < } < echo $OUTPUT->heading(get_string('admincategory', 'admin', $visiblename), 2);
> echo $OUTPUT->heading(get_string('admincategory', 'admin', $settingspage->visiblename), 2);
echo html_writer::start_tag('form', array('action' => '', 'method' => 'post', 'id' => 'adminsettings')); echo html_writer::start_tag('div'); echo html_writer::input_hidden_params(new moodle_url($PAGE->url, array('sesskey' => sesskey(), 'return' => $return))); echo html_writer::end_tag('div'); echo html_writer::start_tag('fieldset'); echo html_writer::tag('div', '<!-- -->', array('class' => 'clearer')); echo $outputhtml; echo html_writer::end_tag('fieldset'); echo html_writer::end_tag('form');
> > // Add the form change checker. echo $OUTPUT->footer(); > $PAGE->requires->js_call_amd('core_form/changechecker', 'watchFormById', ['adminsettings']);