source: moodle/trunk/fuentes/lib/classes/plugininfo/format.php @ 1331

Last change on this file since 1331 was 1331, checked in by jrpelegrina, 3 years ago

Updated to moodle 3.0.3

File size: 5.9 KB
Line 
1<?php
2// This file is part of Moodle - http://moodle.org/
3//
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
16
17/**
18 * Defines classes used for plugin info.
19 *
20 * @package    core
21 * @copyright  2011 David Mudrak <david@moodle.com>
22 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24namespace core\plugininfo;
25
26use moodle_url, part_of_admin_tree, admin_settingpage, core_plugin_manager;
27
28defined('MOODLE_INTERNAL') || die();
29
30/**
31 * Class for course formats
32 */
33class format extends base {
34    /**
35     * Finds all enabled plugins, the result may include missing plugins.
36     * @return array|null of enabled plugins $pluginname=>$pluginname, null means unknown
37     */
38    public static function get_enabled_plugins() {
39        global $DB;
40
41        $plugins = core_plugin_manager::instance()->get_installed_plugins('format');
42        if (!$plugins) {
43            return array();
44        }
45        $installed = array();
46        foreach ($plugins as $plugin => $version) {
47            $installed[] = 'format_'.$plugin;
48        }
49
50        list($installed, $params) = $DB->get_in_or_equal($installed, SQL_PARAMS_NAMED);
51        $disabled = $DB->get_records_select('config_plugins', "plugin $installed AND name = 'disabled'", $params, 'plugin ASC');
52        foreach ($disabled as $conf) {
53            if (empty($conf->value)) {
54                continue;
55            }
56            list($type, $name) = explode('_', $conf->plugin, 2);
57            unset($plugins[$name]);
58        }
59
60        $enabled = array();
61        foreach ($plugins as $plugin => $version) {
62            $enabled[$plugin] = $plugin;
63        }
64
65        return $enabled;
66    }
67
68    /**
69     * Gathers and returns the information about all plugins of the given type
70     *
71     * @param string $type the name of the plugintype, eg. mod, auth or workshopform
72     * @param string $typerootdir full path to the location of the plugin dir
73     * @param string $typeclass the name of the actually called class
74     * @param core_plugin_manager $pluginman the plugin manager calling this method
75     * @return array of plugintype classes, indexed by the plugin name
76     */
77    public static function get_plugins($type, $typerootdir, $typeclass, $pluginman) {
78        global $CFG;
79        require_once($CFG->dirroot.'/course/lib.php');
80
81        $formats = parent::get_plugins($type, $typerootdir, $typeclass, $pluginman);
82        $order = get_sorted_course_formats();
83        $sortedformats = array();
84        foreach ($order as $formatname) {
85            $sortedformats[$formatname] = $formats[$formatname];
86        }
87        return $sortedformats;
88    }
89
90    public function get_settings_section_name() {
91        return 'formatsetting' . $this->name;
92    }
93
94    public function load_settings(part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) {
95        global $CFG, $USER, $DB, $OUTPUT, $PAGE; // In case settings.php wants to refer to them.
96        $ADMIN = $adminroot; // May be used in settings.php.
97        $plugininfo = $this; // Also can be used inside settings.php.
98
99        if (!$this->is_installed_and_upgraded()) {
100            return;
101        }
102
103        if (!$hassiteconfig or !file_exists($this->full_path('settings.php'))) {
104            return;
105        }
106
107        $section = $this->get_settings_section_name();
108
109        $settings = new admin_settingpage($section, $this->displayname, 'moodle/site:config', $this->is_enabled() === false);
110        include($this->full_path('settings.php')); // This may also set $settings to null.
111
112        if ($settings) {
113            $ADMIN->add($parentnodename, $settings);
114        }
115    }
116
117    public function is_uninstall_allowed() {
118        if ($this->name !== get_config('moodlecourse', 'format') && $this->name !== 'site') {
119            return true;
120        } else {
121            return false;
122        }
123    }
124
125    /**
126     * Return URL used for management of plugins of this type.
127     * @return moodle_url
128     */
129    public static function get_manage_url() {
130        return new moodle_url('/admin/settings.php', array('section'=>'manageformats'));
131    }
132
133    public function get_uninstall_extra_warning() {
134        global $DB;
135
136        $coursecount = $DB->count_records('course', array('format' => $this->name));
137
138        if (!$coursecount) {
139            return '';
140        }
141
142        $defaultformat = $this->pluginman->plugin_name('format_'.get_config('moodlecourse', 'format'));
143        $message = get_string(
144            'formatuninstallwithcourses', 'core_admin',
145            (object)array('count' => $coursecount, 'format' => $this->displayname,
146                'defaultformat' => $defaultformat));
147
148        return $message;
149    }
150
151    /**
152     * Pre-uninstall hook.
153     *
154     * This is intended for disabling of plugin, some DB table purging, etc.
155     *
156     * NOTE: to be called from uninstall_plugin() only.
157     * @private
158     */
159    public function uninstall_cleanup() {
160        global $DB;
161
162        if (($defaultformat = get_config('moodlecourse', 'format')) && $defaultformat !== $this->name) {
163            $courses = $DB->get_records('course', array('format' => $this->name), 'id');
164            $data = (object)array('id' => null, 'format' => $defaultformat);
165            foreach ($courses as $record) {
166                $data->id = $record->id;
167                update_course($data);
168            }
169        }
170
171        $DB->delete_records('course_format_options', array('format' => $this->name));
172
173        parent::uninstall_cleanup();
174    }
175}
Note: See TracBrowser for help on using the repository browser.