2 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
18 * Functions and classes used during installation, upgrades and for admin settings.
20 * ADMIN SETTINGS TREE INTRODUCTION
22 * This file performs the following tasks:
23 * -it defines the necessary objects and interfaces to build the Moodle
25 * -it defines the admin_externalpage_setup()
27 * ADMIN_SETTING OBJECTS
29 * Moodle settings are represented by objects that inherit from the admin_setting
30 * class. These objects encapsulate how to read a setting, how to write a new value
31 * to a setting, and how to appropriately display the HTML to modify the setting.
33 * ADMIN_SETTINGPAGE OBJECTS
35 * The admin_setting objects are then grouped into admin_settingpages. The latter
36 * appear in the Moodle admin tree block. All interaction with admin_settingpage
37 * objects is handled by the admin/settings.php file.
39 * ADMIN_EXTERNALPAGE OBJECTS
41 * There are some settings in Moodle that are too complex to (efficiently) handle
42 * with admin_settingpages. (Consider, for example, user management and displaying
43 * lists of users.) In this case, we use the admin_externalpage object. This object
44 * places a link to an external PHP file in the admin tree block.
46 * If you're using an admin_externalpage object for some settings, you can take
47 * advantage of the admin_externalpage_* functions. For example, suppose you wanted
48 * to add a foo.php file into admin. First off, you add the following line to
49 * admin/settings/first.php (at the end of the file) or to some other file in
52 * $ADMIN->add('userinterface', new admin_externalpage('foo', get_string('foo'),
53 * $CFG->wwwdir . '/' . '$CFG->admin . '/foo.php', 'some_role_permission'));
56 * Next, in foo.php, your file structure would resemble the following:
58 * require(__DIR__.'/../../config.php');
59 * require_once($CFG->libdir.'/adminlib.php');
60 * admin_externalpage_setup('foo');
61 * // functionality like processing form submissions goes here
62 * echo $OUTPUT->header();
63 * // your HTML goes here
64 * echo $OUTPUT->footer();
67 * The admin_externalpage_setup() function call ensures the user is logged in,
68 * and makes sure that they have the proper role permission to access the page.
69 * It also configures all $PAGE properties needed for navigation.
71 * ADMIN_CATEGORY OBJECTS
73 * Above and beyond all this, we have admin_category objects. These objects
74 * appear as folders in the admin tree block. They contain admin_settingpage's,
75 * admin_externalpage's, and other admin_category's.
79 * admin_settingpage's, admin_externalpage's, and admin_category's all inherit
80 * from part_of_admin_tree (a pseudointerface). This interface insists that
81 * a class has a check_access method for access permissions, a locate method
82 * used to find a specific node in the admin tree and find parent path.
84 * admin_category's inherit from parentable_part_of_admin_tree. This pseudo-
85 * interface ensures that the class implements a recursive add function which
86 * accepts a part_of_admin_tree object and searches for the proper place to
87 * put it. parentable_part_of_admin_tree implies part_of_admin_tree.
89 * Please note that the $this->name field of any part_of_admin_tree must be
90 * UNIQUE throughout the ENTIRE admin tree.
92 * The $this->name field of an admin_setting object (which is *not* part_of_
93 * admin_tree) must be unique on the respective admin_settingpage where it is
96 * Original author: Vincenzo K. Marcovecchio
97 * Maintainer: Petr Skoda
101 * @copyright 1999 onwards Martin Dougiamas http://dougiamas.com
102 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
105 use core_admin\local\settings\linkable_settings_page
;
107 defined('MOODLE_INTERNAL') ||
die();
110 require_once($CFG->libdir
.'/ddllib.php');
111 require_once($CFG->libdir
.'/xmlize.php');
112 require_once($CFG->libdir
.'/messagelib.php');
114 // Add classes, traits, and interfaces which should be autoloaded.
115 // The autoloader is configured late in setup.php, after ABORT_AFTER_CONFIG.
116 // This is also required where the setup system is not included at all.
117 require_once($CFG->dirroot
.'/'.$CFG->admin
.'/classes/local/settings/linkable_settings_page.php');
119 define('INSECURE_DATAROOT_WARNING', 1);
120 define('INSECURE_DATAROOT_ERROR', 2);
123 * Automatically clean-up all plugin data and remove the plugin DB tables
125 * NOTE: do not call directly, use new /admin/plugins.php?uninstall=component instead!
127 * @param string $type The plugin type, eg. 'mod', 'qtype', 'workshopgrading' etc.
128 * @param string $name The plugin name, eg. 'forum', 'multichoice', 'accumulative' etc.
129 * @uses global $OUTPUT to produce notices and other messages
132 function uninstall_plugin($type, $name) {
133 global $CFG, $DB, $OUTPUT;
135 // This may take a long time.
136 core_php_time_limit
::raise();
138 // Recursively uninstall all subplugins first.
139 $subplugintypes = core_component
::get_plugin_types_with_subplugins();
140 if (isset($subplugintypes[$type])) {
141 $base = core_component
::get_plugin_directory($type, $name);
143 $subpluginsfile = "{$base}/db/subplugins.json";
144 if (file_exists($subpluginsfile)) {
145 $subplugins = (array) json_decode(file_get_contents($subpluginsfile))->plugintypes
;
146 } else if (file_exists("{$base}/db/subplugins.php")) {
147 debugging('Use of subplugins.php has been deprecated. ' .
148 'Please update your plugin to provide a subplugins.json file instead.',
151 include("{$base}/db/subplugins.php");
154 if (!empty($subplugins)) {
155 foreach (array_keys($subplugins) as $subplugintype) {
156 $instances = core_component
::get_plugin_list($subplugintype);
157 foreach ($instances as $subpluginname => $notusedpluginpath) {
158 uninstall_plugin($subplugintype, $subpluginname);
164 $component = $type . '_' . $name; // eg. 'qtype_multichoice' or 'workshopgrading_accumulative' or 'mod_forum'
166 if ($type === 'mod') {
167 $pluginname = $name; // eg. 'forum'
168 if (get_string_manager()->string_exists('modulename', $component)) {
169 $strpluginname = get_string('modulename', $component);
171 $strpluginname = $component;
175 $pluginname = $component;
176 if (get_string_manager()->string_exists('pluginname', $component)) {
177 $strpluginname = get_string('pluginname', $component);
179 $strpluginname = $component;
183 echo $OUTPUT->heading($pluginname);
185 // Delete all tag areas, collections and instances associated with this plugin.
186 core_tag_area
::uninstall($component);
188 // Custom plugin uninstall.
189 $plugindirectory = core_component
::get_plugin_directory($type, $name);
190 $uninstalllib = $plugindirectory . '/db/uninstall.php';
191 if (file_exists($uninstalllib)) {
192 require_once($uninstalllib);
193 $uninstallfunction = 'xmldb_' . $pluginname . '_uninstall'; // eg. 'xmldb_workshop_uninstall()'
194 if (function_exists($uninstallfunction)) {
195 // Do not verify result, let plugin complain if necessary.
196 $uninstallfunction();
200 // Specific plugin type cleanup.
201 $plugininfo = core_plugin_manager
::instance()->get_plugin_info($component);
203 $plugininfo->uninstall_cleanup();
204 core_plugin_manager
::reset_caches();
208 // perform clean-up task common for all the plugin/subplugin types
210 //delete the web service functions and pre-built services
211 require_once($CFG->dirroot
.'/lib/externallib.php');
212 external_delete_descriptions($component);
214 // delete calendar events
215 $DB->delete_records('event', array('modulename' => $pluginname));
216 $DB->delete_records('event', ['component' => $component]);
218 // Delete scheduled tasks.
219 $DB->delete_records('task_adhoc', ['component' => $component]);
220 $DB->delete_records('task_scheduled', array('component' => $component));
222 // Delete Inbound Message datakeys.
223 $DB->delete_records_select('messageinbound_datakeys',
224 'handler IN (SELECT id FROM {messageinbound_handlers} WHERE component = ?)', array($component));
226 // Delete Inbound Message handlers.
227 $DB->delete_records('messageinbound_handlers', array('component' => $component));
229 // delete all the logs
230 $DB->delete_records('log', array('module' => $pluginname));
232 // delete log_display information
233 $DB->delete_records('log_display', array('component' => $component));
235 // delete the module configuration records
236 unset_all_config_for_plugin($component);
237 if ($type === 'mod') {
238 unset_all_config_for_plugin($pluginname);
241 // delete message provider
242 message_provider_uninstall($component);
244 // delete the plugin tables
245 $xmldbfilepath = $plugindirectory . '/db/install.xml';
246 drop_plugin_tables($component, $xmldbfilepath, false);
247 if ($type === 'mod' or $type === 'block') {
248 // non-frankenstyle table prefixes
249 drop_plugin_tables($name, $xmldbfilepath, false);
252 // delete the capabilities that were defined by this module
253 capabilities_cleanup($component);
255 // Delete all remaining files in the filepool owned by the component.
256 $fs = get_file_storage();
257 $fs->delete_component_files($component);
259 // Finally purge all caches.
262 // Invalidate the hash used for upgrade detections.
263 set_config('allversionshash', '');
265 echo $OUTPUT->notification(get_string('success'), 'notifysuccess');
269 * Returns the version of installed component
271 * @param string $component component name
272 * @param string $source either 'disk' or 'installed' - where to get the version information from
273 * @return string|bool version number or false if the component is not found
275 function get_component_version($component, $source='installed') {
278 list($type, $name) = core_component
::normalize_component($component);
280 // moodle core or a core subsystem
281 if ($type === 'core') {
282 if ($source === 'installed') {
283 if (empty($CFG->version
)) {
286 return $CFG->version
;
289 if (!is_readable($CFG->dirroot
.'/version.php')) {
292 $version = null; //initialize variable for IDEs
293 include($CFG->dirroot
.'/version.php');
300 if ($type === 'mod') {
301 if ($source === 'installed') {
302 if ($CFG->version
< 2013092001.02) {
303 return $DB->get_field('modules', 'version', array('name'=>$name));
305 return get_config('mod_'.$name, 'version');
309 $mods = core_component
::get_plugin_list('mod');
310 if (empty($mods[$name]) or !is_readable($mods[$name].'/version.php')) {
313 $plugin = new stdClass();
314 $plugin->version
= null;
316 include($mods[$name].'/version.php');
317 return $plugin->version
;
323 if ($type === 'block') {
324 if ($source === 'installed') {
325 if ($CFG->version
< 2013092001.02) {
326 return $DB->get_field('block', 'version', array('name'=>$name));
328 return get_config('block_'.$name, 'version');
331 $blocks = core_component
::get_plugin_list('block');
332 if (empty($blocks[$name]) or !is_readable($blocks[$name].'/version.php')) {
335 $plugin = new stdclass();
336 include($blocks[$name].'/version.php');
337 return $plugin->version
;
342 // all other plugin types
343 if ($source === 'installed') {
344 return get_config($type.'_'.$name, 'version');
346 $plugins = core_component
::get_plugin_list($type);
347 if (empty($plugins[$name])) {
350 $plugin = new stdclass();
351 include($plugins[$name].'/version.php');
352 return $plugin->version
;
358 * Delete all plugin tables
360 * @param string $name Name of plugin, used as table prefix
361 * @param string $file Path to install.xml file
362 * @param bool $feedback defaults to true
363 * @return bool Always returns true
365 function drop_plugin_tables($name, $file, $feedback=true) {
368 // first try normal delete
369 if (file_exists($file) and $DB->get_manager()->delete_tables_from_xmldb_file($file)) {
373 // then try to find all tables that start with name and are not in any xml file
374 $used_tables = get_used_table_names();
376 $tables = $DB->get_tables();
378 /// Iterate over, fixing id fields as necessary
379 foreach ($tables as $table) {
380 if (in_array($table, $used_tables)) {
384 if (strpos($table, $name) !== 0) {
388 // found orphan table --> delete it
389 if ($DB->get_manager()->table_exists($table)) {
390 $xmldb_table = new xmldb_table($table);
391 $DB->get_manager()->drop_table($xmldb_table);
399 * Returns names of all known tables == tables that moodle knows about.
401 * @return array Array of lowercase table names
403 function get_used_table_names() {
404 $table_names = array();
405 $dbdirs = get_db_directories();
407 foreach ($dbdirs as $dbdir) {
408 $file = $dbdir.'/install.xml';
410 $xmldb_file = new xmldb_file($file);
412 if (!$xmldb_file->fileExists()) {
416 $loaded = $xmldb_file->loadXMLStructure();
417 $structure = $xmldb_file->getStructure();
419 if ($loaded and $tables = $structure->getTables()) {
420 foreach($tables as $table) {
421 $table_names[] = strtolower($table->getName());
430 * Returns list of all directories where we expect install.xml files
431 * @return array Array of paths
433 function get_db_directories() {
438 /// First, the main one (lib/db)
439 $dbdirs[] = $CFG->libdir
.'/db';
441 /// Then, all the ones defined by core_component::get_plugin_types()
442 $plugintypes = core_component
::get_plugin_types();
443 foreach ($plugintypes as $plugintype => $pluginbasedir) {
444 if ($plugins = core_component
::get_plugin_list($plugintype)) {
445 foreach ($plugins as $plugin => $plugindir) {
446 $dbdirs[] = $plugindir.'/db';
455 * Try to obtain or release the cron lock.
456 * @param string $name name of lock
457 * @param int $until timestamp when this lock considered stale, null means remove lock unconditionally
458 * @param bool $ignorecurrent ignore current lock state, usually extend previous lock, defaults to false
459 * @return bool true if lock obtained
461 function set_cron_lock($name, $until, $ignorecurrent=false) {
464 debugging("Tried to get a cron lock for a null fieldname");
468 // remove lock by force == remove from config table
469 if (is_null($until)) {
470 set_config($name, null);
474 if (!$ignorecurrent) {
475 // read value from db - other processes might have changed it
476 $value = $DB->get_field('config', 'value', array('name'=>$name));
478 if ($value and $value > time()) {
484 set_config($name, $until);
489 * Test if and critical warnings are present
492 function admin_critical_warnings_present() {
495 if (!has_capability('moodle/site:config', context_system
::instance())) {
499 if (!isset($SESSION->admin_critical_warning
)) {
500 $SESSION->admin_critical_warning
= 0;
501 if (is_dataroot_insecure(true) === INSECURE_DATAROOT_ERROR
) {
502 $SESSION->admin_critical_warning
= 1;
506 return $SESSION->admin_critical_warning
;
510 * Detects if float supports at least 10 decimal digits
512 * Detects if float supports at least 10 decimal digits
513 * and also if float-->string conversion works as expected.
515 * @return bool true if problem found
517 function is_float_problem() {
518 $num1 = 2009010200.01;
519 $num2 = 2009010200.02;
521 return ((string)$num1 === (string)$num2 or $num1 === $num2 or $num2 <= (string)$num1);
525 * Try to verify that dataroot is not accessible from web.
527 * Try to verify that dataroot is not accessible from web.
528 * It is not 100% correct but might help to reduce number of vulnerable sites.
529 * Protection from httpd.conf and .htaccess is not detected properly.
531 * @uses INSECURE_DATAROOT_WARNING
532 * @uses INSECURE_DATAROOT_ERROR
533 * @param bool $fetchtest try to test public access by fetching file, default false
534 * @return mixed empty means secure, INSECURE_DATAROOT_ERROR found a critical problem, INSECURE_DATAROOT_WARNING might be problematic
536 function is_dataroot_insecure($fetchtest=false) {
539 $siteroot = str_replace('\\', '/', strrev($CFG->dirroot
.'/')); // win32 backslash workaround
541 $rp = preg_replace('|https?://[^/]+|i', '', $CFG->wwwroot
, 1);
542 $rp = strrev(trim($rp, '/'));
543 $rp = explode('/', $rp);
545 if (strpos($siteroot, '/'.$r.'/') === 0) {
546 $siteroot = substr($siteroot, strlen($r)+
1); // moodle web in subdirectory
548 break; // probably alias root
552 $siteroot = strrev($siteroot);
553 $dataroot = str_replace('\\', '/', $CFG->dataroot
.'/');
555 if (strpos($dataroot, $siteroot) !== 0) {
560 return INSECURE_DATAROOT_WARNING
;
563 // now try all methods to fetch a test file using http protocol
565 $httpdocroot = str_replace('\\', '/', strrev($CFG->dirroot
.'/'));
566 preg_match('|(https?://[^/]+)|i', $CFG->wwwroot
, $matches);
567 $httpdocroot = $matches[1];
568 $datarooturl = $httpdocroot.'/'. substr($dataroot, strlen($siteroot));
569 make_upload_directory('diag');
570 $testfile = $CFG->dataroot
.'/diag/public.txt';
571 if (!file_exists($testfile)) {
572 file_put_contents($testfile, 'test file, do not delete');
573 @chmod
($testfile, $CFG->filepermissions
);
575 $teststr = trim(file_get_contents($testfile));
576 if (empty($teststr)) {
578 return INSECURE_DATAROOT_WARNING
;
581 $testurl = $datarooturl.'/diag/public.txt';
582 if (extension_loaded('curl') and
583 !(stripos(ini_get('disable_functions'), 'curl_init') !== FALSE) and
584 !(stripos(ini_get('disable_functions'), 'curl_setop') !== FALSE) and
585 ($ch = @curl_init
($testurl)) !== false) {
586 curl_setopt($ch, CURLOPT_RETURNTRANSFER
, true);
587 curl_setopt($ch, CURLOPT_HEADER
, false);
588 $data = curl_exec($ch);
589 if (!curl_errno($ch)) {
591 if ($data === $teststr) {
593 return INSECURE_DATAROOT_ERROR
;
599 if ($data = @file_get_contents
($testurl)) {
601 if ($data === $teststr) {
602 return INSECURE_DATAROOT_ERROR
;
606 preg_match('|https?://([^/]+)|i', $testurl, $matches);
607 $sitename = $matches[1];
609 if ($fp = @fsockopen
($sitename, 80, $error)) {
610 preg_match('|https?://[^/]+(.*)|i', $testurl, $matches);
611 $localurl = $matches[1];
612 $out = "GET $localurl HTTP/1.1\r\n";
613 $out .= "Host: $sitename\r\n";
614 $out .= "Connection: Close\r\n\r\n";
620 $data .= fgets($fp, 1024);
621 } else if (@fgets
($fp, 1024) === "\r\n") {
627 if ($data === $teststr) {
628 return INSECURE_DATAROOT_ERROR
;
632 return INSECURE_DATAROOT_WARNING
;
636 * Enables CLI maintenance mode by creating new dataroot/climaintenance.html file.
638 function enable_cli_maintenance_mode() {
641 if (file_exists("$CFG->dataroot/climaintenance.html")) {
642 unlink("$CFG->dataroot/climaintenance.html");
645 if (isset($CFG->maintenance_message
) and !html_is_blank($CFG->maintenance_message
)) {
646 $data = $CFG->maintenance_message
;
647 $data = bootstrap_renderer
::early_error_content($data, null, null, null);
648 $data = bootstrap_renderer
::plain_page(get_string('sitemaintenance', 'admin'), $data);
650 } else if (file_exists("$CFG->dataroot/climaintenance.template.html")) {
651 $data = file_get_contents("$CFG->dataroot/climaintenance.template.html");
654 $data = get_string('sitemaintenance', 'admin');
655 $data = bootstrap_renderer
::early_error_content($data, null, null, null);
656 $data = bootstrap_renderer
::plain_page(get_string('sitemaintenancetitle', 'admin',
657 format_string($SITE->fullname
, true, ['context' => context_system
::instance()])), $data);
660 file_put_contents("$CFG->dataroot/climaintenance.html", $data);
661 chmod("$CFG->dataroot/climaintenance.html", $CFG->filepermissions
);
664 /// CLASS DEFINITIONS /////////////////////////////////////////////////////////
668 * Interface for anything appearing in the admin tree
670 * The interface that is implemented by anything that appears in the admin tree
671 * block. It forces inheriting classes to define a method for checking user permissions
672 * and methods for finding something in the admin tree.
674 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
676 interface part_of_admin_tree
{
679 * Finds a named part_of_admin_tree.
681 * Used to find a part_of_admin_tree. If a class only inherits part_of_admin_tree
682 * and not parentable_part_of_admin_tree, then this function should only check if
683 * $this->name matches $name. If it does, it should return a reference to $this,
684 * otherwise, it should return a reference to NULL.
686 * If a class inherits parentable_part_of_admin_tree, this method should be called
687 * recursively on all child objects (assuming, of course, the parent object's name
688 * doesn't match the search criterion).
690 * @param string $name The internal name of the part_of_admin_tree we're searching for.
691 * @return mixed An object reference or a NULL reference.
693 public function locate($name);
696 * Removes named part_of_admin_tree.
698 * @param string $name The internal name of the part_of_admin_tree we want to remove.
699 * @return bool success.
701 public function prune($name);
705 * @param string $query
706 * @return mixed array-object structure of found settings and pages
708 public function search($query);
711 * Verifies current user's access to this part_of_admin_tree.
713 * Used to check if the current user has access to this part of the admin tree or
714 * not. If a class only inherits part_of_admin_tree and not parentable_part_of_admin_tree,
715 * then this method is usually just a call to has_capability() in the site context.
717 * If a class inherits parentable_part_of_admin_tree, this method should return the
718 * logical OR of the return of check_access() on all child objects.
720 * @return bool True if the user has access, false if she doesn't.
722 public function check_access();
725 * Mostly useful for removing of some parts of the tree in admin tree block.
727 * @return True is hidden from normal list view
729 public function is_hidden();
732 * Show we display Save button at the page bottom?
735 public function show_save();
740 * Interface implemented by any part_of_admin_tree that has children.
742 * The interface implemented by any part_of_admin_tree that can be a parent
743 * to other part_of_admin_tree's. (For now, this only includes admin_category.) Apart
744 * from ensuring part_of_admin_tree compliancy, it also ensures inheriting methods
745 * include an add method for adding other part_of_admin_tree objects as children.
747 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
749 interface parentable_part_of_admin_tree
extends part_of_admin_tree
{
752 * Adds a part_of_admin_tree object to the admin tree.
754 * Used to add a part_of_admin_tree object to this object or a child of this
755 * object. $something should only be added if $destinationname matches
756 * $this->name. If it doesn't, add should be called on child objects that are
757 * also parentable_part_of_admin_tree's.
759 * $something should be appended as the last child in the $destinationname. If the
760 * $beforesibling is specified, $something should be prepended to it. If the given
761 * sibling is not found, $something should be appended to the end of $destinationname
762 * and a developer debugging message should be displayed.
764 * @param string $destinationname The internal name of the new parent for $something.
765 * @param part_of_admin_tree $something The object to be added.
766 * @return bool True on success, false on failure.
768 public function add($destinationname, $something, $beforesibling = null);
774 * The object used to represent folders (a.k.a. categories) in the admin tree block.
776 * Each admin_category object contains a number of part_of_admin_tree objects.
778 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
780 class admin_category
implements parentable_part_of_admin_tree
, linkable_settings_page
{
782 /** @var part_of_admin_tree[] An array of part_of_admin_tree objects that are this object's children */
784 /** @var string An internal name for this category. Must be unique amongst ALL part_of_admin_tree objects */
786 /** @var string The displayed name for this category. Usually obtained through get_string() */
788 /** @var bool Should this category be hidden in admin tree block? */
790 /** @var mixed Either a string or an array or strings */
792 /** @var mixed Either a string or an array or strings */
795 /** @var array fast lookup category cache, all categories of one tree point to one cache */
796 protected $category_cache;
798 /** @var bool If set to true children will be sorted when calling {@link admin_category::get_children()} */
799 protected $sort = false;
800 /** @var bool If set to true children will be sorted in ascending order. */
801 protected $sortasc = true;
802 /** @var bool If set to true sub categories and pages will be split and then sorted.. */
803 protected $sortsplit = true;
804 /** @var bool $sorted True if the children have been sorted and don't need resorting */
805 protected $sorted = false;
808 * Constructor for an empty admin category
810 * @param string $name The internal name for this category. Must be unique amongst ALL part_of_admin_tree objects
811 * @param string $visiblename The displayed named for this category. Usually obtained through get_string()
812 * @param bool $hidden hide category in admin tree block, defaults to false
814 public function __construct($name, $visiblename, $hidden=false) {
815 $this->children
= array();
817 $this->visiblename
= $visiblename;
818 $this->hidden
= $hidden;
822 * Get the URL to view this settings page.
826 public function get_settings_page_url(): moodle_url
{
827 return new moodle_url(
828 '/admin/category.php',
830 'category' => $this->name
,
836 * Returns a reference to the part_of_admin_tree object with internal name $name.
838 * @param string $name The internal name of the object we want.
839 * @param bool $findpath initialize path and visiblepath arrays
840 * @return mixed A reference to the object with internal name $name if found, otherwise a reference to NULL.
843 public function locate($name, $findpath=false) {
844 if (!isset($this->category_cache
[$this->name
])) {
845 // somebody much have purged the cache
846 $this->category_cache
[$this->name
] = $this;
849 if ($this->name
== $name) {
851 $this->visiblepath
[] = $this->visiblename
;
852 $this->path
[] = $this->name
;
857 // quick category lookup
858 if (!$findpath and isset($this->category_cache
[$name])) {
859 return $this->category_cache
[$name];
863 foreach($this->children
as $childid=>$unused) {
864 if ($return = $this->children
[$childid]->locate($name, $findpath)) {
869 if (!is_null($return) and $findpath) {
870 $return->visiblepath
[] = $this->visiblename
;
871 $return->path
[] = $this->name
;
880 * @param string query
881 * @return mixed array-object structure of found settings and pages
883 public function search($query) {
885 foreach ($this->get_children() as $child) {
886 $subsearch = $child->search($query);
887 if (!is_array($subsearch)) {
888 debugging('Incorrect search result from '.$child->name
);
891 $result = array_merge($result, $subsearch);
897 * Removes part_of_admin_tree object with internal name $name.
899 * @param string $name The internal name of the object we want to remove.
900 * @return bool success
902 public function prune($name) {
904 if ($this->name
== $name) {
905 return false; //can not remove itself
908 foreach($this->children
as $precedence => $child) {
909 if ($child->name
== $name) {
910 // clear cache and delete self
911 while($this->category_cache
) {
912 // delete the cache, but keep the original array address
913 array_pop($this->category_cache
);
915 unset($this->children
[$precedence]);
917 } else if ($this->children
[$precedence]->prune($name)) {
925 * Adds a part_of_admin_tree to a child or grandchild (or great-grandchild, and so forth) of this object.
927 * By default the new part of the tree is appended as the last child of the parent. You
928 * can specify a sibling node that the new part should be prepended to. If the given
929 * sibling is not found, the part is appended to the end (as it would be by default) and
930 * a developer debugging message is displayed.
932 * @throws coding_exception if the $beforesibling is empty string or is not string at all.
933 * @param string $destinationame The internal name of the immediate parent that we want for $something.
934 * @param mixed $something A part_of_admin_tree or setting instance to be added.
935 * @param string $beforesibling The name of the parent's child the $something should be prepended to.
936 * @return bool True if successfully added, false if $something can not be added.
938 public function add($parentname, $something, $beforesibling = null) {
941 $parent = $this->locate($parentname);
942 if (is_null($parent)) {
943 debugging('parent does not exist!');
947 if ($something instanceof part_of_admin_tree
) {
948 if (!($parent instanceof parentable_part_of_admin_tree
)) {
949 debugging('error - parts of tree can be inserted only into parentable parts');
952 if ($CFG->debugdeveloper
&& !is_null($this->locate($something->name
))) {
953 // The name of the node is already used, simply warn the developer that this should not happen.
954 // It is intentional to check for the debug level before performing the check.
955 debugging('Duplicate admin page name: ' . $something->name
, DEBUG_DEVELOPER
);
957 if (is_null($beforesibling)) {
958 // Append $something as the parent's last child.
959 $parent->children
[] = $something;
961 if (!is_string($beforesibling) or trim($beforesibling) === '') {
962 throw new coding_exception('Unexpected value of the beforesibling parameter');
964 // Try to find the position of the sibling.
965 $siblingposition = null;
966 foreach ($parent->children
as $childposition => $child) {
967 if ($child->name
=== $beforesibling) {
968 $siblingposition = $childposition;
972 if (is_null($siblingposition)) {
973 debugging('Sibling '.$beforesibling.' not found', DEBUG_DEVELOPER
);
974 $parent->children
[] = $something;
976 $parent->children
= array_merge(
977 array_slice($parent->children
, 0, $siblingposition),
979 array_slice($parent->children
, $siblingposition)
983 if ($something instanceof admin_category
) {
984 if (isset($this->category_cache
[$something->name
])) {
985 debugging('Duplicate admin category name: '.$something->name
);
987 $this->category_cache
[$something->name
] = $something;
988 $something->category_cache
=& $this->category_cache
;
989 foreach ($something->children
as $child) {
990 // just in case somebody already added subcategories
991 if ($child instanceof admin_category
) {
992 if (isset($this->category_cache
[$child->name
])) {
993 debugging('Duplicate admin category name: '.$child->name
);
995 $this->category_cache
[$child->name
] = $child;
996 $child->category_cache
=& $this->category_cache
;
1005 debugging('error - can not add this element');
1012 * Checks if the user has access to anything in this category.
1014 * @return bool True if the user has access to at least one child in this category, false otherwise.
1016 public function check_access() {
1017 foreach ($this->children
as $child) {
1018 if ($child->check_access()) {
1026 * Is this category hidden in admin tree block?
1028 * @return bool True if hidden
1030 public function is_hidden() {
1031 return $this->hidden
;
1035 * Show we display Save button at the page bottom?
1038 public function show_save() {
1039 foreach ($this->children
as $child) {
1040 if ($child->show_save()) {
1048 * Sets sorting on this category.
1050 * Please note this function doesn't actually do the sorting.
1051 * It can be called anytime.
1052 * Sorting occurs when the user calls get_children.
1053 * Code using the children array directly won't see the sorted results.
1055 * @param bool $sort If set to true children will be sorted, if false they won't be.
1056 * @param bool $asc If true sorting will be ascending, otherwise descending.
1057 * @param bool $split If true we sort pages and sub categories separately.
1059 public function set_sorting($sort, $asc = true, $split = true) {
1060 $this->sort
= (bool)$sort;
1061 $this->sortasc
= (bool)$asc;
1062 $this->sortsplit
= (bool)$split;
1066 * Returns the children associated with this category.
1068 * @return part_of_admin_tree[]
1070 public function get_children() {
1071 // If we should sort and it hasn't already been sorted.
1072 if ($this->sort
&& !$this->sorted
) {
1073 if ($this->sortsplit
) {
1074 $categories = array();
1076 foreach ($this->children
as $child) {
1077 if ($child instanceof admin_category
) {
1078 $categories[] = $child;
1083 core_collator
::asort_objects_by_property($categories, 'visiblename');
1084 core_collator
::asort_objects_by_property($pages, 'visiblename');
1085 if (!$this->sortasc
) {
1086 $categories = array_reverse($categories);
1087 $pages = array_reverse($pages);
1089 $this->children
= array_merge($pages, $categories);
1091 core_collator
::asort_objects_by_property($this->children
, 'visiblename');
1092 if (!$this->sortasc
) {
1093 $this->children
= array_reverse($this->children
);
1096 $this->sorted
= true;
1098 return $this->children
;
1102 * Magically gets a property from this object.
1105 * @return part_of_admin_tree[]
1106 * @throws coding_exception
1108 public function __get($property) {
1109 if ($property === 'children') {
1110 return $this->get_children();
1112 throw new coding_exception('Invalid property requested.');
1116 * Magically sets a property against this object.
1118 * @param string $property
1119 * @param mixed $value
1120 * @throws coding_exception
1122 public function __set($property, $value) {
1123 if ($property === 'children') {
1124 $this->sorted
= false;
1125 $this->children
= $value;
1127 throw new coding_exception('Invalid property requested.');
1132 * Checks if an inaccessible property is set.
1134 * @param string $property
1136 * @throws coding_exception
1138 public function __isset($property) {
1139 if ($property === 'children') {
1140 return isset($this->children
);
1142 throw new coding_exception('Invalid property requested.');
1148 * Root of admin settings tree, does not have any parent.
1150 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1152 class admin_root
extends admin_category
{
1153 /** @var array List of errors */
1155 /** @var string search query */
1157 /** @var bool full tree flag - true means all settings required, false only pages required */
1159 /** @var bool flag indicating loaded tree */
1161 /** @var mixed site custom defaults overriding defaults in settings files*/
1162 public $custom_defaults;
1165 * @param bool $fulltree true means all settings required,
1166 * false only pages required
1168 public function __construct($fulltree) {
1171 parent
::__construct('root', get_string('administration'), false);
1172 $this->errors
= array();
1174 $this->fulltree
= $fulltree;
1175 $this->loaded
= false;
1177 $this->category_cache
= array();
1179 // load custom defaults if found
1180 $this->custom_defaults
= null;
1181 $defaultsfile = "$CFG->dirroot/local/defaults.php";
1182 if (is_readable($defaultsfile)) {
1183 $defaults = array();
1184 include($defaultsfile);
1185 if (is_array($defaults) and count($defaults)) {
1186 $this->custom_defaults
= $defaults;
1192 * Empties children array, and sets loaded to false
1194 * @param bool $requirefulltree
1196 public function purge_children($requirefulltree) {
1197 $this->children
= array();
1198 $this->fulltree
= ($requirefulltree ||
$this->fulltree
);
1199 $this->loaded
= false;
1200 //break circular dependencies - this helps PHP 5.2
1201 while($this->category_cache
) {
1202 array_pop($this->category_cache
);
1204 $this->category_cache
= array();
1210 * Links external PHP pages into the admin tree.
1212 * See detailed usage example at the top of this document (adminlib.php)
1214 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1216 class admin_externalpage
implements part_of_admin_tree
, linkable_settings_page
{
1218 /** @var string An internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects */
1221 /** @var string The displayed name for this external page. Usually obtained through get_string(). */
1222 public $visiblename;
1224 /** @var string The external URL that we should link to when someone requests this external page. */
1227 /** @var array The role capability/permission a user must have to access this external page. */
1228 public $req_capability;
1230 /** @var object The context in which capability/permission should be checked, default is site context. */
1233 /** @var bool hidden in admin tree block. */
1236 /** @var mixed either string or array of string */
1239 /** @var array list of visible names of page parents */
1240 public $visiblepath;
1243 * Constructor for adding an external page into the admin tree.
1245 * @param string $name The internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects.
1246 * @param string $visiblename The displayed name for this external page. Usually obtained through get_string().
1247 * @param string $url The external URL that we should link to when someone requests this external page.
1248 * @param mixed $req_capability The role capability/permission a user must have to access this external page. Defaults to 'moodle/site:config'.
1249 * @param boolean $hidden Is this external page hidden in admin tree block? Default false.
1250 * @param stdClass $context The context the page relates to. Not sure what happens
1251 * if you specify something other than system or front page. Defaults to system.
1253 public function __construct($name, $visiblename, $url, $req_capability='moodle/site:config', $hidden=false, $context=NULL) {
1254 $this->name
= $name;
1255 $this->visiblename
= $visiblename;
1257 if (is_array($req_capability)) {
1258 $this->req_capability
= $req_capability;
1260 $this->req_capability
= array($req_capability);
1262 $this->hidden
= $hidden;
1263 $this->context
= $context;
1267 * Get the URL to view this settings page.
1269 * @return moodle_url
1271 public function get_settings_page_url(): moodle_url
{
1272 return new moodle_url($this->url
);
1276 * Returns a reference to the part_of_admin_tree object with internal name $name.
1278 * @param string $name The internal name of the object we want.
1279 * @param bool $findpath defaults to false
1280 * @return mixed A reference to the object with internal name $name if found, otherwise a reference to NULL.
1282 public function locate($name, $findpath=false) {
1283 if ($this->name
== $name) {
1285 $this->visiblepath
= array($this->visiblename
);
1286 $this->path
= array($this->name
);
1296 * This function always returns false, required function by interface
1298 * @param string $name
1301 public function prune($name) {
1306 * Search using query
1308 * @param string $query
1309 * @return mixed array-object structure of found settings and pages
1311 public function search($query) {
1313 if (strpos(strtolower($this->name
), $query) !== false) {
1315 } else if (strpos(core_text
::strtolower($this->visiblename
), $query) !== false) {
1319 $result = new stdClass();
1320 $result->page
= $this;
1321 $result->settings
= array();
1322 return array($this->name
=> $result);
1329 * Determines if the current user has access to this external page based on $this->req_capability.
1331 * @return bool True if user has access, false otherwise.
1333 public function check_access() {
1335 $context = empty($this->context
) ? context_system
::instance() : $this->context
;
1336 foreach($this->req_capability
as $cap) {
1337 if (has_capability($cap, $context)) {
1345 * Is this external page hidden in admin tree block?
1347 * @return bool True if hidden
1349 public function is_hidden() {
1350 return $this->hidden
;
1354 * Show we display Save button at the page bottom?
1357 public function show_save() {
1363 * Used to store details of the dependency between two settings elements.
1365 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1366 * @copyright 2017 Davo Smith, Synergy Learning
1368 class admin_settingdependency
{
1369 /** @var string the name of the setting to be shown/hidden */
1370 public $settingname;
1371 /** @var string the setting this is dependent on */
1372 public $dependenton;
1373 /** @var string the condition to show/hide the element */
1375 /** @var string the value to compare against */
1378 /** @var string[] list of valid conditions */
1379 private static $validconditions = ['checked', 'notchecked', 'noitemselected', 'eq', 'neq', 'in'];
1382 * admin_settingdependency constructor.
1383 * @param string $settingname
1384 * @param string $dependenton
1385 * @param string $condition
1386 * @param string $value
1387 * @throws \coding_exception
1389 public function __construct($settingname, $dependenton, $condition, $value) {
1390 $this->settingname
= $this->parse_name($settingname);
1391 $this->dependenton
= $this->parse_name($dependenton);
1392 $this->condition
= $condition;
1393 $this->value
= $value;
1395 if (!in_array($this->condition
, self
::$validconditions)) {
1396 throw new coding_exception("Invalid condition '$condition'");
1401 * Convert the setting name into the form field name.
1402 * @param string $name
1405 private function parse_name($name) {
1406 $bits = explode('/', $name);
1407 $name = array_pop($bits);
1410 $plugin = array_pop($bits);
1411 if ($plugin === 'moodle') {
1415 return 's_'.$plugin.'_'.$name;
1419 * Gather together all the dependencies in a format suitable for initialising javascript
1420 * @param admin_settingdependency[] $dependencies
1423 public static function prepare_for_javascript($dependencies) {
1425 foreach ($dependencies as $d) {
1426 if (!isset($result[$d->dependenton
])) {
1427 $result[$d->dependenton
] = [];
1429 if (!isset($result[$d->dependenton
][$d->condition
])) {
1430 $result[$d->dependenton
][$d->condition
] = [];
1432 if (!isset($result[$d->dependenton
][$d->condition
][$d->value
])) {
1433 $result[$d->dependenton
][$d->condition
][$d->value
] = [];
1435 $result[$d->dependenton
][$d->condition
][$d->value
][] = $d->settingname
;
1442 * Used to group a number of admin_setting objects into a page and add them to the admin tree.
1444 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1446 class admin_settingpage
implements part_of_admin_tree
, linkable_settings_page
{
1448 /** @var string An internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects */
1451 /** @var string The displayed name for this external page. Usually obtained through get_string(). */
1452 public $visiblename;
1454 /** @var mixed An array of admin_setting objects that are part of this setting page. */
1457 /** @var admin_settingdependency[] list of settings to hide when certain conditions are met */
1458 protected $dependencies = [];
1460 /** @var array The role capability/permission a user must have to access this external page. */
1461 public $req_capability;
1463 /** @var object The context in which capability/permission should be checked, default is site context. */
1466 /** @var bool hidden in admin tree block. */
1469 /** @var mixed string of paths or array of strings of paths */
1472 /** @var array list of visible names of page parents */
1473 public $visiblepath;
1476 * see admin_settingpage for details of this function
1478 * @param string $name The internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects.
1479 * @param string $visiblename The displayed name for this external page. Usually obtained through get_string().
1480 * @param mixed $req_capability The role capability/permission a user must have to access this external page. Defaults to 'moodle/site:config'.
1481 * @param boolean $hidden Is this external page hidden in admin tree block? Default false.
1482 * @param stdClass $context The context the page relates to. Not sure what happens
1483 * if you specify something other than system or front page. Defaults to system.
1485 public function __construct($name, $visiblename, $req_capability='moodle/site:config', $hidden=false, $context=NULL) {
1486 $this->settings
= new stdClass();
1487 $this->name
= $name;
1488 $this->visiblename
= $visiblename;
1489 if (is_array($req_capability)) {
1490 $this->req_capability
= $req_capability;
1492 $this->req_capability
= array($req_capability);
1494 $this->hidden
= $hidden;
1495 $this->context
= $context;
1499 * Get the URL to view this page.
1501 * @return moodle_url
1503 public function get_settings_page_url(): moodle_url
{
1504 return new moodle_url(
1505 '/admin/settings.php',
1507 'section' => $this->name
,
1513 * see admin_category
1515 * @param string $name
1516 * @param bool $findpath
1517 * @return mixed Object (this) if name == this->name, else returns null
1519 public function locate($name, $findpath=false) {
1520 if ($this->name
== $name) {
1522 $this->visiblepath
= array($this->visiblename
);
1523 $this->path
= array($this->name
);
1533 * Search string in settings page.
1535 * @param string $query
1538 public function search($query) {
1541 foreach ($this->settings
as $setting) {
1542 if ($setting->is_related($query)) {
1543 $found[] = $setting;
1548 $result = new stdClass();
1549 $result->page
= $this;
1550 $result->settings
= $found;
1551 return array($this->name
=> $result);
1555 if (strpos(strtolower($this->name
), $query) !== false) {
1557 } else if (strpos(core_text
::strtolower($this->visiblename
), $query) !== false) {
1561 $result = new stdClass();
1562 $result->page
= $this;
1563 $result->settings
= array();
1564 return array($this->name
=> $result);
1571 * This function always returns false, required by interface
1573 * @param string $name
1574 * @return bool Always false
1576 public function prune($name) {
1581 * adds an admin_setting to this admin_settingpage
1583 * not the same as add for admin_category. adds an admin_setting to this admin_settingpage. settings appear (on the settingpage) in the order in which they're added
1584 * n.b. each admin_setting in an admin_settingpage must have a unique internal name
1586 * @param object $setting is the admin_setting object you want to add
1587 * @return bool true if successful, false if not
1589 public function add($setting) {
1590 if (!($setting instanceof admin_setting
)) {
1591 debugging('error - not a setting instance');
1595 $name = $setting->name
;
1596 if ($setting->plugin
) {
1597 $name = $setting->plugin
. $name;
1599 $this->settings
->{$name} = $setting;
1604 * Hide the named setting if the specified condition is matched.
1606 * @param string $settingname
1607 * @param string $dependenton
1608 * @param string $condition
1609 * @param string $value
1611 public function hide_if($settingname, $dependenton, $condition = 'notchecked', $value = '1') {
1612 $this->dependencies
[] = new admin_settingdependency($settingname, $dependenton, $condition, $value);
1614 // Reformat the dependency name to the plugin | name format used in the display.
1615 $dependenton = str_replace('/', ' | ', $dependenton);
1617 // Let the setting know, so it can be displayed underneath.
1618 $findname = str_replace('/', '', $settingname);
1619 foreach ($this->settings
as $name => $setting) {
1620 if ($name === $findname) {
1621 $setting->add_dependent_on($dependenton);
1627 * see admin_externalpage
1629 * @return bool Returns true for yes false for no
1631 public function check_access() {
1633 $context = empty($this->context
) ? context_system
::instance() : $this->context
;
1634 foreach($this->req_capability
as $cap) {
1635 if (has_capability($cap, $context)) {
1643 * outputs this page as html in a table (suitable for inclusion in an admin pagetype)
1644 * @return string Returns an XHTML string
1646 public function output_html() {
1647 $adminroot = admin_get_root();
1648 $return = '<fieldset>'."\n".'<div class="clearer"><!-- --></div>'."\n";
1649 foreach($this->settings
as $setting) {
1650 $fullname = $setting->get_full_name();
1651 if (array_key_exists($fullname, $adminroot->errors
)) {
1652 $data = $adminroot->errors
[$fullname]->data
;
1654 $data = $setting->get_setting();
1655 // do not use defaults if settings not available - upgrade settings handles the defaults!
1657 $return .= $setting->output_html($data);
1659 $return .= '</fieldset>';
1664 * Is this settings page hidden in admin tree block?
1666 * @return bool True if hidden
1668 public function is_hidden() {
1669 return $this->hidden
;
1673 * Show we display Save button at the page bottom?
1676 public function show_save() {
1677 foreach($this->settings
as $setting) {
1678 if (empty($setting->nosave
)) {
1686 * Should any of the settings on this page be shown / hidden based on conditions?
1689 public function has_dependencies() {
1690 return (bool)$this->dependencies
;
1694 * Format the setting show/hide conditions ready to initialise the page javascript
1697 public function get_dependencies_for_javascript() {
1698 if (!$this->has_dependencies()) {
1701 return admin_settingdependency
::prepare_for_javascript($this->dependencies
);
1707 * Admin settings class. Only exists on setting pages.
1708 * Read & write happens at this level; no authentication.
1710 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1712 abstract class admin_setting
{
1713 /** @var string unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins. */
1715 /** @var string localised name */
1716 public $visiblename;
1717 /** @var string localised long description in Markdown format */
1718 public $description;
1719 /** @var mixed Can be string or array of string */
1720 public $defaultsetting;
1722 public $updatedcallback;
1723 /** @var mixed can be String or Null. Null means main config table */
1724 public $plugin; // null means main config table
1725 /** @var bool true indicates this setting does not actually save anything, just information */
1726 public $nosave = false;
1727 /** @var bool if set, indicates that a change to this setting requires rebuild course cache */
1728 public $affectsmodinfo = false;
1729 /** @var array of admin_setting_flag - These are extra checkboxes attached to a setting. */
1730 private $flags = array();
1731 /** @var bool Whether this field must be forced LTR. */
1732 private $forceltr = null;
1733 /** @var array list of other settings that may cause this setting to be hidden */
1734 private $dependenton = [];
1735 /** @var bool Whether this setting uses a custom form control */
1736 protected $customcontrol = false;
1740 * @param string $name unique ascii name, either 'mysetting' for settings that in config,
1741 * or 'myplugin/mysetting' for ones in config_plugins.
1742 * @param string $visiblename localised name
1743 * @param string $description localised long description
1744 * @param mixed $defaultsetting string or array depending on implementation
1746 public function __construct($name, $visiblename, $description, $defaultsetting) {
1747 $this->parse_setting_name($name);
1748 $this->visiblename
= $visiblename;
1749 $this->description
= $description;
1750 $this->defaultsetting
= $defaultsetting;
1754 * Generic function to add a flag to this admin setting.
1756 * @param bool $enabled - One of self::OPTION_ENABLED or self::OPTION_DISABLED
1757 * @param bool $default - The default for the flag
1758 * @param string $shortname - The shortname for this flag. Used as a suffix for the setting name.
1759 * @param string $displayname - The display name for this flag. Used as a label next to the checkbox.
1761 protected function set_flag_options($enabled, $default, $shortname, $displayname) {
1762 if (empty($this->flags
[$shortname])) {
1763 $this->flags
[$shortname] = new admin_setting_flag($enabled, $default, $shortname, $displayname);
1765 $this->flags
[$shortname]->set_options($enabled, $default);
1770 * Set the enabled options flag on this admin setting.
1772 * @param bool $enabled - One of self::OPTION_ENABLED or self::OPTION_DISABLED
1773 * @param bool $default - The default for the flag
1775 public function set_enabled_flag_options($enabled, $default) {
1776 $this->set_flag_options($enabled, $default, 'enabled', new lang_string('enabled', 'core_admin'));
1780 * Set the advanced options flag on this admin setting.
1782 * @param bool $enabled - One of self::OPTION_ENABLED or self::OPTION_DISABLED
1783 * @param bool $default - The default for the flag
1785 public function set_advanced_flag_options($enabled, $default) {
1786 $this->set_flag_options($enabled, $default, 'adv', new lang_string('advanced'));
1791 * Set the locked options flag on this admin setting.
1793 * @param bool $enabled - One of self::OPTION_ENABLED or self::OPTION_DISABLED
1794 * @param bool $default - The default for the flag
1796 public function set_locked_flag_options($enabled, $default) {
1797 $this->set_flag_options($enabled, $default, 'locked', new lang_string('locked', 'core_admin'));
1801 * Set the required options flag on this admin setting.
1803 * @param bool $enabled - One of self::OPTION_ENABLED or self::OPTION_DISABLED.
1804 * @param bool $default - The default for the flag.
1806 public function set_required_flag_options($enabled, $default) {
1807 $this->set_flag_options($enabled, $default, 'required', new lang_string('required', 'core_admin'));
1811 * Is this option forced in config.php?
1815 public function is_readonly(): bool {
1818 if (empty($this->plugin
)) {
1819 if (array_key_exists($this->name
, $CFG->config_php_settings
)) {
1823 if (array_key_exists($this->plugin
, $CFG->forced_plugin_settings
)
1824 and array_key_exists($this->name
, $CFG->forced_plugin_settings
[$this->plugin
])) {
1832 * Get the currently saved value for a setting flag
1834 * @param admin_setting_flag $flag - One of the admin_setting_flag for this admin_setting.
1837 public function get_setting_flag_value(admin_setting_flag
$flag) {
1838 $value = $this->config_read($this->name
. '_' . $flag->get_shortname());
1839 if (!isset($value)) {
1840 $value = $flag->get_default();
1843 return !empty($value);
1847 * Get the list of defaults for the flags on this setting.
1849 * @param array of strings describing the defaults for this setting. This is appended to by this function.
1851 public function get_setting_flag_defaults(& $defaults) {
1852 foreach ($this->flags
as $flag) {
1853 if ($flag->is_enabled() && $flag->get_default()) {
1854 $defaults[] = $flag->get_displayname();
1860 * Output the input fields for the advanced and locked flags on this setting.
1862 * @param bool $adv - The current value of the advanced flag.
1863 * @param bool $locked - The current value of the locked flag.
1864 * @return string $output - The html for the flags.
1866 public function output_setting_flags() {
1869 foreach ($this->flags
as $flag) {
1870 if ($flag->is_enabled()) {
1871 $output .= $flag->output_setting_flag($this);
1875 if (!empty($output)) {
1876 return html_writer
::tag('span', $output, array('class' => 'adminsettingsflags'));
1882 * Write the values of the flags for this admin setting.
1884 * @param array $data - The data submitted from the form or null to set the default value for new installs.
1885 * @return bool - true if successful.
1887 public function write_setting_flags($data) {
1889 foreach ($this->flags
as $flag) {
1890 $result = $result && $flag->write_setting_flag($this, $data);
1896 * Set up $this->name and potentially $this->plugin
1898 * Set up $this->name and possibly $this->plugin based on whether $name looks
1899 * like 'settingname' or 'plugin/settingname'. Also, do some sanity checking
1900 * on the names, that is, output a developer debug warning if the name
1901 * contains anything other than [a-zA-Z0-9_]+.
1903 * @param string $name the setting name passed in to the constructor.
1905 private function parse_setting_name($name) {
1906 $bits = explode('/', $name);
1907 if (count($bits) > 2) {
1908 throw new moodle_exception('invalidadminsettingname', '', '', $name);
1910 $this->name
= array_pop($bits);
1911 if (!preg_match('/^[a-zA-Z0-9_]+$/', $this->name
)) {
1912 throw new moodle_exception('invalidadminsettingname', '', '', $name);
1914 if (!empty($bits)) {
1915 $this->plugin
= array_pop($bits);
1916 if ($this->plugin
=== 'moodle') {
1917 $this->plugin
= null;
1918 } else if (!preg_match('/^[a-zA-Z0-9_]+$/', $this->plugin
)) {
1919 throw new moodle_exception('invalidadminsettingname', '', '', $name);
1925 * Returns the fullname prefixed by the plugin
1928 public function get_full_name() {
1929 return 's_'.$this->plugin
.'_'.$this->name
;
1933 * Returns the ID string based on plugin and name
1936 public function get_id() {
1937 return 'id_s_'.$this->plugin
.'_'.$this->name
;
1941 * @param bool $affectsmodinfo If true, changes to this setting will
1942 * cause the course cache to be rebuilt
1944 public function set_affects_modinfo($affectsmodinfo) {
1945 $this->affectsmodinfo
= $affectsmodinfo;
1949 * Returns the config if possible
1951 * @return mixed returns config if successful else null
1953 public function config_read($name) {
1955 if (!empty($this->plugin
)) {
1956 $value = get_config($this->plugin
, $name);
1957 return $value === false ?
NULL : $value;
1960 if (isset($CFG->$name)) {
1969 * Used to set a config pair and log change
1971 * @param string $name
1972 * @param mixed $value Gets converted to string if not null
1973 * @return bool Write setting to config table
1975 public function config_write($name, $value) {
1976 global $DB, $USER, $CFG;
1978 if ($this->nosave
) {
1982 // make sure it is a real change
1983 $oldvalue = get_config($this->plugin
, $name);
1984 $oldvalue = ($oldvalue === false) ?
null : $oldvalue; // normalise
1985 $value = is_null($value) ?
null : (string)$value;
1987 if ($oldvalue === $value) {
1992 set_config($name, $value, $this->plugin
);
1994 // Some admin settings affect course modinfo
1995 if ($this->affectsmodinfo
) {
1996 // Clear course cache for all courses
1997 rebuild_course_cache(0, true);
2000 $this->add_to_config_log($name, $oldvalue, $value);
2002 return true; // BC only
2006 * Log config changes if necessary.
2007 * @param string $name
2008 * @param string $oldvalue
2009 * @param string $value
2011 protected function add_to_config_log($name, $oldvalue, $value) {
2012 add_to_config_log($name, $oldvalue, $value, $this->plugin
);
2016 * Returns current value of this setting
2017 * @return mixed array or string depending on instance, NULL means not set yet
2019 public abstract function get_setting();
2022 * Returns default setting if exists
2023 * @return mixed array or string depending on instance; NULL means no default, user must supply
2025 public function get_defaultsetting() {
2026 $adminroot = admin_get_root(false, false);
2027 if (!empty($adminroot->custom_defaults
)) {
2028 $plugin = is_null($this->plugin
) ?
'moodle' : $this->plugin
;
2029 if (isset($adminroot->custom_defaults
[$plugin])) {
2030 if (array_key_exists($this->name
, $adminroot->custom_defaults
[$plugin])) { // null is valid value here ;-)
2031 return $adminroot->custom_defaults
[$plugin][$this->name
];
2035 return $this->defaultsetting
;
2041 * @param mixed $data string or array, must not be NULL
2042 * @return string empty string if ok, string error message otherwise
2044 public abstract function write_setting($data);
2047 * Return part of form with setting
2048 * This function should always be overwritten
2050 * @param mixed $data array or string depending on setting
2051 * @param string $query
2054 public function output_html($data, $query='') {
2055 // should be overridden
2060 * Function called if setting updated - cleanup, cache reset, etc.
2061 * @param string $functionname Sets the function name
2064 public function set_updatedcallback($functionname) {
2065 $this->updatedcallback
= $functionname;
2069 * Execute postupdatecallback if necessary.
2070 * @param mixed $original original value before write_setting()
2071 * @return bool true if changed, false if not.
2073 public function post_write_settings($original) {
2074 // Comparison must work for arrays too.
2075 if (serialize($original) === serialize($this->get_setting())) {
2079 $callbackfunction = $this->updatedcallback
;
2080 if (!empty($callbackfunction) and is_callable($callbackfunction)) {
2081 $callbackfunction($this->get_full_name());
2087 * Is setting related to query text - used when searching
2088 * @param string $query
2091 public function is_related($query) {
2092 if (strpos(strtolower($this->name
), $query) !== false) {
2095 if (strpos(core_text
::strtolower($this->visiblename
), $query) !== false) {
2098 if (strpos(core_text
::strtolower($this->description
), $query) !== false) {
2101 $current = $this->get_setting();
2102 if (!is_null($current)) {
2103 if (is_string($current)) {
2104 if (strpos(core_text
::strtolower($current), $query) !== false) {
2109 $default = $this->get_defaultsetting();
2110 if (!is_null($default)) {
2111 if (is_string($default)) {
2112 if (strpos(core_text
::strtolower($default), $query) !== false) {
2121 * Get whether this should be displayed in LTR mode.
2125 public function get_force_ltr() {
2126 return $this->forceltr
;
2130 * Set whether to force LTR or not.
2132 * @param bool $value True when forced, false when not force, null when unknown.
2134 public function set_force_ltr($value) {
2135 $this->forceltr
= $value;
2139 * Add a setting to the list of those that could cause this one to be hidden
2140 * @param string $dependenton
2142 public function add_dependent_on($dependenton) {
2143 $this->dependenton
[] = $dependenton;
2147 * Get a list of the settings that could cause this one to be hidden.
2150 public function get_dependent_on() {
2151 return $this->dependenton
;
2155 * Whether this setting uses a custom form control.
2156 * This function is especially useful to decide if we should render a label element for this setting or not.
2160 public function has_custom_form_control(): bool {
2161 return $this->customcontrol
;
2166 * An additional option that can be applied to an admin setting.
2167 * The currently supported options are 'ADVANCED', 'LOCKED' and 'REQUIRED'.
2169 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2171 class admin_setting_flag
{
2172 /** @var bool Flag to indicate if this option can be toggled for this setting */
2173 private $enabled = false;
2174 /** @var bool Flag to indicate if this option defaults to true or false */
2175 private $default = false;
2176 /** @var string Short string used to create setting name - e.g. 'adv' */
2177 private $shortname = '';
2178 /** @var string String used as the label for this flag */
2179 private $displayname = '';
2180 /** @const Checkbox for this flag is displayed in admin page */
2181 const ENABLED
= true;
2182 /** @const Checkbox for this flag is not displayed in admin page */
2183 const DISABLED
= false;
2188 * @param bool $enabled Can this option can be toggled.
2189 * Should be one of admin_setting_flag::ENABLED or admin_setting_flag::DISABLED.
2190 * @param bool $default The default checked state for this setting option.
2191 * @param string $shortname The shortname of this flag. Currently supported flags are 'locked' and 'adv'
2192 * @param string $displayname The displayname of this flag. Used as a label for the flag.
2194 public function __construct($enabled, $default, $shortname, $displayname) {
2195 $this->shortname
= $shortname;
2196 $this->displayname
= $displayname;
2197 $this->set_options($enabled, $default);
2201 * Update the values of this setting options class
2203 * @param bool $enabled Can this option can be toggled.
2204 * Should be one of admin_setting_flag::ENABLED or admin_setting_flag::DISABLED.
2205 * @param bool $default The default checked state for this setting option.
2207 public function set_options($enabled, $default) {
2208 $this->enabled
= $enabled;
2209 $this->default = $default;
2213 * Should this option appear in the interface and be toggleable?
2215 * @return bool Is it enabled?
2217 public function is_enabled() {
2218 return $this->enabled
;
2222 * Should this option be checked by default?
2224 * @return bool Is it on by default?
2226 public function get_default() {
2227 return $this->default;
2231 * Return the short name for this flag. e.g. 'adv' or 'locked'
2235 public function get_shortname() {
2236 return $this->shortname
;
2240 * Return the display name for this flag. e.g. 'Advanced' or 'Locked'
2244 public function get_displayname() {
2245 return $this->displayname
;
2249 * Save the submitted data for this flag - or set it to the default if $data is null.
2251 * @param admin_setting $setting - The admin setting for this flag
2252 * @param array $data - The data submitted from the form or null to set the default value for new installs.
2255 public function write_setting_flag(admin_setting
$setting, $data) {
2257 if ($this->is_enabled()) {
2258 if (!isset($data)) {
2259 $value = $this->get_default();
2261 $value = !empty($data[$setting->get_full_name() . '_' . $this->get_shortname()]);
2263 $result = $setting->config_write($setting->name
. '_' . $this->get_shortname(), $value);
2271 * Output the checkbox for this setting flag. Should only be called if the flag is enabled.
2273 * @param admin_setting $setting - The admin setting for this flag
2274 * @return string - The html for the checkbox.
2276 public function output_setting_flag(admin_setting
$setting) {
2279 $value = $setting->get_setting_flag_value($this);
2281 $context = new stdClass();
2282 $context->id
= $setting->get_id() . '_' . $this->get_shortname();
2283 $context->name
= $setting->get_full_name() . '_' . $this->get_shortname();
2284 $context->value
= 1;
2285 $context->checked
= $value ?
true : false;
2286 $context->label
= $this->get_displayname();
2288 return $OUTPUT->render_from_template('core_admin/setting_flag', $context);
2294 * No setting - just heading and text.
2296 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2298 class admin_setting_heading
extends admin_setting
{
2301 * not a setting, just text
2302 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
2303 * @param string $heading heading
2304 * @param string $information text in box
2306 public function __construct($name, $heading, $information) {
2307 $this->nosave
= true;
2308 parent
::__construct($name, $heading, $information, '');
2312 * Always returns true
2313 * @return bool Always returns true
2315 public function get_setting() {
2320 * Always returns true
2321 * @return bool Always returns true
2323 public function get_defaultsetting() {
2328 * Never write settings
2329 * @return string Always returns an empty string
2331 public function write_setting($data) {
2332 // do not write any setting
2337 * Returns an HTML string
2338 * @return string Returns an HTML string
2340 public function output_html($data, $query='') {
2342 $context = new stdClass();
2343 $context->title
= $this->visiblename
;
2344 $context->description
= $this->description
;
2345 $context->descriptionformatted
= highlight($query, markdown_to_html($this->description
));
2346 return $OUTPUT->render_from_template('core_admin/setting_heading', $context);
2351 * No setting - just name and description in same row.
2353 * @copyright 2018 onwards Amaia Anabitarte
2354 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2356 class admin_setting_description
extends admin_setting
{
2359 * Not a setting, just text
2361 * @param string $name
2362 * @param string $visiblename
2363 * @param string $description
2365 public function __construct($name, $visiblename, $description) {
2366 $this->nosave
= true;
2367 parent
::__construct($name, $visiblename, $description, '');
2371 * Always returns true
2373 * @return bool Always returns true
2375 public function get_setting() {
2380 * Always returns true
2382 * @return bool Always returns true
2384 public function get_defaultsetting() {
2389 * Never write settings
2391 * @param mixed $data Gets converted to str for comparison against yes value
2392 * @return string Always returns an empty string
2394 public function write_setting($data) {
2395 // Do not write any setting.
2400 * Returns an HTML string
2402 * @param string $data
2403 * @param string $query
2404 * @return string Returns an HTML string
2406 public function output_html($data, $query='') {
2409 $context = new stdClass();
2410 $context->title
= $this->visiblename
;
2411 $context->description
= $this->description
;
2413 return $OUTPUT->render_from_template('core_admin/setting_description', $context);
2420 * The most flexible setting, the user enters text.
2422 * This type of field should be used for config settings which are using
2423 * English words and are not localised (passwords, database name, list of values, ...).
2425 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2427 class admin_setting_configtext
extends admin_setting
{
2429 /** @var mixed int means PARAM_XXX type, string is a allowed format in regex */
2431 /** @var int default field size */
2435 * Config text constructor
2437 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
2438 * @param string $visiblename localised
2439 * @param string $description long localised info
2440 * @param string $defaultsetting
2441 * @param mixed $paramtype int means PARAM_XXX type, string is a allowed format in regex
2442 * @param int $size default field size
2444 public function __construct($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW
, $size=null) {
2445 $this->paramtype
= $paramtype;
2446 if (!is_null($size)) {
2447 $this->size
= $size;
2449 $this->size
= ($paramtype === PARAM_INT
) ?
5 : 30;
2451 parent
::__construct($name, $visiblename, $description, $defaultsetting);
2455 * Get whether this should be displayed in LTR mode.
2457 * Try to guess from the PARAM type unless specifically set.
2459 public function get_force_ltr() {
2460 $forceltr = parent
::get_force_ltr();
2461 if ($forceltr === null) {
2462 return !is_rtl_compatible($this->paramtype
);
2468 * Return the setting
2470 * @return mixed returns config if successful else null
2472 public function get_setting() {
2473 return $this->config_read($this->name
);
2476 public function write_setting($data) {
2477 if ($this->paramtype
=== PARAM_INT
and $data === '') {
2478 // do not complain if '' used instead of 0
2481 // $data is a string
2482 $validated = $this->validate($data);
2483 if ($validated !== true) {
2486 return ($this->config_write($this->name
, $data) ?
'' : get_string('errorsetting', 'admin'));
2490 * Validate data before storage
2491 * @param string data
2492 * @return mixed true if ok string if error found
2494 public function validate($data) {
2495 // allow paramtype to be a custom regex if it is the form of /pattern/
2496 if (preg_match('#^/.*/$#', $this->paramtype
)) {
2497 if (preg_match($this->paramtype
, $data)) {
2500 return get_string('validateerror', 'admin');
2503 } else if ($this->paramtype
=== PARAM_RAW
) {
2507 $cleaned = clean_param($data, $this->paramtype
);
2508 if ("$data" === "$cleaned") { // implicit conversion to string is needed to do exact comparison
2511 return get_string('validateerror', 'admin');
2517 * Return an XHTML string for the setting
2518 * @return string Returns an XHTML string
2520 public function output_html($data, $query='') {
2523 $default = $this->get_defaultsetting();
2524 $context = (object) [
2525 'size' => $this->size
,
2526 'id' => $this->get_id(),
2527 'name' => $this->get_full_name(),
2529 'forceltr' => $this->get_force_ltr(),
2530 'readonly' => $this->is_readonly(),
2532 $element = $OUTPUT->render_from_template('core_admin/setting_configtext', $context);
2534 return format_admin_setting($this, $this->visiblename
, $element, $this->description
, true, '', $default, $query);
2539 * Text input with a maximum length constraint.
2541 * @copyright 2015 onwards Ankit Agarwal
2542 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2544 class admin_setting_configtext_with_maxlength
extends admin_setting_configtext
{
2546 /** @var int maximum number of chars allowed. */
2547 protected $maxlength;
2550 * Config text constructor
2552 * @param string $name unique ascii name, either 'mysetting' for settings that in config,
2553 * or 'myplugin/mysetting' for ones in config_plugins.
2554 * @param string $visiblename localised
2555 * @param string $description long localised info
2556 * @param string $defaultsetting
2557 * @param mixed $paramtype int means PARAM_XXX type, string is a allowed format in regex
2558 * @param int $size default field size
2559 * @param mixed $maxlength int maxlength allowed, 0 for infinite.
2561 public function __construct($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW
,
2562 $size=null, $maxlength = 0) {
2563 $this->maxlength
= $maxlength;
2564 parent
::__construct($name, $visiblename, $description, $defaultsetting, $paramtype, $size);
2568 * Validate data before storage
2570 * @param string $data data
2571 * @return mixed true if ok string if error found
2573 public function validate($data) {
2574 $parentvalidation = parent
::validate($data);
2575 if ($parentvalidation === true) {
2576 if ($this->maxlength
> 0) {
2577 // Max length check.
2578 $length = core_text
::strlen($data);
2579 if ($length > $this->maxlength
) {
2580 return get_string('maximumchars', 'moodle', $this->maxlength
);
2584 return true; // No max length check needed.
2587 return $parentvalidation;
2593 * General text area without html editor.
2595 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2597 class admin_setting_configtextarea
extends admin_setting_configtext
{
2602 * @param string $name
2603 * @param string $visiblename
2604 * @param string $description
2605 * @param mixed $defaultsetting string or array
2606 * @param mixed $paramtype
2607 * @param string $cols The number of columns to make the editor
2608 * @param string $rows The number of rows to make the editor
2610 public function __construct($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW
, $cols='60', $rows='8') {
2611 $this->rows
= $rows;
2612 $this->cols
= $cols;
2613 parent
::__construct($name, $visiblename, $description, $defaultsetting, $paramtype);
2617 * Returns an XHTML string for the editor
2619 * @param string $data
2620 * @param string $query
2621 * @return string XHTML string for the editor
2623 public function output_html($data, $query='') {
2626 $default = $this->get_defaultsetting();
2627 $defaultinfo = $default;
2628 if (!is_null($default) and $default !== '') {
2629 $defaultinfo = "\n".$default;
2632 $context = (object) [
2633 'cols' => $this->cols
,
2634 'rows' => $this->rows
,
2635 'id' => $this->get_id(),
2636 'name' => $this->get_full_name(),
2638 'forceltr' => $this->get_force_ltr(),
2639 'readonly' => $this->is_readonly(),
2641 $element = $OUTPUT->render_from_template('core_admin/setting_configtextarea', $context);
2643 return format_admin_setting($this, $this->visiblename
, $element, $this->description
, true, '', $defaultinfo, $query);
2648 * General text area with html editor.
2650 class admin_setting_confightmleditor
extends admin_setting_configtextarea
{
2653 * @param string $name
2654 * @param string $visiblename
2655 * @param string $description
2656 * @param mixed $defaultsetting string or array
2657 * @param mixed $paramtype
2659 public function __construct($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW
, $cols='60', $rows='8') {
2660 parent
::__construct($name, $visiblename, $description, $defaultsetting, $paramtype, $cols, $rows);
2661 $this->set_force_ltr(false);
2662 editors_head_setup();
2666 * Returns an XHTML string for the editor
2668 * @param string $data
2669 * @param string $query
2670 * @return string XHTML string for the editor
2672 public function output_html($data, $query='') {
2673 $editor = editors_get_preferred_editor(FORMAT_HTML
);
2674 $editor->set_text($data);
2675 $editor->use_editor($this->get_id(), array('noclean'=>true));
2676 return parent
::output_html($data, $query);
2680 * Checks if data has empty html.
2682 * @param string $data
2683 * @return string Empty when no errors.
2685 public function write_setting($data) {
2686 if (trim(html_to_text($data)) === '') {
2689 return parent
::write_setting($data);
2695 * Password field, allows unmasking of password
2697 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2699 class admin_setting_configpasswordunmask
extends admin_setting_configtext
{
2703 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
2704 * @param string $visiblename localised
2705 * @param string $description long localised info
2706 * @param string $defaultsetting default password
2708 public function __construct($name, $visiblename, $description, $defaultsetting) {
2709 parent
::__construct($name, $visiblename, $description, $defaultsetting, PARAM_RAW
, 30);
2713 * Log config changes if necessary.
2714 * @param string $name
2715 * @param string $oldvalue
2716 * @param string $value
2718 protected function add_to_config_log($name, $oldvalue, $value) {
2719 if ($value !== '') {
2720 $value = '********';
2722 if ($oldvalue !== '' and $oldvalue !== null) {
2723 $oldvalue = '********';
2725 parent
::add_to_config_log($name, $oldvalue, $value);
2729 * Returns HTML for the field.
2731 * @param string $data Value for the field
2732 * @param string $query Passed as final argument for format_admin_setting
2733 * @return string Rendered HTML
2735 public function output_html($data, $query='') {
2738 $context = (object) [
2739 'id' => $this->get_id(),
2740 'name' => $this->get_full_name(),
2741 'size' => $this->size
,
2742 'value' => $this->is_readonly() ?
null : $data,
2743 'forceltr' => $this->get_force_ltr(),
2744 'readonly' => $this->is_readonly(),
2746 $element = $OUTPUT->render_from_template('core_admin/setting_configpasswordunmask', $context);
2747 return format_admin_setting($this, $this->visiblename
, $element, $this->description
, true, '', null, $query);
2752 * Password field, allows unmasking of password, with an advanced checkbox that controls an additional $name.'_adv' setting.
2754 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2755 * @copyright 2018 Paul Holden (pholden@greenhead.ac.uk)
2757 class admin_setting_configpasswordunmask_with_advanced
extends admin_setting_configpasswordunmask
{
2762 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
2763 * @param string $visiblename localised
2764 * @param string $description long localised info
2765 * @param array $defaultsetting ('value'=>string, 'adv'=>bool)
2767 public function __construct($name, $visiblename, $description, $defaultsetting) {
2768 parent
::__construct($name, $visiblename, $description, $defaultsetting['value']);
2769 $this->set_advanced_flag_options(admin_setting_flag
::ENABLED
, !empty($defaultsetting['adv']));
2774 * Admin setting class for encrypted values using secure encryption.
2776 * @copyright 2019 The Open University
2777 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2779 class admin_setting_encryptedpassword
extends admin_setting
{
2782 * Constructor. Same as parent except that the default value is always an empty string.
2784 * @param string $name Internal name used in config table
2785 * @param string $visiblename Name shown on form
2786 * @param string $description Description that appears below field
2788 public function __construct(string $name, string $visiblename, string $description) {
2789 parent
::__construct($name, $visiblename, $description, '');
2792 public function get_setting() {
2793 return $this->config_read($this->name
);
2796 public function write_setting($data) {
2797 $data = trim($data);
2799 // Value can really be set to nothing.
2802 // Encrypt value before saving it.
2803 $savedata = \core\encryption
::encrypt($data);
2805 return ($this->config_write($this->name
, $savedata) ?
'' : get_string('errorsetting', 'admin'));
2808 public function output_html($data, $query='') {
2811 $default = $this->get_defaultsetting();
2812 $context = (object) [
2813 'id' => $this->get_id(),
2814 'name' => $this->get_full_name(),
2815 'set' => $data !== '',
2816 'novalue' => $this->get_setting() === null
2818 $element = $OUTPUT->render_from_template('core_admin/setting_encryptedpassword', $context);
2820 return format_admin_setting($this, $this->visiblename
, $element, $this->description
,
2821 true, '', $default, $query);
2826 * Empty setting used to allow flags (advanced) on settings that can have no sensible default.
2827 * Note: Only advanced makes sense right now - locked does not.
2829 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2831 class admin_setting_configempty
extends admin_setting_configtext
{
2834 * @param string $name
2835 * @param string $visiblename
2836 * @param string $description
2838 public function __construct($name, $visiblename, $description) {
2839 parent
::__construct($name, $visiblename, $description, '', PARAM_RAW
);
2843 * Returns an XHTML string for the hidden field
2845 * @param string $data
2846 * @param string $query
2847 * @return string XHTML string for the editor
2849 public function output_html($data, $query='') {
2852 $context = (object) [
2853 'id' => $this->get_id(),
2854 'name' => $this->get_full_name()
2856 $element = $OUTPUT->render_from_template('core_admin/setting_configempty', $context);
2858 return format_admin_setting($this, $this->visiblename
, $element, $this->description
, true, '', get_string('none'), $query);
2866 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2868 class admin_setting_configfile
extends admin_setting_configtext
{
2871 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
2872 * @param string $visiblename localised
2873 * @param string $description long localised info
2874 * @param string $defaultdirectory default directory location
2876 public function __construct($name, $visiblename, $description, $defaultdirectory) {
2877 parent
::__construct($name, $visiblename, $description, $defaultdirectory, PARAM_RAW
, 50);
2881 * Returns XHTML for the field
2883 * Returns XHTML for the field and also checks whether the file
2884 * specified in $data exists using file_exists()
2886 * @param string $data File name and path to use in value attr
2887 * @param string $query
2888 * @return string XHTML field
2890 public function output_html($data, $query='') {
2891 global $CFG, $OUTPUT;
2893 $default = $this->get_defaultsetting();
2894 $context = (object) [
2895 'id' => $this->get_id(),
2896 'name' => $this->get_full_name(),
2897 'size' => $this->size
,
2899 'showvalidity' => !empty($data),
2900 'valid' => $data && file_exists($data),
2901 'readonly' => !empty($CFG->preventexecpath
) ||
$this->is_readonly(),
2902 'forceltr' => $this->get_force_ltr(),
2905 if ($context->readonly
) {
2906 $this->visiblename
.= '<div class="alert alert-info">'.get_string('execpathnotallowed', 'admin').'</div>';
2909 $element = $OUTPUT->render_from_template('core_admin/setting_configfile', $context);
2911 return format_admin_setting($this, $this->visiblename
, $element, $this->description
, true, '', $default, $query);
2915 * Checks if execpatch has been disabled in config.php
2917 public function write_setting($data) {
2919 if (!empty($CFG->preventexecpath
)) {
2920 if ($this->get_setting() === null) {
2921 // Use default during installation.
2922 $data = $this->get_defaultsetting();
2923 if ($data === null) {
2930 return parent
::write_setting($data);
2937 * Path to executable file
2939 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2941 class admin_setting_configexecutable
extends admin_setting_configfile
{
2944 * Returns an XHTML field
2946 * @param string $data This is the value for the field
2947 * @param string $query
2948 * @return string XHTML field
2950 public function output_html($data, $query='') {
2951 global $CFG, $OUTPUT;
2952 $default = $this->get_defaultsetting();
2953 require_once("$CFG->libdir/filelib.php");
2955 $context = (object) [
2956 'id' => $this->get_id(),
2957 'name' => $this->get_full_name(),
2958 'size' => $this->size
,
2960 'showvalidity' => !empty($data),
2961 'valid' => $data && file_exists($data) && !is_dir($data) && file_is_executable($data),
2962 'readonly' => !empty($CFG->preventexecpath
),
2963 'forceltr' => $this->get_force_ltr()
2966 if (!empty($CFG->preventexecpath
)) {
2967 $this->visiblename
.= '<div class="alert alert-info">'.get_string('execpathnotallowed', 'admin').'</div>';
2970 $element = $OUTPUT->render_from_template('core_admin/setting_configexecutable', $context);
2972 return format_admin_setting($this, $this->visiblename
, $element, $this->description
, true, '', $default, $query);
2980 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2982 class admin_setting_configdirectory
extends admin_setting_configfile
{
2985 * Returns an XHTML field
2987 * @param string $data This is the value for the field
2988 * @param string $query
2989 * @return string XHTML
2991 public function output_html($data, $query='') {
2992 global $CFG, $OUTPUT;
2993 $default = $this->get_defaultsetting();
2995 $context = (object) [
2996 'id' => $this->get_id(),
2997 'name' => $this->get_full_name(),
2998 'size' => $this->size
,
3000 'showvalidity' => !empty($data),
3001 'valid' => $data && file_exists($data) && is_dir($data),
3002 'readonly' => !empty($CFG->preventexecpath
),
3003 'forceltr' => $this->get_force_ltr()
3006 if (!empty($CFG->preventexecpath
)) {
3007 $this->visiblename
.= '<div class="alert alert-info">'.get_string('execpathnotallowed', 'admin').'</div>';
3010 $element = $OUTPUT->render_from_template('core_admin/setting_configdirectory', $context);
3012 return format_admin_setting($this, $this->visiblename
, $element, $this->description
, true, '', $default, $query);
3020 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3022 class admin_setting_configcheckbox
extends admin_setting
{
3023 /** @var string Value used when checked */
3025 /** @var string Value used when not checked */
3030 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
3031 * @param string $visiblename localised
3032 * @param string $description long localised info
3033 * @param string $defaultsetting
3034 * @param string $yes value used when checked
3035 * @param string $no value used when not checked
3037 public function __construct($name, $visiblename, $description, $defaultsetting, $yes='1', $no='0') {
3038 parent
::__construct($name, $visiblename, $description, $defaultsetting);
3039 $this->yes
= (string)$yes;
3040 $this->no
= (string)$no;
3044 * Retrieves the current setting using the objects name
3048 public function get_setting() {
3049 return $this->config_read($this->name
);
3053 * Sets the value for the setting
3055 * Sets the value for the setting to either the yes or no values
3056 * of the object by comparing $data to yes
3058 * @param mixed $data Gets converted to str for comparison against yes value
3059 * @return string empty string or error
3061 public function write_setting($data) {
3062 if ((string)$data === $this->yes
) { // convert to strings before comparison
3067 return ($this->config_write($this->name
, $data) ?
'' : get_string('errorsetting', 'admin'));
3071 * Returns an XHTML checkbox field
3073 * @param string $data If $data matches yes then checkbox is checked
3074 * @param string $query
3075 * @return string XHTML field
3077 public function output_html($data, $query='') {
3080 $context = (object) [
3081 'id' => $this->get_id(),
3082 'name' => $this->get_full_name(),
3084 'value' => $this->yes
,
3085 'checked' => (string) $data === $this->yes
,
3086 'readonly' => $this->is_readonly(),
3089 $default = $this->get_defaultsetting();
3090 if (!is_null($default)) {
3091 if ((string)$default === $this->yes
) {
3092 $defaultinfo = get_string('checkboxyes', 'admin');
3094 $defaultinfo = get_string('checkboxno', 'admin');
3097 $defaultinfo = NULL;
3100 $element = $OUTPUT->render_from_template('core_admin/setting_configcheckbox', $context);
3102 return format_admin_setting($this, $this->visiblename
, $element, $this->description
, true, '', $defaultinfo, $query);
3108 * Multiple checkboxes, each represents different value, stored in csv format
3110 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3112 class admin_setting_configmulticheckbox
extends admin_setting
{
3113 /** @var array Array of choices value=>label */
3115 /** @var callable|null Loader function for choices */
3116 protected $choiceloader = null;
3119 * Constructor: uses parent::__construct
3121 * The $choices parameter may be either an array of $value => $label format,
3122 * e.g. [1 => get_string('yes')], or a callback function which takes no parameters and
3123 * returns an array in that format.
3125 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
3126 * @param string $visiblename localised
3127 * @param string $description long localised info
3128 * @param array $defaultsetting array of selected
3129 * @param array|callable $choices array of $value => $label for each checkbox, or a callback
3131 public function __construct($name, $visiblename, $description, $defaultsetting, $choices) {
3132 if (is_array($choices)) {
3133 $this->choices
= $choices;
3135 if (is_callable($choices)) {
3136 $this->choiceloader
= $choices;
3138 parent
::__construct($name, $visiblename, $description, $defaultsetting);
3142 * This function may be used in ancestors for lazy loading of choices
3144 * Override this method if loading of choices is expensive, such
3145 * as when it requires multiple db requests.
3147 * @return bool true if loaded, false if error
3149 public function load_choices() {
3150 if ($this->choiceloader
) {
3151 if (!is_array($this->choices
)) {
3152 $this->choices
= call_user_func($this->choiceloader
);
3159 * Is setting related to query text - used when searching
3161 * @param string $query
3162 * @return bool true on related, false on not or failure
3164 public function is_related($query) {
3165 if (!$this->load_choices() or empty($this->choices
)) {
3168 if (parent
::is_related($query)) {
3172 foreach ($this->choices
as $desc) {
3173 if (strpos(core_text
::strtolower($desc), $query) !== false) {
3181 * Returns the current setting if it is set
3183 * @return mixed null if null, else an array
3185 public function get_setting() {
3186 $result = $this->config_read($this->name
);
3188 if (is_null($result)) {
3191 if ($result === '') {
3194 $enabled = explode(',', $result);
3196 foreach ($enabled as $option) {
3197 $setting[$option] = 1;
3203 * Saves the setting(s) provided in $data
3205 * @param array $data An array of data, if not array returns empty str
3206 * @return mixed empty string on useless data or bool true=success, false=failed
3208 public function write_setting($data) {
3209 if (!is_array($data)) {
3210 return ''; // ignore it
3212 if (!$this->load_choices() or empty($this->choices
)) {
3215 unset($data['xxxxx']);
3217 foreach ($data as $key => $value) {
3218 if ($value and array_key_exists($key, $this->choices
)) {
3222 return $this->config_write($this->name
, implode(',', $result)) ?
'' : get_string('errorsetting', 'admin');
3226 * Returns XHTML field(s) as required by choices
3228 * Relies on data being an array should data ever be another valid vartype with
3229 * acceptable value this may cause a warning/error
3230 * if (!is_array($data)) would fix the problem
3232 * @todo Add vartype handling to ensure $data is an array
3234 * @param array $data An array of checked values
3235 * @param string $query
3236 * @return string XHTML field
3238 public function output_html($data, $query='') {
3241 if (!$this->load_choices() or empty($this->choices
)) {
3245 $default = $this->get_defaultsetting();
3246 if (is_null($default)) {
3249 if (is_null($data)) {
3253 $context = (object) [
3254 'id' => $this->get_id(),
3255 'name' => $this->get_full_name(),
3259 $defaults = array();
3260 foreach ($this->choices
as $key => $description) {
3261 if (!empty($default[$key])) {
3262 $defaults[] = $description;
3267 'checked' => !empty($data[$key]),
3268 'label' => highlightfast($query, $description)
3272 if (is_null($default)) {
3273 $defaultinfo = null;
3274 } else if (!empty($defaults)) {
3275 $defaultinfo = implode(', ', $defaults);
3277 $defaultinfo = get_string('none');
3280 $context->options
= $options;
3281 $context->hasoptions
= !empty($options);
3283 $element = $OUTPUT->render_from_template('core_admin/setting_configmulticheckbox', $context);
3285 return format_admin_setting($this, $this->visiblename
, $element, $this->description
, false, '', $defaultinfo, $query);
3292 * Multiple checkboxes 2, value stored as string 00101011
3294 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3296 class admin_setting_configmulticheckbox2
extends admin_setting_configmulticheckbox
{
3299 * Returns the setting if set
3301 * @return mixed null if not set, else an array of set settings
3303 public function get_setting() {
3304 $result = $this->config_read($this->name
);
3305 if (is_null($result)) {
3308 if (!$this->load_choices()) {
3311 $result = str_pad($result, count($this->choices
), '0');
3312 $result = preg_split('//', $result, -1, PREG_SPLIT_NO_EMPTY
);
3314 foreach ($this->choices
as $key=>$unused) {
3315 $value = array_shift($result);
3324 * Save setting(s) provided in $data param
3326 * @param array $data An array of settings to save
3327 * @return mixed empty string for bad data or bool true=>success, false=>error
3329 public function write_setting($data) {
3330 if (!is_array($data)) {
3331 return ''; // ignore it
3333 if (!$this->load_choices() or empty($this->choices
)) {
3337 foreach ($this->choices
as $key=>$unused) {
3338 if (!empty($data[$key])) {
3344 return $this->config_write($this->name
, $result) ?
'' : get_string('errorsetting', 'admin');
3350 * Select one value from list
3352 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3354 class admin_setting_configselect
extends admin_setting
{
3355 /** @var array Array of choices value=>label */
3357 /** @var array Array of choices grouped using optgroups */
3359 /** @var callable|null Loader function for choices */
3360 protected $choiceloader = null;
3361 /** @var callable|null Validation function */
3362 protected $validatefunction = null;
3367 * If you want to lazy-load the choices, pass a callback function that returns a choice
3368 * array for the $choices parameter.
3370 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
3371 * @param string $visiblename localised
3372 * @param string $description long localised info
3373 * @param string|int $defaultsetting
3374 * @param array|callable|null $choices array of $value=>$label for each selection, or callback
3376 public function __construct($name, $visiblename, $description, $defaultsetting, $choices) {
3377 // Look for optgroup and single options.
3378 if (is_array($choices)) {
3379 $this->choices
= [];
3380 foreach ($choices as $key => $val) {
3381 if (is_array($val)) {
3382 $this->optgroups
[$key] = $val;
3383 $this->choices
= array_merge($this->choices
, $val);
3385 $this->choices
[$key] = $val;
3389 if (is_callable($choices)) {
3390 $this->choiceloader
= $choices;
3393 parent
::__construct($name, $visiblename, $description, $defaultsetting);
3397 * Sets a validate function.
3399 * The callback will be passed one parameter, the new setting value, and should return either
3400 * an empty string '' if the value is OK, or an error message if not.
3402 * @param callable|null $validatefunction Validate function or null to clear
3403 * @since Moodle 3.10
3405 public function set_validate_function(?callable
$validatefunction = null) {
3406 $this->validatefunction
= $validatefunction;
3410 * This function may be used in ancestors for lazy loading of choices
3412 * Override this method if loading of choices is expensive, such
3413 * as when it requires multiple db requests.
3415 * @return bool true if loaded, false if error
3417 public function load_choices() {
3418 if ($this->choiceloader
) {
3419 if (!is_array($this->choices
)) {
3420 $this->choices
= call_user_func($this->choiceloader
);
3428 * Check if this is $query is related to a choice
3430 * @param string $query
3431 * @return bool true if related, false if not
3433 public function is_related($query) {
3434 if (parent
::is_related($query)) {
3437 if (!$this->load_choices()) {
3440 foreach ($this->choices
as $key=>$value) {
3441 if (strpos(core_text
::strtolower($key), $query) !== false) {
3444 if (strpos(core_text
::strtolower($value), $query) !== false) {
3452 * Return the setting
3454 * @return mixed returns config if successful else null
3456 public function get_setting() {
3457 return $this->config_read($this->name
);
3463 * @param string $data
3464 * @return string empty of error string
3466 public function write_setting($data) {
3467 if (!$this->load_choices() or empty($this->choices
)) {
3470 if (!array_key_exists($data, $this->choices
)) {
3471 return ''; // ignore it
3474 // Validate the new setting.
3475 $error = $this->validate_setting($data);
3480 return ($this->config_write($this->name
, $data) ?
'' : get_string('errorsetting', 'admin'));
3484 * Validate the setting. This uses the callback function if provided; subclasses could override
3485 * to carry out validation directly in the class.
3487 * @param string $data New value being set
3488 * @return string Empty string if valid, or error message text
3489 * @since Moodle 3.10
3491 protected function validate_setting(string $data): string {
3492 // If validation function is specified, call it now.
3493 if ($this->validatefunction
) {
3494 return call_user_func($this->validatefunction
, $data);
3501 * Returns XHTML select field
3503 * Ensure the options are loaded, and generate the XHTML for the select
3504 * element and any warning message. Separating this out from output_html
3505 * makes it easier to subclass this class.
3507 * @param string $data the option to show as selected.
3508 * @param string $current the currently selected option in the database, null if none.
3509 * @param string $default the default selected option.
3510 * @return array the HTML for the select element, and a warning message.
3511 * @deprecated since Moodle 3.2
3513 public function output_select_html($data, $current, $default, $extraname = '') {
3514 debugging('The method admin_setting_configselect::output_select_html is depreacted, do not use any more.', DEBUG_DEVELOPER
);
3518 * Returns XHTML select field and wrapping div(s)
3520 * @see output_select_html()
3522 * @param string $data the option to show as selected
3523 * @param string $query
3524 * @return string XHTML field and wrapping div
3526 public function output_html($data, $query='') {
3529 $default = $this->get_defaultsetting();
3530 $current = $this->get_setting();
3532 if (!$this->load_choices() ||
empty($this->choices
)) {
3536 $context = (object) [
3537 'id' => $this->get_id(),
3538 'name' => $this->get_full_name(),
3541 if (!is_null($default) && array_key_exists($default, $this->choices
)) {
3542 $defaultinfo = $this->choices
[$default];
3544 $defaultinfo = NULL;
3549 if ($current === null) {
3551 } else if (empty($current) && (array_key_exists('', $this->choices
) ||
array_key_exists(0, $this->choices
))) {
3553 } else if (!array_key_exists($current, $this->choices
)) {
3554 $warning = get_string('warningcurrentsetting', 'admin', $current);
3555 if (!is_null($default) && $data == $current) {
3556 $data = $default; // Use default instead of first value when showing the form.
3561 $template = 'core_admin/setting_configselect';
3563 if (!empty($this->optgroups
)) {
3565 foreach ($this->optgroups
as $label => $choices) {
3566 $optgroup = array('label' => $label, 'options' => []);
3567 foreach ($choices as $value => $name) {
3568 $optgroup['options'][] = [
3571 'selected' => (string) $value == $data
3573 unset($this->choices
[$value]);
3575 $optgroups[] = $optgroup;
3577 $context->options
= $options;
3578 $context->optgroups
= $optgroups;
3579 $template = 'core_admin/setting_configselect_optgroup';
3582 foreach ($this->choices
as $value => $name) {
3586 'selected' => (string) $value == $data
3589 $context->options
= $options;
3590 $context->readonly
= $this->is_readonly();
3592 $element = $OUTPUT->render_from_template($template, $context);
3594 return format_admin_setting($this, $this->visiblename
, $element, $this->description
, true, $warning, $defaultinfo, $query);
3599 * Select multiple items from list
3601 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3603 class admin_setting_configmultiselect
extends admin_setting_configselect
{
3606 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
3607 * @param string $visiblename localised
3608 * @param string $description long localised info
3609 * @param array $defaultsetting array of selected items
3610 * @param array $choices array of $value=>$label for each list item
3612 public function __construct($name, $visiblename, $description, $defaultsetting, $choices) {
3613 parent
::__construct($name, $visiblename, $description, $defaultsetting, $choices);
3617 * Returns the select setting(s)
3619 * @return mixed null or array. Null if no settings else array of setting(s)
3621 public function get_setting() {
3622 $result = $this->config_read($this->name
);
3623 if (is_null($result)) {
3626 if ($result === '') {
3629 return explode(',', $result);
3633 * Saves setting(s) provided through $data
3635 * Potential bug in the works should anyone call with this function
3636 * using a vartype that is not an array
3638 * @param array $data
3640 public function write_setting($data) {
3641 if (!is_array($data)) {
3642 return ''; //ignore it
3644 if (!$this->load_choices() or empty($this->choices
)) {
3648 unset($data['xxxxx']);
3651 foreach ($data as $value) {
3652 if (!array_key_exists($value, $this->choices
)) {
3653 continue; // ignore it
3658 return ($this->config_write($this->name
, implode(',', $save)) ?
'' : get_string('errorsetting', 'admin'));
3662 * Is setting related to query text - used when searching
3664 * @param string $query
3665 * @return bool true if related, false if not
3667 public function is_related($query) {
3668 if (!$this->load_choices() or empty($this->choices
)) {
3671 if (parent
::is_related($query)) {
3675 foreach ($this->choices
as $desc) {
3676 if (strpos(core_text
::strtolower($desc), $query) !== false) {
3684 * Returns XHTML multi-select field
3686 * @todo Add vartype handling to ensure $data is an array
3687 * @param array $data Array of values to select by default
3688 * @param string $query
3689 * @return string XHTML multi-select field
3691 public function output_html($data, $query='') {
3694 if (!$this->load_choices() or empty($this->choices
)) {
3698 $default = $this->get_defaultsetting();
3699 if (is_null($default)) {
3702 if (is_null($data)) {
3706 $context = (object) [
3707 'id' => $this->get_id(),
3708 'name' => $this->get_full_name(),
3709 'size' => min(10, count($this->choices
))
3714 $template = 'core_admin/setting_configmultiselect';
3716 if (!empty($this->optgroups
)) {
3718 foreach ($this->optgroups
as $label => $choices) {
3719 $optgroup = array('label' => $label, 'options' => []);
3720 foreach ($choices as $value => $name) {
3721 if (in_array($value, $default)) {
3722 $defaults[] = $name;
3724 $optgroup['options'][] = [
3727 'selected' => in_array($value, $data)
3729 unset($this->choices
[$value]);
3731 $optgroups[] = $optgroup;
3733 $context->optgroups
= $optgroups;
3734 $template = 'core_admin/setting_configmultiselect_optgroup';
3737 foreach ($this->choices
as $value => $name) {
3738 if (in_array($value, $default)) {
3739 $defaults[] = $name;
3744 'selected' => in_array($value, $data)
3747 $context->options
= $options;
3748 $context->readonly
= $this->is_readonly();
3750 if (is_null($default)) {
3751 $defaultinfo = NULL;
3752 } if (!empty($defaults)) {
3753 $defaultinfo = implode(', ', $defaults);
3755 $defaultinfo = get_string('none');
3758 $element = $OUTPUT->render_from_template($template, $context);
3760 return format_admin_setting($this, $this->visiblename
, $element, $this->description
, true, '', $defaultinfo, $query);
3767 * This is a liiitle bit messy. we're using two selects, but we're returning
3768 * them as an array named after $name (so we only use $name2 internally for the setting)
3770 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3772 class admin_setting_configtime
extends admin_setting
{
3773 /** @var string Used for setting second select (minutes) */
3778 * @param string $hoursname setting for hours
3779 * @param string $minutesname setting for hours
3780 * @param string $visiblename localised
3781 * @param string $description long localised info
3782 * @param array $defaultsetting array representing default time 'h'=>hours, 'm'=>minutes
3784 public function __construct($hoursname, $minutesname, $visiblename, $description, $defaultsetting) {
3785 $this->name2
= $minutesname;
3786 parent
::__construct($hoursname, $visiblename, $description, $defaultsetting);
3790 * Get the selected time
3792 * @return mixed An array containing 'h'=>xx, 'm'=>xx, or null if not set
3794 public function get_setting() {
3795 $result1 = $this->config_read($this->name
);
3796 $result2 = $this->config_read($this->name2
);
3797 if (is_null($result1) or is_null($result2)) {
3801 return array('h' => $result1, 'm' => $result2);
3805 * Store the time (hours and minutes)
3807 * @param array $data Must be form 'h'=>xx, 'm'=>xx
3808 * @return bool true if success, false if not
3810 public function write_setting($data) {
3811 if (!is_array($data)) {
3815 $result = $this->config_write($this->name
, (int)$data['h']) && $this->config_write($this->name2
, (int)$data['m']);
3816 return ($result ?
'' : get_string('errorsetting', 'admin'));
3820 * Returns XHTML time select fields
3822 * @param array $data Must be form 'h'=>xx, 'm'=>xx
3823 * @param string $query
3824 * @return string XHTML time select fields and wrapping div(s)
3826 public function output_html($data, $query='') {
3829 $default = $this->get_defaultsetting();
3830 if (is_array($default)) {
3831 $defaultinfo = $default['h'].':'.$default['m'];
3833 $defaultinfo = NULL;
3836 $context = (object) [
3837 'id' => $this->get_id(),
3838 'name' => $this->get_full_name(),
3839 'readonly' => $this->is_readonly(),
3840 'hours' => array_map(function($i) use ($data) {
3844 'selected' => $i == $data['h']
3847 'minutes' => array_map(function($i) use ($data) {
3851 'selected' => $i == $data['m']
3856 $element = $OUTPUT->render_from_template('core_admin/setting_configtime', $context);
3858 return format_admin_setting($this, $this->visiblename
, $element, $this->description
,
3859 $this->get_id() . 'h', '', $defaultinfo, $query);
3866 * Seconds duration setting.
3868 * @copyright 2012 Petr Skoda (http://skodak.org)
3869 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3871 class admin_setting_configduration
extends admin_setting
{
3873 /** @var int default duration unit */
3874 protected $defaultunit;
3875 /** @var callable|null Validation function */
3876 protected $validatefunction = null;
3880 * @param string $name unique ascii name, either 'mysetting' for settings that in config,
3881 * or 'myplugin/mysetting' for ones in config_plugins.
3882 * @param string $visiblename localised name
3883 * @param string $description localised long description
3884 * @param mixed $defaultsetting string or array depending on implementation
3885 * @param int $defaultunit - day, week, etc. (in seconds)
3887 public function __construct($name, $visiblename, $description, $defaultsetting, $defaultunit = 86400) {
3888 if (is_number($defaultsetting)) {
3889 $defaultsetting = self
::parse_seconds($defaultsetting);
3891 $units = self
::get_units();
3892 if (isset($units[$defaultunit])) {
3893 $this->defaultunit
= $defaultunit;
3895 $this->defaultunit
= 86400;
3897 parent
::__construct($name, $visiblename, $description, $defaultsetting);
3901 * Sets a validate function.
3903 * The callback will be passed one parameter, the new setting value, and should return either
3904 * an empty string '' if the value is OK, or an error message if not.
3906 * @param callable|null $validatefunction Validate function or null to clear
3907 * @since Moodle 3.10
3909 public function set_validate_function(?callable
$validatefunction = null) {
3910 $this->validatefunction
= $validatefunction;
3914 * Validate the setting. This uses the callback function if provided; subclasses could override
3915 * to carry out validation directly in the class.
3917 * @param int $data New value being set
3918 * @return string Empty string if valid, or error message text
3919 * @since Moodle 3.10
3921 protected function validate_setting(int $data): string {
3922 // If validation function is specified, call it now.
3923 if ($this->validatefunction
) {
3924 return call_user_func($this->validatefunction
, $data);
3927 return get_string('errorsetting', 'admin');
3934 * Returns selectable units.
3938 protected static function get_units() {
3940 604800 => get_string('weeks'),
3941 86400 => get_string('days'),
3942 3600 => get_string('hours'),
3943 60 => get_string('minutes'),
3944 1 => get_string('seconds'),
3949 * Converts seconds to some more user friendly string.
3951 * @param int $seconds
3954 protected static function get_duration_text($seconds) {
3955 if (empty($seconds)) {
3956 return get_string('none');
3958 $data = self
::parse_seconds($seconds);
3959 switch ($data['u']) {
3961 return get_string('numweeks', '', $data['v']);
3963 return get_string('numdays', '', $data['v']);
3965 return get_string('numhours', '', $data['v']);
3967 return get_string('numminutes', '', $data['v']);
3969 return get_string('numseconds', '', $data['v']*$data['u']);
3974 * Finds suitable units for given duration.
3976 * @param int $seconds
3979 protected static function parse_seconds($seconds) {
3980 foreach (self
::get_units() as $unit => $unused) {
3981 if ($seconds %
$unit === 0) {
3982 return array('v'=>(int)($seconds/$unit), 'u'=>$unit);
3985 return array('v'=>(int)$seconds, 'u'=>1);
3989 * Get the selected duration as array.
3991 * @return mixed An array containing 'v'=>xx, 'u'=>xx, or null if not set
3993 public function get_setting() {
3994 $seconds = $this->config_read($this->name
);
3995 if (is_null($seconds)) {
3999 return self
::parse_seconds($seconds);
4003 * Store the duration as seconds.
4005 * @param array $data Must be form 'h'=>xx, 'm'=>xx
4006 * @return bool true if success, false if not
4008 public function write_setting($data) {
4009 if (!is_array($data)) {
4013 $unit = (int)$data['u'];
4014 $value = (int)$data['v'];
4015 $seconds = $value * $unit;
4017 // Validate the new setting.
4018 $error = $this->validate_setting($seconds);
4023 $result = $this->config_write($this->name
, $seconds);
4024 return ($result ?
'' : get_string('errorsetting', 'admin'));
4028 * Returns duration text+select fields.
4030 * @param array $data Must be form 'v'=>xx, 'u'=>xx
4031 * @param string $query
4032 * @return string duration text+select fields and wrapping div(s)
4034 public function output_html($data, $query='') {
4037 $default = $this->get_defaultsetting();
4038 if (is_number($default)) {
4039 $defaultinfo = self
::get_duration_text($default);
4040 } else if (is_array($default)) {
4041 $defaultinfo = self
::get_duration_text($default['v']*$default['u']);
4043 $defaultinfo = null;
4046 $inputid = $this->get_id() . 'v';
4047 $units = self
::get_units();
4048 $defaultunit = $this->defaultunit
;
4050 $context = (object) [
4051 'id' => $this->get_id(),
4052 'name' => $this->get_full_name(),
4053 'value' => $data['v'],
4054 'readonly' => $this->is_readonly(),
4055 'options' => array_map(function($unit) use ($units, $data, $defaultunit) {
4058 'name' => $units[$unit],
4059 'selected' => ($data['v'] == 0 && $unit == $defaultunit) ||
$unit == $data['u']
4061 }, array_keys($units))
4064 $element = $OUTPUT->render_from_template('core_admin/setting_configduration', $context);
4066 return format_admin_setting($this, $this->visiblename
, $element, $this->description
, $inputid, '', $defaultinfo, $query);
4072 * Seconds duration setting with an advanced checkbox, that controls a additional
4073 * $name.'_adv' setting.
4075 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4076 * @copyright 2014 The Open University
4078 class admin_setting_configduration_with_advanced
extends admin_setting_configduration
{
4081 * @param string $name unique ascii name, either 'mysetting' for settings that in config,
4082 * or 'myplugin/mysetting' for ones in config_plugins.
4083 * @param string $visiblename localised name
4084 * @param string $description localised long description
4085 * @param array $defaultsetting array of int value, and bool whether it is
4086 * is advanced by default.
4087 * @param int $defaultunit - day, week, etc. (in seconds)
4089 public function __construct($name, $visiblename, $description, $defaultsetting, $defaultunit = 86400) {
4090 parent
::__construct($name, $visiblename, $description, $defaultsetting['value'], $defaultunit);
4091 $this->set_advanced_flag_options(admin_setting_flag
::ENABLED
, !empty($defaultsetting['adv']));
4097 * Used to validate a textarea used for ip addresses
4099 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4100 * @copyright 2011 Petr Skoda (http://skodak.org)
4102 class admin_setting_configiplist
extends admin_setting_configtextarea
{
4105 * Validate the contents of the textarea as IP addresses
4107 * Used to validate a new line separated list of IP addresses collected from
4108 * a textarea control
4110 * @param string $data A list of IP Addresses separated by new lines
4111 * @return mixed bool true for success or string:error on failure
4113 public function validate($data) {
4115 $lines = explode("\n", $data);
4121 foreach ($lines as $line) {
4122 $tokens = explode('#', $line);
4123 $ip = trim($tokens[0]);
4127 if (preg_match('#^(\d{1,3})(\.\d{1,3}){0,3}$#', $ip, $match) ||
4128 preg_match('#^(\d{1,3})(\.\d{1,3}){0,3}(\/\d{1,2})$#', $ip, $match) ||
4129 preg_match('#^(\d{1,3})(\.\d{1,3}){3}(-\d{1,3})$#', $ip, $match)) {
4138 return get_string('validateiperror', 'admin', join(', ', $badips));
4144 * Used to validate a textarea used for domain names, wildcard domain names and IP addresses/ranges (both IPv4 and IPv6 format).
4146 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4147 * @copyright 2016 Jake Dallimore (jrhdallimore@gmail.com)
4149 class admin_setting_configmixedhostiplist
extends admin_setting_configtextarea
{
4152 * Validate the contents of the textarea as either IP addresses, domain name or wildcard domain name (RFC 4592).
4153 * Used to validate a new line separated list of entries collected from a textarea control.
4155 * This setting provides support for internationalised domain names (IDNs), however, such UTF-8 names will be converted to
4156 * their ascii-compatible encoding (punycode) on save, and converted back to their UTF-8 representation when fetched
4157 * via the get_setting() method, which has been overriden.
4159 * @param string $data A list of FQDNs, DNS wildcard format domains, and IP addresses, separated by new lines.
4160 * @return mixed bool true for success or string:error on failure
4162 public function validate($data) {
4166 $entries = explode("\n", $data);
4169 foreach ($entries as $key => $entry) {
4170 $entry = trim($entry);
4171 if (empty($entry)) {
4172 return get_string('validateemptylineerror', 'admin');
4175 // Validate each string entry against the supported formats.
4176 if (\core\ip_utils
::is_ip_address($entry) || \core\ip_utils
::is_ipv6_range($entry)
4177 || \core\ip_utils
::is_ipv4_range($entry) || \core\ip_utils
::is_domain_name($entry)
4178 || \core\ip_utils
::is_domain_matching_pattern($entry)) {
4182 // Otherwise, the entry is invalid.
4183 $badentries[] = $entry;
4187 return get_string('validateerrorlist', 'admin', join(', ', $badentries));
4193 * Convert any lines containing international domain names (IDNs) to their ascii-compatible encoding (ACE).
4195 * @param string $data the setting data, as sent from the web form.
4196 * @return string $data the setting data, with all IDNs converted (using punycode) to their ascii encoded version.
4198 protected function ace_encode($data) {
4202 $entries = explode("\n", $data);
4203 foreach ($entries as $key => $entry) {
4204 $entry = trim($entry);
4205 // This regex matches any string that has non-ascii character.
4206 if (preg_match('/[^\x00-\x7f]/', $entry)) {
4207 // If we can convert the unicode string to an idn, do so.
4208 // Otherwise, leave the original unicode string alone and let the validation function handle it (it will fail).
4209 $val = idn_to_ascii($entry, IDNA_NONTRANSITIONAL_TO_ASCII
, INTL_IDNA_VARIANT_UTS46
);
4210 $entries[$key] = $val ?
$val : $entry;
4213 return implode("\n", $entries);
4217 * Decode any ascii-encoded domain names back to their utf-8 representation for display.
4219 * @param string $data the setting data, as found in the database.
4220 * @return string $data the setting data, with all ascii-encoded IDNs decoded back to their utf-8 representation.
4222 protected function ace_decode($data) {
4223 $entries = explode("\n", $data);
4224 foreach ($entries as $key => $entry) {
4225 $entry = trim($entry);
4226 if (strpos($entry, 'xn--') !== false) {
4227 $entries[$key] = idn_to_utf8($entry, IDNA_NONTRANSITIONAL_TO_ASCII
, INTL_IDNA_VARIANT_UTS46
);
4230 return implode("\n", $entries);
4234 * Override, providing utf8-decoding for ascii-encoded IDN strings.
4236 * @return mixed returns punycode-converted setting string if successful, else null.
4238 public function get_setting() {
4239 // Here, we need to decode any ascii-encoded IDNs back to their native, utf-8 representation.
4240 $data = $this->config_read($this->name
);
4241 if (function_exists('idn_to_utf8') && !is_null($data)) {
4242 $data = $this->ace_decode($data);
4248 * Override, providing ascii-encoding for utf8 (native) IDN strings.
4250 * @param string $data
4253 public function write_setting($data) {
4254 if ($this->paramtype
=== PARAM_INT
and $data === '') {
4255 // Do not complain if '' used instead of 0.
4259 // Try to convert any non-ascii domains to ACE prior to validation - we can't modify anything in validate!
4260 if (function_exists('idn_to_ascii')) {
4261 $data = $this->ace_encode($data);
4264 $validated = $this->validate($data);
4265 if ($validated !== true) {
4268 return ($this->config_write($this->name
, $data) ?
'' : get_string('errorsetting', 'admin'));
4273 * Used to validate a textarea used for port numbers.
4275 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4276 * @copyright 2016 Jake Dallimore (jrhdallimore@gmail.com)
4278 class admin_setting_configportlist
extends admin_setting_configtextarea
{
4281 * Validate the contents of the textarea as port numbers.
4282 * Used to validate a new line separated list of ports collected from a textarea control.
4284 * @param string $data A list of ports separated by new lines
4285 * @return mixed bool true for success or string:error on failure
4287 public function validate($data) {
4291 $ports = explode("\n", $data);
4293 foreach ($ports as $port) {
4294 $port = trim($port);
4296 return get_string('validateemptylineerror', 'admin');
4299 // Is the string a valid integer number?
4300 if (strval(intval($port)) !== $port ||
intval($port) <= 0) {
4301 $badentries[] = $port;
4305 return get_string('validateerrorlist', 'admin', $badentries);
4313 * An admin setting for selecting one or more users who have a capability
4314 * in the system context
4316 * An admin setting for selecting one or more users, who have a particular capability
4317 * in the system context. Warning, make sure the list will never be too long. There is
4318 * no paging or searching of this list.
4320 * To correctly get a list of users from this config setting, you need to call the
4321 * get_users_from_config($CFG->mysetting, $capability); function in moodlelib.php.
4323 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4325 class admin_setting_users_with_capability
extends admin_setting_configmultiselect
{
4326 /** @var string The capabilities name */
4327 protected $capability;
4328 /** @var int include admin users too */
4329 protected $includeadmins;
4334 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
4335 * @param string $visiblename localised name
4336 * @param string $description localised long description
4337 * @param array $defaultsetting array of usernames
4338 * @param string $capability string capability name.
4339 * @param bool $includeadmins include administrators
4341 function __construct($name, $visiblename, $description, $defaultsetting, $capability, $includeadmins = true) {
4342 $this->capability
= $capability;
4343 $this->includeadmins
= $includeadmins;
4344 parent
::__construct($name, $visiblename, $description, $defaultsetting, NULL);
4348 * Load all of the uses who have the capability into choice array
4350 * @return bool Always returns true
4352 function load_choices() {
4353 if (is_array($this->choices
)) {
4356 list($sort, $sortparams) = users_order_by_sql('u');
4357 if (!empty($sortparams)) {
4358 throw new coding_exception('users_order_by_sql returned some query parameters. ' .
4359 'This is unexpected, and a problem because there is no way to pass these ' .
4360 'parameters to get_users_by_capability. See MDL-34657.');
4362 $userfieldsapi = \core_user\fields
::for_name();
4363 $userfields = 'u.id, u.username, ' . $userfieldsapi->get_sql('u', false, '', '', false)->selects
;
4364 $users = get_users_by_capability(context_system
::instance(), $this->capability
, $userfields, $sort);
4365 $this->choices
= array(
4366 '$@NONE@$' => get_string('nobody'),
4367 '$@ALL@$' => get_string('everyonewhocan', 'admin', get_capability_string($this->capability
)),
4369 if ($this->includeadmins
) {
4370 $admins = get_admins();
4371 foreach ($admins as $user) {
4372 $this->choices
[$user->id
] = fullname($user);
4375 if (is_array($users)) {
4376 foreach ($users as $user) {
4377 $this->choices
[$user->id
] = fullname($user);
4384 * Returns the default setting for class
4386 * @return mixed Array, or string. Empty string if no default
4388 public function get_defaultsetting() {
4389 $this->load_choices();
4390 $defaultsetting = parent
::get_defaultsetting();
4391 if (empty($defaultsetting)) {
4392 return array('$@NONE@$');
4393 } else if (array_key_exists($defaultsetting, $this->choices
)) {
4394 return $defaultsetting;
4401 * Returns the current setting
4403 * @return mixed array or string
4405 public function get_setting() {
4406 $result = parent
::get_setting();
4407 if ($result === null) {
4408 // this is necessary for settings upgrade
4411 if (empty($result)) {
4412 $result = array('$@NONE@$');
4418 * Save the chosen setting provided as $data
4420 * @param array $data
4421 * @return mixed string or array
4423 public function write_setting($data) {
4424 // If all is selected, remove any explicit options.
4425 if (in_array('$@ALL@$', $data)) {
4426 $data = array('$@ALL@$');
4428 // None never needs to be written to the DB.
4429 if (in_array('$@NONE@$', $data)) {
4430 unset($data[array_search('$@NONE@$', $data)]);
4432 return parent
::write_setting($data);
4438 * Special checkbox for calendar - resets SESSION vars.
4440 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4442 class admin_setting_special_adminseesall
extends admin_setting_configcheckbox
{
4444 * Calls the parent::__construct with default values
4446 * name => calendar_adminseesall
4447 * visiblename => get_string('adminseesall', 'admin')
4448 * description => get_string('helpadminseesall', 'admin')
4449 * defaultsetting => 0
4451 public function __construct() {
4452 parent
::__construct('calendar_adminseesall', get_string('adminseesall', 'admin'),
4453 get_string('helpadminseesall', 'admin'), '0');
4457 * Stores the setting passed in $data
4459 * @param mixed gets converted to string for comparison
4460 * @return string empty string or error message
4462 public function write_setting($data) {
4464 return parent
::write_setting($data);
4469 * Special select for settings that are altered in setup.php and can not be altered on the fly
4471 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4473 class admin_setting_special_selectsetup
extends admin_setting_configselect
{
4475 * Reads the setting directly from the database
4479 public function get_setting() {
4480 // read directly from db!
4481 return get_config(NULL, $this->name
);
4485 * Save the setting passed in $data
4487 * @param string $data The setting to save
4488 * @return string empty or error message
4490 public function write_setting($data) {
4492 // do not change active CFG setting!
4493 $current = $CFG->{$this->name
};
4494 $result = parent
::write_setting($data);
4495 $CFG->{$this->name
} = $current;
4502 * Special select for frontpage - stores data in course table
4504 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4506 class admin_setting_sitesetselect
extends admin_setting_configselect
{
4508 * Returns the site name for the selected site
4511 * @return string The site name of the selected site
4513 public function get_setting() {
4514 $site = course_get_format(get_site())->get_course();
4515 return $site->{$this->name
};
4519 * Updates the database and save the setting
4521 * @param string data
4522 * @return string empty or error message
4524 public function write_setting($data) {
4525 global $DB, $SITE, $COURSE;
4526 if (!in_array($data, array_keys($this->choices
))) {
4527 return get_string('errorsetting', 'admin');
4529 $record = new stdClass();
4530 $record->id
= SITEID
;
4531 $temp = $this->name
;
4532 $record->$temp = $data;
4533 $record->timemodified
= time();
4535 course_get_format($SITE)->update_course_format_options($record);
4536 $DB->update_record('course', $record);
4539 $SITE = $DB->get_record('course', array('id'=>$SITE->id
), '*', MUST_EXIST
);
4540 if ($SITE->id
== $COURSE->id
) {
4543 core_courseformat\base
::reset_course_cache($SITE->id
);
4552 * Select for blog's bloglevel setting: if set to 0, will set blog_menu
4555 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4557 class admin_setting_bloglevel
extends admin_setting_configselect
{
4559 * Updates the database and save the setting
4561 * @param string data
4562 * @return string empty or error message
4564 public function write_setting($data) {
4567 $blogblocks = $DB->get_records_select('block', "name LIKE 'blog_%' AND visible = 1");
4568 foreach ($blogblocks as $block) {
4569 $DB->set_field('block', 'visible', 0, array('id' => $block->id
));
4572 // reenable all blocks only when switching from disabled blogs
4573 if (isset($CFG->bloglevel
) and $CFG->bloglevel
== 0) {
4574 $blogblocks = $DB->get_records_select('block', "name LIKE 'blog_%' AND visible = 0");
4575 foreach ($blogblocks as $block) {
4576 $DB->set_field('block', 'visible', 1, array('id' => $block->id
));
4580 return parent
::write_setting($data);
4586 * Special select - lists on the frontpage - hacky
4588 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4590 class admin_setting_courselist_frontpage
extends admin_setting
{
4591 /** @var array Array of choices value=>label */
4595 * Construct override, requires one param
4597 * @param bool $loggedin Is the user logged in
4599 public function __construct($loggedin) {
4601 require_once($CFG->dirroot
.'/course/lib.php');
4602 $name = 'frontpage'.($loggedin ?
'loggedin' : '');
4603 $visiblename = get_string('frontpage'.($loggedin ?
'loggedin' : ''),'admin');
4604 $description = get_string('configfrontpage'.($loggedin ?
'loggedin' : ''),'admin');
4605 $defaults = array(FRONTPAGEALLCOURSELIST
);
4606 parent
::__construct($name, $visiblename, $description, $defaults);
4610 * Loads the choices available
4612 * @return bool always returns true
4614 public function load_choices() {
4615 if (is_array($this->choices
)) {
4618 $this->choices
= array(FRONTPAGENEWS
=> get_string('frontpagenews'),
4619 FRONTPAGEALLCOURSELIST
=> get_string('frontpagecourselist'),
4620 FRONTPAGEENROLLEDCOURSELIST
=> get_string('frontpageenrolledcourselist'),
4621 FRONTPAGECATEGORYNAMES
=> get_string('frontpagecategorynames'),
4622 FRONTPAGECATEGORYCOMBO
=> get_string('frontpagecategorycombo'),
4623 FRONTPAGECOURSESEARCH
=> get_string('frontpagecoursesearch'),
4624 'none' => get_string('none'));
4625 if ($this->name
=== 'frontpage') {
4626 unset($this->choices
[FRONTPAGEENROLLEDCOURSELIST
]);
4632 * Returns the selected settings
4634 * @param mixed array or setting or null
4636 public function get_setting() {
4637 $result = $this->config_read($this->name
);
4638 if (is_null($result)) {
4641 if ($result === '') {
4644 return explode(',', $result);
4648 * Save the selected options
4650 * @param array $data
4651 * @return mixed empty string (data is not an array) or bool true=success false=failure
4653 public function write_setting($data) {
4654 if (!is_array($data)) {
4657 $this->load_choices();
4659 foreach($data as $datum) {
4660 if ($datum == 'none' or !array_key_exists($datum, $this->choices
)) {
4663 $save[$datum] = $datum; // no duplicates
4665 return ($this->config_write($this->name
, implode(',', $save)) ?
'' : get_string('errorsetting', 'admin'));
4669 * Return XHTML select field and wrapping div
4671 * @todo Add vartype handling to make sure $data is an array
4672 * @param array $data Array of elements to select by default
4673 * @return string XHTML select field and wrapping div
4675 public function output_html($data, $query='') {
4678 $this->load_choices();
4679 $currentsetting = array();
4680 foreach ($data as $key) {
4681 if ($key != 'none' and array_key_exists($key, $this->choices
)) {
4682 $currentsetting[] = $key; // already selected first
4686 $context = (object) [
4687 'id' => $this->get_id(),
4688 'name' => $this->get_full_name(),
4691 $options = $this->choices
;
4693 for ($i = 0; $i < count($this->choices
) - 1; $i++
) {
4694 if (!array_key_exists($i, $currentsetting)) {
4695 $currentsetting[$i] = 'none';
4699 'options' => array_map(function($option) use ($options, $currentsetting, $i) {
4701 'name' => $options[$option],
4703 'selected' => $currentsetting[$i] == $option
4705 }, array_keys($options))
4708 $context->selects
= $selects;
4710 $element = $OUTPUT->render_from_template('core_admin/setting_courselist_frontpage', $context);
4712 return format_admin_setting($this, $this->visiblename
, $element, $this->description
, false, '', null, $query);
4718 * Special checkbox for frontpage - stores data in course table
4720 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4722 class admin_setting_sitesetcheckbox
extends admin_setting_configcheckbox
{
4724 * Returns the current sites name
4728 public function get_setting() {
4729 $site = course_get_format(get_site())->get_course();
4730 return $site->{$this->name
};
4734 * Save the selected setting
4736 * @param string $data The selected site
4737 * @return string empty string or error message
4739 public function write_setting($data) {
4740 global $DB, $SITE, $COURSE;
4741 $record = new stdClass();
4742 $record->id
= $SITE->id
;
4743 $record->{$this->name
} = ($data == '1' ?
1 : 0);
4744 $record->timemodified
= time();
4746 course_get_format($SITE)->update_course_format_options($record);
4747 $DB->update_record('course', $record);
4750 $SITE = $DB->get_record('course', array('id'=>$SITE->id
), '*', MUST_EXIST
);
4751 if ($SITE->id
== $COURSE->id
) {
4754 core_courseformat\base
::reset_course_cache($SITE->id
);
4761 * Special text for frontpage - stores data in course table.
4762 * Empty string means not set here. Manual setting is required.
4764 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4766 class admin_setting_sitesettext
extends admin_setting_configtext
{
4771 public function __construct() {
4772 call_user_func_array(['parent', '__construct'], func_get_args());
4773 $this->set_force_ltr(false);
4777 * Return the current setting
4779 * @return mixed string or null
4781 public function get_setting() {
4782 $site = course_get_format(get_site())->get_course();
4783 return $site->{$this->name
} != '' ?
$site->{$this->name
} : NULL;
4787 * Validate the selected data
4789 * @param string $data The selected value to validate
4790 * @return mixed true or message string
4792 public function validate($data) {
4794 $cleaned = clean_param($data, PARAM_TEXT
);
4795 if ($cleaned === '') {
4796 return get_string('required');
4798 if ($this->name
==='shortname' &&
4799 $DB->record_exists_sql('SELECT id from {course} WHERE shortname = ? AND id <> ?', array($data, $SITE->id
))) {
4800 return get_string('shortnametaken', 'error', $data);
4802 if ("$data" == "$cleaned") { // implicit conversion to string is needed to do exact comparison
4805 return get_string('validateerror', 'admin');
4810 * Save the selected setting
4812 * @param string $data The selected value
4813 * @return string empty or error message
4815 public function write_setting($data) {
4816 global $DB, $SITE, $COURSE;
4817 $data = trim($data);
4818 $validated = $this->validate($data);
4819 if ($validated !== true) {
4823 $record = new stdClass();
4824 $record->id
= $SITE->id
;
4825 $record->{$this->name
} = $data;
4826 $record->timemodified
= time();
4828 course_get_format($SITE)->update_course_format_options($record);
4829 $DB->update_record('course', $record);
4832 $SITE = $DB->get_record('course', array('id'=>$SITE->id
), '*', MUST_EXIST
);
4833 if ($SITE->id
== $COURSE->id
) {
4836 core_courseformat\base
::reset_course_cache($SITE->id
);
4844 * This type of field should be used for mandatory config settings.
4846 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4848 class admin_setting_requiredtext
extends admin_setting_configtext
{
4851 * Validate data before storage.
4853 * @param string $data The string to be validated.
4854 * @return bool|string true for success or error string if invalid.
4856 public function validate($data) {
4857 $cleaned = clean_param($data, PARAM_TEXT
);
4858 if ($cleaned === '') {
4859 return get_string('required');
4862 return parent
::validate($data);
4867 * Special text editor for site description.
4869 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4871 class admin_setting_special_frontpagedesc
extends admin_setting_confightmleditor
{
4874 * Calls parent::__construct with specific arguments
4876 public function __construct() {
4877 parent
::__construct('summary', get_string('frontpagedescription'), get_string('frontpagedescriptionhelp'), null,
4882 * Return the current setting
4883 * @return string The current setting
4885 public function get_setting() {
4886 $site = course_get_format(get_site())->get_course();
4887 return $site->{$this->name
};
4891 * Save the new setting
4893 * @param string $data The new value to save
4894 * @return string empty or error message
4896 public function write_setting($data) {
4897 global $DB, $SITE, $COURSE;
4898 $record = new stdClass();
4899 $record->id
= $SITE->id
;
4900 $record->{$this->name
} = $data;
4901 $record->timemodified
= time();
4903 course_get_format($SITE)->update_course_format_options($record);
4904 $DB->update_record('course', $record);
4907 $SITE = $DB->get_record('course', array('id'=>$SITE->id
), '*', MUST_EXIST
);
4908 if ($SITE->id
== $COURSE->id
) {
4911 core_courseformat\base
::reset_course_cache($SITE->id
);
4919 * Administration interface for emoticon_manager settings.
4921 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4923 class admin_setting_emoticons
extends admin_setting
{
4926 * Calls parent::__construct with specific args
4928 public function __construct() {
4931 $manager = get_emoticon_manager();
4932 $defaults = $this->prepare_form_data($manager->default_emoticons());
4933 parent
::__construct('emoticons', get_string('emoticons', 'admin'), get_string('emoticons_desc', 'admin'), $defaults);
4937 * Return the current setting(s)
4939 * @return array Current settings array
4941 public function get_setting() {
4944 $manager = get_emoticon_manager();
4946 $config = $this->config_read($this->name
);
4947 if (is_null($config)) {
4951 $config = $manager->decode_stored_config($config);
4952 if (is_null($config)) {
4956 return $this->prepare_form_data($config);
4960 * Save selected settings
4962 * @param array $data Array of settings to save
4965 public function write_setting($data) {
4967 $manager = get_emoticon_manager();
4968 $emoticons = $this->process_form_data($data);
4970 if ($emoticons === false) {
4974 if ($this->config_write($this->name
, $manager->encode_stored_config($emoticons))) {
4975 return ''; // success
4977 return get_string('errorsetting', 'admin') . $this->visiblename
. html_writer
::empty_tag('br');
4982 * Return XHTML field(s) for options
4984 * @param array $data Array of options to set in HTML
4985 * @return string XHTML string for the fields and wrapping div(s)
4987 public function output_html($data, $query='') {
4990 $context = (object) [
4991 'name' => $this->get_full_name(),
4997 foreach ($data as $field => $value) {
4999 // When $i == 0: text.
5000 // When $i == 1: imagename.
5001 // When $i == 2: imagecomponent.
5002 // When $i == 3: altidentifier.
5003 // When $i == 4: altcomponent.
5004 $fields[$i] = (object) [
5013 if (!empty($fields[1]->value
)) {
5014 if (get_string_manager()->string_exists($fields[3]->value
, $fields[4]->value
)) {
5015 $alt = get_string($fields[3]->value
, $fields[4]->value
);
5017 $alt = $fields[0]->value
;
5019 $icon = new pix_emoticon($fields[1]->value
, $alt, $fields[2]->value
);
5021 $context->emoticons
[] = [
5022 'fields' => $fields,
5023 'icon' => $icon ?
$icon->export_for_template($OUTPUT) : null
5030 $context->reseturl
= new moodle_url('/admin/resetemoticons.php');
5031 $element = $OUTPUT->render_from_template('core_admin/setting_emoticons', $context);
5032 return format_admin_setting($this, $this->visiblename
, $element, $this->description
, false, '', NULL, $query);
5036 * Converts the array of emoticon objects provided by {@see emoticon_manager} into admin settings form data
5038 * @see self::process_form_data()
5039 * @param array $emoticons array of emoticon objects as returned by {@see emoticon_manager}
5040 * @return array of form fields and their values
5042 protected function prepare_form_data(array $emoticons) {
5046 foreach ($emoticons as $emoticon) {
5047 $form['text'.$i] = $emoticon->text
;
5048 $form['imagename'.$i] = $emoticon->imagename
;
5049 $form['imagecomponent'.$i] = $emoticon->imagecomponent
;
5050 $form['altidentifier'.$i] = $emoticon->altidentifier
;
5051 $form['altcomponent'.$i] = $emoticon->altcomponent
;
5054 // add one more blank field set for new object
5055 $form['text'.$i] = '';
5056 $form['imagename'.$i] = '';
5057 $form['imagecomponent'.$i] = '';
5058 $form['altidentifier'.$i] = '';
5059 $form['altcomponent'.$i] = '';
5065 * Converts the data from admin settings form into an array of emoticon objects
5067 * @see self::prepare_form_data()
5068 * @param array $data array of admin form fields and values
5069 * @return false|array of emoticon objects
5071 protected function process_form_data(array $form) {
5073 $count = count($form); // number of form field values
5076 // we must get five fields per emoticon object
5080 $emoticons = array();
5081 for ($i = 0; $i < $count / 5; $i++
) {
5082 $emoticon = new stdClass();
5083 $emoticon->text
= clean_param(trim($form['text'.$i]), PARAM_NOTAGS
);
5084 $emoticon->imagename
= clean_param(trim($form['imagename'.$i]), PARAM_PATH
);
5085 $emoticon->imagecomponent
= clean_param(trim($form['imagecomponent'.$i]), PARAM_COMPONENT
);
5086 $emoticon->altidentifier
= clean_param(trim($form['altidentifier'.$i]), PARAM_STRINGID
);
5087 $emoticon->altcomponent
= clean_param(trim($form['altcomponent'.$i]), PARAM_COMPONENT
);
5089 if (strpos($emoticon->text
, ':/') !== false or strpos($emoticon->text
, '//') !== false) {
5090 // prevent from breaking http://url.addresses by accident
5091 $emoticon->text
= '';
5094 if (strlen($emoticon->text
) < 2) {
5095 // do not allow single character emoticons
5096 $emoticon->text
= '';
5099 if (preg_match('/^[a-zA-Z]+[a-zA-Z0-9]*$/', $emoticon->text
)) {
5100 // emoticon text must contain some non-alphanumeric character to prevent
5101 // breaking HTML tags
5102 $emoticon->text
= '';
5105 if ($emoticon->text
!== '' and $emoticon->imagename
!== '' and $emoticon->imagecomponent
!== '') {
5106 $emoticons[] = $emoticon;
5116 * Special setting for limiting of the list of available languages.
5118 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5120 class admin_setting_langlist
extends admin_setting_configtext
{
5122 * Calls parent::__construct with specific arguments
5124 public function __construct() {
5125 parent
::__construct('langlist', get_string('langlist', 'admin'), get_string('configlanglist', 'admin'), '', PARAM_NOTAGS
);
5129 * Validate that each language identifier exists on the site
5131 * @param string $data
5132 * @return bool|string True if validation successful, otherwise error string
5134 public function validate($data) {
5135 $parentcheck = parent
::validate($data);
5136 if ($parentcheck !== true) {
5137 return $parentcheck;
5144 // Normalize language identifiers.
5145 $langcodes = array_map('trim', explode(',', $data));
5146 foreach ($langcodes as $langcode) {
5147 // If the langcode contains optional alias, split it out.
5148 [$langcode, ] = preg_split('/\s*\|\s*/', $langcode, 2);
5150 if (!get_string_manager()->translation_exists($langcode)) {
5151 return get_string('invalidlanguagecode', 'error', $langcode);
5159 * Save the new setting
5161 * @param string $data The new setting
5164 public function write_setting($data) {
5165 $return = parent
::write_setting($data);
5166 get_string_manager()->reset_caches();
5173 * Allows to specify comma separated list of known country codes.
5175 * This is a simple subclass of the plain input text field with added validation so that all the codes are actually
5180 * @copyright 2020 David Mudrák <david@moodle.com>
5181 * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5183 class admin_setting_countrycodes
extends admin_setting_configtext
{
5186 * Construct the instance of the setting.
5188 * @param string $name Name of the admin setting such as 'allcountrycodes' or 'myplugin/countries'.
5189 * @param lang_string|string $visiblename Language string with the field label text.
5190 * @param lang_string|string $description Language string with the field description text.
5191 * @param string $defaultsetting Default value of the setting.
5192 * @param int $size Input text field size.
5194 public function __construct($name, $visiblename, $description, $defaultsetting = '', $size = null) {
5195 parent
::__construct($name, $visiblename, $description, $defaultsetting, '/^(?:\w+(?:,\w+)*)?$/', $size);
5199 * Validate the setting value before storing it.
5201 * The value is first validated through custom regex so that it is a word consisting of letters, numbers or underscore; or
5202 * a comma separated list of such words.
5204 * @param string $data Value inserted into the setting field.
5205 * @return bool|string True if the value is OK, error string otherwise.
5207 public function validate($data) {
5209 $parentcheck = parent
::validate($data);
5211 if ($parentcheck !== true) {
5212 return $parentcheck;
5219 $allcountries = get_string_manager()->get_list_of_countries(true);
5221 foreach (explode(',', $data) as $code) {
5222 if (!isset($allcountries[$code])) {
5223 return get_string('invalidcountrycode', 'core_error', $code);
5233 * Selection of one of the recognised countries using the list
5234 * returned by {@link get_list_of_countries()}.
5236 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5238 class admin_settings_country_select
extends admin_setting_configselect
{
5239 protected $includeall;
5240 public function __construct($name, $visiblename, $description, $defaultsetting, $includeall=false) {
5241 $this->includeall
= $includeall;
5242 parent
::__construct($name, $visiblename, $description, $defaultsetting, null);
5246 * Lazy-load the available choices for the select box
5248 public function load_choices() {
5250 if (is_array($this->choices
)) {
5253 $this->choices
= array_merge(
5254 array('0' => get_string('choosedots')),
5255 get_string_manager()->get_list_of_countries($this->includeall
));
5262 * admin_setting_configselect for the default number of sections in a course,
5263 * simply so we can lazy-load the choices.
5265 * @copyright 2011 The Open University
5266 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5268 class admin_settings_num_course_sections
extends admin_setting_configselect
{
5269 public function __construct($name, $visiblename, $description, $defaultsetting) {
5270 parent
::__construct($name, $visiblename, $description, $defaultsetting, array());
5273 /** Lazy-load the available choices for the select box */
5274 public function load_choices() {
5275 $max = get_config('moodlecourse', 'maxsections');
5276 if (!isset($max) ||
!is_numeric($max)) {
5279 for ($i = 0; $i <= $max; $i++
) {
5280 $this->choices
[$i] = "$i";
5288 * Course category selection
5290 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5292 class admin_settings_coursecat_select
extends admin_setting_configselect_autocomplete
{
5294 * Calls parent::__construct with specific arguments
5296 public function __construct($name, $visiblename, $description, $defaultsetting = 1) {
5297 parent
::__construct($name, $visiblename, $description, $defaultsetting, $choices = null);
5301 * Load the available choices for the select box
5305 public function load_choices() {
5306 if (is_array($this->choices
)) {
5309 $this->choices
= core_course_category
::make_categories_list('', 0, ' / ');
5316 * Special control for selecting days to backup
5318 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5320 class admin_setting_special_backupdays
extends admin_setting_configmulticheckbox2
{
5322 * Calls parent::__construct with specific arguments
5324 public function __construct() {
5325 parent
::__construct('backup_auto_weekdays', get_string('automatedbackupschedule','backup'), get_string('automatedbackupschedulehelp','backup'), array(), NULL);
5326 $this->plugin
= 'backup';
5330 * Load the available choices for the select box
5332 * @return bool Always returns true
5334 public function load_choices() {
5335 if (is_array($this->choices
)) {
5338 $this->choices
= array();
5339 $days = array('sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday');
5340 foreach ($days as $day) {
5341 $this->choices
[$day] = get_string($day, 'calendar');
5348 * Special setting for backup auto destination.
5352 * @copyright 2014 Frédéric Massart - FMCorz.net
5353 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5355 class admin_setting_special_backup_auto_destination
extends admin_setting_configdirectory
{
5358 * Calls parent::__construct with specific arguments.
5360 public function __construct() {
5361 parent
::__construct('backup/backup_auto_destination', new lang_string('saveto'), new lang_string('backupsavetohelp'), '');
5365 * Check if the directory must be set, depending on backup/backup_auto_storage.
5367 * Note: backup/backup_auto_storage must be specified BEFORE this setting otherwise
5368 * there will be conflicts if this validation happens before the other one.
5370 * @param string $data Form data.
5371 * @return string Empty when no errors.
5373 public function write_setting($data) {
5374 $storage = (int) get_config('backup', 'backup_auto_storage');
5375 if ($storage !== 0) {
5376 if (empty($data) ||
!file_exists($data) ||
!is_dir($data) ||
!is_writable($data) ) {
5377 // The directory must exist and be writable.
5378 return get_string('backuperrorinvaliddestination');
5381 return parent
::write_setting($data);
5387 * Special debug setting
5389 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5391 class admin_setting_special_debug
extends admin_setting_configselect
{
5393 * Calls parent::__construct with specific arguments
5395 public function __construct() {
5396 parent
::__construct('debug', get_string('debug', 'admin'), get_string('configdebug', 'admin'), DEBUG_NONE
, NULL);
5400 * Load the available choices for the select box
5404 public function load_choices() {
5405 if (is_array($this->choices
)) {
5408 $this->choices
= array(DEBUG_NONE
=> get_string('debugnone', 'admin'),
5409 DEBUG_MINIMAL
=> get_string('debugminimal', 'admin'),
5410 DEBUG_NORMAL
=> get_string('debugnormal', 'admin'),
5411 DEBUG_ALL
=> get_string('debugall', 'admin'),
5412 DEBUG_DEVELOPER
=> get_string('debugdeveloper', 'admin'));
5419 * Special admin control
5421 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5423 class admin_setting_special_calendar_weekend
extends admin_setting
{
5425 * Calls parent::__construct with specific arguments
5427 public function __construct() {
5428 $name = 'calendar_weekend';
5429 $visiblename = get_string('calendar_weekend', 'admin');
5430 $description = get_string('helpweekenddays', 'admin');
5431 $default = array ('0', '6'); // Saturdays and Sundays
5432 parent
::__construct($name, $visiblename, $description, $default);
5436 * Gets the current settings as an array
5438 * @return mixed Null if none, else array of settings
5440 public function get_setting() {
5441 $result = $this->config_read($this->name
);
5442 if (is_null($result)) {
5445 if ($result === '') {
5448 $settings = array();
5449 for ($i=0; $i<7; $i++
) {
5450 if ($result & (1 << $i)) {
5458 * Save the new settings
5460 * @param array $data Array of new settings
5463 public function write_setting($data) {
5464 if (!is_array($data)) {
5467 unset($data['xxxxx']);
5469 foreach($data as $index) {
5470 $result |
= 1 << $index;
5472 return ($this->config_write($this->name
, $result) ?
'' : get_string('errorsetting', 'admin'));
5476 * Return XHTML to display the control
5478 * @param array $data array of selected days
5479 * @param string $query
5480 * @return string XHTML for display (field + wrapping div(s)
5482 public function output_html($data, $query='') {
5485 // The order matters very much because of the implied numeric keys.
5486 $days = array('sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday');
5487 $context = (object) [
5488 'name' => $this->get_full_name(),
5489 'id' => $this->get_id(),
5490 'days' => array_map(function($index) use ($days, $data) {
5493 'label' => get_string($days[$index], 'calendar'),
5494 'checked' => in_array($index, $data)
5496 }, array_keys($days))
5499 $element = $OUTPUT->render_from_template('core_admin/setting_special_calendar_weekend', $context);
5501 return format_admin_setting($this, $this->visiblename
, $element, $this->description
, false, '', NULL, $query);
5508 * Admin setting that allows a user to pick a behaviour.
5510 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5512 class admin_setting_question_behaviour
extends admin_setting_configselect
{
5514 * @param string $name name of config variable
5515 * @param string $visiblename display name
5516 * @param string $description description
5517 * @param string $default default.
5519 public function __construct($name, $visiblename, $description, $default) {
5520 parent
::__construct($name, $visiblename, $description, $default, null);
5524 * Load list of behaviours as choices
5525 * @return bool true => success, false => error.
5527 public function load_choices() {
5529 require_once($CFG->dirroot
. '/question/engine/lib.php');
5530 $this->choices
= question_engine
::get_behaviour_options('');
5537 * Admin setting that allows a user to pick appropriate roles for something.
5539 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5541 class admin_setting_pickroles
extends admin_setting_configmulticheckbox
{
5542 /** @var array Array of capabilities which identify roles */
5546 * @param string $name Name of config variable
5547 * @param string $visiblename Display name
5548 * @param string $description Description
5549 * @param array $types Array of archetypes which identify
5550 * roles that will be enabled by default.
5552 public function __construct($name, $visiblename, $description, $types) {
5553 parent
::__construct($name, $visiblename, $description, NULL, NULL);
5554 $this->types
= $types;
5558 * Load roles as choices
5560 * @return bool true=>success, false=>error
5562 public function load_choices() {
5564 if (during_initial_install()) {
5567 if (is_array($this->choices
)) {
5570 if ($roles = get_all_roles()) {
5571 $this->choices
= role_fix_names($roles, null, ROLENAME_ORIGINAL
, true);
5579 * Return the default setting for this control
5581 * @return array Array of default settings
5583 public function get_defaultsetting() {
5586 if (during_initial_install()) {
5590 foreach($this->types
as $archetype) {
5591 if ($caproles = get_archetype_roles($archetype)) {
5592 foreach ($caproles as $caprole) {
5593 $result[$caprole->id
] = 1;
5603 * Admin setting that is a list of installed filter plugins.
5605 * @copyright 2015 The Open University
5606 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5608 class admin_setting_pickfilters
extends admin_setting_configmulticheckbox
{
5613 * @param string $name unique ascii name, either 'mysetting' for settings
5614 * that in config, or 'myplugin/mysetting' for ones in config_plugins.
5615 * @param string $visiblename localised name
5616 * @param string $description localised long description
5617 * @param array $default the default. E.g. array('urltolink' => 1, 'emoticons' => 1)
5619 public function __construct($name, $visiblename, $description, $default) {
5620 if (empty($default)) {
5623 $this->load_choices();
5624 foreach ($default as $plugin) {
5625 if (!isset($this->choices
[$plugin])) {
5626 unset($default[$plugin]);
5629 parent
::__construct($name, $visiblename, $description, $default, null);
5632 public function load_choices() {
5633 if (is_array($this->choices
)) {
5636 $this->choices
= array();
5638 foreach (core_component
::get_plugin_list('filter') as $plugin => $unused) {
5639 $this->choices
[$plugin] = filter_get_name($plugin);
5647 * Text field with an advanced checkbox, that controls a additional $name.'_adv' setting.
5649 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5651 class admin_setting_configtext_with_advanced
extends admin_setting_configtext
{
5654 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
5655 * @param string $visiblename localised
5656 * @param string $description long localised info
5657 * @param array $defaultsetting ('value'=>string, '__construct'=>bool)
5658 * @param mixed $paramtype int means PARAM_XXX type, string is a allowed format in regex
5659 * @param int $size default field size
5661 public function __construct($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW
, $size=null) {
5662 parent
::__construct($name, $visiblename, $description, $defaultsetting['value'], $paramtype, $size);
5663 $this->set_advanced_flag_options(admin_setting_flag
::ENABLED
, !empty($defaultsetting['adv']));
5669 * Checkbox with an advanced checkbox that controls an additional $name.'_adv' config setting.
5671 * @copyright 2009 Petr Skoda (http://skodak.org)
5672 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5674 class admin_setting_configcheckbox_with_advanced
extends admin_setting_configcheckbox
{
5678 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
5679 * @param string $visiblename localised
5680 * @param string $description long localised info
5681 * @param array $defaultsetting ('value'=>string, 'adv'=>bool)
5682 * @param string $yes value used when checked
5683 * @param string $no value used when not checked
5685 public function __construct($name, $visiblename, $description, $defaultsetting, $yes='1', $no='0') {
5686 parent
::__construct($name, $visiblename, $description, $defaultsetting['value'], $yes, $no);
5687 $this->set_advanced_flag_options(admin_setting_flag
::ENABLED
, !empty($defaultsetting['adv']));
5694 * Checkbox with an advanced checkbox that controls an additional $name.'_locked' config setting.
5696 * This is nearly a copy/paste of admin_setting_configcheckbox_with_adv
5698 * @copyright 2010 Sam Hemelryk
5699 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5701 class admin_setting_configcheckbox_with_lock
extends admin_setting_configcheckbox
{
5704 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
5705 * @param string $visiblename localised
5706 * @param string $description long localised info
5707 * @param array $defaultsetting ('value'=>string, 'locked'=>bool)
5708 * @param string $yes value used when checked
5709 * @param string $no value used when not checked
5711 public function __construct($name, $visiblename, $description, $defaultsetting, $yes='1', $no='0') {
5712 parent
::__construct($name, $visiblename, $description, $defaultsetting['value'], $yes, $no);
5713 $this->set_locked_flag_options(admin_setting_flag
::ENABLED
, !empty($defaultsetting['locked']));
5719 * Autocomplete as you type form element.
5721 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5723 class admin_setting_configselect_autocomplete
extends admin_setting_configselect
{
5724 /** @var boolean $tags Should we allow typing new entries to the field? */
5725 protected $tags = false;
5726 /** @var string $ajax Name of an AMD module to send/process ajax requests. */
5727 protected $ajax = '';
5728 /** @var string $placeholder Placeholder text for an empty list. */
5729 protected $placeholder = '';
5730 /** @var bool $casesensitive Whether the search has to be case-sensitive. */
5731 protected $casesensitive = false;
5732 /** @var bool $showsuggestions Show suggestions by default - but this can be turned off. */
5733 protected $showsuggestions = true;
5734 /** @var string $noselectionstring String that is shown when there are no selections. */
5735 protected $noselectionstring = '';
5738 * Returns XHTML select field and wrapping div(s)
5740 * @see output_select_html()
5742 * @param string $data the option to show as selected
5743 * @param string $query
5744 * @return string XHTML field and wrapping div
5746 public function output_html($data, $query='') {
5749 $html = parent
::output_html($data, $query);
5755 $this->placeholder
= get_string('search');
5757 $params = array('#' . $this->get_id(), $this->tags
, $this->ajax
,
5758 $this->placeholder
, $this->casesensitive
, $this->showsuggestions
, $this->noselectionstring
);
5760 // Load autocomplete wrapper for select2 library.
5761 $PAGE->requires
->js_call_amd('core/form-autocomplete', 'enhance', $params);
5768 * Dropdown menu with an advanced checkbox, that controls a additional $name.'_adv' setting.
5770 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5772 class admin_setting_configselect_with_advanced
extends admin_setting_configselect
{
5774 * Calls parent::__construct with specific arguments
5776 public function __construct($name, $visiblename, $description, $defaultsetting, $choices) {
5777 parent
::__construct($name, $visiblename, $description, $defaultsetting['value'], $choices);
5778 $this->set_advanced_flag_options(admin_setting_flag
::ENABLED
, !empty($defaultsetting['adv']));
5784 * Select with an advanced checkbox that controls an additional $name.'_locked' config setting.
5786 * @copyright 2017 Marina Glancy
5787 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5789 class admin_setting_configselect_with_lock
extends admin_setting_configselect
{
5792 * @param string $name unique ascii name, either 'mysetting' for settings that in config,
5793 * or 'myplugin/mysetting' for ones in config_plugins.
5794 * @param string $visiblename localised
5795 * @param string $description long localised info
5796 * @param array $defaultsetting ('value'=>string, 'locked'=>bool)
5797 * @param array $choices array of $value=>$label for each selection
5799 public function __construct($name, $visiblename, $description, $defaultsetting, $choices) {
5800 parent
::__construct($name, $visiblename, $description, $defaultsetting['value'], $choices);
5801 $this->set_locked_flag_options(admin_setting_flag
::ENABLED
, !empty($defaultsetting['locked']));
5807 * Graded roles in gradebook
5809 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5811 class admin_setting_special_gradebookroles
extends admin_setting_pickroles
{
5813 * Calls parent::__construct with specific arguments
5815 public function __construct() {
5816 parent
::__construct('gradebookroles', get_string('gradebookroles', 'admin'),
5817 get_string('configgradebookroles', 'admin'),
5825 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5827 class admin_setting_regradingcheckbox
extends admin_setting_configcheckbox
{
5829 * Saves the new settings passed in $data
5831 * @param string $data
5832 * @return mixed string or Array
5834 public function write_setting($data) {
5837 $oldvalue = $this->config_read($this->name
);
5838 $return = parent
::write_setting($data);
5839 $newvalue = $this->config_read($this->name
);
5841 if ($oldvalue !== $newvalue) {
5842 // force full regrading
5843 $DB->set_field('grade_items', 'needsupdate', 1, array('needsupdate'=>0));
5852 * Which roles to show on course description page
5854 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5856 class admin_setting_special_coursecontact
extends admin_setting_pickroles
{
5858 * Calls parent::__construct with specific arguments
5860 public function __construct() {
5861 parent
::__construct('coursecontact', get_string('coursecontact', 'admin'),
5862 get_string('coursecontact_desc', 'admin'),
5863 array('editingteacher'));
5864 $this->set_updatedcallback(function (){
5865 cache
::make('core', 'coursecontacts')->purge();
5873 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5875 class admin_setting_special_gradelimiting
extends admin_setting_configcheckbox
{
5877 * Calls parent::__construct with specific arguments
5879 public function __construct() {
5880 parent
::__construct('unlimitedgrades', get_string('unlimitedgrades', 'grades'),
5881 get_string('unlimitedgrades_help', 'grades'), '0', '1', '0');
5885 * Old syntax of class constructor. Deprecated in PHP7.
5887 * @deprecated since Moodle 3.1
5889 public function admin_setting_special_gradelimiting() {
5890 debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER
);
5891 self
::__construct();
5895 * Force site regrading
5897 function regrade_all() {
5899 require_once("$CFG->libdir/gradelib.php");
5900 grade_force_site_regrading();
5904 * Saves the new settings
5906 * @param mixed $data
5907 * @return string empty string or error message
5909 function write_setting($data) {
5910 $previous = $this->get_setting();
5912 if ($previous === null) {
5914 $this->regrade_all();
5917 if ($data != $previous) {
5918 $this->regrade_all();
5921 return ($this->config_write($this->name
, $data) ?
'' : get_string('errorsetting', 'admin'));
5927 * Special setting for $CFG->grade_minmaxtouse.
5930 * @copyright 2015 Frédéric Massart - FMCorz.net
5931 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5933 class admin_setting_special_grademinmaxtouse
extends admin_setting_configselect
{
5938 public function __construct() {
5939 parent
::__construct('grade_minmaxtouse', new lang_string('minmaxtouse', 'grades'),
5940 new lang_string('minmaxtouse_desc', 'grades'), GRADE_MIN_MAX_FROM_GRADE_ITEM
,
5942 GRADE_MIN_MAX_FROM_GRADE_ITEM
=> get_string('gradeitemminmax', 'grades'),
5943 GRADE_MIN_MAX_FROM_GRADE_GRADE
=> get_string('gradegrademinmax', 'grades')
5949 * Saves the new setting.
5951 * @param mixed $data
5952 * @return string empty string or error message
5954 function write_setting($data) {
5957 $previous = $this->get_setting();
5958 $result = parent
::write_setting($data);
5960 // If saved and the value has changed.
5961 if (empty($result) && $previous != $data) {
5962 require_once($CFG->libdir
. '/gradelib.php');
5963 grade_force_site_regrading();
5973 * Primary grade export plugin - has state tracking.
5975 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5977 class admin_setting_special_gradeexport
extends admin_setting_configmulticheckbox
{
5979 * Calls parent::__construct with specific arguments
5981 public function __construct() {
5982 parent
::__construct('gradeexport', get_string('gradeexport', 'admin'),
5983 get_string('configgradeexport', 'admin'), array(), NULL);
5987 * Load the available choices for the multicheckbox
5989 * @return bool always returns true
5991 public function load_choices() {
5992 if (is_array($this->choices
)) {
5995 $this->choices
= array();
5997 if ($plugins = core_component
::get_plugin_list('gradeexport')) {
5998 foreach($plugins as $plugin => $unused) {
5999 $this->choices
[$plugin] = get_string('pluginname', 'gradeexport_'.$plugin);
6008 * A setting for setting the default grade point value. Must be an integer between 1 and $CFG->gradepointmax.
6010 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
6012 class admin_setting_special_gradepointdefault
extends admin_setting_configtext
{
6014 * Config gradepointmax constructor
6016 * @param string $name Overidden by "gradepointmax"
6017 * @param string $visiblename Overridden by "gradepointmax" language string.
6018 * @param string $description Overridden by "gradepointmax_help" language string.
6019 * @param string $defaultsetting Not used, overridden by 100.
6020 * @param mixed $paramtype Overridden by PARAM_INT.
6021 * @param int $size Overridden by 5.
6023 public function __construct($name = '', $visiblename = '', $description = '', $defaultsetting = '', $paramtype = PARAM_INT
, $size = 5) {
6024 $name = 'gradepointdefault';
6025 $visiblename = get_string('gradepointdefault', 'grades');
6026 $description = get_string('gradepointdefault_help', 'grades');
6027 $defaultsetting = 100;
6028 $paramtype = PARAM_INT
;
6030 parent
::__construct($name, $visiblename, $description, $defaultsetting, $paramtype, $size);
6034 * Validate data before storage
6035 * @param string $data The submitted data
6036 * @return bool|string true if ok, string if error found
6038 public function validate($data) {
6040 if (((string)(int)$data === (string)$data && $data > 0 && $data <= $CFG->gradepointmax
)) {
6043 return get_string('gradepointdefault_validateerror', 'grades');
6050 * A setting for setting the maximum grade value. Must be an integer between 1 and 10000.
6052 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
6054 class admin_setting_special_gradepointmax
extends admin_setting_configtext
{
6057 * Config gradepointmax constructor
6059 * @param string $name Overidden by "gradepointmax"
6060 * @param string $visiblename Overridden by "gradepointmax" language string.
6061 * @param string $description Overridden by "gradepointmax_help" language string.
6062 * @param string $defaultsetting Not used, overridden by 100.
6063 * @param mixed $paramtype Overridden by PARAM_INT.
6064 * @param int $size Overridden by 5.
6066 public function __construct($name = '', $visiblename = '', $description = '', $defaultsetting = '', $paramtype = PARAM_INT
, $size = 5) {
6067 $name = 'gradepointmax';
6068 $visiblename = get_string('gradepointmax', 'grades');
6069 $description = get_string('gradepointmax_help', 'grades');
6070 $defaultsetting = 100;
6071 $paramtype = PARAM_INT
;
6073 parent
::__construct($name, $visiblename, $description, $defaultsetting, $paramtype, $size);
6077 * Save the selected setting
6079 * @param string $data The selected site
6080 * @return string empty string or error message
6082 public function write_setting($data) {
6084 $data = (int)$this->defaultsetting
;
6088 return parent
::write_setting($data);
6092 * Validate data before storage
6093 * @param string $data The submitted data
6094 * @return bool|string true if ok, string if error found
6096 public function validate($data) {
6097 if (((string)(int)$data === (string)$data && $data > 0 && $data <= 10000)) {
6100 return get_string('gradepointmax_validateerror', 'grades');
6105 * Return an XHTML string for the setting
6106 * @param array $data Associative array of value=>xx, forced=>xx, adv=>xx
6107 * @param string $query search query to be highlighted
6108 * @return string XHTML to display control
6110 public function output_html($data, $query = '') {
6113 $default = $this->get_defaultsetting();
6114 $context = (object) [
6115 'size' => $this->size
,
6116 'id' => $this->get_id(),
6117 'name' => $this->get_full_name(),
6122 'forceltr' => $this->get_force_ltr()
6124 $element = $OUTPUT->render_from_template('core_admin/setting_configtext', $context);
6126 return format_admin_setting($this, $this->visiblename
, $element, $this->description
, true, '', $default, $query);
6132 * Grade category settings
6134 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
6136 class admin_setting_gradecat_combo
extends admin_setting
{
6137 /** @var array Array of choices */
6141 * Sets choices and calls parent::__construct with passed arguments
6142 * @param string $name
6143 * @param string $visiblename
6144 * @param string $description
6145 * @param mixed $defaultsetting string or array depending on implementation
6146 * @param array $choices An array of choices for the control
6148 public function __construct($name, $visiblename, $description, $defaultsetting, $choices) {
6149 $this->choices
= $choices;
6150 parent
::__construct($name, $visiblename, $description, $defaultsetting);
6154 * Return the current setting(s) array
6156 * @return array Array of value=>xx, forced=>xx, adv=>xx
6158 public function get_setting() {
6161 $value = $this->config_read($this->name
);
6162 $flag = $this->config_read($this->name
.'_flag');
6164 if (is_null($value) or is_null($flag)) {
6169 $forced = (boolean
)(1 & $flag); // first bit
6170 $adv = (boolean
)(2 & $flag); // second bit
6172 return array('value' => $value, 'forced' => $forced, 'adv' => $adv);
6176 * Save the new settings passed in $data
6178 * @todo Add vartype handling to ensure $data is array
6179 * @param array $data Associative array of value=>xx, forced=>xx, adv=>xx
6180 * @return string empty or error message
6182 public function write_setting($data) {
6185 $value = $data['value'];
6186 $forced = empty($data['forced']) ?
0 : 1;
6187 $adv = empty($data['adv']) ?
0 : 2;
6188 $flag = ($forced |
$adv); //bitwise or
6190 if (!in_array($value, array_keys($this->choices
))) {
6191 return 'Error setting ';
6194 $oldvalue = $this->config_read($this->name
);
6195 $oldflag = (int)$this->config_read($this->name
.'_flag');
6196 $oldforced = (1 & $oldflag); // first bit
6198 $result1 = $this->config_write($this->name
, $value);
6199 $result2 = $this->config_write($this->name
.'_flag', $flag);
6201 // force regrade if needed
6202 if ($oldforced != $forced or ($forced and $value != $oldvalue)) {
6203 require_once($CFG->libdir
.'/gradelib.php');
6204 grade_category
::updated_forced_settings();
6207 if ($result1 and $result2) {
6210 return get_string('errorsetting', 'admin');
6215 * Return XHTML to display the field and wrapping div
6217 * @todo Add vartype handling to ensure $data is array
6218 * @param array $data Associative array of value=>xx, forced=>xx, adv=>xx
6219 * @param string $query
6220 * @return string XHTML to display control
6222 public function output_html($data, $query='') {
6225 $value = $data['value'];
6227 $default = $this->get_defaultsetting();
6228 if (!is_null($default)) {
6229 $defaultinfo = array();
6230 if (isset($this->choices
[$default['value']])) {
6231 $defaultinfo[] = $this->choices
[$default['value']];
6233 if (!empty($default['forced'])) {
6234 $defaultinfo[] = get_string('force');
6236 if (!empty($default['adv'])) {
6237 $defaultinfo[] = get_string('advanced');
6239 $defaultinfo = implode(', ', $defaultinfo);
6242 $defaultinfo = NULL;
6245 $options = $this->choices
;
6246 $context = (object) [
6247 'id' => $this->get_id(),
6248 'name' => $this->get_full_name(),
6249 'forced' => !empty($data['forced']),
6250 'advanced' => !empty($data['adv']),
6251 'options' => array_map(function($option) use ($options, $value) {
6254 'name' => $options[$option],
6255 'selected' => $option == $value
6257 }, array_keys($options)),
6260 $element = $OUTPUT->render_from_template('core_admin/setting_gradecat_combo', $context);
6262 return format_admin_setting($this, $this->visiblename
, $element, $this->description
, true, '', $defaultinfo, $query);
6268 * Selection of grade report in user profiles
6270 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
6272 class admin_setting_grade_profilereport
extends admin_setting_configselect
{
6274 * Calls parent::__construct with specific arguments
6276 public function __construct() {
6277 parent
::__construct('grade_profilereport', get_string('profilereport', 'grades'), get_string('profilereport_help', 'grades'), 'user', null);
6281 * Loads an array of choices for the configselect control
6283 * @return bool always return true
6285 public function load_choices() {
6286 if (is_array($this->choices
)) {
6289 $this->choices
= array();
6292 require_once($CFG->libdir
.'/gradelib.php');
6294 foreach (core_component
::get_plugin_list('gradereport') as $plugin => $plugindir) {
6295 if (file_exists($plugindir.'/lib.php')) {
6296 require_once($plugindir.'/lib.php');
6297 $functionname = 'grade_report_'.$plugin.'_profilereport';
6298 if (function_exists($functionname)) {
6299 $this->choices
[$plugin] = get_string('pluginname', 'gradereport_'.$plugin);
6308 * Provides a selection of grade reports to be used for "grades".
6310 * @copyright 2015 Adrian Greeve <adrian@moodle.com>
6311 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
6313 class admin_setting_my_grades_report
extends admin_setting_configselect
{
6316 * Calls parent::__construct with specific arguments.
6318 public function __construct() {
6319 parent
::__construct('grade_mygrades_report', new lang_string('mygrades', 'grades'),
6320 new lang_string('mygrades_desc', 'grades'), 'overview', null);
6324 * Loads an array of choices for the configselect control.
6326 * @return bool always returns true.
6328 public function load_choices() {
6329 global $CFG; // Remove this line and behold the horror of behat test failures!
6330 $this->choices
= array();
6331 foreach (core_component
::get_plugin_list('gradereport') as $plugin => $plugindir) {
6332 if (file_exists($plugindir . '/lib.php')) {
6333 require_once($plugindir . '/lib.php');
6334 // Check to see if the class exists. Check the correct plugin convention first.
6335 if (class_exists('gradereport_' . $plugin)) {
6336 $classname = 'gradereport_' . $plugin;
6337 } else if (class_exists('grade_report_' . $plugin)) {
6338 // We are using the old plugin naming convention.
6339 $classname = 'grade_report_' . $plugin;
6343 if ($classname::supports_mygrades()) {
6344 $this->choices
[$plugin] = get_string('pluginname', 'gradereport_' . $plugin);
6348 // Add an option to specify an external url.
6349 $this->choices
['external'] = get_string('externalurl', 'grades');
6355 * Special class for register auth selection
6357 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
6359 class admin_setting_special_registerauth
extends admin_setting_configselect
{
6361 * Calls parent::__construct with specific arguments
6363 public function __construct() {
6364 parent
::__construct('registerauth', get_string('selfregistration', 'auth'), get_string('selfregistration_help', 'auth'), '', null);
6368 * Returns the default option
6370 * @return string empty or default option
6372 public function get_defaultsetting() {
6373 $this->load_choices();
6374 $defaultsetting = parent
::get_defaultsetting();
6375 if (array_key_exists($defaultsetting, $this->choices
)) {
6376 return $defaultsetting;
6383 * Loads the possible choices for the array
6385 * @return bool always returns true
6387 public function load_choices() {
6390 if (is_array($this->choices
)) {
6393 $this->choices
= array();
6394 $this->choices
[''] = get_string('disable');
6396 $authsenabled = get_enabled_auth_plugins();
6398 foreach ($authsenabled as $auth) {
6399 $authplugin = get_auth_plugin($auth);
6400 if (!$authplugin->can_signup()) {
6403 // Get the auth title (from core or own auth lang files)
6404 $authtitle = $authplugin->get_title();
6405 $this->choices
[$auth] = $authtitle;
6413 * General plugins manager
6415 class admin_page_pluginsoverview
extends admin_externalpage
{
6418 * Sets basic information about the external page
6420 public function __construct() {
6422 parent
::__construct('pluginsoverview', get_string('pluginsoverview', 'core_admin'),
6423 "$CFG->wwwroot/$CFG->admin/plugins.php");
6428 * Module manage page
6430 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
6432 class admin_page_managemods
extends admin_externalpage
{
6434 * Calls parent::__construct with specific arguments
6436 public function __construct() {
6438 parent
::__construct('managemodules', get_string('modsettings', 'admin'), "$CFG->wwwroot/$CFG->admin/modules.php");
6442 * Try to find the specified module
6444 * @param string $query The module to search for
6447 public function search($query) {
6449 if ($result = parent
::search($query)) {
6454 if ($modules = $DB->get_records('modules')) {
6455 foreach ($modules as $module) {
6456 if (!file_exists("$CFG->dirroot/mod/$module->name/lib.php")) {
6459 if (strpos($module->name
, $query) !== false) {
6463 $strmodulename = get_string('modulename', $module->name
);
6464 if (strpos(core_text
::strtolower($strmodulename), $query) !== false) {
6471 $result = new stdClass();
6472 $result->page
= $this;
6473 $result->settings
= array();
6474 return array($this->name
=> $result);
6483 * Special class for enrol plugins management.
6485 * @copyright 2010 Petr Skoda {@link http://skodak.org}
6486 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
6488 class admin_setting_manageenrols
extends admin_setting
{
6490 * Calls parent::__construct with specific arguments
6492 public function __construct() {
6493 $this->nosave
= true;
6494 parent
::__construct('enrolsui', get_string('manageenrols', 'enrol'), '', '');
6498 * Always returns true, does nothing
6502 public function get_setting() {
6507 * Always returns true, does nothing
6511 public function get_defaultsetting() {
6516 * Always returns '', does not write anything
6518 * @return string Always returns ''
6520 public function write_setting($data) {
6521 // do not write any setting
6526 * Checks if $query is one of the available enrol plugins
6528 * @param string $query The string to search for
6529 * @return bool Returns true if found, false if not
6531 public function is_related($query) {
6532 if (parent
::is_related($query)) {
6536 $query = core_text
::strtolower($query);
6537 $enrols = enrol_get_plugins(false);
6538 foreach ($enrols as $name=>$enrol) {
6539 $localised = get_string('pluginname', 'enrol_'.$name);
6540 if (strpos(core_text
::strtolower($name), $query) !== false) {
6543 if (strpos(core_text
::strtolower($localised), $query) !== false) {
6551 * Builds the XHTML to display the control
6553 * @param string $data Unused
6554 * @param string $query
6557 public function output_html($data, $query='') {
6558 global $CFG, $OUTPUT, $DB, $PAGE;
6561 $strup = get_string('up');
6562 $strdown = get_string('down');
6563 $strsettings = get_string('settings');
6564 $strenable = get_string('enable');
6565 $strdisable = get_string('disable');
6566 $struninstall = get_string('uninstallplugin', 'core_admin');
6567 $strusage = get_string('enrolusage', 'enrol');
6568 $strversion = get_string('version');
6569 $strtest = get_string('testsettings', 'core_enrol');
6571 $pluginmanager = core_plugin_manager
::instance();
6573 $enrols_available = enrol_get_plugins(false);
6574 $active_enrols = enrol_get_plugins(true);
6576 $allenrols = array();
6577 foreach ($active_enrols as $key=>$enrol) {
6578 $allenrols[$key] = true;
6580 foreach ($enrols_available as $key=>$enrol) {
6581 $allenrols[$key] = true;
6583 // Now find all borked plugins and at least allow then to uninstall.
6584 $condidates = $DB->get_fieldset_sql("SELECT DISTINCT enrol FROM {enrol}");
6585 foreach ($condidates as $candidate) {
6586 if (empty($allenrols[$candidate])) {
6587 $allenrols[$candidate] = true;
6591 $return = $OUTPUT->heading(get_string('actenrolshhdr', 'enrol'), 3, 'main', true);
6592 $return .= $OUTPUT->box_start('generalbox enrolsui');
6594 $table = new html_table();
6595 $table->head
= array(get_string('name'), $strusage, $strversion, $strenable, $strup.'/'.$strdown, $strsettings, $strtest, $struninstall);
6596 $table->colclasses
= array('leftalign', 'centeralign', 'centeralign', 'centeralign', 'centeralign', 'centeralign', 'centeralign', 'centeralign');
6597 $table->id
= 'courseenrolmentplugins';
6598 $table->attributes
['class'] = 'admintable generaltable';
6599 $table->data
= array();
6601 // Iterate through enrol plugins and add to the display table.
6603 $enrolcount = count($active_enrols);
6604 $url = new moodle_url('/admin/enrol.php', array('sesskey'=>sesskey()));
6606 foreach($allenrols as $enrol => $unused) {
6607 $plugininfo = $pluginmanager->get_plugin_info('enrol_'.$enrol);
6608 $version = get_config('enrol_'.$enrol, 'version');
6609 if ($version === false) {
6613 if (get_string_manager()->string_exists('pluginname', 'enrol_'.$enrol)) {
6614 $name = get_string('pluginname', 'enrol_'.$enrol);
6619 $ci = $DB->count_records('enrol', array('enrol'=>$enrol));
6620 $cp = $DB->count_records_select('user_enrolments', "enrolid IN (SELECT id FROM {enrol} WHERE enrol = ?)", array($enrol));
6621 $usage = "$ci / $cp";
6625 if (isset($active_enrols[$enrol])) {
6626 $aurl = new moodle_url($url, array('action'=>'disable', 'enrol'=>$enrol));
6627 $hideshow = "<a href=\"$aurl\">";
6628 $hideshow .= $OUTPUT->pix_icon('t/hide', $strdisable) . '</a>';
6630 $displayname = $name;
6631 } else if (isset($enrols_available[$enrol])) {
6632 $aurl = new moodle_url($url, array('action'=>'enable', 'enrol'=>$enrol));
6633 $hideshow = "<a href=\"$aurl\">";
6634 $hideshow .= $OUTPUT->pix_icon('t/show', $strenable) . '</a>';
6636 $displayname = $name;
6637 $class = 'dimmed_text';
6641 $displayname = '<span class="notifyproblem">'.$name.'</span>';
6643 if ($PAGE->theme
->resolve_image_location('icon', 'enrol_' . $name, false)) {
6644 $icon = $OUTPUT->pix_icon('icon', '', 'enrol_' . $name, array('class' => 'icon pluginicon'));
6646 $icon = $OUTPUT->pix_icon('spacer', '', 'moodle', array('class' => 'icon pluginicon noicon'));
6649 // Up/down link (only if enrol is enabled).
6652 if ($updowncount > 1) {
6653 $aurl = new moodle_url($url, array('action'=>'up', 'enrol'=>$enrol));
6654 $updown .= "<a href=\"$aurl\">";
6655 $updown .= $OUTPUT->pix_icon('t/up', $strup) . '</a> ';
6657 $updown .= $OUTPUT->spacer() . ' ';
6659 if ($updowncount < $enrolcount) {
6660 $aurl = new moodle_url($url, array('action'=>'down', 'enrol'=>$enrol));
6661 $updown .= "<a href=\"$aurl\">";
6662 $updown .= $OUTPUT->pix_icon('t/down', $strdown) . '</a> ';
6664 $updown .= $OUTPUT->spacer() . ' ';
6669 // Add settings link.
6672 } else if ($surl = $plugininfo->get_settings_url()) {
6673 $settings = html_writer
::link($surl, $strsettings);
6678 // Add uninstall info.
6680 if ($uninstallurl = core_plugin_manager
::instance()->get_uninstall_url('enrol_'.$enrol, 'manage')) {
6681 $uninstall = html_writer
::link($uninstallurl, $struninstall);
6685 if (!empty($enrols_available[$enrol]) and method_exists($enrols_available[$enrol], 'test_settings')) {
6686 $testsettingsurl = new moodle_url('/enrol/test_settings.php', array('enrol'=>$enrol, 'sesskey'=>sesskey()));
6687 $test = html_writer
::link($testsettingsurl, $strtest);
6690 // Add a row to the table.
6691 $row = new html_table_row(array($icon.$displayname, $usage, $version, $hideshow, $updown, $settings, $test, $uninstall));
6693 $row->attributes
['class'] = $class;
6695 $table->data
[] = $row;
6697 $printed[$enrol] = true;
6700 $return .= html_writer
::table($table);
6701 $return .= get_string('configenrolplugins', 'enrol').'<br />'.get_string('tablenosave', 'admin');
6702 $return .= $OUTPUT->box_end();
6703 return highlight($query, $return);
6709 * Blocks manage page
6711 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
6713 class admin_page_manageblocks
extends admin_externalpage
{
6715 * Calls parent::__construct with specific arguments
6717 public function __construct() {
6719 parent
::__construct('manageblocks', get_string('blocksettings', 'admin'), "$CFG->wwwroot/$CFG->admin/blocks.php");
6723 * Search for a specific block
6725 * @param string $query The string to search for
6728 public function search($query) {
6730 if ($result = parent
::search($query)) {
6735 if ($blocks = $DB->get_records('block')) {
6736 foreach ($blocks as $block) {
6737 if (!file_exists("$CFG->dirroot/blocks/$block->name/")) {
6740 if (strpos($block->name
, $query) !== false) {
6744 $strblockname = get_string('pluginname', 'block_'.$block->name
);
6745 if (strpos(core_text
::strtolower($strblockname), $query) !== false) {
6752 $result = new stdClass();
6753 $result->page
= $this;
6754 $result->settings
= array();
6755 return array($this->name
=> $result);
6763 * Message outputs configuration
6765 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
6767 class admin_page_managemessageoutputs
extends admin_externalpage
{
6769 * Calls parent::__construct with specific arguments
6771 public function __construct() {
6773 parent
::__construct('managemessageoutputs',
6774 get_string('defaultmessageoutputs', 'message'),
6775 new moodle_url('/admin/message.php')
6780 * Search for a specific message processor
6782 * @param string $query The string to search for
6785 public function search($query) {
6787 if ($result = parent
::search($query)) {
6792 if ($processors = get_message_processors()) {
6793 foreach ($processors as $processor) {
6794 if (!$processor->available
) {
6797 if (strpos($processor->name
, $query) !== false) {
6801 $strprocessorname = get_string('pluginname', 'message_'.$processor->name
);
6802 if (strpos(core_text
::strtolower($strprocessorname), $query) !== false) {
6809 $result = new stdClass();
6810 $result->page
= $this;
6811 $result->settings
= array();
6812 return array($this->name
=> $result);
6820 * Manage question behaviours page
6822 * @copyright 2011 The Open University
6823 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
6825 class admin_page_manageqbehaviours
extends admin_externalpage
{
6829 public function __construct() {
6831 parent
::__construct('manageqbehaviours', get_string('manageqbehaviours', 'admin'),
6832 new moodle_url('/admin/qbehaviours.php'));
6836 * Search question behaviours for the specified string
6838 * @param string $query The string to search for in question behaviours
6841 public function search($query) {
6843 if ($result = parent
::search($query)) {
6848 require_once($CFG->dirroot
. '/question/engine/lib.php');
6849 foreach (core_component
::get_plugin_list('qbehaviour') as $behaviour => $notused) {
6850 if (strpos(core_text
::strtolower(question_engine
::get_behaviour_name($behaviour)),
6851 $query) !== false) {
6857 $result = new stdClass();
6858 $result->page
= $this;
6859 $result->settings
= array();
6860 return array($this->name
=> $result);
6869 * Question type manage page
6871 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
6873 class admin_page_manageqtypes
extends admin_externalpage
{
6875 * Calls parent::__construct with specific arguments
6877 public function __construct() {
6879 parent
::__construct('manageqtypes', get_string('manageqtypes', 'admin'),
6880 new moodle_url('/admin/qtypes.php'));
6884 * Search question types for the specified string
6886 * @param string $query The string to search for in question types
6889 public function search($query) {
6891 if ($result = parent
::search($query)) {
6896 require_once($CFG->dirroot
. '/question/engine/bank.php');
6897 foreach (question_bank
::get_all_qtypes() as $qtype) {
6898 if (strpos(core_text
::strtolower($qtype->local_name()), $query) !== false) {
6904 $result = new stdClass();
6905 $result->page
= $this;
6906 $result->settings
= array();
6907 return array($this->name
=> $result);
6915 class admin_page_manageportfolios
extends admin_externalpage
{
6917 * Calls parent::__construct with specific arguments
6919 public function __construct() {
6921 parent
::__construct('manageportfolios', get_string('manageportfolios', 'portfolio'),
6922 "$CFG->wwwroot/$CFG->admin/portfolio.php");
6926 * Searches page for the specified string.
6927 * @param string $query The string to search for
6928 * @return bool True if it is found on this page
6930 public function search($query) {
6932 if ($result = parent
::search($query)) {
6937 $portfolios = core_component
::get_plugin_list('portfolio');
6938 foreach ($portfolios as $p => $dir) {
6939 if (strpos($p, $query) !== false) {
6945 foreach (portfolio_instances(false, false) as $instance) {
6946 $title = $instance->get('name');
6947 if (strpos(core_text
::strtolower($title), $query) !== false) {
6955 $result = new stdClass();
6956 $result->page
= $this;
6957 $result->settings
= array();
6958 return array($this->name
=> $result);
6966 class admin_page_managerepositories
extends admin_externalpage
{
6968 * Calls parent::__construct with specific arguments
6970 public function __construct() {
6972 parent
::__construct('managerepositories', get_string('manage',
6973 'repository'), "$CFG->wwwroot/$CFG->admin/repository.php");
6977 * Searches page for the specified string.
6978 * @param string $query The string to search for
6979 * @return bool True if it is found on this page
6981 public function search($query) {
6983 if ($result = parent
::search($query)) {
6988 $repositories= core_component
::get_plugin_list('repository');
6989 foreach ($repositories as $p => $dir) {
6990 if (strpos($p, $query) !== false) {
6996 foreach (repository
::get_types() as $instance) {
6997 $title = $instance->get_typename();
6998 if (strpos(core_text
::strtolower($title), $query) !== false) {
7006 $result = new stdClass();
7007 $result->page
= $this;
7008 $result->settings
= array();
7009 return array($this->name
=> $result);
7018 * Special class for authentication administration.
7020 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
7022 class admin_setting_manageauths
extends admin_setting
{
7024 * Calls parent::__construct with specific arguments
7026 public function __construct() {
7027 $this->nosave
= true;
7028 parent
::__construct('authsui', get_string('authsettings', 'admin'), '', '');
7032 * Always returns true
7036 public function get_setting() {
7041 * Always returns true
7045 public function get_defaultsetting() {
7050 * Always returns '' and doesn't write anything
7052 * @return string Always returns ''
7054 public function write_setting($data) {
7055 // do not write any setting
7060 * Search to find if Query is related to auth plugin
7062 * @param string $query The string to search for
7063 * @return bool true for related false for not
7065 public function is_related($query) {
7066 if (parent
::is_related($query)) {
7070 $authsavailable = core_component
::get_plugin_list('auth');
7071 foreach ($authsavailable as $auth => $dir) {
7072 if (strpos($auth, $query) !== false) {
7075 $authplugin = get_auth_plugin($auth);
7076 $authtitle = $authplugin->get_title();
7077 if (strpos(core_text
::strtolower($authtitle), $query) !== false) {
7085 * Return XHTML to display control
7087 * @param mixed $data Unused
7088 * @param string $query
7089 * @return string highlight
7091 public function output_html($data, $query='') {
7092 global $CFG, $OUTPUT, $DB;
7095 $txt = get_strings(array('authenticationplugins', 'users', 'administration',
7096 'settings', 'edit', 'name', 'enable', 'disable',
7097 'up', 'down', 'none', 'users'));
7098 $txt->updown
= "$txt->up/$txt->down";
7099 $txt->uninstall
= get_string('uninstallplugin', 'core_admin');
7100 $txt->testsettings
= get_string('testsettings', 'core_auth');
7102 $authsavailable = core_component
::get_plugin_list('auth');
7103 get_enabled_auth_plugins(true); // fix the list of enabled auths
7104 if (empty($CFG->auth
)) {
7105 $authsenabled = array();
7107 $authsenabled = explode(',', $CFG->auth
);
7110 // construct the display array, with enabled auth plugins at the top, in order
7111 $displayauths = array();
7112 $registrationauths = array();
7113 $registrationauths[''] = $txt->disable
;
7114 $authplugins = array();
7115 foreach ($authsenabled as $auth) {
7116 $authplugin = get_auth_plugin($auth);
7117 $authplugins[$auth] = $authplugin;
7118 /// Get the auth title (from core or own auth lang files)
7119 $authtitle = $authplugin->get_title();
7121 $displayauths[$auth] = $authtitle;
7122 if ($authplugin->can_signup()) {
7123 $registrationauths[$auth] = $authtitle;
7127 foreach ($authsavailable as $auth => $dir) {
7128 if (array_key_exists($auth, $displayauths)) {
7129 continue; //already in the list
7131 $authplugin = get_auth_plugin($auth);
7132 $authplugins[$auth] = $authplugin;
7133 /// Get the auth title (from core or own auth lang files)
7134 $authtitle = $authplugin->get_title();
7136 $displayauths[$auth] = $authtitle;
7137 if ($authplugin->can_signup()) {
7138 $registrationauths[$auth] = $authtitle;
7142 $return = $OUTPUT->heading(get_string('actauthhdr', 'auth'), 3, 'main');
7143 if (in_array('mnet', $authsenabled)) {
7144 $notify = new \core\output\notification
(get_string('xmlrpcmnetauthenticationenabled', 'admin'),
7145 \core\output\notification
::NOTIFY_WARNING
);
7146 $return .= $OUTPUT->render($notify);
7148 $return .= $OUTPUT->box_start('generalbox authsui');
7150 $table = new html_table();
7151 $table->head
= array($txt->name
, $txt->users
, $txt->enable
, $txt->updown
, $txt->settings
, $txt->testsettings
, $txt->uninstall
);
7152 $table->colclasses
= array('leftalign', 'centeralign', 'centeralign', 'centeralign', 'centeralign', 'centeralign', 'centeralign');
7153 $table->data
= array();
7154 $table->attributes
['class'] = 'admintable generaltable';
7155 $table->id
= 'manageauthtable';
7157 //add always enabled plugins first
7158 $displayname = $displayauths['manual'];
7159 $settings = "<a href=\"settings.php?section=authsettingmanual\">{$txt->settings}</a>";
7160 $usercount = $DB->count_records('user', array('auth'=>'manual', 'deleted'=>0));
7161 $table->data
[] = array($displayname, $usercount, '', '', $settings, '', '');
7162 $displayname = $displayauths['nologin'];
7163 $usercount = $DB->count_records('user', array('auth'=>'nologin', 'deleted'=>0));
7164 $table->data
[] = array($displayname, $usercount, '', '', '', '', '');
7167 // iterate through auth plugins and add to the display table
7169 $authcount = count($authsenabled);
7170 $url = "auth.php?sesskey=" . sesskey();
7171 foreach ($displayauths as $auth => $name) {
7172 if ($auth == 'manual' or $auth == 'nologin') {
7177 if (in_array($auth, $authsenabled)) {
7178 $hideshow = "<a href=\"$url&action=disable&auth=$auth\">";
7179 $hideshow .= $OUTPUT->pix_icon('t/hide', get_string('disable')) . '</a>';
7181 $displayname = $name;
7184 $hideshow = "<a href=\"$url&action=enable&auth=$auth\">";
7185 $hideshow .= $OUTPUT->pix_icon('t/show', get_string('enable')) . '</a>';
7187 $displayname = $name;
7188 $class = 'dimmed_text';
7191 $usercount = $DB->count_records('user', array('auth'=>$auth, 'deleted'=>0));
7193 // up/down link (only if auth is enabled)
7196 if ($updowncount > 1) {
7197 $updown .= "<a href=\"$url&action=up&auth=$auth\">";
7198 $updown .= $OUTPUT->pix_icon('t/up', get_string('moveup')) . '</a> ';
7201 $updown .= $OUTPUT->spacer() . ' ';
7203 if ($updowncount < $authcount) {
7204 $updown .= "<a href=\"$url&action=down&auth=$auth\">";
7205 $updown .= $OUTPUT->pix_icon('t/down', get_string('movedown')) . '</a> ';
7208 $updown .= $OUTPUT->spacer() . ' ';
7214 if (file_exists($CFG->dirroot
.'/auth/'.$auth.'/settings.php')) {
7215 $settings = "<a href=\"settings.php?section=authsetting$auth\">{$txt->settings}</a>";
7216 } else if (file_exists($CFG->dirroot
.'/auth/'.$auth.'/config.html')) {
7217 $settings = "<a href=\"auth_config.php?auth=$auth\">{$txt->settings}</a>";
7224 if ($uninstallurl = core_plugin_manager
::instance()->get_uninstall_url('auth_'.$auth, 'manage')) {
7225 $uninstall = html_writer
::link($uninstallurl, $txt->uninstall
);
7229 if (!empty($authplugins[$auth]) and method_exists($authplugins[$auth], 'test_settings')) {
7230 $testurl = new moodle_url('/auth/test_settings.php', array('auth'=>$auth, 'sesskey'=>sesskey()));
7231 $test = html_writer
::link($testurl, $txt->testsettings
);
7234 // Add a row to the table.
7235 $row = new html_table_row(array($displayname, $usercount, $hideshow, $updown, $settings, $test, $uninstall));
7237 $row->attributes
['class'] = $class;
7239 $table->data
[] = $row;
7241 $return .= html_writer
::table($table);
7242 $return .= get_string('configauthenticationplugins', 'admin').'<br />'.get_string('tablenosave', 'filters');
7243 $return .= $OUTPUT->box_end();
7244 return highlight($query, $return);
7250 * Special class for authentication administration.
7252 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
7254 class admin_setting_manageeditors
extends admin_setting
{
7256 * Calls parent::__construct with specific arguments
7258 public function __construct() {
7259 $this->nosave
= true;
7260 parent
::__construct('editorsui', get_string('editorsettings', 'editor'), '', '');
7264 * Always returns true, does nothing
7268 public function get_setting() {
7273 * Always returns true, does nothing
7277 public function get_defaultsetting() {
7282 * Always returns '', does not write anything
7284 * @return string Always returns ''
7286 public function write_setting($data) {
7287 // do not write any setting
7292 * Checks if $query is one of the available editors
7294 * @param string $query The string to search for
7295 * @return bool Returns true if found, false if not
7297 public function is_related($query) {
7298 if (parent
::is_related($query)) {
7302 $editors_available = editors_get_available();
7303 foreach ($editors_available as $editor=>$editorstr) {
7304 if (strpos($editor, $query) !== false) {
7307 if (strpos(core_text
::strtolower($editorstr), $query) !== false) {
7315 * Builds the XHTML to display the control
7317 * @param string $data Unused
7318 * @param string $query
7321 public function output_html($data, $query='') {
7322 global $CFG, $OUTPUT;
7325 $txt = get_strings(array('administration', 'settings', 'edit', 'name', 'enable', 'disable',
7326 'up', 'down', 'none'));
7327 $struninstall = get_string('uninstallplugin', 'core_admin');
7329 $txt->updown
= "$txt->up/$txt->down";
7331 $editors_available = editors_get_available();
7332 $active_editors = explode(',', $CFG->texteditors
);
7334 $active_editors = array_reverse($active_editors);
7335 foreach ($active_editors as $key=>$editor) {
7336 if (empty($editors_available[$editor])) {
7337 unset($active_editors[$key]);
7339 $name = $editors_available[$editor];
7340 unset($editors_available[$editor]);
7341 $editors_available[$editor] = $name;
7344 if (empty($active_editors)) {
7345 //$active_editors = array('textarea');
7347 $editors_available = array_reverse($editors_available, true);
7348 $return = $OUTPUT->heading(get_string('acteditorshhdr', 'editor'), 3, 'main', true);
7349 $return .= $OUTPUT->box_start('generalbox editorsui');
7351 $table = new html_table();
7352 $table->head
= array($txt->name
, $txt->enable
, $txt->updown
, $txt->settings
, $struninstall);
7353 $table->colclasses
= array('leftalign', 'centeralign', 'centeralign', 'centeralign', 'centeralign');
7354 $table->id
= 'editormanagement';
7355 $table->attributes
['class'] = 'admintable generaltable';
7356 $table->data
= array();
7358 // iterate through auth plugins and add to the display table
7360 $editorcount = count($active_editors);
7361 $url = "editors.php?sesskey=" . sesskey();
7362 foreach ($editors_available as $editor => $name) {
7365 if (in_array($editor, $active_editors)) {
7366 $hideshow = "<a href=\"$url&action=disable&editor=$editor\">";
7367 $hideshow .= $OUTPUT->pix_icon('t/hide', get_string('disable')) . '</a>';
7369 $displayname = $name;
7372 $hideshow = "<a href=\"$url&action=enable&editor=$editor\">";
7373 $hideshow .= $OUTPUT->pix_icon('t/show', get_string('enable')) . '</a>';
7375 $displayname = $name;
7376 $class = 'dimmed_text';
7379 // up/down link (only if auth is enabled)
7382 if ($updowncount > 1) {
7383 $updown .= "<a href=\"$url&action=up&editor=$editor\">";
7384 $updown .= $OUTPUT->pix_icon('t/up', get_string('moveup')) . '</a> ';
7387 $updown .= $OUTPUT->spacer() . ' ';
7389 if ($updowncount < $editorcount) {
7390 $updown .= "<a href=\"$url&action=down&editor=$editor\">";
7391 $updown .= $OUTPUT->pix_icon('t/down', get_string('movedown')) . '</a> ';
7394 $updown .= $OUTPUT->spacer() . ' ';
7400 if (file_exists($CFG->dirroot
.'/lib/editor/'.$editor.'/settings.php')) {
7401 $eurl = new moodle_url('/admin/settings.php', array('section'=>'editorsettings'.$editor));
7402 $settings = "<a href='$eurl'>{$txt->settings}</a>";
7408 if ($uninstallurl = core_plugin_manager
::instance()->get_uninstall_url('editor_'.$editor, 'manage')) {
7409 $uninstall = html_writer
::link($uninstallurl, $struninstall);
7412 // Add a row to the table.
7413 $row = new html_table_row(array($displayname, $hideshow, $updown, $settings, $uninstall));
7415 $row->attributes
['class'] = $class;
7417 $table->data
[] = $row;
7419 $return .= html_writer
::table($table);
7420 $return .= get_string('configeditorplugins', 'editor').'<br />'.get_string('tablenosave', 'admin');
7421 $return .= $OUTPUT->box_end();
7422 return highlight($query, $return);
7427 * Special class for antiviruses administration.
7429 * @copyright 2015 Ruslan Kabalin, Lancaster University.
7430 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
7432 class admin_setting_manageantiviruses
extends admin_setting
{
7434 * Calls parent::__construct with specific arguments
7436 public function __construct() {
7437 $this->nosave
= true;
7438 parent
::__construct('antivirusesui', get_string('antivirussettings', 'antivirus'), '', '');
7442 * Always returns true, does nothing
7446 public function get_setting() {
7451 * Always returns true, does nothing
7455 public function get_defaultsetting() {
7460 * Always returns '', does not write anything
7462 * @param string $data Unused
7463 * @return string Always returns ''
7465 public function write_setting($data) {
7466 // Do not write any setting.
7471 * Checks if $query is one of the available editors
7473 * @param string $query The string to search for
7474 * @return bool Returns true if found, false if not
7476 public function is_related($query) {
7477 if (parent
::is_related($query)) {
7481 $antivirusesavailable = \core\antivirus\manager
::get_available();
7482 foreach ($antivirusesavailable as $antivirus => $antivirusstr) {
7483 if (strpos($antivirus, $query) !== false) {
7486 if (strpos(core_text
::strtolower($antivirusstr), $query) !== false) {
7494 * Builds the XHTML to display the control
7496 * @param string $data Unused
7497 * @param string $query
7500 public function output_html($data, $query='') {
7501 global $CFG, $OUTPUT;
7504 $txt = get_strings(array('administration', 'settings', 'edit', 'name', 'enable', 'disable',
7505 'up', 'down', 'none'));
7506 $struninstall = get_string('uninstallplugin', 'core_admin');
7508 $txt->updown
= "$txt->up/$txt->down";
7510 $antivirusesavailable = \core\antivirus\manager
::get_available();
7511 $activeantiviruses = explode(',', $CFG->antiviruses
);
7513 $activeantiviruses = array_reverse($activeantiviruses);
7514 foreach ($activeantiviruses as $key => $antivirus) {
7515 if (empty($antivirusesavailable[$antivirus])) {
7516 unset($activeantiviruses[$key]);
7518 $name = $antivirusesavailable[$antivirus];
7519 unset($antivirusesavailable[$antivirus]);
7520 $antivirusesavailable[$antivirus] = $name;
7523 $antivirusesavailable = array_reverse($antivirusesavailable, true);
7524 $return = $OUTPUT->heading(get_string('actantivirushdr', 'antivirus'), 3, 'main', true);
7525 $return .= $OUTPUT->box_start('generalbox antivirusesui');
7527 $table = new html_table();
7528 $table->head
= array($txt->name
, $txt->enable
, $txt->updown
, $txt->settings
, $struninstall);
7529 $table->colclasses
= array('leftalign', 'centeralign', 'centeralign', 'centeralign', 'centeralign');
7530 $table->id
= 'antivirusmanagement';
7531 $table->attributes
['class'] = 'admintable generaltable';
7532 $table->data
= array();
7534 // Iterate through auth plugins and add to the display table.
7536 $antiviruscount = count($activeantiviruses);
7537 $baseurl = new moodle_url('/admin/antiviruses.php', array('sesskey' => sesskey()));
7538 foreach ($antivirusesavailable as $antivirus => $name) {
7541 if (in_array($antivirus, $activeantiviruses)) {
7542 $hideshowurl = $baseurl;
7543 $hideshowurl->params(array('action' => 'disable', 'antivirus' => $antivirus));
7544 $hideshowimg = $OUTPUT->pix_icon('t/hide', get_string('disable'));
7545 $hideshow = html_writer
::link($hideshowurl, $hideshowimg);
7547 $displayname = $name;
7549 $hideshowurl = $baseurl;
7550 $hideshowurl->params(array('action' => 'enable', 'antivirus' => $antivirus));
7551 $hideshowimg = $OUTPUT->pix_icon('t/show', get_string('enable'));
7552 $hideshow = html_writer
::link($hideshowurl, $hideshowimg);
7554 $displayname = $name;
7555 $class = 'dimmed_text';
7561 if ($updowncount > 1) {
7562 $updownurl = $baseurl;
7563 $updownurl->params(array('action' => 'up', 'antivirus' => $antivirus));
7564 $updownimg = $OUTPUT->pix_icon('t/up', get_string('moveup'));
7565 $updown = html_writer
::link($updownurl, $updownimg);
7567 $updownimg = $OUTPUT->spacer();
7569 if ($updowncount < $antiviruscount) {
7570 $updownurl = $baseurl;
7571 $updownurl->params(array('action' => 'down', 'antivirus' => $antivirus));
7572 $updownimg = $OUTPUT->pix_icon('t/down', get_string('movedown'));
7573 $updown = html_writer
::link($updownurl, $updownimg);
7575 $updownimg = $OUTPUT->spacer();
7581 if (file_exists($CFG->dirroot
.'/lib/antivirus/'.$antivirus.'/settings.php')) {
7582 $eurl = new moodle_url('/admin/settings.php', array('section' => 'antivirussettings'.$antivirus));
7583 $settings = html_writer
::link($eurl, $txt->settings
);
7589 if ($uninstallurl = core_plugin_manager
::instance()->get_uninstall_url('antivirus_'.$antivirus, 'manage')) {
7590 $uninstall = html_writer
::link($uninstallurl, $struninstall);
7593 // Add a row to the table.
7594 $row = new html_table_row(array($displayname, $hideshow, $updown, $settings, $uninstall));
7596 $row->attributes
['class'] = $class;
7598 $table->data
[] = $row;
7600 $return .= html_writer
::table($table);
7601 $return .= get_string('configantivirusplugins', 'antivirus') . html_writer
::empty_tag('br') . get_string('tablenosave', 'admin');
7602 $return .= $OUTPUT->box_end();
7603 return highlight($query, $return);
7608 * Special class for license administration.
7610 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
7611 * @deprecated since Moodle 3.9 MDL-45184. Please use \tool_licensemanager\manager instead.
7612 * @todo MDL-45184 This class will be deleted in Moodle 4.1.
7614 class admin_setting_managelicenses
extends admin_setting
{
7616 * @deprecated since Moodle 3.9 MDL-45184. Please use \tool_licensemanager\manager instead.
7617 * @todo MDL-45184 This class will be deleted in Moodle 4.1
7619 public function __construct() {
7622 debugging('admin_setting_managelicenses class is deprecated. Please use \tool_licensemanager\manager instead.',
7625 // Replace admin setting load with new external page load for tool_licensemanager, if not loaded already.
7626 if (!is_null($ADMIN->locate('licensemanager'))) {
7627 $temp = new admin_externalpage('licensemanager',
7628 get_string('licensemanager', 'tool_licensemanager'),
7629 \tool_licensemanager\helper
::get_licensemanager_url());
7631 $ADMIN->add('license', $temp);
7636 * Always returns true, does nothing
7638 * @deprecated since Moodle 3.9 MDL-45184.
7639 * @todo MDL-45184 This method will be deleted in Moodle 4.1
7643 public function get_setting() {
7644 debugging('admin_setting_managelicenses class is deprecated. Please use \tool_licensemanager\manager instead.',
7651 * Always returns true, does nothing
7653 * @deprecated since Moodle 3.9 MDL-45184.
7654 * @todo MDL-45184 This method will be deleted in Moodle 4.1
7658 public function get_defaultsetting() {
7659 debugging('admin_setting_managelicenses class is deprecated. Please use \tool_licensemanager\manager instead.',
7666 * Always returns '', does not write anything
7668 * @deprecated since Moodle 3.9 MDL-45184.
7669 * @todo MDL-45184 This method will be deleted in Moodle 4.1
7671 * @return string Always returns ''
7673 public function write_setting($data) {
7674 debugging('admin_setting_managelicenses class is deprecated. Please use \tool_licensemanager\manager instead.',
7677 // do not write any setting
7682 * Builds the XHTML to display the control
7684 * @deprecated since Moodle 3.9 MDL-45184. Please use \tool_licensemanager\manager instead.
7685 * @todo MDL-45184 This method will be deleted in Moodle 4.1
7687 * @param string $data Unused
7688 * @param string $query
7691 public function output_html($data, $query='') {
7692 debugging('admin_setting_managelicenses class is deprecated. Please use \tool_licensemanager\manager instead.',
7695 redirect(\tool_licensemanager\helper
::get_licensemanager_url());
7700 * Course formats manager. Allows to enable/disable formats and jump to settings
7702 class admin_setting_manageformats
extends admin_setting
{
7705 * Calls parent::__construct with specific arguments
7707 public function __construct() {
7708 $this->nosave
= true;
7709 parent
::__construct('formatsui', new lang_string('manageformats', 'core_admin'), '', '');
7713 * Always returns true
7717 public function get_setting() {
7722 * Always returns true
7726 public function get_defaultsetting() {
7731 * Always returns '' and doesn't write anything
7733 * @param mixed $data string or array, must not be NULL
7734 * @return string Always returns ''
7736 public function write_setting($data) {
7737 // do not write any setting
7742 * Search to find if Query is related to format plugin
7744 * @param string $query The string to search for
7745 * @return bool true for related false for not
7747 public function is_related($query) {
7748 if (parent
::is_related($query)) {
7751 $formats = core_plugin_manager
::instance()->get_plugins_of_type('format');
7752 foreach ($formats as $format) {
7753 if (strpos($format->component
, $query) !== false ||
7754 strpos(core_text
::strtolower($format->displayname
), $query) !== false) {
7762 * Return XHTML to display control
7764 * @param mixed $data Unused
7765 * @param string $query
7766 * @return string highlight
7768 public function output_html($data, $query='') {
7769 global $CFG, $OUTPUT;
7771 $return = $OUTPUT->heading(new lang_string('courseformats'), 3, 'main');
7772 $return .= $OUTPUT->box_start('generalbox formatsui');
7774 $formats = core_plugin_manager
::instance()->get_plugins_of_type('format');
7777 $txt = get_strings(array('settings', 'name', 'enable', 'disable', 'up', 'down', 'default'));
7778 $txt->uninstall
= get_string('uninstallplugin', 'core_admin');
7779 $txt->updown
= "$txt->up/$txt->down";
7781 $table = new html_table();
7782 $table->head
= array($txt->name
, $txt->enable
, $txt->updown
, $txt->uninstall
, $txt->settings
);
7783 $table->align
= array('left', 'center', 'center', 'center', 'center');
7784 $table->attributes
['class'] = 'manageformattable generaltable admintable';
7785 $table->data
= array();
7788 $defaultformat = get_config('moodlecourse', 'format');
7789 $spacer = $OUTPUT->pix_icon('spacer', '', 'moodle', array('class' => 'iconsmall'));
7790 foreach ($formats as $format) {
7791 $url = new moodle_url('/admin/courseformats.php',
7792 array('sesskey' => sesskey(), 'format' => $format->name
));
7795 if ($format->is_enabled()) {
7796 $strformatname = $format->displayname
;
7797 if ($defaultformat === $format->name
) {
7798 $hideshow = $txt->default;
7800 $hideshow = html_writer
::link($url->out(false, array('action' => 'disable')),
7801 $OUTPUT->pix_icon('t/hide', $txt->disable
, 'moodle', array('class' => 'iconsmall')));
7804 $strformatname = $format->displayname
;
7805 $class = 'dimmed_text';
7806 $hideshow = html_writer
::link($url->out(false, array('action' => 'enable')),
7807 $OUTPUT->pix_icon('t/show', $txt->enable
, 'moodle', array('class' => 'iconsmall')));
7811 $updown .= html_writer
::link($url->out(false, array('action' => 'up')),
7812 $OUTPUT->pix_icon('t/up', $txt->up
, 'moodle', array('class' => 'iconsmall'))). '';
7816 if ($cnt < count($formats) - 1) {
7817 $updown .= ' '.html_writer
::link($url->out(false, array('action' => 'down')),
7818 $OUTPUT->pix_icon('t/down', $txt->down
, 'moodle', array('class' => 'iconsmall')));
7824 if ($format->get_settings_url()) {
7825 $settings = html_writer
::link($format->get_settings_url(), $txt->settings
);
7828 if ($uninstallurl = core_plugin_manager
::instance()->get_uninstall_url('format_'.$format->name
, 'manage')) {
7829 $uninstall = html_writer
::link($uninstallurl, $txt->uninstall
);
7831 $row = new html_table_row(array($strformatname, $hideshow, $updown, $uninstall, $settings));
7833 $row->attributes
['class'] = $class;
7835 $table->data
[] = $row;
7837 $return .= html_writer
::table($table);
7838 $link = html_writer
::link(new moodle_url('/admin/settings.php', array('section' => 'coursesettings')), new lang_string('coursesettings'));
7839 $return .= html_writer
::tag('p', get_string('manageformatsgotosettings', 'admin', $link));
7840 $return .= $OUTPUT->box_end();
7841 return highlight($query, $return);
7846 * Custom fields manager. Allows to enable/disable custom fields and jump to settings.
7849 * @copyright 2018 Toni Barbera
7850 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
7852 class admin_setting_managecustomfields
extends admin_setting
{
7855 * Calls parent::__construct with specific arguments
7857 public function __construct() {
7858 $this->nosave
= true;
7859 parent
::__construct('customfieldsui', new lang_string('managecustomfields', 'core_admin'), '', '');
7863 * Always returns true
7867 public function get_setting() {
7872 * Always returns true
7876 public function get_defaultsetting() {
7881 * Always returns '' and doesn't write anything
7883 * @param mixed $data string or array, must not be NULL
7884 * @return string Always returns ''
7886 public function write_setting($data) {
7887 // Do not write any setting.
7892 * Search to find if Query is related to format plugin
7894 * @param string $query The string to search for
7895 * @return bool true for related false for not
7897 public function is_related($query) {
7898 if (parent
::is_related($query)) {
7901 $formats = core_plugin_manager
::instance()->get_plugins_of_type('customfield');
7902 foreach ($formats as $format) {
7903 if (strpos($format->component
, $query) !== false ||
7904 strpos(core_text
::strtolower($format->displayname
), $query) !== false) {
7912 * Return XHTML to display control
7914 * @param mixed $data Unused
7915 * @param string $query
7916 * @return string highlight
7918 public function output_html($data, $query='') {
7919 global $CFG, $OUTPUT;
7921 $return = $OUTPUT->heading(new lang_string('customfields', 'core_customfield'), 3, 'main');
7922 $return .= $OUTPUT->box_start('generalbox customfieldsui');
7924 $fields = core_plugin_manager
::instance()->get_plugins_of_type('customfield');
7926 $txt = get_strings(array('settings', 'name', 'enable', 'disable', 'up', 'down'));
7927 $txt->uninstall
= get_string('uninstallplugin', 'core_admin');
7928 $txt->updown
= "$txt->up/$txt->down";
7930 $table = new html_table();
7931 $table->head
= array($txt->name
, $txt->enable
, $txt->uninstall
, $txt->settings
);
7932 $table->align
= array('left', 'center', 'center', 'center');
7933 $table->attributes
['class'] = 'managecustomfieldtable generaltable admintable';
7934 $table->data
= array();
7936 $spacer = $OUTPUT->pix_icon('spacer', '', 'moodle', array('class' => 'iconsmall'));
7937 foreach ($fields as $field) {
7938 $url = new moodle_url('/admin/customfields.php',
7939 array('sesskey' => sesskey(), 'field' => $field->name
));
7941 if ($field->is_enabled()) {
7942 $strfieldname = $field->displayname
;
7944 $hideshow = html_writer
::link($url->out(false, array('action' => 'disable')),
7945 $OUTPUT->pix_icon('t/hide', $txt->disable
, 'moodle', array('class' => 'iconsmall')));
7947 $strfieldname = $field->displayname
;
7948 $class = 'dimmed_text';
7949 $hideshow = html_writer
::link($url->out(false, array('action' => 'enable')),
7950 $OUTPUT->pix_icon('t/show', $txt->enable
, 'moodle', array('class' => 'iconsmall')));
7953 if ($field->get_settings_url()) {
7954 $settings = html_writer
::link($field->get_settings_url(), $txt->settings
);
7957 if ($uninstallurl = core_plugin_manager
::instance()->get_uninstall_url('customfield_'.$field->name
, 'manage')) {
7958 $uninstall = html_writer
::link($uninstallurl, $txt->uninstall
);
7960 $row = new html_table_row(array($strfieldname, $hideshow, $uninstall, $settings));
7961 $row->attributes
['class'] = $class;
7962 $table->data
[] = $row;
7964 $return .= html_writer
::table($table);
7965 $return .= $OUTPUT->box_end();
7966 return highlight($query, $return);
7971 * Data formats manager. Allow reorder and to enable/disable data formats and jump to settings
7973 * @copyright 2016 Brendan Heywood (brendan@catalyst-au.net)
7974 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
7976 class admin_setting_managedataformats
extends admin_setting
{
7979 * Calls parent::__construct with specific arguments
7981 public function __construct() {
7982 $this->nosave
= true;
7983 parent
::__construct('managedataformats', new lang_string('managedataformats'), '', '');
7987 * Always returns true
7991 public function get_setting() {
7996 * Always returns true
8000 public function get_defaultsetting() {
8005 * Always returns '' and doesn't write anything
8007 * @param mixed $data string or array, must not be NULL
8008 * @return string Always returns ''
8010 public function write_setting($data) {
8011 // Do not write any setting.
8016 * Search to find if Query is related to format plugin
8018 * @param string $query The string to search for
8019 * @return bool true for related false for not
8021 public function is_related($query) {
8022 if (parent
::is_related($query)) {
8025 $formats = core_plugin_manager
::instance()->get_plugins_of_type('dataformat');
8026 foreach ($formats as $format) {
8027 if (strpos($format->component
, $query) !== false ||
8028 strpos(core_text
::strtolower($format->displayname
), $query) !== false) {
8036 * Return XHTML to display control
8038 * @param mixed $data Unused
8039 * @param string $query
8040 * @return string highlight
8042 public function output_html($data, $query='') {
8043 global $CFG, $OUTPUT;
8046 $formats = core_plugin_manager
::instance()->get_plugins_of_type('dataformat');
8048 $txt = get_strings(array('settings', 'name', 'enable', 'disable', 'up', 'down', 'default'));
8049 $txt->uninstall
= get_string('uninstallplugin', 'core_admin');
8050 $txt->updown
= "$txt->up/$txt->down";
8052 $table = new html_table();
8053 $table->head
= array($txt->name
, $txt->enable
, $txt->updown
, $txt->uninstall
, $txt->settings
);
8054 $table->align
= array('left', 'center', 'center', 'center', 'center');
8055 $table->attributes
['class'] = 'manageformattable generaltable admintable';
8056 $table->data
= array();
8059 $spacer = $OUTPUT->pix_icon('spacer', '', 'moodle', array('class' => 'iconsmall'));
8061 foreach ($formats as $format) {
8062 if ($format->is_enabled() && $format->is_installed_and_upgraded()) {
8066 foreach ($formats as $format) {
8067 $status = $format->get_status();
8068 $url = new moodle_url('/admin/dataformats.php',
8069 array('sesskey' => sesskey(), 'name' => $format->name
));
8072 if ($format->is_enabled()) {
8073 $strformatname = $format->displayname
;
8074 if ($totalenabled == 1&& $format->is_enabled()) {
8077 $hideshow = html_writer
::link($url->out(false, array('action' => 'disable')),
8078 $OUTPUT->pix_icon('t/hide', $txt->disable
, 'moodle', array('class' => 'iconsmall')));
8081 $class = 'dimmed_text';
8082 $strformatname = $format->displayname
;
8083 $hideshow = html_writer
::link($url->out(false, array('action' => 'enable')),
8084 $OUTPUT->pix_icon('t/show', $txt->enable
, 'moodle', array('class' => 'iconsmall')));
8089 $updown .= html_writer
::link($url->out(false, array('action' => 'up')),
8090 $OUTPUT->pix_icon('t/up', $txt->up
, 'moodle', array('class' => 'iconsmall'))). '';
8094 if ($cnt < count($formats) - 1) {
8095 $updown .= ' '.html_writer
::link($url->out(false, array('action' => 'down')),
8096 $OUTPUT->pix_icon('t/down', $txt->down
, 'moodle', array('class' => 'iconsmall')));
8102 if ($status === core_plugin_manager
::PLUGIN_STATUS_MISSING
) {
8103 $uninstall = get_string('status_missing', 'core_plugin');
8104 } else if ($status === core_plugin_manager
::PLUGIN_STATUS_NEW
) {
8105 $uninstall = get_string('status_new', 'core_plugin');
8106 } else if ($uninstallurl = core_plugin_manager
::instance()->get_uninstall_url('dataformat_'.$format->name
, 'manage')) {
8107 if ($totalenabled != 1 ||
!$format->is_enabled()) {
8108 $uninstall = html_writer
::link($uninstallurl, $txt->uninstall
);
8113 if ($format->get_settings_url()) {
8114 $settings = html_writer
::link($format->get_settings_url(), $txt->settings
);
8117 $row = new html_table_row(array($strformatname, $hideshow, $updown, $uninstall, $settings));
8119 $row->attributes
['class'] = $class;
8121 $table->data
[] = $row;
8124 $return .= html_writer
::table($table);
8125 return highlight($query, $return);
8130 * Special class for filter administration.
8132 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
8134 class admin_page_managefilters
extends admin_externalpage
{
8136 * Calls parent::__construct with specific arguments
8138 public function __construct() {
8140 parent
::__construct('managefilters', get_string('filtersettings', 'admin'), "$CFG->wwwroot/$CFG->admin/filters.php");
8144 * Searches all installed filters for specified filter
8146 * @param string $query The filter(string) to search for
8147 * @param string $query
8149 public function search($query) {
8151 if ($result = parent
::search($query)) {
8156 $filternames = filter_get_all_installed();
8157 foreach ($filternames as $path => $strfiltername) {
8158 if (strpos(core_text
::strtolower($strfiltername), $query) !== false) {
8162 if (strpos($path, $query) !== false) {
8169 $result = new stdClass
;
8170 $result->page
= $this;
8171 $result->settings
= array();
8172 return array($this->name
=> $result);
8180 * Generic class for managing plugins in a table that allows re-ordering and enable/disable of each plugin.
8181 * Requires a get_rank method on the plugininfo class for sorting.
8183 * @copyright 2017 Damyon Wiese
8184 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
8186 abstract class admin_setting_manage_plugins
extends admin_setting
{
8189 * Get the admin settings section name (just a unique string)
8193 public function get_section_name() {
8194 return 'manage' . $this->get_plugin_type() . 'plugins';
8198 * Get the admin settings section title (use get_string).
8202 abstract public function get_section_title();
8205 * Get the type of plugin to manage.
8209 abstract public function get_plugin_type();
8212 * Get the name of the second column.
8216 public function get_info_column_name() {
8221 * Get the type of plugin to manage.
8223 * @param plugininfo The plugin info class.
8226 abstract public function get_info_column($plugininfo);
8229 * Calls parent::__construct with specific arguments
8231 public function __construct() {
8232 $this->nosave
= true;
8233 parent
::__construct($this->get_section_name(), $this->get_section_title(), '', '');
8237 * Always returns true, does nothing
8241 public function get_setting() {
8246 * Always returns true, does nothing
8250 public function get_defaultsetting() {
8255 * Always returns '', does not write anything
8257 * @param mixed $data
8258 * @return string Always returns ''
8260 public function write_setting($data) {
8261 // Do not write any setting.
8266 * Checks if $query is one of the available plugins of this type
8268 * @param string $query The string to search for
8269 * @return bool Returns true if found, false if not
8271 public function is_related($query) {
8272 if (parent
::is_related($query)) {
8276 $query = core_text
::strtolower($query);
8277 $plugins = core_plugin_manager
::instance()->get_plugins_of_type($this->get_plugin_type());
8278 foreach ($plugins as $name => $plugin) {
8279 $localised = $plugin->displayname
;
8280 if (strpos(core_text
::strtolower($name), $query) !== false) {
8283 if (strpos(core_text
::strtolower($localised), $query) !== false) {
8291 * The URL for the management page for this plugintype.
8293 * @return moodle_url
8295 protected function get_manage_url() {
8296 return new moodle_url('/admin/updatesetting.php');
8300 * Builds the HTML to display the control.
8302 * @param string $data Unused
8303 * @param string $query
8306 public function output_html($data, $query = '') {
8307 global $CFG, $OUTPUT, $DB, $PAGE;
8309 $context = (object) [
8310 'manageurl' => new moodle_url($this->get_manage_url(), [
8311 'type' => $this->get_plugin_type(),
8312 'sesskey' => sesskey(),
8314 'infocolumnname' => $this->get_info_column_name(),
8318 $pluginmanager = core_plugin_manager
::instance();
8319 $allplugins = $pluginmanager->get_plugins_of_type($this->get_plugin_type());
8320 $enabled = $pluginmanager->get_enabled_plugins($this->get_plugin_type());
8321 $plugins = array_merge($enabled, $allplugins);
8322 foreach ($plugins as $key => $plugin) {
8323 $pluginlink = new moodle_url($context->manageurl
, ['plugin' => $key]);
8325 $pluginkey = (object) [
8326 'plugin' => $plugin->displayname
,
8327 'enabled' => $plugin->is_enabled(),
8330 'movedownlink' => '',
8331 'settingslink' => $plugin->get_settings_url(),
8332 'uninstalllink' => '',
8336 // Enable/Disable link.
8337 $togglelink = new moodle_url($pluginlink);
8338 if ($plugin->is_enabled()) {
8339 $toggletarget = false;
8340 $togglelink->param('action', 'disable');
8342 if (count($context->plugins
)) {
8343 // This is not the first plugin.
8344 $pluginkey->moveuplink
= new moodle_url($pluginlink, ['action' => 'up']);
8347 if (count($enabled) > count($context->plugins
) +
1) {
8348 // This is not the last plugin.
8349 $pluginkey->movedownlink
= new moodle_url($pluginlink, ['action' => 'down']);
8352 $pluginkey->info
= $this->get_info_column($plugin);
8354 $toggletarget = true;
8355 $togglelink->param('action', 'enable');
8358 $pluginkey->toggletarget
= $toggletarget;
8359 $pluginkey->togglelink
= $togglelink;
8361 $frankenstyle = $plugin->type
. '_' . $plugin->name
;
8362 if ($uninstalllink = core_plugin_manager
::instance()->get_uninstall_url($frankenstyle, 'manage')) {
8363 // This plugin supports uninstallation.
8364 $pluginkey->uninstalllink
= $uninstalllink;
8367 if (!empty($this->get_info_column_name())) {
8368 // This plugintype has an info column.
8369 $pluginkey->info
= $this->get_info_column($plugin);
8372 $context->plugins
[] = $pluginkey;
8375 $str = $OUTPUT->render_from_template('core_admin/setting_manage_plugins', $context);
8376 return highlight($query, $str);
8381 * Generic class for managing plugins in a table that allows re-ordering and enable/disable of each plugin.
8382 * Requires a get_rank method on the plugininfo class for sorting.
8384 * @copyright 2017 Andrew Nicols <andrew@nicols.co.uk>
8385 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
8387 class admin_setting_manage_fileconverter_plugins
extends admin_setting_manage_plugins
{
8388 public function get_section_title() {
8389 return get_string('type_fileconverter_plural', 'plugin');
8392 public function get_plugin_type() {
8393 return 'fileconverter';
8396 public function get_info_column_name() {
8397 return get_string('supportedconversions', 'plugin');
8400 public function get_info_column($plugininfo) {
8401 return $plugininfo->get_supported_conversions();
8406 * Special class for media player plugins management.
8408 * @copyright 2016 Marina Glancy
8409 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
8411 class admin_setting_managemediaplayers
extends admin_setting
{
8413 * Calls parent::__construct with specific arguments
8415 public function __construct() {
8416 $this->nosave
= true;
8417 parent
::__construct('managemediaplayers', get_string('managemediaplayers', 'media'), '', '');
8421 * Always returns true, does nothing
8425 public function get_setting() {
8430 * Always returns true, does nothing
8434 public function get_defaultsetting() {
8439 * Always returns '', does not write anything
8441 * @param mixed $data
8442 * @return string Always returns ''
8444 public function write_setting($data) {
8445 // Do not write any setting.
8450 * Checks if $query is one of the available enrol plugins
8452 * @param string $query The string to search for
8453 * @return bool Returns true if found, false if not
8455 public function is_related($query) {
8456 if (parent
::is_related($query)) {
8460 $query = core_text
::strtolower($query);
8461 $plugins = core_plugin_manager
::instance()->get_plugins_of_type('media');
8462 foreach ($plugins as $name => $plugin) {
8463 $localised = $plugin->displayname
;
8464 if (strpos(core_text
::strtolower($name), $query) !== false) {
8467 if (strpos(core_text
::strtolower($localised), $query) !== false) {
8475 * Sort plugins so enabled plugins are displayed first and all others are displayed in the end sorted by rank.
8476 * @return \core\plugininfo\media[]
8478 protected function get_sorted_plugins() {
8479 $pluginmanager = core_plugin_manager
::instance();
8481 $plugins = $pluginmanager->get_plugins_of_type('media');
8482 $enabledplugins = $pluginmanager->get_enabled_plugins('media');
8484 // Sort plugins so enabled plugins are displayed first and all others are displayed in the end sorted by rank.
8485 \core_collator
::asort_objects_by_method($plugins, 'get_rank', \core_collator
::SORT_NUMERIC
);
8487 $order = array_values($enabledplugins);
8488 $order = array_merge($order, array_diff(array_reverse(array_keys($plugins)), $order));
8490 $sortedplugins = array();
8491 foreach ($order as $name) {
8492 $sortedplugins[$name] = $plugins[$name];
8495 return $sortedplugins;
8499 * Builds the XHTML to display the control
8501 * @param string $data Unused
8502 * @param string $query
8505 public function output_html($data, $query='') {
8506 global $CFG, $OUTPUT, $DB, $PAGE;
8509 $strup = get_string('up');
8510 $strdown = get_string('down');
8511 $strsettings = get_string('settings');
8512 $strenable = get_string('enable');
8513 $strdisable = get_string('disable');
8514 $struninstall = get_string('uninstallplugin', 'core_admin');
8515 $strversion = get_string('version');
8516 $strname = get_string('name');
8517 $strsupports = get_string('supports', 'core_media');
8519 $pluginmanager = core_plugin_manager
::instance();
8521 $plugins = $this->get_sorted_plugins();
8522 $enabledplugins = $pluginmanager->get_enabled_plugins('media');
8524 $return = $OUTPUT->box_start('generalbox mediaplayersui');
8526 $table = new html_table();
8527 $table->head
= array($strname, $strsupports, $strversion,
8528 $strenable, $strup.'/'.$strdown, $strsettings, $struninstall);
8529 $table->colclasses
= array('leftalign', 'leftalign', 'centeralign',
8530 'centeralign', 'centeralign', 'centeralign', 'centeralign');
8531 $table->id
= 'mediaplayerplugins';
8532 $table->attributes
['class'] = 'admintable generaltable';
8533 $table->data
= array();
8535 // Iterate through media plugins and add to the display table.
8537 $url = new moodle_url('/admin/media.php', array('sesskey' => sesskey()));
8539 $spacer = $OUTPUT->pix_icon('spacer', '', 'moodle', array('class' => 'iconsmall'));
8541 $usedextensions = [];
8542 foreach ($plugins as $name => $plugin) {
8543 $url->param('media', $name);
8544 $plugininfo = $pluginmanager->get_plugin_info('media_'.$name);
8545 $version = $plugininfo->versiondb
;
8546 $supports = $plugininfo->supports($usedextensions);
8550 if (!$plugininfo->is_installed_and_upgraded()) {
8553 $displayname = '<span class="notifyproblem">'.$name.'</span>';
8555 $enabled = $plugininfo->is_enabled();
8557 $hideshow = html_writer
::link(new moodle_url($url, array('action' => 'disable')),
8558 $OUTPUT->pix_icon('t/hide', $strdisable, 'moodle', array('class' => 'iconsmall')));
8560 $hideshow = html_writer
::link(new moodle_url($url, array('action' => 'enable')),
8561 $OUTPUT->pix_icon('t/show', $strenable, 'moodle', array('class' => 'iconsmall')));
8562 $class = 'dimmed_text';
8564 $displayname = $plugin->displayname
;
8565 if (get_string_manager()->string_exists('pluginname_help', 'media_' . $name)) {
8566 $displayname .= ' ' . $OUTPUT->help_icon('pluginname', 'media_' . $name);
8569 if ($PAGE->theme
->resolve_image_location('icon', 'media_' . $name, false)) {
8570 $icon = $OUTPUT->pix_icon('icon', '', 'media_' . $name, array('class' => 'icon pluginicon'));
8572 $icon = $OUTPUT->pix_icon('spacer', '', 'moodle', array('class' => 'icon pluginicon noicon'));
8575 // Up/down link (only if enrol is enabled).
8578 if ($updowncount > 1) {
8579 $updown = html_writer
::link(new moodle_url($url, array('action' => 'up')),
8580 $OUTPUT->pix_icon('t/up', $strup, 'moodle', array('class' => 'iconsmall')));
8584 if ($updowncount < count($enabledplugins)) {
8585 $updown .= html_writer
::link(new moodle_url($url, array('action' => 'down')),
8586 $OUTPUT->pix_icon('t/down', $strdown, 'moodle', array('class' => 'iconsmall')));
8594 $status = $plugininfo->get_status();
8595 if ($status === core_plugin_manager
::PLUGIN_STATUS_MISSING
) {
8596 $uninstall = get_string('status_missing', 'core_plugin') . '<br/>';
8598 if ($status === core_plugin_manager
::PLUGIN_STATUS_NEW
) {
8599 $uninstall = get_string('status_new', 'core_plugin');
8600 } else if ($uninstallurl = $pluginmanager->get_uninstall_url('media_'.$name, 'manage')) {
8601 $uninstall .= html_writer
::link($uninstallurl, $struninstall);
8605 if ($plugininfo->get_settings_url()) {
8606 $settings = html_writer
::link($plugininfo->get_settings_url(), $strsettings);
8609 // Add a row to the table.
8610 $row = new html_table_row(array($icon.$displayname, $supports, $version, $hideshow, $updown, $settings, $uninstall));
8612 $row->attributes
['class'] = $class;
8614 $table->data
[] = $row;
8616 $printed[$name] = true;
8619 $return .= html_writer
::table($table);
8620 $return .= $OUTPUT->box_end();
8621 return highlight($query, $return);
8627 * Content bank content types manager. Allow reorder and to enable/disable content bank content types and jump to settings
8629 * @copyright 2020 Amaia Anabitarte <amaia@moodle.com>
8630 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
8632 class admin_setting_managecontentbankcontenttypes
extends admin_setting
{
8635 * Calls parent::__construct with specific arguments
8637 public function __construct() {
8638 $this->nosave
= true;
8639 parent
::__construct('contentbank', new lang_string('managecontentbanktypes'), '', '');
8643 * Always returns true
8647 public function get_setting() {
8652 * Always returns true
8656 public function get_defaultsetting() {
8661 * Always returns '' and doesn't write anything
8663 * @param mixed $data string or array, must not be NULL
8664 * @return string Always returns ''
8666 public function write_setting($data) {
8667 // Do not write any setting.
8672 * Search to find if Query is related to content bank plugin
8674 * @param string $query The string to search for
8675 * @return bool true for related false for not
8677 public function is_related($query) {
8678 if (parent
::is_related($query)) {
8681 $types = core_plugin_manager
::instance()->get_plugins_of_type('contenttype');
8682 foreach ($types as $type) {
8683 if (strpos($type->component
, $query) !== false ||
8684 strpos(core_text
::strtolower($type->displayname
), $query) !== false) {
8692 * Return XHTML to display control
8694 * @param mixed $data Unused
8695 * @param string $query
8696 * @return string highlight
8698 public function output_html($data, $query='') {
8699 global $CFG, $OUTPUT;
8702 $types = core_plugin_manager
::instance()->get_plugins_of_type('contenttype');
8703 $txt = get_strings(array('settings', 'name', 'enable', 'disable', 'order', 'up', 'down', 'default'));
8704 $txt->uninstall
= get_string('uninstallplugin', 'core_admin');
8706 $table = new html_table();
8707 $table->head
= array($txt->name
, $txt->enable
, $txt->order
, $txt->settings
, $txt->uninstall
);
8708 $table->align
= array('left', 'center', 'center', 'center', 'center');
8709 $table->attributes
['class'] = 'managecontentbanktable generaltable admintable';
8710 $table->data
= array();
8711 $spacer = $OUTPUT->pix_icon('spacer', '', 'moodle', array('class' => 'iconsmall'));
8715 foreach ($types as $type) {
8716 if ($type->is_enabled() && $type->is_installed_and_upgraded()) {
8721 foreach ($types as $type) {
8722 $url = new moodle_url('/admin/contentbank.php',
8723 array('sesskey' => sesskey(), 'name' => $type->name
));
8726 $strtypename = $type->displayname
;
8727 if ($type->is_enabled()) {
8728 $hideshow = html_writer
::link($url->out(false, array('action' => 'disable')),
8729 $OUTPUT->pix_icon('t/hide', $txt->disable
, 'moodle', array('class' => 'iconsmall')));
8731 $class = 'dimmed_text';
8732 $hideshow = html_writer
::link($url->out(false, array('action' => 'enable')),
8733 $OUTPUT->pix_icon('t/show', $txt->enable
, 'moodle', array('class' => 'iconsmall')));
8738 $updown .= html_writer
::link($url->out(false, array('action' => 'up')),
8739 $OUTPUT->pix_icon('t/up', $txt->up
, 'moodle', array('class' => 'iconsmall'))). '';
8743 if ($count < count($types) - 1) {
8744 $updown .= ' '.html_writer
::link($url->out(false, array('action' => 'down')),
8745 $OUTPUT->pix_icon('t/down', $txt->down
, 'moodle', array('class' => 'iconsmall')));
8751 if ($type->get_settings_url()) {
8752 $settings = html_writer
::link($type->get_settings_url(), $txt->settings
);
8756 if ($uninstallurl = core_plugin_manager
::instance()->get_uninstall_url('contenttype_'.$type->name
, 'manage')) {
8757 $uninstall = html_writer
::link($uninstallurl, $txt->uninstall
);
8760 $row = new html_table_row(array($strtypename, $hideshow, $updown, $settings, $uninstall));
8762 $row->attributes
['class'] = $class;
8764 $table->data
[] = $row;
8767 $return .= html_writer
::table($table);
8768 return highlight($query, $return);
8773 * Initialise admin page - this function does require login and permission
8774 * checks specified in page definition.
8776 * This function must be called on each admin page before other code.
8778 * @global moodle_page $PAGE
8780 * @param string $section name of page
8781 * @param string $extrabutton extra HTML that is added after the blocks editing on/off button.
8782 * @param array $extraurlparams an array paramname => paramvalue, or parameters that need to be
8783 * added to the turn blocks editing on/off form, so this page reloads correctly.
8784 * @param string $actualurl if the actual page being viewed is not the normal one for this
8785 * page (e.g. admin/roles/allow.php, instead of admin/roles/manage.php, you can pass the alternate URL here.
8786 * @param array $options Additional options that can be specified for page setup.
8787 * pagelayout - This option can be used to set a specific pagelyaout, admin is default.
8788 * nosearch - Do not display search bar
8790 function admin_externalpage_setup($section, $extrabutton = '', array $extraurlparams = null, $actualurl = '', array $options = array()) {
8791 global $CFG, $PAGE, $USER, $SITE, $OUTPUT;
8793 $PAGE->set_context(null); // hack - set context to something, by default to system context
8796 require_login(null, false);
8798 if (!empty($options['pagelayout'])) {
8799 // A specific page layout has been requested.
8800 $PAGE->set_pagelayout($options['pagelayout']);
8801 } else if ($section === 'upgradesettings') {
8802 $PAGE->set_pagelayout('maintenance');
8804 $PAGE->set_pagelayout('admin');
8807 $adminroot = admin_get_root(false, false); // settings not required for external pages
8808 $extpage = $adminroot->locate($section, true);
8810 $hassiteconfig = has_capability('moodle/site:config', context_system
::instance());
8811 if (empty($extpage) or !($extpage instanceof admin_externalpage
)) {
8812 // The requested section isn't in the admin tree
8813 // It could be because the user has inadequate capapbilities or because the section doesn't exist
8814 if (!$hassiteconfig) {
8815 // The requested section could depend on a different capability
8816 // but most likely the user has inadequate capabilities
8817 throw new \
moodle_exception('accessdenied', 'admin');
8819 throw new \
moodle_exception('sectionerror', 'admin', "$CFG->wwwroot/$CFG->admin/");
8823 // this eliminates our need to authenticate on the actual pages
8824 if (!$extpage->check_access()) {
8825 throw new \
moodle_exception('accessdenied', 'admin');
8829 navigation_node
::require_admin_tree();
8831 // $PAGE->set_extra_button($extrabutton); TODO
8834 $actualurl = $extpage->url
;
8837 $PAGE->set_url($actualurl, $extraurlparams);
8838 if (strpos($PAGE->pagetype
, 'admin-') !== 0) {
8839 $PAGE->set_pagetype('admin-' . $PAGE->pagetype
);
8842 if (empty($SITE->fullname
) ||
empty($SITE->shortname
)) {
8843 // During initial install.
8844 $strinstallation = get_string('installation', 'install');
8845 $strsettings = get_string('settings');
8846 $PAGE->navbar
->add($strsettings);
8847 $PAGE->set_title($strinstallation);
8848 $PAGE->set_heading($strinstallation);
8849 $PAGE->set_cacheable(false);
8853 // Locate the current item on the navigation and make it active when found.
8854 $path = $extpage->path
;
8855 $node = $PAGE->settingsnav
;
8856 while ($node && count($path) > 0) {
8857 $node = $node->get(array_pop($path));
8860 $node->make_active();
8864 $adminediting = optional_param('adminedit', -1, PARAM_BOOL
);
8865 if ($PAGE->user_allowed_editing() && $adminediting != -1) {
8866 $USER->editing
= $adminediting;
8869 $visiblepathtosection = array_reverse($extpage->visiblepath
);
8871 if ($PAGE->user_allowed_editing() && !$PAGE->theme
->haseditswitch
) {
8872 if ($PAGE->user_is_editing()) {
8873 $caption = get_string('blockseditoff');
8874 $url = new moodle_url($PAGE->url
, array('adminedit'=>'0', 'sesskey'=>sesskey()));
8876 $caption = get_string('blocksediton');
8877 $url = new moodle_url($PAGE->url
, array('adminedit'=>'1', 'sesskey'=>sesskey()));
8879 $PAGE->set_button($OUTPUT->single_button($url, $caption, 'get'));
8882 $PAGE->set_title("$SITE->shortname: " . implode(": ", $visiblepathtosection));
8883 $PAGE->set_heading($SITE->fullname
);
8885 if ($hassiteconfig && empty($options['nosearch'])) {
8886 $PAGE->add_header_action($OUTPUT->render_from_template('core_admin/header_search_input', [
8887 'action' => new moodle_url('/admin/search.php'),
8888 'query' => $PAGE->url
->get_param('query'),
8892 // prevent caching in nav block
8893 $PAGE->navigation
->clear_cache();
8897 * Returns the reference to admin tree root
8899 * @return object admin_root object
8901 function admin_get_root($reload=false, $requirefulltree=true) {
8902 global $CFG, $DB, $OUTPUT, $ADMIN;
8904 if (is_null($ADMIN)) {
8905 // create the admin tree!
8906 $ADMIN = new admin_root($requirefulltree);
8909 if ($reload or ($requirefulltree and !$ADMIN->fulltree
)) {
8910 $ADMIN->purge_children($requirefulltree);
8913 if (!$ADMIN->loaded
) {
8914 // we process this file first to create categories first and in correct order
8915 require($CFG->dirroot
.'/'.$CFG->admin
.'/settings/top.php');
8917 // now we process all other files in admin/settings to build the admin tree
8918 foreach (glob($CFG->dirroot
.'/'.$CFG->admin
.'/settings/*.php') as $file) {
8919 if ($file == $CFG->dirroot
.'/'.$CFG->admin
.'/settings/top.php') {
8922 if ($file == $CFG->dirroot
.'/'.$CFG->admin
.'/settings/plugins.php') {
8923 // plugins are loaded last - they may insert pages anywhere
8928 require($CFG->dirroot
.'/'.$CFG->admin
.'/settings/plugins.php');
8930 $ADMIN->loaded
= true;
8936 /// settings utility functions
8939 * This function applies default settings.
8940 * Because setting the defaults of some settings can enable other settings,
8941 * this function is called recursively until no more new settings are found.
8943 * @param object $node, NULL means complete tree, null by default
8944 * @param bool $unconditional if true overrides all values with defaults, true by default
8945 * @param array $admindefaultsettings default admin settings to apply. Used recursively
8946 * @param array $settingsoutput The names and values of the changed settings. Used recursively
8947 * @return array $settingsoutput The names and values of the changed settings
8949 function admin_apply_default_settings($node=null, $unconditional=true, $admindefaultsettings=array(), $settingsoutput=array()) {
8952 if (is_null($node)) {
8953 core_plugin_manager
::reset_caches();
8954 $node = admin_get_root(true, true);
8955 $counter = count($settingsoutput);
8958 if ($node instanceof admin_category
) {
8959 $entries = array_keys($node->children
);
8960 foreach ($entries as $entry) {
8961 $settingsoutput = admin_apply_default_settings(
8962 $node->children
[$entry], $unconditional, $admindefaultsettings, $settingsoutput
8966 } else if ($node instanceof admin_settingpage
) {
8967 foreach ($node->settings
as $setting) {
8968 if (!$unconditional && !is_null($setting->get_setting())) {
8969 // Do not override existing defaults.
8972 $defaultsetting = $setting->get_defaultsetting();
8973 if (is_null($defaultsetting)) {
8974 // No value yet - default maybe applied after admin user creation or in upgradesettings.
8978 $settingname = $node->name
. '_' . $setting->name
; // Get a unique name for the setting.
8980 if (!array_key_exists($settingname, $admindefaultsettings)) { // Only update a setting if not already processed.
8981 $admindefaultsettings[$settingname] = $settingname;
8982 $settingsoutput[$settingname] = $defaultsetting;
8984 // Set the default for this setting.
8985 $setting->write_setting($defaultsetting);
8986 $setting->write_setting_flags(null);
8988 unset($admindefaultsettings[$settingname]); // Remove processed settings.
8993 // Call this function recursively until all settings are processed.
8994 if (($node instanceof admin_root
) && ($counter != count($settingsoutput))) {
8995 $settingsoutput = admin_apply_default_settings(null, $unconditional, $admindefaultsettings, $settingsoutput);
8997 // Just in case somebody modifies the list of active plugins directly.
8998 core_plugin_manager
::reset_caches();
9000 return $settingsoutput;
9004 * Store changed settings, this function updates the errors variable in $ADMIN
9006 * @param object $formdata from form
9007 * @return int number of changed settings
9009 function admin_write_settings($formdata) {
9010 global $CFG, $SITE, $DB;
9012 $olddbsessions = !empty($CFG->dbsessions
);
9013 $formdata = (array)$formdata;
9016 foreach ($formdata as $fullname=>$value) {
9017 if (strpos($fullname, 's_') !== 0) {
9018 continue; // not a config value
9020 $data[$fullname] = $value;
9023 $adminroot = admin_get_root();
9024 $settings = admin_find_write_settings($adminroot, $data);
9027 foreach ($settings as $fullname=>$setting) {
9028 /** @var $setting admin_setting */
9029 $original = $setting->get_setting();
9030 $error = $setting->write_setting($data[$fullname]);
9031 if ($error !== '') {
9032 $adminroot->errors
[$fullname] = new stdClass();
9033 $adminroot->errors
[$fullname]->data
= $data[$fullname];
9034 $adminroot->errors
[$fullname]->id
= $setting->get_id();
9035 $adminroot->errors
[$fullname]->error
= $error;
9037 $setting->write_setting_flags($data);
9039 if ($setting->post_write_settings($original)) {
9044 if ($olddbsessions != !empty($CFG->dbsessions
)) {
9048 // Now update $SITE - just update the fields, in case other people have a
9049 // a reference to it (e.g. $PAGE, $COURSE).
9050 $newsite = $DB->get_record('course', array('id'=>$SITE->id
));
9051 foreach (get_object_vars($newsite) as $field => $value) {
9052 $SITE->$field = $value;
9055 // now reload all settings - some of them might depend on the changed
9056 admin_get_root(true);
9061 * Internal recursive function - finds all settings from submitted form
9063 * @param object $node Instance of admin_category, or admin_settingpage
9064 * @param array $data
9067 function admin_find_write_settings($node, $data) {
9074 if ($node instanceof admin_category
) {
9075 if ($node->check_access()) {
9076 $entries = array_keys($node->children
);
9077 foreach ($entries as $entry) {
9078 $return = array_merge($return, admin_find_write_settings($node->children
[$entry], $data));
9082 } else if ($node instanceof admin_settingpage
) {
9083 if ($node->check_access()) {
9084 foreach ($node->settings
as $setting) {
9085 $fullname = $setting->get_full_name();
9086 if (array_key_exists($fullname, $data)) {
9087 $return[$fullname] = $setting;
9098 * Internal function - prints the search results
9100 * @param string $query String to search for
9101 * @return string empty or XHTML
9103 function admin_search_settings_html($query) {
9104 global $CFG, $OUTPUT, $PAGE;
9106 if (core_text
::strlen($query) < 2) {
9109 $query = core_text
::strtolower($query);
9111 $adminroot = admin_get_root();
9112 $findings = $adminroot->search($query);
9113 $savebutton = false;
9115 $tpldata = (object) [
9116 'actionurl' => $PAGE->url
->out(false),
9118 'sesskey' => sesskey(),
9121 foreach ($findings as $found) {
9122 $page = $found->page
;
9123 $settings = $found->settings
;
9124 if ($page->is_hidden()) {
9125 // hidden pages are not displayed in search results
9129 $heading = highlight($query, $page->visiblename
);
9131 if ($page instanceof admin_externalpage
) {
9132 $headingurl = new moodle_url($page->url
);
9133 } else if ($page instanceof admin_settingpage
) {
9134 $headingurl = new moodle_url('/admin/settings.php', ['section' => $page->name
]);
9139 // Locate the page in the admin root and populate its visiblepath attribute.
9141 $located = $adminroot->locate($page->name
, true);
9143 foreach ($located->visiblepath
as $pathitem) {
9144 array_unshift($path, (string) $pathitem);
9148 $sectionsettings = [];
9149 if (!empty($settings)) {
9150 foreach ($settings as $setting) {
9151 if (empty($setting->nosave
)) {
9154 $fullname = $setting->get_full_name();
9155 if (array_key_exists($fullname, $adminroot->errors
)) {
9156 $data = $adminroot->errors
[$fullname]->data
;
9158 $data = $setting->get_setting();
9159 // do not use defaults if settings not available - upgradesettings handles the defaults!
9161 $sectionsettings[] = $setting->output_html($data, $query);
9165 $tpldata->results
[] = (object) [
9166 'title' => $heading,
9168 'url' => $headingurl->out(false),
9169 'settings' => $sectionsettings
9173 $tpldata->showsave
= $savebutton;
9174 $tpldata->hasresults
= !empty($tpldata->results
);
9176 return $OUTPUT->render_from_template('core_admin/settings_search_results', $tpldata);
9180 * Internal function - returns arrays of html pages with uninitialised settings
9182 * @param object $node Instance of admin_category or admin_settingpage
9185 function admin_output_new_settings_by_page($node) {
9189 if ($node instanceof admin_category
) {
9190 $entries = array_keys($node->children
);
9191 foreach ($entries as $entry) {
9192 $return +
= admin_output_new_settings_by_page($node->children
[$entry]);
9195 } else if ($node instanceof admin_settingpage
) {
9196 $newsettings = array();
9197 foreach ($node->settings
as $setting) {
9198 if (is_null($setting->get_setting())) {
9199 $newsettings[] = $setting;
9202 if (count($newsettings) > 0) {
9203 $adminroot = admin_get_root();
9204 $page = $OUTPUT->heading(get_string('upgradesettings','admin').' - '.$node->visiblename
, 2, 'main');
9205 $page .= '<fieldset class="adminsettings">'."\n";
9206 foreach ($newsettings as $setting) {
9207 $fullname = $setting->get_full_name();
9208 if (array_key_exists($fullname, $adminroot->errors
)) {
9209 $data = $adminroot->errors
[$fullname]->data
;
9211 $data = $setting->get_setting();
9212 if (is_null($data)) {
9213 $data = $setting->get_defaultsetting();
9216 $page .= '<div class="clearer"><!-- --></div>'."\n";
9217 $page .= $setting->output_html($data);
9219 $page .= '</fieldset>';
9220 $return[$node->name
] = $page;
9228 * Format admin settings
9230 * @param object $setting
9231 * @param string $title label element
9232 * @param string $form form fragment, html code - not highlighted automatically
9233 * @param string $description
9234 * @param mixed $label link label to id, true by default or string being the label to connect it to
9235 * @param string $warning warning text
9236 * @param sting $defaultinfo defaults info, null means nothing, '' is converted to "Empty" string, defaults to null
9237 * @param string $query search query to be highlighted
9238 * @return string XHTML
9240 function format_admin_setting($setting, $title='', $form='', $description='', $label=true, $warning='', $defaultinfo=NULL, $query='') {
9241 global $CFG, $OUTPUT;
9243 $context = (object) [
9244 'name' => empty($setting->plugin
) ?
$setting->name
: "$setting->plugin | $setting->name",
9245 'fullname' => $setting->get_full_name(),
9248 // Sometimes the id is not id_s_name, but id_s_name_m or something, and this does not validate.
9249 if ($label === true) {
9250 $context->labelfor
= $setting->get_id();
9251 } else if ($label === false) {
9252 $context->labelfor
= '';
9254 $context->labelfor
= $label;
9257 $form .= $setting->output_setting_flags();
9259 $context->warning
= $warning;
9260 $context->override
= '';
9261 if (empty($setting->plugin
)) {
9262 if (array_key_exists($setting->name
, $CFG->config_php_settings
)) {
9263 $context->override
= get_string('configoverride', 'admin');
9266 if (array_key_exists($setting->plugin
, $CFG->forced_plugin_settings
) and array_key_exists($setting->name
, $CFG->forced_plugin_settings
[$setting->plugin
])) {
9267 $context->override
= get_string('configoverride', 'admin');
9271 $defaults = array();
9272 if (!is_null($defaultinfo)) {
9273 if ($defaultinfo === '') {
9274 $defaultinfo = get_string('emptysettingvalue', 'admin');
9276 $defaults[] = $defaultinfo;
9279 $context->default = null;
9280 $setting->get_setting_flag_defaults($defaults);
9281 if (!empty($defaults)) {
9282 $defaultinfo = implode(', ', $defaults);
9283 $defaultinfo = highlight($query, nl2br(s($defaultinfo)));
9284 $context->default = get_string('defaultsettinginfo', 'admin', $defaultinfo);
9288 $context->error
= '';
9289 $adminroot = admin_get_root();
9290 if (array_key_exists($context->fullname
, $adminroot->errors
)) {
9291 $context->error
= $adminroot->errors
[$context->fullname
]->error
;
9294 if ($dependenton = $setting->get_dependent_on()) {
9295 $context->dependenton
= get_string('settingdependenton', 'admin', implode(', ', $dependenton));
9298 $context->id
= 'admin-' . $setting->name
;
9299 $context->title
= highlightfast($query, $title);
9300 $context->name
= highlightfast($query, $context->name
);
9301 $context->description
= highlight($query, markdown_to_html($description));
9302 $context->element
= $form;
9303 $context->forceltr
= $setting->get_force_ltr();
9304 $context->customcontrol
= $setting->has_custom_form_control();
9306 return $OUTPUT->render_from_template('core_admin/setting', $context);
9310 * Based on find_new_settings{@link ()} in upgradesettings.php
9311 * Looks to find any admin settings that have not been initialized. Returns 1 if it finds any.
9313 * @param object $node Instance of admin_category, or admin_settingpage
9314 * @return boolean true if any settings haven't been initialised, false if they all have
9316 function any_new_admin_settings($node) {
9318 if ($node instanceof admin_category
) {
9319 $entries = array_keys($node->children
);
9320 foreach ($entries as $entry) {
9321 if (any_new_admin_settings($node->children
[$entry])) {
9326 } else if ($node instanceof admin_settingpage
) {
9327 foreach ($node->settings
as $setting) {
9328 if ($setting->get_setting() === NULL) {
9338 * Given a table and optionally a column name should replaces be done?
9340 * @param string $table name
9341 * @param string $column name
9342 * @return bool success or fail
9344 function db_should_replace($table, $column = '', $additionalskiptables = ''): bool {
9346 // TODO: this is horrible hack, we should have a hook and each plugin should be responsible for proper replacing...
9347 $skiptables = ['config', 'config_plugins', 'filter_config', 'sessions',
9348 'events_queue', 'repository_instance_config', 'block_instances', 'files'];
9350 // Additional skip tables.
9351 if (!empty($additionalskiptables)) {
9352 $skiptables = array_merge($skiptables, explode(',', str_replace(' ', '', $additionalskiptables)));
9355 // Don't process these.
9356 if (in_array($table, $skiptables)) {
9360 // To be safe never replace inside a table that looks related to logging.
9361 if (preg_match('/(^|_)logs?($|_)/', $table)) {
9365 // Do column based exclusions.
9366 if (!empty($column)) {
9367 // Don't touch anything that looks like a hash.
9368 if (preg_match('/hash$/', $column)) {
9377 * Moved from admin/replace.php so that we can use this in cron
9379 * @param string $search string to look for
9380 * @param string $replace string to replace
9381 * @return bool success or fail
9383 function db_replace($search, $replace, $additionalskiptables = '') {
9384 global $DB, $CFG, $OUTPUT;
9386 // Turn off time limits, sometimes upgrades can be slow.
9387 core_php_time_limit
::raise();
9389 if (!$tables = $DB->get_tables() ) { // No tables yet at all.
9392 foreach ($tables as $table) {
9394 if (!db_should_replace($table, '', $additionalskiptables)) {
9398 if ($columns = $DB->get_columns($table)) {
9399 $DB->set_debug(true);
9400 foreach ($columns as $column) {
9401 if (!db_should_replace($table, $column->name
)) {
9404 $DB->replace_all_text($table, $column, $search, $replace);
9406 $DB->set_debug(false);
9410 // delete modinfo caches
9411 rebuild_course_cache(0, true);
9413 // TODO: we should ask all plugins to do the search&replace, for now let's do only blocks...
9414 $blocks = core_component
::get_plugin_list('block');
9415 foreach ($blocks as $blockname=>$fullblock) {
9416 if ($blockname === 'NEWBLOCK') { // Someone has unzipped the template, ignore it
9420 if (!is_readable($fullblock.'/lib.php')) {
9424 $function = 'block_'.$blockname.'_global_db_replace';
9425 include_once($fullblock.'/lib.php');
9426 if (!function_exists($function)) {
9430 echo $OUTPUT->notification("Replacing in $blockname blocks...", 'notifysuccess');
9431 $function($search, $replace);
9432 echo $OUTPUT->notification("...finished", 'notifysuccess');
9435 // Trigger an event.
9437 'context' => context_system
::instance(),
9439 'search' => $search,
9440 'replace' => $replace
9443 $event = \core\event\database_text_field_content_replaced
::create($eventargs);
9452 * Manage repository settings
9454 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
9456 class admin_setting_managerepository
extends admin_setting
{
9461 * calls parent::__construct with specific arguments
9463 public function __construct() {
9465 parent
::__construct('managerepository', get_string('manage', 'repository'), '', '');
9466 $this->baseurl
= $CFG->wwwroot
. '/' . $CFG->admin
. '/repository.php?sesskey=' . sesskey();
9470 * Always returns true, does nothing
9474 public function get_setting() {
9479 * Always returns true does nothing
9483 public function get_defaultsetting() {
9488 * Always returns s_managerepository
9490 * @return string Always return 's_managerepository'
9492 public function get_full_name() {
9493 return 's_managerepository';
9497 * Always returns '' doesn't do anything
9499 public function write_setting($data) {
9500 $url = $this->baseurl
. '&new=' . $data;
9503 // Should not use redirect and exit here
9504 // Find a better way to do this.
9510 * Searches repository plugins for one that matches $query
9512 * @param string $query The string to search for
9513 * @return bool true if found, false if not
9515 public function is_related($query) {
9516 if (parent
::is_related($query)) {
9520 $repositories= core_component
::get_plugin_list('repository');
9521 foreach ($repositories as $p => $dir) {
9522 if (strpos($p, $query) !== false) {
9526 foreach (repository
::get_types() as $instance) {
9527 $title = $instance->get_typename();
9528 if (strpos(core_text
::strtolower($title), $query) !== false) {
9536 * Helper function that generates a moodle_url object
9537 * relevant to the repository
9540 function repository_action_url($repository) {
9541 return new moodle_url($this->baseurl
, array('sesskey'=>sesskey(), 'repos'=>$repository));
9545 * Builds XHTML to display the control
9547 * @param string $data Unused
9548 * @param string $query
9549 * @return string XHTML
9551 public function output_html($data, $query='') {
9552 global $CFG, $USER, $OUTPUT;
9554 // Get strings that are used
9555 $strshow = get_string('on', 'repository');
9556 $strhide = get_string('off', 'repository');
9557 $strdelete = get_string('disabled', 'repository');
9559 $actionchoicesforexisting = array(
9562 'delete' => $strdelete
9565 $actionchoicesfornew = array(
9566 'newon' => $strshow,
9567 'newoff' => $strhide,
9568 'delete' => $strdelete
9572 $return .= $OUTPUT->box_start('generalbox');
9574 // Set strings that are used multiple times
9575 $settingsstr = get_string('settings');
9576 $disablestr = get_string('disable');
9578 // Table to list plug-ins
9579 $table = new html_table();
9580 $table->head
= array(get_string('name'), get_string('isactive', 'repository'), get_string('order'), $settingsstr);
9581 $table->align
= array('left', 'center', 'center', 'center', 'center');
9582 $table->data
= array();
9584 // Get list of used plug-ins
9585 $repositorytypes = repository
::get_types();
9586 if (!empty($repositorytypes)) {
9587 // Array to store plugins being used
9588 $alreadyplugins = array();
9589 $totalrepositorytypes = count($repositorytypes);
9591 foreach ($repositorytypes as $i) {
9593 $typename = $i->get_typename();
9594 // Display edit link only if you can config the type or if it has multiple instances (e.g. has instance config)
9595 $typeoptionnames = repository
::static_function($typename, 'get_type_option_names');
9596 $instanceoptionnames = repository
::static_function($typename, 'get_instance_option_names');
9598 if (!empty($typeoptionnames) ||
!empty($instanceoptionnames)) {
9599 // Calculate number of instances in order to display them for the Moodle administrator
9600 if (!empty($instanceoptionnames)) {
9602 $params['context'] = array(context_system
::instance());
9603 $params['onlyvisible'] = false;
9604 $params['type'] = $typename;
9605 $admininstancenumber = count(repository
::static_function($typename, 'get_instances', $params));
9607 $admininstancenumbertext = get_string('instancesforsite', 'repository', $admininstancenumber);
9608 $params['context'] = array();
9609 $instances = repository
::static_function($typename, 'get_instances', $params);
9610 $courseinstances = array();
9611 $userinstances = array();
9613 foreach ($instances as $instance) {
9614 $repocontext = context
::instance_by_id($instance->instance
->contextid
);
9615 if ($repocontext->contextlevel
== CONTEXT_COURSE
) {
9616 $courseinstances[] = $instance;
9617 } else if ($repocontext->contextlevel
== CONTEXT_USER
) {
9618 $userinstances[] = $instance;
9622 $instancenumber = count($courseinstances);
9623 $courseinstancenumbertext = get_string('instancesforcourses', 'repository', $instancenumber);
9625 // user private instances
9626 $instancenumber = count($userinstances);
9627 $userinstancenumbertext = get_string('instancesforusers', 'repository', $instancenumber);
9629 $admininstancenumbertext = "";
9630 $courseinstancenumbertext = "";
9631 $userinstancenumbertext = "";
9634 $settings .= '<a href="' . $this->baseurl
. '&action=edit&repos=' . $typename . '">' . $settingsstr .'</a>';
9636 $settings .= $OUTPUT->container_start('mdl-left');
9637 $settings .= '<br/>';
9638 $settings .= $admininstancenumbertext;
9639 $settings .= '<br/>';
9640 $settings .= $courseinstancenumbertext;
9641 $settings .= '<br/>';
9642 $settings .= $userinstancenumbertext;
9643 $settings .= $OUTPUT->container_end();
9645 // Get the current visibility
9646 if ($i->get_visible()) {
9647 $currentaction = 'show';
9649 $currentaction = 'hide';
9652 $select = new single_select($this->repository_action_url($typename, 'repos'), 'action', $actionchoicesforexisting, $currentaction, null, 'applyto' . basename($typename));
9654 // Display up/down link
9656 // Should be done with CSS instead.
9657 $spacer = $OUTPUT->spacer(array('height' => 15, 'width' => 15, 'class' => 'smallicon'));
9659 if ($updowncount > 1) {
9660 $updown .= "<a href=\"$this->baseurl&action=moveup&repos=".$typename."\">";
9661 $updown .= $OUTPUT->pix_icon('t/up', get_string('moveup')) . '</a> ';
9666 if ($updowncount < $totalrepositorytypes) {
9667 $updown .= "<a href=\"$this->baseurl&action=movedown&repos=".$typename."\">";
9668 $updown .= $OUTPUT->pix_icon('t/down', get_string('movedown')) . '</a> ';
9676 $table->data
[] = array($i->get_readablename(), $OUTPUT->render($select), $updown, $settings);
9678 if (!in_array($typename, $alreadyplugins)) {
9679 $alreadyplugins[] = $typename;
9684 // Get all the plugins that exist on disk
9685 $plugins = core_component
::get_plugin_list('repository');
9686 if (!empty($plugins)) {
9687 foreach ($plugins as $plugin => $dir) {
9688 // Check that it has not already been listed
9689 if (!in_array($plugin, $alreadyplugins)) {
9690 $select = new single_select($this->repository_action_url($plugin, 'repos'), 'action', $actionchoicesfornew, 'delete', null, 'applyto' . basename($plugin));
9691 $table->data
[] = array(get_string('pluginname', 'repository_'.$plugin), $OUTPUT->render($select), '', '');
9696 $return .= html_writer
::table($table);
9697 $return .= $OUTPUT->box_end();
9698 return highlight($query, $return);
9703 * Special checkbox for enable mobile web service
9704 * If enable then we store the service id of the mobile service into config table
9705 * If disable then we unstore the service id from the config table
9707 class admin_setting_enablemobileservice
extends admin_setting_configcheckbox
{
9709 /** @var boolean True means that the capability 'webservice/rest:use' is set for authenticated user role */
9713 * Return true if Authenticated user role has the capability 'webservice/rest:use', otherwise false.
9717 private function is_protocol_cap_allowed() {
9720 // If the $this->restuse variable is not set, it needs to be set.
9721 if (empty($this->restuse
) and $this->restuse
!==false) {
9723 $params['permission'] = CAP_ALLOW
;
9724 $params['roleid'] = $CFG->defaultuserroleid
;
9725 $params['capability'] = 'webservice/rest:use';
9726 $this->restuse
= $DB->record_exists('role_capabilities', $params);
9729 return $this->restuse
;
9733 * Set the 'webservice/rest:use' to the Authenticated user role (allow or not)
9734 * @param type $status true to allow, false to not set
9736 private function set_protocol_cap($status) {
9738 if ($status and !$this->is_protocol_cap_allowed()) {
9739 //need to allow the cap
9740 $permission = CAP_ALLOW
;
9742 } else if (!$status and $this->is_protocol_cap_allowed()){
9743 //need to disallow the cap
9744 $permission = CAP_INHERIT
;
9747 if (!empty($assign)) {
9748 $systemcontext = context_system
::instance();
9749 assign_capability('webservice/rest:use', $permission, $CFG->defaultuserroleid
, $systemcontext->id
, true);
9754 * Builds XHTML to display the control.
9755 * The main purpose of this overloading is to display a warning when https
9756 * is not supported by the server
9757 * @param string $data Unused
9758 * @param string $query
9759 * @return string XHTML
9761 public function output_html($data, $query='') {
9763 $html = parent
::output_html($data, $query);
9765 if ((string)$data === $this->yes
) {
9766 $notifications = tool_mobile\api
::get_potential_config_issues(); // Safe to call, plugin available if we reach here.
9767 foreach ($notifications as $notification) {
9768 $message = get_string($notification[0], $notification[1]);
9769 $html .= $OUTPUT->notification($message, \core\output\notification
::NOTIFY_WARNING
);
9777 * Retrieves the current setting using the objects name
9781 public function get_setting() {
9784 // First check if is not set.
9785 $result = $this->config_read($this->name
);
9786 if (is_null($result)) {
9790 // For install cli script, $CFG->defaultuserroleid is not set so return 0
9791 // Or if web services aren't enabled this can't be,
9792 if (empty($CFG->defaultuserroleid
) ||
empty($CFG->enablewebservices
)) {
9796 require_once($CFG->dirroot
. '/webservice/lib.php');
9797 $webservicemanager = new webservice();
9798 $mobileservice = $webservicemanager->get_external_service_by_shortname(MOODLE_OFFICIAL_MOBILE_SERVICE
);
9799 if ($mobileservice->enabled
and $this->is_protocol_cap_allowed()) {
9807 * Save the selected setting
9809 * @param string $data The selected site
9810 * @return string empty string or error message
9812 public function write_setting($data) {
9815 //for install cli script, $CFG->defaultuserroleid is not set so do nothing
9816 if (empty($CFG->defaultuserroleid
)) {
9820 $servicename = MOODLE_OFFICIAL_MOBILE_SERVICE
;
9822 require_once($CFG->dirroot
. '/webservice/lib.php');
9823 $webservicemanager = new webservice();
9825 $updateprotocol = false;
9826 if ((string)$data === $this->yes
) {
9827 //code run when enable mobile web service
9828 //enable web service systeme if necessary
9829 set_config('enablewebservices', true);
9831 //enable mobile service
9832 $mobileservice = $webservicemanager->get_external_service_by_shortname(MOODLE_OFFICIAL_MOBILE_SERVICE
);
9833 $mobileservice->enabled
= 1;
9834 $webservicemanager->update_external_service($mobileservice);
9836 // Enable REST server.
9837 $activeprotocols = empty($CFG->webserviceprotocols
) ?
array() : explode(',', $CFG->webserviceprotocols
);
9839 if (!in_array('rest', $activeprotocols)) {
9840 $activeprotocols[] = 'rest';
9841 $updateprotocol = true;
9844 if ($updateprotocol) {
9845 set_config('webserviceprotocols', implode(',', $activeprotocols));
9848 // Allow rest:use capability for authenticated user.
9849 $this->set_protocol_cap(true);
9851 // Disable the mobile service.
9852 $mobileservice = $webservicemanager->get_external_service_by_shortname(MOODLE_OFFICIAL_MOBILE_SERVICE
);
9853 $mobileservice->enabled
= 0;
9854 $webservicemanager->update_external_service($mobileservice);
9857 return (parent
::write_setting($data));
9862 * Special class for management of external services
9864 * @author Petr Skoda (skodak)
9866 class admin_setting_manageexternalservices
extends admin_setting
{
9868 * Calls parent::__construct with specific arguments
9870 public function __construct() {
9871 $this->nosave
= true;
9872 parent
::__construct('webservicesui', get_string('externalservices', 'webservice'), '', '');
9876 * Always returns true, does nothing
9880 public function get_setting() {
9885 * Always returns true, does nothing
9889 public function get_defaultsetting() {
9894 * Always returns '', does not write anything
9896 * @return string Always returns ''
9898 public function write_setting($data) {
9899 // do not write any setting
9904 * Checks if $query is one of the available external services
9906 * @param string $query The string to search for
9907 * @return bool Returns true if found, false if not
9909 public function is_related($query) {
9912 if (parent
::is_related($query)) {
9916 $services = $DB->get_records('external_services', array(), 'id, name');
9917 foreach ($services as $service) {
9918 if (strpos(core_text
::strtolower($service->name
), $query) !== false) {
9926 * Builds the XHTML to display the control
9928 * @param string $data Unused
9929 * @param string $query
9932 public function output_html($data, $query='') {
9933 global $CFG, $OUTPUT, $DB;
9936 $stradministration = get_string('administration');
9937 $stredit = get_string('edit');
9938 $strservice = get_string('externalservice', 'webservice');
9939 $strdelete = get_string('delete');
9940 $strplugin = get_string('plugin', 'admin');
9941 $stradd = get_string('add');
9942 $strfunctions = get_string('functions', 'webservice');
9943 $strusers = get_string('users');
9944 $strserviceusers = get_string('serviceusers', 'webservice');
9946 $esurl = "$CFG->wwwroot/$CFG->admin/webservice/service.php";
9947 $efurl = "$CFG->wwwroot/$CFG->admin/webservice/service_functions.php";
9948 $euurl = "$CFG->wwwroot/$CFG->admin/webservice/service_users.php";
9950 // built in services
9951 $services = $DB->get_records_select('external_services', 'component IS NOT NULL', null, 'name');
9953 if (!empty($services)) {
9954 $return .= $OUTPUT->heading(get_string('servicesbuiltin', 'webservice'), 3, 'main');
9958 $table = new html_table();
9959 $table->head
= array($strservice, $strplugin, $strfunctions, $strusers, $stredit);
9960 $table->colclasses
= array('leftalign service', 'leftalign plugin', 'centeralign functions', 'centeralign users', 'centeralign ');
9961 $table->id
= 'builtinservices';
9962 $table->attributes
['class'] = 'admintable externalservices generaltable';
9963 $table->data
= array();
9965 // iterate through auth plugins and add to the display table
9966 foreach ($services as $service) {
9967 $name = $service->name
;
9970 if ($service->enabled
) {
9971 $displayname = "<span>$name</span>";
9973 $displayname = "<span class=\"dimmed_text\">$name</span>";
9976 $plugin = $service->component
;
9978 $functions = "<a href=\"$efurl?id=$service->id\">$strfunctions</a>";
9980 if ($service->restrictedusers
) {
9981 $users = "<a href=\"$euurl?id=$service->id\">$strserviceusers</a>";
9983 $users = get_string('allusers', 'webservice');
9986 $edit = "<a href=\"$esurl?id=$service->id\">$stredit</a>";
9988 // add a row to the table
9989 $table->data
[] = array($displayname, $plugin, $functions, $users, $edit);
9991 $return .= html_writer
::table($table);
9995 $return .= $OUTPUT->heading(get_string('servicescustom', 'webservice'), 3, 'main');
9996 $services = $DB->get_records_select('external_services', 'component IS NULL', null, 'name');
9998 $table = new html_table();
9999 $table->head
= array($strservice, $strdelete, $strfunctions, $strusers, $stredit);
10000 $table->colclasses
= array('leftalign service', 'leftalign plugin', 'centeralign functions', 'centeralign users', 'centeralign ');
10001 $table->id
= 'customservices';
10002 $table->attributes
['class'] = 'admintable externalservices generaltable';
10003 $table->data
= array();
10005 // iterate through auth plugins and add to the display table
10006 foreach ($services as $service) {
10007 $name = $service->name
;
10010 if ($service->enabled
) {
10011 $displayname = "<span>$name</span>";
10013 $displayname = "<span class=\"dimmed_text\">$name</span>";
10017 $delete = "<a href=\"$esurl?action=delete&sesskey=".sesskey()."&id=$service->id\">$strdelete</a>";
10019 $functions = "<a href=\"$efurl?id=$service->id\">$strfunctions</a>";
10021 if ($service->restrictedusers
) {
10022 $users = "<a href=\"$euurl?id=$service->id\">$strserviceusers</a>";
10024 $users = get_string('allusers', 'webservice');
10027 $edit = "<a href=\"$esurl?id=$service->id\">$stredit</a>";
10029 // add a row to the table
10030 $table->data
[] = array($displayname, $delete, $functions, $users, $edit);
10032 // add new custom service option
10033 $return .= html_writer
::table($table);
10035 $return .= '<br />';
10036 // add a token to the table
10037 $return .= "<a href=\"$esurl?id=0\">$stradd</a>";
10039 return highlight($query, $return);
10044 * Special class for overview of external services
10046 * @author Jerome Mouneyrac
10048 class admin_setting_webservicesoverview
extends admin_setting
{
10051 * Calls parent::__construct with specific arguments
10053 public function __construct() {
10054 $this->nosave
= true;
10055 parent
::__construct('webservicesoverviewui',
10056 get_string('webservicesoverview', 'webservice'), '', '');
10060 * Always returns true, does nothing
10064 public function get_setting() {
10069 * Always returns true, does nothing
10073 public function get_defaultsetting() {
10078 * Always returns '', does not write anything
10080 * @return string Always returns ''
10082 public function write_setting($data) {
10083 // do not write any setting
10088 * Builds the XHTML to display the control
10090 * @param string $data Unused
10091 * @param string $query
10094 public function output_html($data, $query='') {
10095 global $CFG, $OUTPUT;
10098 $brtag = html_writer
::empty_tag('br');
10100 /// One system controlling Moodle with Token
10101 $return .= $OUTPUT->heading(get_string('onesystemcontrolling', 'webservice'), 3, 'main');
10102 $table = new html_table();
10103 $table->head
= array(get_string('step', 'webservice'), get_string('status'),
10104 get_string('description'));
10105 $table->colclasses
= array('leftalign step', 'leftalign status', 'leftalign description');
10106 $table->id
= 'onesystemcontrol';
10107 $table->attributes
['class'] = 'admintable wsoverview generaltable';
10108 $table->data
= array();
10110 $return .= $brtag . get_string('onesystemcontrollingdescription', 'webservice')
10113 /// 1. Enable Web Services
10115 $url = new moodle_url("/admin/search.php?query=enablewebservices");
10116 $row[0] = "1. " . html_writer
::tag('a', get_string('enablews', 'webservice'),
10117 array('href' => $url));
10118 $status = html_writer
::tag('span', get_string('no'), array('class' => 'badge badge-danger'));
10119 if ($CFG->enablewebservices
) {
10120 $status = get_string('yes');
10123 $row[2] = get_string('enablewsdescription', 'webservice');
10124 $table->data
[] = $row;
10126 /// 2. Enable protocols
10128 $url = new moodle_url("/admin/settings.php?section=webserviceprotocols");
10129 $row[0] = "2. " . html_writer
::tag('a', get_string('enableprotocols', 'webservice'),
10130 array('href' => $url));
10131 $status = html_writer
::tag('span', get_string('none'), array('class' => 'badge badge-danger'));
10132 //retrieve activated protocol
10133 $active_protocols = empty($CFG->webserviceprotocols
) ?
10134 array() : explode(',', $CFG->webserviceprotocols
);
10135 if (!empty($active_protocols)) {
10137 foreach ($active_protocols as $protocol) {
10138 $status .= $protocol . $brtag;
10142 $row[2] = get_string('enableprotocolsdescription', 'webservice');
10143 $table->data
[] = $row;
10145 /// 3. Create user account
10147 $url = new moodle_url("/user/editadvanced.php?id=-1");
10148 $row[0] = "3. " . html_writer
::tag('a', get_string('createuser', 'webservice'),
10149 array('href' => $url));
10151 $row[2] = get_string('createuserdescription', 'webservice');
10152 $table->data
[] = $row;
10154 /// 4. Add capability to users
10156 $url = new moodle_url("/admin/roles/check.php?contextid=1");
10157 $row[0] = "4. " . html_writer
::tag('a', get_string('checkusercapability', 'webservice'),
10158 array('href' => $url));
10160 $row[2] = get_string('checkusercapabilitydescription', 'webservice');
10161 $table->data
[] = $row;
10163 /// 5. Select a web service
10165 $url = new moodle_url("/admin/settings.php?section=externalservices");
10166 $row[0] = "5. " . html_writer
::tag('a', get_string('selectservice', 'webservice'),
10167 array('href' => $url));
10169 $row[2] = get_string('createservicedescription', 'webservice');
10170 $table->data
[] = $row;
10172 /// 6. Add functions
10174 $url = new moodle_url("/admin/settings.php?section=externalservices");
10175 $row[0] = "6. " . html_writer
::tag('a', get_string('addfunctions', 'webservice'),
10176 array('href' => $url));
10178 $row[2] = get_string('addfunctionsdescription', 'webservice');
10179 $table->data
[] = $row;
10181 /// 7. Add the specific user
10183 $url = new moodle_url("/admin/settings.php?section=externalservices");
10184 $row[0] = "7. " . html_writer
::tag('a', get_string('selectspecificuser', 'webservice'),
10185 array('href' => $url));
10187 $row[2] = get_string('selectspecificuserdescription', 'webservice');
10188 $table->data
[] = $row;
10190 /// 8. Create token for the specific user
10192 $url = new moodle_url('/admin/webservice/tokens.php', ['action' => 'create']);
10193 $row[0] = "8. " . html_writer
::tag('a', get_string('createtokenforuser', 'webservice'),
10194 array('href' => $url));
10196 $row[2] = get_string('createtokenforuserdescription', 'webservice');
10197 $table->data
[] = $row;
10199 /// 9. Enable the documentation
10201 $url = new moodle_url("/admin/search.php?query=enablewsdocumentation");
10202 $row[0] = "9. " . html_writer
::tag('a', get_string('enabledocumentation', 'webservice'),
10203 array('href' => $url));
10204 $status = '<span class="warning">' . get_string('no') . '</span>';
10205 if ($CFG->enablewsdocumentation
) {
10206 $status = get_string('yes');
10209 $row[2] = get_string('enabledocumentationdescription', 'webservice');
10210 $table->data
[] = $row;
10212 /// 10. Test the service
10214 $url = new moodle_url("/admin/webservice/testclient.php");
10215 $row[0] = "10. " . html_writer
::tag('a', get_string('testwithtestclient', 'webservice'),
10216 array('href' => $url));
10218 $row[2] = get_string('testwithtestclientdescription', 'webservice');
10219 $table->data
[] = $row;
10221 $return .= html_writer
::table($table);
10223 /// Users as clients with token
10224 $return .= $brtag . $brtag . $brtag;
10225 $return .= $OUTPUT->heading(get_string('userasclients', 'webservice'), 3, 'main');
10226 $table = new html_table();
10227 $table->head
= array(get_string('step', 'webservice'), get_string('status'),
10228 get_string('description'));
10229 $table->colclasses
= array('leftalign step', 'leftalign status', 'leftalign description');
10230 $table->id
= 'userasclients';
10231 $table->attributes
['class'] = 'admintable wsoverview generaltable';
10232 $table->data
= array();
10234 $return .= $brtag . get_string('userasclientsdescription', 'webservice') .
10237 /// 1. Enable Web Services
10239 $url = new moodle_url("/admin/search.php?query=enablewebservices");
10240 $row[0] = "1. " . html_writer
::tag('a', get_string('enablews', 'webservice'),
10241 array('href' => $url));
10242 $status = html_writer
::tag('span', get_string('no'), array('class' => 'badge badge-danger'));
10243 if ($CFG->enablewebservices
) {
10244 $status = get_string('yes');
10247 $row[2] = get_string('enablewsdescription', 'webservice');
10248 $table->data
[] = $row;
10250 /// 2. Enable protocols
10252 $url = new moodle_url("/admin/settings.php?section=webserviceprotocols");
10253 $row[0] = "2. " . html_writer
::tag('a', get_string('enableprotocols', 'webservice'),
10254 array('href' => $url));
10255 $status = html_writer
::tag('span', get_string('none'), array('class' => 'badge badge-danger'));
10256 //retrieve activated protocol
10257 $active_protocols = empty($CFG->webserviceprotocols
) ?
10258 array() : explode(',', $CFG->webserviceprotocols
);
10259 if (!empty($active_protocols)) {
10261 foreach ($active_protocols as $protocol) {
10262 $status .= $protocol . $brtag;
10266 $row[2] = get_string('enableprotocolsdescription', 'webservice');
10267 $table->data
[] = $row;
10270 /// 3. Select a web service
10272 $url = new moodle_url("/admin/settings.php?section=externalservices");
10273 $row[0] = "3. " . html_writer
::tag('a', get_string('selectservice', 'webservice'),
10274 array('href' => $url));
10276 $row[2] = get_string('createserviceforusersdescription', 'webservice');
10277 $table->data
[] = $row;
10279 /// 4. Add functions
10281 $url = new moodle_url("/admin/settings.php?section=externalservices");
10282 $row[0] = "4. " . html_writer
::tag('a', get_string('addfunctions', 'webservice'),
10283 array('href' => $url));
10285 $row[2] = get_string('addfunctionsdescription', 'webservice');
10286 $table->data
[] = $row;
10288 /// 5. Add capability to users
10290 $url = new moodle_url("/admin/roles/check.php?contextid=1");
10291 $row[0] = "5. " . html_writer
::tag('a', get_string('addcapabilitytousers', 'webservice'),
10292 array('href' => $url));
10294 $row[2] = get_string('addcapabilitytousersdescription', 'webservice');
10295 $table->data
[] = $row;
10297 /// 6. Test the service
10299 $url = new moodle_url("/admin/webservice/testclient.php");
10300 $row[0] = "6. " . html_writer
::tag('a', get_string('testwithtestclient', 'webservice'),
10301 array('href' => $url));
10303 $row[2] = get_string('testauserwithtestclientdescription', 'webservice');
10304 $table->data
[] = $row;
10306 $return .= html_writer
::table($table);
10308 return highlight($query, $return);
10315 * Special class for web service protocol administration.
10317 * @author Petr Skoda (skodak)
10319 class admin_setting_managewebserviceprotocols
extends admin_setting
{
10322 * Calls parent::__construct with specific arguments
10324 public function __construct() {
10325 $this->nosave
= true;
10326 parent
::__construct('webservicesui', get_string('manageprotocols', 'webservice'), '', '');
10330 * Always returns true, does nothing
10334 public function get_setting() {
10339 * Always returns true, does nothing
10343 public function get_defaultsetting() {
10348 * Always returns '', does not write anything
10350 * @return string Always returns ''
10352 public function write_setting($data) {
10353 // do not write any setting
10358 * Checks if $query is one of the available webservices
10360 * @param string $query The string to search for
10361 * @return bool Returns true if found, false if not
10363 public function is_related($query) {
10364 if (parent
::is_related($query)) {
10368 $protocols = core_component
::get_plugin_list('webservice');
10369 foreach ($protocols as $protocol=>$location) {
10370 if (strpos($protocol, $query) !== false) {
10373 $protocolstr = get_string('pluginname', 'webservice_'.$protocol);
10374 if (strpos(core_text
::strtolower($protocolstr), $query) !== false) {
10382 * Builds the XHTML to display the control
10384 * @param string $data Unused
10385 * @param string $query
10388 public function output_html($data, $query='') {
10389 global $CFG, $OUTPUT;
10392 $stradministration = get_string('administration');
10393 $strsettings = get_string('settings');
10394 $stredit = get_string('edit');
10395 $strprotocol = get_string('protocol', 'webservice');
10396 $strenable = get_string('enable');
10397 $strdisable = get_string('disable');
10398 $strversion = get_string('version');
10400 $protocols_available = core_component
::get_plugin_list('webservice');
10401 $activeprotocols = empty($CFG->webserviceprotocols
) ?
array() : explode(',', $CFG->webserviceprotocols
);
10402 ksort($protocols_available);
10404 foreach ($activeprotocols as $key => $protocol) {
10405 if (empty($protocols_available[$protocol])) {
10406 unset($activeprotocols[$key]);
10410 $return = $OUTPUT->heading(get_string('actwebserviceshhdr', 'webservice'), 3, 'main');
10411 if (in_array('xmlrpc', $activeprotocols)) {
10412 $notify = new \core\output\notification
(get_string('xmlrpcwebserviceenabled', 'admin'),
10413 \core\output\notification
::NOTIFY_WARNING
);
10414 $return .= $OUTPUT->render($notify);
10416 $return .= $OUTPUT->box_start('generalbox webservicesui');
10418 $table = new html_table();
10419 $table->head
= array($strprotocol, $strversion, $strenable, $strsettings);
10420 $table->colclasses
= array('leftalign', 'centeralign', 'centeralign', 'centeralign', 'centeralign');
10421 $table->id
= 'webserviceprotocols';
10422 $table->attributes
['class'] = 'admintable generaltable';
10423 $table->data
= array();
10425 // iterate through auth plugins and add to the display table
10426 $url = "$CFG->wwwroot/$CFG->admin/webservice/protocols.php?sesskey=" . sesskey();
10427 foreach ($protocols_available as $protocol => $location) {
10428 $name = get_string('pluginname', 'webservice_'.$protocol);
10430 $plugin = new stdClass();
10431 if (file_exists($CFG->dirroot
.'/webservice/'.$protocol.'/version.php')) {
10432 include($CFG->dirroot
.'/webservice/'.$protocol.'/version.php');
10434 $version = isset($plugin->version
) ?
$plugin->version
: '';
10437 if (in_array($protocol, $activeprotocols)) {
10438 $hideshow = "<a href=\"$url&action=disable&webservice=$protocol\">";
10439 $hideshow .= $OUTPUT->pix_icon('t/hide', $strdisable) . '</a>';
10440 $displayname = "<span>$name</span>";
10442 $hideshow = "<a href=\"$url&action=enable&webservice=$protocol\">";
10443 $hideshow .= $OUTPUT->pix_icon('t/show', $strenable) . '</a>';
10444 $displayname = "<span class=\"dimmed_text\">$name</span>";
10448 if (file_exists($CFG->dirroot
.'/webservice/'.$protocol.'/settings.php')) {
10449 $settings = "<a href=\"settings.php?section=webservicesetting$protocol\">$strsettings</a>";
10454 // add a row to the table
10455 $table->data
[] = array($displayname, $version, $hideshow, $settings);
10457 $return .= html_writer
::table($table);
10458 $return .= get_string('configwebserviceplugins', 'webservice');
10459 $return .= $OUTPUT->box_end();
10461 return highlight($query, $return);
10468 * @copyright 2010 Sam Hemelryk
10469 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
10471 class admin_setting_configcolourpicker
extends admin_setting
{
10474 * Information for previewing the colour
10478 protected $previewconfig = null;
10481 * Use default when empty.
10483 protected $usedefaultwhenempty = true;
10487 * @param string $name
10488 * @param string $visiblename
10489 * @param string $description
10490 * @param string $defaultsetting
10491 * @param array $previewconfig Array('selector'=>'.some .css .selector','style'=>'backgroundColor');
10493 public function __construct($name, $visiblename, $description, $defaultsetting, array $previewconfig = null,
10494 $usedefaultwhenempty = true) {
10495 $this->previewconfig
= $previewconfig;
10496 $this->usedefaultwhenempty
= $usedefaultwhenempty;
10497 parent
::__construct($name, $visiblename, $description, $defaultsetting);
10498 $this->set_force_ltr(true);
10502 * Return the setting
10504 * @return mixed returns config if successful else null
10506 public function get_setting() {
10507 return $this->config_read($this->name
);
10511 * Saves the setting
10513 * @param string $data
10516 public function write_setting($data) {
10517 $data = $this->validate($data);
10518 if ($data === false) {
10519 return get_string('validateerror', 'admin');
10521 return ($this->config_write($this->name
, $data) ?
'' : get_string('errorsetting', 'admin'));
10525 * Validates the colour that was entered by the user
10527 * @param string $data
10528 * @return string|false
10530 protected function validate($data) {
10532 * List of valid HTML colour names
10536 $colornames = array(
10537 'aliceblue', 'antiquewhite', 'aqua', 'aquamarine', 'azure',
10538 'beige', 'bisque', 'black', 'blanchedalmond', 'blue',
10539 'blueviolet', 'brown', 'burlywood', 'cadetblue', 'chartreuse',
10540 'chocolate', 'coral', 'cornflowerblue', 'cornsilk', 'crimson',
10541 'cyan', 'darkblue', 'darkcyan', 'darkgoldenrod', 'darkgray',
10542 'darkgrey', 'darkgreen', 'darkkhaki', 'darkmagenta',
10543 'darkolivegreen', 'darkorange', 'darkorchid', 'darkred',
10544 'darksalmon', 'darkseagreen', 'darkslateblue', 'darkslategray',
10545 'darkslategrey', 'darkturquoise', 'darkviolet', 'deeppink',
10546 'deepskyblue', 'dimgray', 'dimgrey', 'dodgerblue', 'firebrick',
10547 'floralwhite', 'forestgreen', 'fuchsia', 'gainsboro',
10548 'ghostwhite', 'gold', 'goldenrod', 'gray', 'grey', 'green',
10549 'greenyellow', 'honeydew', 'hotpink', 'indianred', 'indigo',
10550 'ivory', 'khaki', 'lavender', 'lavenderblush', 'lawngreen',
10551 'lemonchiffon', 'lightblue', 'lightcoral', 'lightcyan',
10552 'lightgoldenrodyellow', 'lightgray', 'lightgrey', 'lightgreen',
10553 'lightpink', 'lightsalmon', 'lightseagreen', 'lightskyblue',
10554 'lightslategray', 'lightslategrey', 'lightsteelblue', 'lightyellow',
10555 'lime', 'limegreen', 'linen', 'magenta', 'maroon',
10556 'mediumaquamarine', 'mediumblue', 'mediumorchid', 'mediumpurple',
10557 'mediumseagreen', 'mediumslateblue', 'mediumspringgreen',
10558 'mediumturquoise', 'mediumvioletred', 'midnightblue', 'mintcream',
10559 'mistyrose', 'moccasin', 'navajowhite', 'navy', 'oldlace', 'olive',
10560 'olivedrab', 'orange', 'orangered', 'orchid', 'palegoldenrod',
10561 'palegreen', 'paleturquoise', 'palevioletred', 'papayawhip',
10562 'peachpuff', 'peru', 'pink', 'plum', 'powderblue', 'purple', 'red',
10563 'rosybrown', 'royalblue', 'saddlebrown', 'salmon', 'sandybrown',
10564 'seagreen', 'seashell', 'sienna', 'silver', 'skyblue', 'slateblue',
10565 'slategray', 'slategrey', 'snow', 'springgreen', 'steelblue', 'tan',
10566 'teal', 'thistle', 'tomato', 'turquoise', 'violet', 'wheat', 'white',
10567 'whitesmoke', 'yellow', 'yellowgreen'
10570 if (preg_match('/^#?([[:xdigit:]]{3}){1,2}$/', $data)) {
10571 if (strpos($data, '#')!==0) {
10575 } else if (in_array(strtolower($data), $colornames)) {
10577 } else if (preg_match('/rgb\(\d{0,3}%?\, ?\d{0,3}%?, ?\d{0,3}%?\)/i', $data)) {
10579 } else if (preg_match('/rgba\(\d{0,3}%?\, ?\d{0,3}%?, ?\d{0,3}%?\, ?\d(\.\d)?\)/i', $data)) {
10581 } else if (preg_match('/hsl\(\d{0,3}\, ?\d{0,3}%, ?\d{0,3}%\)/i', $data)) {
10583 } else if (preg_match('/hsla\(\d{0,3}\, ?\d{0,3}%,\d{0,3}%\, ?\d(\.\d)?\)/i', $data)) {
10585 } else if (($data == 'transparent') ||
($data == 'currentColor') ||
($data == 'inherit')) {
10587 } else if (empty($data)) {
10588 if ($this->usedefaultwhenempty
){
10589 return $this->defaultsetting
;
10599 * Generates the HTML for the setting
10601 * @global moodle_page $PAGE
10602 * @global core_renderer $OUTPUT
10603 * @param string $data
10604 * @param string $query
10606 public function output_html($data, $query = '') {
10607 global $PAGE, $OUTPUT;
10609 $icon = new pix_icon('i/loading', get_string('loading', 'admin'), 'moodle', ['class' => 'loadingicon']);
10610 $context = (object) [
10611 'id' => $this->get_id(),
10612 'name' => $this->get_full_name(),
10614 'icon' => $icon->export_for_template($OUTPUT),
10615 'haspreviewconfig' => !empty($this->previewconfig
),
10616 'forceltr' => $this->get_force_ltr(),
10617 'readonly' => $this->is_readonly(),
10620 $element = $OUTPUT->render_from_template('core_admin/setting_configcolourpicker', $context);
10621 $PAGE->requires
->js_init_call('M.util.init_colour_picker', array($this->get_id(), $this->previewconfig
));
10623 return format_admin_setting($this, $this->visiblename
, $element, $this->description
, true, '',
10624 $this->get_defaultsetting(), $query);
10631 * Class used for uploading of one file into file storage,
10632 * the file name is stored in config table.
10634 * Please note you need to implement your own '_pluginfile' callback function,
10635 * this setting only stores the file, it does not deal with file serving.
10637 * @copyright 2013 Petr Skoda {@link http://skodak.org}
10638 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
10640 class admin_setting_configstoredfile
extends admin_setting
{
10641 /** @var array file area options - should be one file only */
10642 protected $options;
10643 /** @var string name of the file area */
10644 protected $filearea;
10645 /** @var int intemid */
10647 /** @var string used for detection of changes */
10648 protected $oldhashes;
10651 * Create new stored file setting.
10653 * @param string $name low level setting name
10654 * @param string $visiblename human readable setting name
10655 * @param string $description description of setting
10656 * @param mixed $filearea file area for file storage
10657 * @param int $itemid itemid for file storage
10658 * @param array $options file area options
10660 public function __construct($name, $visiblename, $description, $filearea, $itemid = 0, array $options = null) {
10661 parent
::__construct($name, $visiblename, $description, '');
10662 $this->filearea
= $filearea;
10663 $this->itemid
= $itemid;
10664 $this->options
= (array)$options;
10665 $this->customcontrol
= true;
10669 * Applies defaults and returns all options.
10672 protected function get_options() {
10675 require_once("$CFG->libdir/filelib.php");
10676 require_once("$CFG->dirroot/repository/lib.php");
10678 'mainfile' => '', 'subdirs' => 0, 'maxbytes' => -1, 'maxfiles' => 1,
10679 'accepted_types' => '*', 'return_types' => FILE_INTERNAL
, 'areamaxbytes' => FILE_AREA_MAX_BYTES_UNLIMITED
,
10680 'context' => context_system
::instance());
10681 foreach($this->options
as $k => $v) {
10682 $defaults[$k] = $v;
10688 public function get_setting() {
10689 return $this->config_read($this->name
);
10692 public function write_setting($data) {
10695 // Let's not deal with validation here, this is for admins only.
10696 $current = $this->get_setting();
10697 if (empty($data) && $current === null) {
10698 // This will be the case when applying default settings (installation).
10699 return ($this->config_write($this->name
, '') ?
'' : get_string('errorsetting', 'admin'));
10700 } else if (!is_number($data)) {
10701 // Draft item id is expected here!
10702 return get_string('errorsetting', 'admin');
10705 $options = $this->get_options();
10706 $fs = get_file_storage();
10707 $component = is_null($this->plugin
) ?
'core' : $this->plugin
;
10709 $this->oldhashes
= null;
10711 $hash = sha1('/'.$options['context']->id
.'/'.$component.'/'.$this->filearea
.'/'.$this->itemid
.$current);
10712 if ($file = $fs->get_file_by_hash($hash)) {
10713 $this->oldhashes
= $file->get_contenthash().$file->get_pathnamehash();
10718 if ($fs->file_exists($options['context']->id
, $component, $this->filearea
, $this->itemid
, '/', '.')) {
10719 // Make sure the settings form was not open for more than 4 days and draft areas deleted in the meantime.
10720 // But we can safely ignore that if the destination area is empty, so that the user is not prompt
10721 // with an error because the draft area does not exist, as he did not use it.
10722 $usercontext = context_user
::instance($USER->id
);
10723 if (!$fs->file_exists($usercontext->id
, 'user', 'draft', $data, '/', '.') && $current !== '') {
10724 return get_string('errorsetting', 'admin');
10728 file_save_draft_area_files($data, $options['context']->id
, $component, $this->filearea
, $this->itemid
, $options);
10729 $files = $fs->get_area_files($options['context']->id
, $component, $this->filearea
, $this->itemid
, 'sortorder,filepath,filename', false);
10733 /** @var stored_file $file */
10734 $file = reset($files);
10735 $filepath = $file->get_filepath().$file->get_filename();
10738 return ($this->config_write($this->name
, $filepath) ?
'' : get_string('errorsetting', 'admin'));
10741 public function post_write_settings($original) {
10742 $options = $this->get_options();
10743 $fs = get_file_storage();
10744 $component = is_null($this->plugin
) ?
'core' : $this->plugin
;
10746 $current = $this->get_setting();
10749 $hash = sha1('/'.$options['context']->id
.'/'.$component.'/'.$this->filearea
.'/'.$this->itemid
.$current);
10750 if ($file = $fs->get_file_by_hash($hash)) {
10751 $newhashes = $file->get_contenthash().$file->get_pathnamehash();
10756 if ($this->oldhashes
=== $newhashes) {
10757 $this->oldhashes
= null;
10760 $this->oldhashes
= null;
10762 $callbackfunction = $this->updatedcallback
;
10763 if (!empty($callbackfunction) and function_exists($callbackfunction)) {
10764 $callbackfunction($this->get_full_name());
10769 public function output_html($data, $query = '') {
10772 $options = $this->get_options();
10773 $id = $this->get_id();
10774 $elname = $this->get_full_name();
10775 $draftitemid = file_get_submitted_draft_itemid($elname);
10776 $component = is_null($this->plugin
) ?
'core' : $this->plugin
;
10777 file_prepare_draft_area($draftitemid, $options['context']->id
, $component, $this->filearea
, $this->itemid
, $options);
10779 // Filemanager form element implementation is far from optimal, we need to rework this if we ever fix it...
10780 require_once("$CFG->dirroot/lib/form/filemanager.php");
10782 $fmoptions = new stdClass();
10783 $fmoptions->mainfile
= $options['mainfile'];
10784 $fmoptions->maxbytes
= $options['maxbytes'];
10785 $fmoptions->maxfiles
= $options['maxfiles'];
10786 $fmoptions->subdirs
= $options['subdirs'];
10787 $fmoptions->accepted_types
= $options['accepted_types'];
10788 $fmoptions->return_types
= $options['return_types'];
10789 $fmoptions->context
= $options['context'];
10790 $fmoptions->areamaxbytes
= $options['areamaxbytes'];
10792 $fm = new MoodleQuickForm_filemanager($elname, $this->visiblename
, ['id' => $id], $fmoptions);
10793 $fm->setValue($draftitemid);
10795 return format_admin_setting($this, $this->visiblename
,
10796 '<div class="form-filemanager" data-fieldtype="filemanager">' . $fm->toHtml() . '</div>',
10797 $this->description
, true, '', '', $query);
10803 * Administration interface for user specified regular expressions for device detection.
10805 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
10807 class admin_setting_devicedetectregex
extends admin_setting
{
10810 * Calls parent::__construct with specific args
10812 * @param string $name
10813 * @param string $visiblename
10814 * @param string $description
10815 * @param mixed $defaultsetting
10817 public function __construct($name, $visiblename, $description, $defaultsetting = '') {
10819 parent
::__construct($name, $visiblename, $description, $defaultsetting);
10823 * Return the current setting(s)
10825 * @return array Current settings array
10827 public function get_setting() {
10830 $config = $this->config_read($this->name
);
10831 if (is_null($config)) {
10835 return $this->prepare_form_data($config);
10839 * Save selected settings
10841 * @param array $data Array of settings to save
10844 public function write_setting($data) {
10845 if (empty($data)) {
10849 if ($this->config_write($this->name
, $this->process_form_data($data))) {
10850 return ''; // success
10852 return get_string('errorsetting', 'admin') . $this->visiblename
. html_writer
::empty_tag('br');
10857 * Return XHTML field(s) for regexes
10859 * @param array $data Array of options to set in HTML
10860 * @return string XHTML string for the fields and wrapping div(s)
10862 public function output_html($data, $query='') {
10865 $context = (object) [
10866 'expressions' => [],
10867 'name' => $this->get_full_name()
10870 if (empty($data)) {
10873 $looplimit = (count($data)/2)+
1;
10876 for ($i=0; $i<$looplimit; $i++
) {
10878 $expressionname = 'expression'.$i;
10880 if (!empty($data[$expressionname])){
10881 $expression = $data[$expressionname];
10886 $valuename = 'value'.$i;
10888 if (!empty($data[$valuename])){
10889 $value = $data[$valuename];
10894 $context->expressions
[] = [
10896 'expression' => $expression,
10901 $element = $OUTPUT->render_from_template('core_admin/setting_devicedetectregex', $context);
10903 return format_admin_setting($this, $this->visiblename
, $element, $this->description
, false, '', null, $query);
10907 * Converts the string of regexes
10909 * @see self::process_form_data()
10910 * @param $regexes string of regexes
10911 * @return array of form fields and their values
10913 protected function prepare_form_data($regexes) {
10915 $regexes = json_decode($regexes);
10921 foreach ($regexes as $value => $regex) {
10922 $expressionname = 'expression'.$i;
10923 $valuename = 'value'.$i;
10925 $form[$expressionname] = $regex;
10926 $form[$valuename] = $value;
10934 * Converts the data from admin settings form into a string of regexes
10936 * @see self::prepare_form_data()
10937 * @param array $data array of admin form fields and values
10938 * @return false|string of regexes
10940 protected function process_form_data(array $form) {
10942 $count = count($form); // number of form field values
10945 // we must get five fields per expression
10949 $regexes = array();
10950 for ($i = 0; $i < $count / 2; $i++
) {
10951 $expressionname = "expression".$i;
10952 $valuename = "value".$i;
10954 $expression = trim($form['expression'.$i]);
10955 $value = trim($form['value'.$i]);
10957 if (empty($expression)){
10961 $regexes[$value] = $expression;
10964 $regexes = json_encode($regexes);
10972 * Multiselect for current modules
10974 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
10976 class admin_setting_configmultiselect_modules
extends admin_setting_configmultiselect
{
10977 private $excludesystem;
10980 * Calls parent::__construct - note array $choices is not required
10982 * @param string $name setting name
10983 * @param string $visiblename localised setting name
10984 * @param string $description setting description
10985 * @param array $defaultsetting a plain array of default module ids
10986 * @param bool $excludesystem If true, excludes modules with 'system' archetype
10988 public function __construct($name, $visiblename, $description, $defaultsetting = array(),
10989 $excludesystem = true) {
10990 parent
::__construct($name, $visiblename, $description, $defaultsetting, null);
10991 $this->excludesystem
= $excludesystem;
10995 * Loads an array of current module choices
10997 * @return bool always return true
10999 public function load_choices() {
11000 if (is_array($this->choices
)) {
11003 $this->choices
= array();
11006 $records = $DB->get_records('modules', array('visible'=>1), 'name');
11007 foreach ($records as $record) {
11008 // Exclude modules if the code doesn't exist
11009 if (file_exists("$CFG->dirroot/mod/$record->name/lib.php")) {
11010 // Also exclude system modules (if specified)
11011 if (!($this->excludesystem
&&
11012 plugin_supports('mod', $record->name
, FEATURE_MOD_ARCHETYPE
) ===
11013 MOD_ARCHETYPE_SYSTEM
)) {
11014 $this->choices
[$record->id
] = $record->name
;
11023 * Admin setting to show if a php extension is enabled or not.
11025 * @copyright 2013 Damyon Wiese
11026 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
11028 class admin_setting_php_extension_enabled
extends admin_setting
{
11030 /** @var string The name of the extension to check for */
11031 private $extension;
11034 * Calls parent::__construct with specific arguments
11036 public function __construct($name, $visiblename, $description, $extension) {
11037 $this->extension
= $extension;
11038 $this->nosave
= true;
11039 parent
::__construct($name, $visiblename, $description, '');
11043 * Always returns true, does nothing
11047 public function get_setting() {
11052 * Always returns true, does nothing
11056 public function get_defaultsetting() {
11061 * Always returns '', does not write anything
11063 * @return string Always returns ''
11065 public function write_setting($data) {
11066 // Do not write any setting.
11071 * Outputs the html for this setting.
11072 * @return string Returns an XHTML string
11074 public function output_html($data, $query='') {
11078 if (!extension_loaded($this->extension
)) {
11079 $warning = $OUTPUT->pix_icon('i/warning', '', '', array('role' => 'presentation')) . ' ' . $this->description
;
11081 $o .= format_admin_setting($this, $this->visiblename
, $warning);
11088 * Server timezone setting.
11090 * @copyright 2015 Totara Learning Solutions Ltd {@link http://www.totaralms.com/}
11091 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
11092 * @author Petr Skoda <petr.skoda@totaralms.com>
11094 class admin_setting_servertimezone
extends admin_setting_configselect
{
11098 public function __construct() {
11099 $default = core_date
::get_default_php_timezone();
11100 if ($default === 'UTC') {
11101 // Nobody really wants UTC, so instead default selection to the country that is confused by the UTC the most.
11102 $default = 'Europe/London';
11105 parent
::__construct('timezone',
11106 new lang_string('timezone', 'core_admin'),
11107 new lang_string('configtimezone', 'core_admin'), $default, null);
11111 * Lazy load timezone options.
11112 * @return bool true if loaded, false if error
11114 public function load_choices() {
11116 if (is_array($this->choices
)) {
11120 $current = isset($CFG->timezone
) ?
$CFG->timezone
: null;
11121 $this->choices
= core_date
::get_list_of_timezones($current, false);
11122 if ($current == 99) {
11123 // Do not show 99 unless it is current value, we want to get rid of it over time.
11124 $this->choices
['99'] = new lang_string('timezonephpdefault', 'core_admin',
11125 core_date
::get_default_php_timezone());
11133 * Forced user timezone setting.
11135 * @copyright 2015 Totara Learning Solutions Ltd {@link http://www.totaralms.com/}
11136 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
11137 * @author Petr Skoda <petr.skoda@totaralms.com>
11139 class admin_setting_forcetimezone
extends admin_setting_configselect
{
11143 public function __construct() {
11144 parent
::__construct('forcetimezone',
11145 new lang_string('forcetimezone', 'core_admin'),
11146 new lang_string('helpforcetimezone', 'core_admin'), '99', null);
11150 * Lazy load timezone options.
11151 * @return bool true if loaded, false if error
11153 public function load_choices() {
11155 if (is_array($this->choices
)) {
11159 $current = isset($CFG->forcetimezone
) ?
$CFG->forcetimezone
: null;
11160 $this->choices
= core_date
::get_list_of_timezones($current, true);
11161 $this->choices
['99'] = new lang_string('timezonenotforced', 'core_admin');
11169 * Search setup steps info.
11172 * @copyright 2016 David Monllao {@link http://www.davidmonllao.com}
11173 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
11175 class admin_setting_searchsetupinfo
extends admin_setting
{
11178 * Calls parent::__construct with specific arguments
11180 public function __construct() {
11181 $this->nosave
= true;
11182 parent
::__construct('searchsetupinfo', '', '', '');
11186 * Always returns true, does nothing
11190 public function get_setting() {
11195 * Always returns true, does nothing
11199 public function get_defaultsetting() {
11204 * Always returns '', does not write anything
11206 * @param array $data
11207 * @return string Always returns ''
11209 public function write_setting($data) {
11210 // Do not write any setting.
11215 * Builds the HTML to display the control
11217 * @param string $data Unused
11218 * @param string $query
11221 public function output_html($data, $query='') {
11222 global $CFG, $OUTPUT, $ADMIN;
11225 $brtag = html_writer
::empty_tag('br');
11227 $searchareas = \core_search\manager
::get_search_areas_list();
11228 $anyenabled = !empty(\core_search\manager
::get_search_areas_list(true));
11229 $anyindexed = false;
11230 foreach ($searchareas as $areaid => $searcharea) {
11231 list($componentname, $varname) = $searcharea->get_config_var_name();
11232 if (get_config($componentname, $varname . '_indexingstart')) {
11233 $anyindexed = true;
11238 $return .= $OUTPUT->heading(get_string('searchsetupinfo', 'admin'), 3, 'main');
11240 $table = new html_table();
11241 $table->head
= array(get_string('step', 'search'), get_string('status'));
11242 $table->colclasses
= array('leftalign step', 'leftalign status');
11243 $table->id
= 'searchsetup';
11244 $table->attributes
['class'] = 'admintable generaltable';
11245 $table->data
= array();
11247 $return .= $brtag . get_string('searchsetupdescription', 'search') . $brtag . $brtag;
11249 // Select a search engine.
11251 $url = new moodle_url('/admin/settings.php?section=manageglobalsearch#admin-searchengine');
11252 $row[0] = '1. ' . html_writer
::tag('a', get_string('selectsearchengine', 'admin'),
11253 array('href' => $url));
11255 $status = html_writer
::tag('span', get_string('no'), array('class' => 'badge badge-danger'));
11256 if (!empty($CFG->searchengine
)) {
11257 $status = html_writer
::tag('span', get_string('pluginname', 'search_' . $CFG->searchengine
),
11258 array('class' => 'badge badge-success'));
11262 $table->data
[] = $row;
11264 // Available areas.
11266 $url = new moodle_url('/admin/searchareas.php');
11267 $row[0] = '2. ' . html_writer
::tag('a', get_string('enablesearchareas', 'admin'),
11268 array('href' => $url));
11270 $status = html_writer
::tag('span', get_string('no'), array('class' => 'badge badge-danger'));
11272 $status = html_writer
::tag('span', get_string('yes'), array('class' => 'badge badge-success'));
11276 $table->data
[] = $row;
11278 // Setup search engine.
11280 if (empty($CFG->searchengine
)) {
11281 $row[0] = '3. ' . get_string('setupsearchengine', 'admin');
11282 $row[1] = html_writer
::tag('span', get_string('no'), array('class' => 'badge badge-danger'));
11284 if ($ADMIN->locate('search' . $CFG->searchengine
)) {
11285 $url = new moodle_url('/admin/settings.php?section=search' . $CFG->searchengine
);
11286 $row[0] = '3. ' . html_writer
::link($url, get_string('setupsearchengine', 'core_admin'));
11288 $row[0] = '3. ' . get_string('setupsearchengine', 'core_admin');
11291 // Check the engine status.
11292 $searchengine = \core_search\manager
::search_engine_instance();
11294 $serverstatus = $searchengine->is_server_ready();
11295 } catch (\moodle_exception
$e) {
11296 $serverstatus = $e->getMessage();
11298 if ($serverstatus === true) {
11299 $status = html_writer
::tag('span', get_string('yes'), array('class' => 'badge badge-success'));
11301 $status = html_writer
::tag('span', $serverstatus, array('class' => 'badge badge-danger'));
11305 $table->data
[] = $row;
11309 $url = new moodle_url('/admin/searchareas.php');
11310 $row[0] = '4. ' . html_writer
::tag('a', get_string('indexdata', 'admin'), array('href' => $url));
11312 $status = html_writer
::tag('span', get_string('yes'), array('class' => 'badge badge-success'));
11314 $status = html_writer
::tag('span', get_string('no'), array('class' => 'badge badge-danger'));
11317 $table->data
[] = $row;
11319 // Enable global search.
11321 $url = new moodle_url("/admin/search.php?query=enableglobalsearch");
11322 $row[0] = '5. ' . html_writer
::tag('a', get_string('enableglobalsearch', 'admin'),
11323 array('href' => $url));
11324 $status = html_writer
::tag('span', get_string('no'), array('class' => 'badge badge-danger'));
11325 if (\core_search\manager
::is_global_search_enabled()) {
11326 $status = html_writer
::tag('span', get_string('yes'), array('class' => 'badge badge-success'));
11329 $table->data
[] = $row;
11331 // Replace front page search.
11333 $url = new moodle_url("/admin/search.php?query=searchincludeallcourses");
11334 $row[0] = '6. ' . html_writer
::tag('a', get_string('replacefrontsearch', 'admin'),
11335 array('href' => $url));
11336 $status = html_writer
::tag('span', get_string('no'), array('class' => 'badge badge-danger'));
11337 if (\core_search\manager
::can_replace_course_search()) {
11338 $status = html_writer
::tag('span', get_string('yes'), array('class' => 'badge badge-success'));
11341 $table->data
[] = $row;
11343 $return .= html_writer
::table($table);
11345 return highlight($query, $return);
11351 * Used to validate the contents of SCSS code and ensuring they are parsable.
11353 * It does not attempt to detect undefined SCSS variables because it is designed
11354 * to be used without knowledge of other config/scss included.
11356 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
11357 * @copyright 2016 Dan Poltawski <dan@moodle.com>
11359 class admin_setting_scsscode
extends admin_setting_configtextarea
{
11362 * Validate the contents of the SCSS to ensure its parsable. Does not
11363 * attempt to detect undefined scss variables.
11365 * @param string $data The scss code from text field.
11366 * @return mixed bool true for success or string:error on failure.
11368 public function validate($data) {
11369 if (empty($data)) {
11373 $scss = new core_scss();
11375 $scss->compile($data);
11376 } catch (ScssPhp\ScssPhp\Exception\ParserException
$e) {
11377 return get_string('scssinvalid', 'admin', $e->getMessage());
11378 } catch (ScssPhp\ScssPhp\Exception\CompilerException
$e) {
11379 // Silently ignore this - it could be a scss variable defined from somewhere
11380 // else which we are not examining here.
11390 * Administration setting to define a list of file types.
11392 * @copyright 2016 Jonathon Fowler <fowlerj@usq.edu.au>
11393 * @copyright 2017 David Mudrák <david@moodle.com>
11394 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
11396 class admin_setting_filetypes
extends admin_setting_configtext
{
11398 /** @var array Allow selection from these file types only. */
11399 protected $onlytypes = [];
11401 /** @var bool Allow selection of 'All file types' (will be stored as '*'). */
11402 protected $allowall = true;
11404 /** @var core_form\filetypes_util instance to use as a helper. */
11405 protected $util = null;
11410 * @param string $name Unique ascii name like 'mycoresetting' or 'myplugin/mysetting'
11411 * @param string $visiblename Localised label of the setting
11412 * @param string $description Localised description of the setting
11413 * @param string $defaultsetting Default setting value.
11414 * @param array $options Setting widget options, an array with optional keys:
11415 * 'onlytypes' => array Allow selection from these file types only; for example ['onlytypes' => ['web_image']].
11416 * 'allowall' => bool Allow to select 'All file types', defaults to true. Does not apply if onlytypes are set.
11418 public function __construct($name, $visiblename, $description, $defaultsetting = '', array $options = []) {
11420 parent
::__construct($name, $visiblename, $description, $defaultsetting, PARAM_RAW
);
11422 if (array_key_exists('onlytypes', $options) && is_array($options['onlytypes'])) {
11423 $this->onlytypes
= $options['onlytypes'];
11426 if (!$this->onlytypes
&& array_key_exists('allowall', $options)) {
11427 $this->allowall
= (bool)$options['allowall'];
11430 $this->util
= new \core_form\filetypes_util
();
11434 * Normalize the user's input and write it to the database as comma separated list.
11436 * Comma separated list as a text representation of the array was chosen to
11437 * make this compatible with how the $CFG->courseoverviewfilesext values are stored.
11439 * @param string $data Value submitted by the admin.
11440 * @return string Epty string if all good, error message otherwise.
11442 public function write_setting($data) {
11443 return parent
::write_setting(implode(',', $this->util
->normalize_file_types($data)));
11447 * Validate data before storage
11449 * @param string $data The setting values provided by the admin
11450 * @return bool|string True if ok, the string if error found
11452 public function validate($data) {
11453 $parentcheck = parent
::validate($data);
11454 if ($parentcheck !== true) {
11455 return $parentcheck;
11458 // Check for unknown file types.
11459 if ($unknown = $this->util
->get_unknown_file_types($data)) {
11460 return get_string('filetypesunknown', 'core_form', implode(', ', $unknown));
11463 // Check for disallowed file types.
11464 if ($notlisted = $this->util
->get_not_listed($data, $this->onlytypes
)) {
11465 return get_string('filetypesnotallowed', 'core_form', implode(', ', $notlisted));
11472 * Return an HTML string for the setting element.
11474 * @param string $data The current setting value
11475 * @param string $query Admin search query to be highlighted
11476 * @return string HTML to be displayed
11478 public function output_html($data, $query='') {
11479 global $OUTPUT, $PAGE;
11481 $default = $this->get_defaultsetting();
11482 $context = (object) [
11483 'id' => $this->get_id(),
11484 'name' => $this->get_full_name(),
11486 'descriptions' => $this->util
->describe_file_types($data),
11488 $element = $OUTPUT->render_from_template('core_admin/setting_filetypes', $context);
11490 $PAGE->requires
->js_call_amd('core_form/filetypes', 'init', [
11492 $this->visiblename
->out(),
11497 return format_admin_setting($this, $this->visiblename
, $element, $this->description
, true, '', $default, $query);
11501 * Should the values be always displayed in LTR mode?
11503 * We always return true here because these values are not RTL compatible.
11505 * @return bool True because these values are not RTL compatible.
11507 public function get_force_ltr() {
11513 * Used to validate the content and format of the age of digital consent map and ensuring it is parsable.
11515 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
11516 * @copyright 2018 Mihail Geshoski <mihail@moodle.com>
11518 class admin_setting_agedigitalconsentmap
extends admin_setting_configtextarea
{
11523 * @param string $name
11524 * @param string $visiblename
11525 * @param string $description
11526 * @param mixed $defaultsetting string or array
11527 * @param mixed $paramtype
11528 * @param string $cols
11529 * @param string $rows
11531 public function __construct($name, $visiblename, $description, $defaultsetting, $paramtype = PARAM_RAW
,
11532 $cols = '60', $rows = '8') {
11533 parent
::__construct($name, $visiblename, $description, $defaultsetting, $paramtype, $cols, $rows);
11534 // Pre-set force LTR to false.
11535 $this->set_force_ltr(false);
11539 * Validate the content and format of the age of digital consent map to ensure it is parsable.
11541 * @param string $data The age of digital consent map from text field.
11542 * @return mixed bool true for success or string:error on failure.
11544 public function validate($data) {
11545 if (empty($data)) {
11550 \core_auth\digital_consent
::parse_age_digital_consent_map($data);
11551 } catch (\moodle_exception
$e) {
11552 return get_string('invalidagedigitalconsent', 'admin', $e->getMessage());
11560 * Selection of plugins that can work as site policy handlers
11562 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
11563 * @copyright 2018 Marina Glancy
11565 class admin_settings_sitepolicy_handler_select
extends admin_setting_configselect
{
11569 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting'
11570 * for ones in config_plugins.
11571 * @param string $visiblename localised
11572 * @param string $description long localised info
11573 * @param string $defaultsetting
11575 public function __construct($name, $visiblename, $description, $defaultsetting = '') {
11576 parent
::__construct($name, $visiblename, $description, $defaultsetting, null);
11580 * Lazy-load the available choices for the select box
11582 public function load_choices() {
11583 if (during_initial_install()) {
11586 if (is_array($this->choices
)) {
11590 $this->choices
= ['' => new lang_string('sitepolicyhandlercore', 'core_admin')];
11591 $manager = new \core_privacy\local\sitepolicy\
manager();
11592 $plugins = $manager->get_all_handlers();
11593 foreach ($plugins as $pname => $unused) {
11594 $this->choices
[$pname] = new lang_string('sitepolicyhandlerplugin', 'core_admin',
11595 ['name' => new lang_string('pluginname', $pname), 'component' => $pname]);
11603 * Used to validate theme presets code and ensuring they compile well.
11605 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
11606 * @copyright 2019 Bas Brands <bas@moodle.com>
11608 class admin_setting_configthemepreset
extends admin_setting_configselect
{
11610 /** @var string The name of the theme to check for */
11611 private $themename;
11615 * @param string $name unique ascii name, either 'mysetting' for settings that in config,
11616 * or 'myplugin/mysetting' for ones in config_plugins.
11617 * @param string $visiblename localised
11618 * @param string $description long localised info
11619 * @param string|int $defaultsetting
11620 * @param array $choices array of $value=>$label for each selection
11621 * @param string $themename name of theme to check presets for.
11623 public function __construct($name, $visiblename, $description, $defaultsetting, $choices, $themename) {
11624 $this->themename
= $themename;
11625 parent
::__construct($name, $visiblename, $description, $defaultsetting, $choices);
11629 * Write settings if validated
11631 * @param string $data
11634 public function write_setting($data) {
11635 $validated = $this->validate($data);
11636 if ($validated !== true) {
11639 return ($this->config_write($this->name
, $data) ?
'' : get_string('errorsetting', 'admin'));
11643 * Validate the preset file to ensure its parsable.
11645 * @param string $data The preset file chosen.
11646 * @return mixed bool true for success or string:error on failure.
11648 public function validate($data) {
11650 if (in_array($data, ['default.scss', 'plain.scss'])) {
11654 $fs = get_file_storage();
11655 $theme = theme_config
::load($this->themename
);
11656 $context = context_system
::instance();
11658 // If the preset has not changed there is no need to validate it.
11659 if ($theme->settings
->preset
== $data) {
11663 if ($presetfile = $fs->get_file($context->id
, 'theme_' . $this->themename
, 'preset', 0, '/', $data)) {
11664 // This operation uses a lot of resources.
11665 raise_memory_limit(MEMORY_EXTRA
);
11666 core_php_time_limit
::raise(300);
11668 // TODO: MDL-62757 When changing anything in this method please do not forget to check
11669 // if the get_css_content_from_scss() method in class theme_config needs updating too.
11671 $compiler = new core_scss();
11672 $compiler->prepend_raw_scss($theme->get_pre_scss_code());
11673 $compiler->append_raw_scss($presetfile->get_content());
11674 if ($scssproperties = $theme->get_scss_property()) {
11675 $compiler->setImportPaths($scssproperties[0]);
11677 $compiler->append_raw_scss($theme->get_extra_scss_code());
11680 $compiler->to_css();
11681 } catch (Exception
$e) {
11682 return get_string('invalidthemepreset', 'admin', $e->getMessage());
11685 // Try to save memory.
11695 * Selection of plugins that can work as H5P libraries handlers
11697 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
11698 * @copyright 2020 Sara Arjona <sara@moodle.com>
11700 class admin_settings_h5plib_handler_select
extends admin_setting_configselect
{
11704 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting'
11705 * for ones in config_plugins.
11706 * @param string $visiblename localised
11707 * @param string $description long localised info
11708 * @param string $defaultsetting
11710 public function __construct($name, $visiblename, $description, $defaultsetting = '') {
11711 parent
::__construct($name, $visiblename, $description, $defaultsetting, null);
11715 * Lazy-load the available choices for the select box
11717 public function load_choices() {
11718 if (during_initial_install()) {
11721 if (is_array($this->choices
)) {
11725 $this->choices
= \core_h5p\local\library\autoloader
::get_all_handlers();
11726 foreach ($this->choices
as $name => $class) {
11727 $this->choices
[$name] = new lang_string('sitepolicyhandlerplugin', 'core_admin',
11728 ['name' => new lang_string('pluginname', $name), 'component' => $name]);