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

/**
 * Settings code for the serlo theme
 *
 * @package   theme_serlo
 * @author    Faisal Kaleem <serlo@adornis.de>
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 * @copyright 2024 Serlo (https://adornis.de)
 */

defined('MOODLE_INTERNAL') || die();

if ($ADMIN->fulltree) {
    // Boost provides a nice setting page which splits settings onto separate tabs. We want to use it here!
    $settings = new theme_boost_admin_settingspage_tabs('themesettingserlo', get_string('configtitle', 'theme_serlo'));

    // Each page is a tab - the first is the "General" tab!
    $page = new admin_settingpage('theme_serlo_general', get_string('generalsettings', 'theme_serlo'));

    // Replicate the preset setting from boost!
    $name = 'theme_serlo/preset';
    $title = get_string('preset', 'theme_serlo');
    $description = get_string('preset_desc', 'theme_serlo');
    $default = 'default.scss';

    // We list files in our own file area to add to the drop down. We will provide our own function to
    // load all the presets from the correct paths!
    $context = context_system::instance();
    $fs = get_file_storage();
    $files = $fs->get_area_files($context->id, 'theme_serlo', 'preset', 0, 'itemid, filepath, filename', false);

    $choices = [];
    foreach ($files as $file) {
        $choices[$file->get_filename()] = $file->get_filename();
    }
    // These are the built in presets from Boost!
    $choices['default.scss'] = 'default.scss';
    $choices['plain.scss'] = 'plain.scss';

    $setting = new admin_setting_configselect($name, $title, $description, $default, $choices);
    $setting->set_updatedcallback('theme_reset_all_caches');
    $page->add($setting);

    // Preset files setting!
    $name = 'theme_serlo/presetfiles';
    $title = get_string('presetfiles', 'theme_serlo');
    $description = get_string('presetfiles_desc', 'theme_serlo');
    $setting = new admin_setting_configstoredfile(
        $name,
        $title,
        $description,
        'preset',
        0,
        ['maxfiles' => 20, 'accepted_types' => ['.scss']]
    );
    $page->add($setting);

    // Variable $brand-color!
    // We use an empty default value because the default colour should come from the preset!
    $name = 'theme_serlo/brandcolor';
    $title = get_string('brandcolor', 'theme_serlo');
    $description = get_string('brandcolor_desc', 'theme_serlo');
    $setting = new admin_setting_configcolourpicker($name, $title, $description, '');
    $setting->set_updatedcallback('theme_reset_all_caches');
    $page->add($setting);

    // Must add the page after definiting all the settings!
    $settings->add($page);

    // Advanced settings.
    $page = new admin_settingpage('theme_serlo_advanced', get_string('advancedsettings', 'theme_serlo'));

    // Raw SCSS to include before the content!
    $setting = new admin_setting_configtextarea(
        'theme_serlo/scsspre',
        get_string('rawscsspre', 'theme_serlo'),
        get_string('rawscsspre_desc', 'theme_serlo'),
        '',
        PARAM_RAW
    );
    $setting->set_updatedcallback('theme_reset_all_caches');
    $page->add($setting);

    // Raw SCSS to include after the content!
    $setting = new admin_setting_configtextarea(
        'theme_serlo/scss',
        get_string('rawscss', 'theme_serlo'),
        get_string('rawscss_desc', 'theme_serlo'),
        '',
        PARAM_RAW
    );
    $setting->set_updatedcallback('theme_reset_all_caches');
    $page->add($setting);

    $settings->add($page);

    // Login page background setting!
    // We use variables for readability!
    $name = 'theme_serlo/loginbackgroundimage';
    $title = get_string('loginbackgroundimage', 'theme_serlo');
    $description = get_string('loginbackgroundimage_desc', 'theme_serlo');
    // This creates the new setting!
    $setting = new admin_setting_configstoredfile($name, $title, $description, 'loginbackgroundimage');
    // This means that theme caches will automatically be cleared when this setting is changed!
    $setting->set_updatedcallback('theme_reset_all_caches');
    // We always have to add the setting to a page for it to have any effect!
    $page->add($setting);
}