Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.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/>.

/**
 * Defines classes used for plugin info.
 *
 * @package    core
 * @copyright  2018 Toni Barbera {@link http://www.moodle.org}
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
namespace core\plugininfo;

< use moodle_url;
use admin_settingpage;
< < defined('MOODLE_INTERNAL') || die();
> use moodle_url;
/** * Class for admin tool plugins * * @package core * @copyright 2018 Toni Barbera {@link http://www.moodle.org} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class customfield extends base {
> public static function plugintype_supports_disabling(): bool { /** > return true; * Allow uninstall > } * @return bool >
*/ public function is_uninstall_allowed() { return true; } /** * Return URL used for management of plugins of this type. * @return moodle_url */ public static function get_manage_url() { return new moodle_url('/admin/settings.php', array('section' => 'managecustomfields')); } /** * Enabled plugins * @return array|null */ public static function get_enabled_plugins() { global $DB; // Get all available plugins. $plugins = \core_plugin_manager::instance()->get_installed_plugins('customfield'); 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('customfield_' . $plugin, 'disabled'); if (empty($disabled)) { $enabled[$plugin] = $plugin; } } return $enabled; }
> public static function enable_plugin(string $pluginname, int $enabled): bool { /** > $haschanged = false; * Pre-uninstall hook. > * > $plugin = 'customfield_' . $pluginname; * This is intended for disabling of plugin, some DB table purging, etc. > $oldvalue = get_config($plugin, 'disabled'); * > $disabled = !$enabled; * NOTE: to be called from uninstall_plugin() only. > // Only set value if there is no config setting or if the value is different from the previous one. */ > if ($oldvalue == false && $disabled) { public function uninstall_cleanup() { > set_config('disabled', $disabled, $plugin); global $DB; > $haschanged = true; $DB->delete_records_select('customfield_data', > } else if ($oldvalue != false && !$disabled) { 'fieldid IN (SELECT f.id FROM {customfield_field} f WHERE f.type = ?)', [$this->name]); > unset_config('disabled', $plugin); $DB->delete_records('customfield_field', ['type' => $this->name]); > $haschanged = true; parent::uninstall_cleanup(); > } } > > if ($haschanged) { /** > add_to_config_log('disabled', $oldvalue, $disabled, $plugin); * Setting section name > \core_plugin_manager::reset_caches(); * > } * @return null|string > */ > return $haschanged; public function get_settings_section_name() { > } return 'customfieldsetting' . $this->name; >
} /** * Load the global settings for a particular availability plugin (if there are any) * * @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.
> /** @var \admin_root $ADMIN */
$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 or !file_exists($this->full_path('settings.php'))) { return; } $section = $this->get_settings_section_name(); $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); } } }