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

/**
 * Class for availability plugins.
 *
 * @package core
 * @copyright 2014 The Open University
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
namespace core\plugininfo;

use admin_settingpage;

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

/**
 * Class for availability plugins.
 *
 * @package core
 * @copyright 2014 The Open University
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class availability extends base {
    public static function get_enabled_plugins() {
        global $DB;

        // Get all available plugins.
        $plugins = \core_plugin_manager::instance()->get_installed_plugins('availability');
        if (!$plugins) {
            return array();
        }

        // Check they are enabled using get_config (which is cached and hopefully fast).
        $enabled = array();
        foreach ($plugins as $plugin => $version) {
            $disabled = get_config('availability_' . $plugin, 'disabled');
            if (empty($disabled)) {
                $enabled[$plugin] = $plugin;
            }
        }

        return $enabled;
    }

> public static function enable_plugin(string $pluginname, int $enabled): bool { /** > $haschanged = false; * Defines if there should be a way to uninstall the plugin via the administration UI. > * > $plugin = 'availability_' . $pluginname; * @return bool > $oldvalue = get_config($plugin, 'disabled'); */ > $disabled = !$enabled; public function is_uninstall_allowed() { > // Only set value if there is no config setting or if the value is different from the previous one. return true; > if ($oldvalue == false && $disabled) { } > set_config('disabled', $disabled, $plugin); > $haschanged = true; /** > } else if ($oldvalue != false && !$disabled) { * Get the name for the settings section. > unset_config('disabled', $plugin); * > $haschanged = true; * @return string > } */ > public function get_settings_section_name() { > if ($haschanged) { return 'availabilitysetting' . $this->name; > add_to_config_log('disabled', $oldvalue, $disabled, $plugin); } > \core_plugin_manager::reset_caches(); > } /** > * Load the global settings for a particular availability plugin (if there are any) > return $haschanged; * > } * @param \part_of_admin_tree $adminroot >
* @param string $parentnodename * @param bool $hassiteconfig */ public function load_settings(\part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) { global $CFG, $USER, $DB, $OUTPUT, $PAGE; // In case settings.php wants to refer to them. $ADMIN = $adminroot; // May be used in settings.php. $plugininfo = $this; // Also can be used inside settings.php $availability = $this; // Also to be used inside settings.php. if (!$this->is_installed_and_upgraded()) { return; } if (!$hassiteconfig) { return; } $section = $this->get_settings_section_name(); $settings = null; if (file_exists($this->full_path('settings.php'))) { $settings = new admin_settingpage($section, $this->displayname, 'moodle/site:config', $this->is_enabled() === false); include($this->full_path('settings.php')); // This may also set $settings to null. } if ($settings) { $ADMIN->add($parentnodename, $settings); } } }