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

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

use moodle_url, part_of_admin_tree, admin_settingpage;

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


/**
 * Class for HTML editors
 */
class editor extends base {
    /**
     * Finds all enabled plugins, the result may include missing plugins.
     * @return array|null of enabled plugins $pluginname=>$pluginname, null means unknown
     */
    public static function get_enabled_plugins() {
        global $CFG;

        if (empty($CFG->texteditors)) {
            return array('atto'=>'atto', 'tinymce'=>'tinymce', 'textarea'=>'textarea');
        }

        $enabled = array();
        foreach (explode(',', $CFG->texteditors) as $editor) {
            $enabled[$editor] = $editor;
        }

        return $enabled;
    }

> public static function enable_plugin(string $pluginname, int $enabled): bool { public function get_settings_section_name() { > global $CFG; return 'editorsettings' . $this->name; > } > $haschanged = false; > if (!empty($CFG->texteditors)) { public function load_settings(part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) { > $plugins = array_flip(explode(',', $CFG->texteditors)); global $CFG, $USER, $DB, $OUTPUT, $PAGE; // In case settings.php wants to refer to them. > } else { $ADMIN = $adminroot; // May be used in settings.php. > $plugins = []; $plugininfo = $this; // Also can be used inside settings.php. > } $editor = $this; // Also can be used inside settings.php. > > // Only set visibility if it's different from the current value. if (!$this->is_installed_and_upgraded()) { > if ($enabled && !array_key_exists($pluginname, $plugins)) { return; > $plugins[$pluginname] = $pluginname; } > $haschanged = true; > } else if (!$enabled && array_key_exists($pluginname, $plugins)) { if (!$hassiteconfig or !file_exists($this->full_path('settings.php'))) { > unset($plugins[$pluginname]); return; > $haschanged = true; } > } > $section = $this->get_settings_section_name(); > // At least one editor must be active. > if (empty($plugins)) { $settings = new admin_settingpage($section, $this->displayname, 'moodle/site:config', $this->is_enabled() === false); > $plugins['textarea'] = 'textarea'; include($this->full_path('settings.php')); // This may also set $settings to null. > $haschanged = true; > } if ($settings) { > $ADMIN->add($parentnodename, $settings); > if ($haschanged) { } > $new = implode(',', array_flip($plugins)); } > add_to_config_log('editor_visibility', !$enabled, $enabled, $pluginname); > set_config('texteditors', $new); /** > // Reset caches. * Basic textarea editor can not be uninstalled. > \core_plugin_manager::reset_caches(); */ > } public function is_uninstall_allowed() { > if ($this->name === 'textarea') { > return $haschanged; return false; > } } else { >
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'=>'manageeditors')); } }