Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 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/>.

/**
 * Defines classes used for plugin info.
 *
 * @package    core
 * @copyright  2011 David Mudrak <david@moodle.com>
 * @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();
> use admin_settingpage; > use moodle_url; > use part_of_admin_tree;
/** * Class for activity modules */ class mod extends base {
> /** > public static function plugintype_supports_disabling(): bool { * Finds all enabled plugins, the result may include missing plugins. > return true; * @return array|null of enabled plugins $pluginname=>$pluginname, null means unknown > } */ >
public static function get_enabled_plugins() { global $DB; return $DB->get_records_menu('modules', array('visible'=>1), 'name ASC', 'name, name AS val'); }
> public static function enable_plugin(string $pluginname, int $enabled): bool { /** > global $DB; * Magic method getter, redirects to read only values. > * > if (!$module = $DB->get_record('modules', ['name' => $pluginname])) { * For module plugins we pretend the object has 'visible' property for compatibility > throw new \moodle_exception('moduledoesnotexist', 'error'); * with plugins developed for Moodle version below 2.4 > } * > * @param string $name > $haschanged = false; * @return mixed > */ > // Only set visibility if it's different from the current value. public function __get($name) { > if ($module->visible != $enabled) { if ($name === 'visible') { > if ($enabled && component_callback_exists("mod_{$pluginname}", 'pre_enable_plugin_actions')) { debugging('This is now an instance of plugininfo_mod, please use $module->is_enabled() instead of $module->visible', DEBUG_DEVELOPER); > // This callback may be used to perform actions that must be completed prior to enabling a plugin. return ($this->is_enabled() !== false); > // Example of this may include: } > // - making a configuration change return parent::__get($name); > // - adding an alert } > // - checking a pre-requisite > // public function init_display_name() { > // If the return value is falsy, then the change will be prevented. if (get_string_manager()->string_exists('pluginname', $this->component)) { > if (!component_callback("mod_{$pluginname}", 'pre_enable_plugin_actions')) { $this->displayname = get_string('pluginname', $this->component); > return false; } else { > } $this->displayname = get_string('modulename', $this->component); > } } > // Set module visibility. } > $DB->set_field('modules', 'visible', $enabled, ['id' => $module->id]); > $haschanged = true; public function get_settings_section_name() { > return 'modsetting' . $this->name; > if ($enabled) { } > // Revert the previous saved visible state for the course module. > $DB->set_field('course_modules', 'visible', '1', ['visibleold' => 1, 'module' => $module->id]); 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. > // Increment course.cacherev for courses where we just made something visible. $ADMIN = $adminroot; // May be used in settings.php. > // This will force cache rebuilding on the next request. $plugininfo = $this; // Also can be used inside settings.php. > increment_revision_number('course', 'cacherev', $module = $this; // Also can be used inside settings.php. > "id IN (SELECT DISTINCT course > FROM {course_modules} if (!$this->is_installed_and_upgraded()) { > WHERE visible = 1 AND module = ?)", return; > [$module->id] } > ); > } else { if (!$hassiteconfig or !file_exists($this->full_path('settings.php'))) { > // Remember the visibility status in visibleold and hide. return; > $sql = "UPDATE {course_modules} } > SET visibleold = visible, visible = 0 > WHERE module = ?"; $section = $this->get_settings_section_name(); > $DB->execute($sql, [$module->id]); > // Increment course.cacherev for courses where we just made something invisible. $settings = new admin_settingpage($section, $this->displayname, 'moodle/site:config', $this->is_enabled() === false); > // This will force cache rebuilding on the next request. include($this->full_path('settings.php')); // This may also set $settings to null. > increment_revision_number('course', 'cacherev', > 'id IN (SELECT DISTINCT course if ($settings) { > FROM {course_modules} $ADMIN->add($parentnodename, $settings); > WHERE visibleold = 1 AND module = ?)', } > [$module->id] } > ); > } /** > * Allow all activity modules but Forum to be uninstalled. > // Include this information into config changes table. * > add_to_config_log('mod_visibility', $module->visible, $enabled, $pluginname); * This exception for the Forum has been hard-coded in Moodle since ages, > \core_plugin_manager::reset_caches(); * we may want to re-think it one day. > } */ > public function is_uninstall_allowed() { > return $haschanged; if ($this->name === 'forum') { > } return false; >
} else {
> /** @var \admin_root $ADMIN */
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/modules.php'); } /** * Return warning with number of activities and number of affected courses. * * @return string */ public function get_uninstall_extra_warning() { global $DB; if (!$module = $DB->get_record('modules', array('name'=>$this->name))) { return ''; } if (!$count = $DB->count_records('course_modules', array('module'=>$module->id))) { return ''; } $sql = "SELECT COUNT('x') FROM ( SELECT course FROM {course_modules} WHERE module = :mid GROUP BY course ) c"; $courses = $DB->count_records_sql($sql, array('mid'=>$module->id)); return '<p>'.get_string('uninstallextraconfirmmod', 'core_plugin', array('instances'=>$count, 'courses'=>$courses)).'</p>'; } /** * Pre-uninstall hook. * * This is intended for disabling of plugin, some DB table purging, etc. * * NOTE: to be called from uninstall_plugin() only. * @private */ public function uninstall_cleanup() { global $DB, $CFG; if (!$module = $DB->get_record('modules', array('name' => $this->name))) { parent::uninstall_cleanup(); return; } // Delete all the relevant instances from all course sections. if ($coursemods = $DB->get_records('course_modules', array('module' => $module->id))) { foreach ($coursemods as $coursemod) { // Do not verify results, there is not much we can do anyway. delete_mod_from_section($coursemod->id, $coursemod->section); } } // Increment course.cacherev for courses that used this module. // This will force cache rebuilding on the next request. increment_revision_number('course', 'cacherev', "id IN (SELECT DISTINCT course FROM {course_modules} WHERE module=?)", array($module->id)); // Delete all the course module records. $DB->delete_records('course_modules', array('module' => $module->id)); // Delete module contexts. if ($coursemods) { foreach ($coursemods as $coursemod) { \context_helper::delete_instance(CONTEXT_MODULE, $coursemod->id); } } // Delete the module entry itself. $DB->delete_records('modules', array('name' => $module->name)); // Cleanup the gradebook. require_once($CFG->libdir.'/gradelib.php'); grade_uninstalled_module($module->name); // Do not look for legacy $module->name . '_uninstall any more, // they should have migrated to db/uninstall.php by now. parent::uninstall_cleanup(); } }