WebSVN – Moodle – Diff – /cache/classes/local/administration_display_helper.php

  * Cache display administration helper.
+ *
  * This file is part of Moodle's cache API, affectionately called MUC.
  * It contains the components that are requried in order to use caching.
+ *
- * @package    core
+ * @package    core_cache
  * @category   cache
  * @author     Peter Burnett <peterburnett@catalyst-au.net>
  * @copyright  2020 Catalyst IT
  * @copyright  2012 Sam Hemelryk
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
+namespace core_cache\local;
+use core_cache\cache;
+use core_cache\config;
+use core_cache\config_writer;
+use core_cache\configurable_cache_interface;
+use core_cache\exception\cache_exception;
+use core_cache\factory;
+use core_cache\form\cache_lock_form;
-namespace core_cache\local;
+use core_cache\form\cache_mode_mappings_form;
+use core_cache\form\cache_definition_sharing_form;
+use core_cache\form\cache_definition_mappings_form;
+use core_cache\form\cachestore_addinstance_form;
+use core_cache\helper as cache_helper;
+use core_cache\lockable_cache_interface;
+use core_cache\store;
+use core_component;
+use core\context;
+use core\context\system as context_system;
 use core\exception\coding_exception;
+use core\exception\moodle_exception;
+use core\output\notification;
+use core\output\single_button;
+use core\url;
-use cache_store, cache_factory, cache_config_writer, cache_helper;
+use html_writer;
-use core\output\notification;
+use stdClass;
 /**
  * A cache helper for administration tasks
+ *
  * @package    core
  * @category   cache
  * @copyright  2020 Peter Burnett <peterburnett@catalyst-au.net>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
-class administration_display_helper extends \core_cache\administration_helper {
+ */
 class administration_display_helper extends \core_cache\administration_helper {
     /**
-     * Please do not call constructor directly. Use cache_factory::get_administration_display_helper() instead.
+     * Please do not call constructor directly. Use factory::get_administration_display_helper() instead.
      */
      * @param array $definitionsummary information about this cache, from the array returned by
      *      core_cache\administration_helper::get_definition_summaries(). Currently only 'sharingoptions'
      *      element is used.
      * @return array of actions. Each action is an action_url.
      */
-    public function get_definition_actions(\context $context, array $definitionsummary): array {
+    public function get_definition_actions(context $context, array $definitionsummary): array {
         global $OUTPUT;
         if (has_capability('moodle/site:config', $context)) {
-            $actions = array();
+            $actions = [];
             // Edit mappings.
             $actions[] = $OUTPUT->action_link(
-                new \moodle_url('/cache/admin.php', array('action' => 'editdefinitionmapping',
+                new url('/cache/admin.php', ['action' => 'editdefinitionmapping',
-                    'definition' => $definitionsummary['id'])),
+                    'definition' => $definitionsummary['id'], ]),
                 get_string('editmappings', 'cache')
             );
             // Edit sharing.
             if (count($definitionsummary['sharingoptions']) > 1) {
                 $actions[] = $OUTPUT->action_link(
-                    new \moodle_url('/cache/admin.php', array('action' => 'editdefinitionsharing',
+                    new url('/cache/admin.php', ['action' => 'editdefinitionsharing',
-                        'definition' => $definitionsummary['id'])),
+                        'definition' => $definitionsummary['id'], ]),
                     get_string('editsharing', 'cache')
                 );
+            }
             // Purge.
             $actions[] = $OUTPUT->action_link(
-                new \moodle_url('/cache/admin.php', array('action' => 'purgedefinition',
+                new url('/cache/admin.php', ['action' => 'purgedefinition',
-                    'definition' => $definitionsummary['id'], 'sesskey' => sesskey())),
+                    'definition' => $definitionsummary['id'], 'sesskey' => sesskey(), ]),
                 get_string('purge', 'cache')
             );
             return $actions;
+        }
-        return array();
+        return [];
+    }
     /**
      * Returns all of the actions that can be performed on a store.
      *      core_cache\administration_helper::get_store_instance_summaries().
      * @return array of actions. Each action is an action_url.
      */
     public function get_store_instance_actions(string $name, array $storedetails): array {
         global $OUTPUT;
-        $actions = array();
+        $actions = [];
-        if (has_capability('moodle/site:config', \context_system::instance())) {
+        if (has_capability('moodle/site:config', context_system::instance())) {
-            $baseurl = new \moodle_url('/cache/admin.php', array('store' => $name));
+            $baseurl = new url('/cache/admin.php', ['store' => $name]);
             if (empty($storedetails['default'])) {
                 // Edit store.
                 $actions[] = $OUTPUT->action_link(
-                    new \moodle_url($baseurl, array('action' => 'editstore', 'plugin' => $storedetails['plugin'])),
+                    new url($baseurl, ['action' => 'editstore', 'plugin' => $storedetails['plugin']]),
                     get_string('editstore', 'cache')
                 );
                 // Delete store.
                 $actions[] = $OUTPUT->action_link(
-                    new \moodle_url($baseurl, array('action' => 'deletestore')),
+                    new url($baseurl, ['action' => 'deletestore']),
                     get_string('deletestore', 'cache')
                 );
+            }
             // Purge store.
             $actions[] = $OUTPUT->action_link(
-                new \moodle_url($baseurl, array('action' => 'purgestore', 'sesskey' => sesskey())),
+                new url($baseurl, ['action' => 'purgestore', 'sesskey' => sesskey()]),
                 get_string('purge', 'cache')
             );
+        }
         return $actions;
+    }
      *      core_cache\administration_helper::get_store_plugin_summaries().
      * @return array of actions. Each action is an action_url.
      */
     public function get_store_plugin_actions(string $name, array $plugindetails): array {
         global $OUTPUT;
-        $actions = array();
+        $actions = [];
-        if (has_capability('moodle/site:config', \context_system::instance())) {
+        if (has_capability('moodle/site:config', context_system::instance())) {
             if (!empty($plugindetails['canaddinstance'])) {
+                $url = new url(
-                $url = new \moodle_url('/cache/admin.php',
+                    '/cache/admin.php',
-                    array('action' => 'addstore', 'plugin' => $name));
+                    ['action' => 'addstore', 'plugin' => $name]
+                );
                 $actions[] = $OUTPUT->action_link(
                     $url,
                     get_string('addinstance', 'cache')
                 );
+            }
+     *
      * @param string $plugin The plugin to add an instance of
      * @return cachestore_addinstance_form
      * @throws coding_exception
      */
-    public function get_add_store_form(string $plugin): \cachestore_addinstance_form {
+    public function get_add_store_form(string $plugin): cachestore_addinstance_form {
         global $CFG; // Needed for includes.
-        $plugins = \core_component::get_plugin_list('cachestore');
+        $plugins = core_component::get_plugin_list('cachestore');
         if (!array_key_exists($plugin, $plugins)) {
-            throw new \coding_exception('Invalid cache plugin used when trying to create an edit form.');
+            throw new coding_exception('Invalid cache plugin used when trying to create an edit form.');
+        }
         $plugindir = $plugins[$plugin];
         $class = 'cachestore_addinstance_form';
-        if (file_exists($plugindir.'/addinstanceform.php')) {
+        if (file_exists($plugindir . '/addinstanceform.php')) {
-            require_once($plugindir.'/addinstanceform.php');
+            require_once($plugindir . '/addinstanceform.php');
-            if (class_exists('cachestore_'.$plugin.'_addinstance_form')) {
+            if (class_exists('cachestore_' . $plugin . '_addinstance_form')) {
-                $class = 'cachestore_'.$plugin.'_addinstance_form';
+                $class = 'cachestore_' . $plugin . '_addinstance_form';
-                if (!array_key_exists('cachestore_addinstance_form', class_parents($class))) {
+                if (!array_key_exists(cachestore_addinstance_form::class, class_parents($class))) {
-                    throw new \coding_exception('Cache plugin add instance forms must extend cachestore_addinstance_form');
+                    throw new coding_exception('Cache plugin add instance forms must extend cachestore_addinstance_form');
+                }
+            }
+        }
         $locks = $this->get_possible_locks_for_stores($plugindir, $plugin);
-        $url = new \moodle_url('/cache/admin.php', array('action' => 'addstore'));
+        $url = new url('/cache/admin.php', ['action' => 'addstore']);
-        return new $class($url, array('plugin' => $plugin, 'store' => null, 'locks' => $locks));
+        return new $class($url, ['plugin' => $plugin, 'store' => null, 'locks' => $locks]);
+    }
     /**
      * Returns a form that can be used to edit a store instance.
+     *
      * @param string $plugin
      * @param string $store
      * @return cachestore_addinstance_form
      * @throws coding_exception
      */
-    public function get_edit_store_form(string $plugin, string $store): \cachestore_addinstance_form {
+    public function get_edit_store_form(string $plugin, string $store): cachestore_addinstance_form {
         global $CFG; // Needed for includes.
-        $plugins = \core_component::get_plugin_list('cachestore');
+        $plugins = core_component::get_plugin_list('cachestore');
         if (!array_key_exists($plugin, $plugins)) {
-            throw new \coding_exception('Invalid cache plugin used when trying to create an edit form.');
+            throw new coding_exception('Invalid cache plugin used when trying to create an edit form.');
+        }
-        $factory = \cache_factory::instance();
+        $factory = factory::instance();
         $config = $factory->create_config_instance();
         $stores = $config->get_all_stores();
         if (!array_key_exists($store, $stores)) {
-            throw new \coding_exception('Invalid store name given when trying to create an edit form.');
+            throw new coding_exception('Invalid store name given when trying to create an edit form.');
         }
         $plugindir = $plugins[$plugin];
         $class = 'cachestore_addinstance_form';
-        if (file_exists($plugindir.'/addinstanceform.php')) {
+        if (file_exists($plugindir . '/addinstanceform.php')) {
-            require_once($plugindir.'/addinstanceform.php');
+            require_once($plugindir . '/addinstanceform.php');
-            if (class_exists('cachestore_'.$plugin.'_addinstance_form')) {
+            if (class_exists('cachestore_' . $plugin . '_addinstance_form')) {
-                $class = 'cachestore_'.$plugin.'_addinstance_form';
+                $class = 'cachestore_' . $plugin . '_addinstance_form';
-                if (!array_key_exists('cachestore_addinstance_form', class_parents($class))) {
+                if (!array_key_exists(cachestore_addinstance_form::class, class_parents($class))) {
-                    throw new \coding_exception('Cache plugin add instance forms must extend cachestore_addinstance_form');
+                    throw new coding_exception('Cache plugin add instance forms must extend cachestore_addinstance_form');
+                }
             }
         }
         $locks = $this->get_possible_locks_for_stores($plugindir, $plugin);
-        $url = new \moodle_url('/cache/admin.php', array('action' => 'editstore', 'plugin' => $plugin, 'store' => $store));
+        $url = new url('/cache/admin.php', ['action' => 'editstore', 'plugin' => $plugin, 'store' => $store]);
-        $editform = new $class($url, array('plugin' => $plugin, 'store' => $store, 'locks' => $locks));
+        $editform = new $class($url, ['plugin' => $plugin, 'store' => $store, 'locks' => $locks]);
         if (isset($stores[$store]['lock'])) {
-            $editform->set_data(array('lock' => $stores[$store]['lock']));
+            $editform->set_data(['lock' => $stores[$store]['lock']]);
+        }
-        }
+        // See if the cachestore is going to want to load data for the form.
-        // See if the cachestore is going to want to load data for the form.
+        // If it has a customised add instance form then it is going to want to.
+        $storeclass = 'cachestore_' . $plugin;
-        // If it has a customised add instance form then it is going to want to.
+        $storedata = $stores[$store];
-        $storeclass = 'cachestore_'.$plugin;
+        if (
-        $storedata = $stores[$store];
+            array_key_exists('configuration', $storedata) &&
-        if (array_key_exists('configuration', $storedata) &&
+            array_key_exists(configurable_cache_interface::class, class_implements($storeclass))
      * @return array|false
      */
     protected function get_possible_locks_for_stores(string $plugindir, string $plugin) {
         global $CFG; // Needed for includes.
         $supportsnativelocking = false;
-        if (file_exists($plugindir.'/lib.php')) {
+        if (file_exists($plugindir . '/lib.php')) {
-            require_once($plugindir.'/lib.php');
+            require_once($plugindir . '/lib.php');
-            $pluginclass = 'cachestore_'.$plugin;
+            $pluginclass = 'cachestore_' . $plugin;
             if (class_exists($pluginclass)) {
-                $supportsnativelocking = array_key_exists('cache_is_lockable', class_implements($pluginclass));
+                $supportsnativelocking = array_key_exists(lockable_cache_interface::class, class_implements($pluginclass));
+            }
+        }
         if (!$supportsnativelocking) {
-            $config = \cache_config::instance();
+            $config = config::instance();
-            $locks = array();
+            $locks = [];
             foreach ($config->get_locks() as $lock => $conf) {
                 if (!empty($conf['default'])) {
                     $name = get_string($lock, 'cache');
                 } else {
+     *
      * @param stdClass $data The mform data.
      * @return array
      * @throws coding_exception
      */
-    public function get_store_configuration_from_data(\stdClass $data): array {
+    public function get_store_configuration_from_data(stdClass $data): array {
         global $CFG;
-        $file = $CFG->dirroot.'/cache/stores/'.$data->plugin.'/lib.php';
+        $file = $CFG->dirroot . '/cache/stores/' . $data->plugin . '/lib.php';
         if (!file_exists($file)) {
-            throw new \coding_exception('Invalid cache plugin provided. '.$file);
+            throw new coding_exception('Invalid cache plugin provided. ' . $file);
+        }
         require_once($file);
-        $class = 'cachestore_'.$data->plugin;
+        $class = 'cachestore_' . $data->plugin;
         if (!class_exists($class)) {
-            throw new \coding_exception('Invalid cache plugin provided.');
+            throw new coding_exception('Invalid cache plugin provided.');
+        }
-        if (array_key_exists('cache_is_configurable', class_implements($class))) {
+        if (array_key_exists(configurable_cache_interface::class, class_implements($class))) {
             return $class::config_get_configuration_array($data);
+        }
-        return array();
+        return [];
+    }
     /**
      * Returns an array of lock plugins for which we can add an instance.
+     *
      * Suitable for use within an mform select element.
+     *
      * @return array
      */
     public function get_addable_lock_options(): array {
-        $plugins = \core_component::get_plugin_list_with_class('cachelock', '', 'lib.php');
+        $plugins = core_component::get_plugin_list_with_class('cachelock', '', 'lib.php');
-        $options = array();
+        $options = [];
         $len = strlen('cachelock_');
         foreach ($plugins as $plugin => $class) {
             $method = "$class::can_add_instance";
             if (is_callable($method) && !call_user_func($method)) {
     /**
      * Gets the form to use when adding a lock instance.
+     *
      * @param string $plugin
-     * @param array $lockplugin
+     * @param array|null $lockplugin
      * @return cache_lock_form
      * @throws coding_exception
      */
-    public function get_add_lock_form(string $plugin, array $lockplugin = null): \cache_lock_form {
+    public function get_add_lock_form(string $plugin, ?array $lockplugin = null): cache_lock_form {
         global $CFG; // Needed for includes.
-        $plugins = \core_component::get_plugin_list('cachelock');
+        $plugins = core_component::get_plugin_list('cachelock');
         if (!array_key_exists($plugin, $plugins)) {
-            throw new \coding_exception('Invalid cache lock plugin requested when trying to create a form.');
+            throw new coding_exception('Invalid cache lock plugin requested when trying to create a form.');
+        }
         $plugindir = $plugins[$plugin];
+        $class = cache_lock_form::class;
-        $class = 'cache_lock_form';
+        $hasaddinstanceform = file_exists($plugindir . '/addinstanceform.php');
+        $hasaddinstanceform = $hasaddinstanceform && in_array(configurable_cache_interface::class, class_implements($class));
-        if (file_exists($plugindir.'/addinstanceform.php') && in_array('cache_is_configurable', class_implements($class))) {
+        if ($hasaddinstanceform) {
-            require_once($plugindir.'/addinstanceform.php');
+            require_once($plugindir . '/addinstanceform.php');
-            if (class_exists('cachelock_'.$plugin.'_addinstance_form')) {
+            if (class_exists('cachelock_' . $plugin . '_addinstance_form')) {
-                $class = 'cachelock_'.$plugin.'_addinstance_form';
+                $class = 'cachelock_' . $plugin . '_addinstance_form';
-                if (!array_key_exists('cache_lock_form', class_parents($class))) {
+                if (!is_a($class, cache_lock_form::class, true)) {
-                    throw new \coding_exception('Cache lock plugin add instance forms must extend cache_lock_form');
+                    throw new coding_exception('Cache lock plugin add instance forms must extend cache_lock_form');
+                }
+            }
         }
-        return new $class(null, array('lock' => $plugin));
+        return new $class(null, ['lock' => $plugin]);
+    }
     /**
      * Gets configuration data from a new lock instance form.
+     *
      * @param string $plugin
      * @param stdClass $data
      * @return array
      * @throws coding_exception
      */
-    public function get_lock_configuration_from_data(string $plugin, \stdClass $data): array {
+    public function get_lock_configuration_from_data(string $plugin, stdClass $data): array {
         global $CFG;
-        $file = $CFG->dirroot.'/cache/locks/'.$plugin.'/lib.php';
+        $file = $CFG->dirroot . '/cache/locks/' . $plugin . '/lib.php';
         if (!file_exists($file)) {
-            throw new \coding_exception('Invalid cache plugin provided. '.$file);
+            throw new coding_exception('Invalid cache plugin provided. ' . $file);
         }
         require_once($file);
-        $class = 'cachelock_'.$plugin;
+        $class = 'cachelock_' . $plugin;
         if (!class_exists($class)) {
-            throw new \coding_exception('Invalid cache plugin provided.');
+            throw new coding_exception('Invalid cache plugin provided.');
+        }
-        if (array_key_exists('cache_is_configurable', class_implements($class))) {
+        if (array_key_exists(configurable_cache_interface::class, class_implements($class))) {
             return $class::config_get_configuration_array($data);
+        }
-        return array();
+        return [];
+    }
      * @param array $forminfo an empty array to be overridden and set.
      * @return array the empty or overridden forminfo array.
      */
     public function perform_cache_actions(string $action, array $forminfo): array {
         switch ($action) {
-            case 'rescandefinitions' : // Rescan definitions.
+            case 'rescandefinitions': // Rescan definitions.
                 $this->action_rescan_definition();
                 break;
-            case 'addstore' : // Add the requested store.
+            case 'addstore': // Add the requested store.
                 $forminfo = $this->action_addstore();
                 break;
-            case 'editstore' : // Edit the requested store.
+            case 'editstore': // Edit the requested store.
                 $forminfo = $this->action_editstore();
                 break;
-            case 'deletestore' : // Delete a given store.
+            case 'deletestore': // Delete a given store.
                 $this->action_deletestore($action);
                 break;
-            case 'editdefinitionmapping' : // Edit definition mappings.
+            case 'editdefinitionmapping': // Edit definition mappings.
                 $forminfo = $this->action_editdefinitionmapping();
                 break;
      */
     public function action_rescan_definition() {
         global $PAGE;
         require_sesskey();
-        \cache_config_writer::update_definitions();
+        config_writer::update_definitions();
         redirect($PAGE->url);
+    }
         global $PAGE;
         $storepluginsummaries = $this->get_store_plugin_summaries();
         $plugin = required_param('plugin', PARAM_PLUGIN);
         if (!$storepluginsummaries[$plugin]['canaddinstance']) {
-            throw new \moodle_exception('ex_unmetstorerequirements', 'cache');
+            throw new moodle_exception('ex_unmetstorerequirements', 'cache');
+        }
         $mform = $this->get_add_store_form($plugin);
         $title = get_string('addstore', 'cache', $storepluginsummaries[$plugin]['name']);
         if ($mform->is_cancelled()) {
             redirect($PAGE->url);
         } else if ($data = $mform->get_data()) {
             $config = $this->get_store_configuration_from_data($data);
-            $writer = \cache_config_writer::instance();
+            $writer = config_writer::instance();
             unset($config['lock']);
             foreach ($writer->get_locks() as $lock => $lockconfig) {
                 if ($lock == $data->lock) {
                     $config['lock'] = $data->lock;
             $writer->add_store_instance($data->name, $data->plugin, $config);
             redirect($PAGE->url, get_string('addstoresuccess', 'cache', $storepluginsummaries[$plugin]['name']), 5);
+        }
         $PAGE->navbar->add(get_string('addstore', 'cache', 'cache'), $PAGE->url);
-        return array('form' => $mform, 'title' => $title);
+        return ['form' => $mform, 'title' => $title];
+    }
     /**
         $title = get_string('addstore', 'cache', $storepluginsummaries[$plugin]['name']);
         if ($mform->is_cancelled()) {
             redirect($PAGE->url);
         } else if ($data = $mform->get_data()) {
             $config = $this->get_store_configuration_from_data($data);
-            $writer = \cache_config_writer::instance();
+            $writer = config_writer::instance();
             unset($config['lock']);
             foreach ($writer->get_locks() as $lock => $lockconfig) {
                 if ($lock == $data->lock) {
+            }
             $writer->edit_store_instance($data->name, $data->plugin, $config);
             redirect($PAGE->url, get_string('editstoresuccess', 'cache', $storepluginsummaries[$plugin]['name']), 5);
+        }
-        return array('form' => $mform, 'title' => $title);
+        return ['form' => $mform, 'title' => $title];
+    }
     /**
+        }
         if ($notifysuccess) {
             if (!$confirm) {
                 $title = get_string('confirmstoredeletion', 'cache');
-                $params = array('store' => $store, 'confirm' => 1, 'action' => $action, 'sesskey' => sesskey());
+                $params = ['store' => $store, 'confirm' => 1, 'action' => $action, 'sesskey' => sesskey()];
-                $url = new \moodle_url($PAGE->url, $params);
+                $url = new url($PAGE->url, $params);
-                $button = new \single_button($url, get_string('deletestore', 'cache'));
+                $button = new single_button($url, get_string('deletestore', 'cache'));
                 $PAGE->set_title($title);
                 $PAGE->set_heading($SITE->fullname);
                 echo $OUTPUT->confirm($confirmation, $button, $PAGE->url);
                 echo $OUTPUT->footer();
                 exit;
             } else {
                 require_sesskey();
-                $writer = \cache_config_writer::instance();
+                $writer = config_writer::instance();
                 $writer->delete_store_instance($store);
                 redirect($PAGE->url, get_string('deletestoresuccess', 'cache'), 5);
+            }
         } else {
             redirect($PAGE->url, $notification, null, notification::NOTIFY_ERROR);
         global $PAGE;
         $definitionsummaries = $this->get_definition_summaries();
         $definition = required_param('definition', PARAM_SAFEPATH);
         if (!array_key_exists($definition, $definitionsummaries)) {
-            throw new \cache_exception('Invalid cache definition requested');
+            throw new cache_exception('Invalid cache definition requested');
+        }
         $title = get_string('editdefinitionmappings', 'cache', $definition);
-        $mform = new \cache_definition_mappings_form($PAGE->url, array('definition' => $definition));
+        $mform = new cache_definition_mappings_form($PAGE->url, ['definition' => $definition]);
         if ($mform->is_cancelled()) {
             redirect($PAGE->url);
         } else if ($data = $mform->get_data()) {
-            $writer = \cache_config_writer::instance();
+            $writer = config_writer::instance();
-            $mappings = array();
+            $mappings = [];
             foreach ($data->mappings as $mapping) {
                 if (!empty($mapping)) {
                     $mappings[] = $mapping;
+                }
+            }
             $writer->set_definition_mappings($definition, $mappings);
             redirect($PAGE->url);
+        }
         $PAGE->navbar->add(get_string('updatedefinitionmapping', 'cache'), $PAGE->url);
-        return array('form' => $mform, 'title' => $title);
+        return ['form' => $mform, 'title' => $title];
+    }
         global $PAGE;
         $definitionsummaries = $this->get_definition_summaries();
         $definition = required_param('definition', PARAM_SAFEPATH);
         if (!array_key_exists($definition, $definitionsummaries)) {
-            throw new \cache_exception('Invalid cache definition requested');
+            throw new cache_exception('Invalid cache definition requested');
+        }
         $title = get_string('editdefinitionsharing', 'cache', $definition);
         $sharingoptions = $definitionsummaries[$definition]['sharingoptions'];
-        $customdata = array('definition' => $definition, 'sharingoptions' => $sharingoptions);
+        $customdata = ['definition' => $definition, 'sharingoptions' => $sharingoptions];
-        $mform = new \cache_definition_sharing_form($PAGE->url, $customdata);
+        $mform = new cache_definition_sharing_form($PAGE->url, $customdata);
-        $mform->set_data(array(
+        $mform->set_data([
             'sharing' => $definitionsummaries[$definition]['selectedsharingoption'],
-            'userinputsharingkey' => $definitionsummaries[$definition]['userinputsharingkey']
+            'userinputsharingkey' => $definitionsummaries[$definition]['userinputsharingkey'],
-        ));
+        ]);
         if ($mform->is_cancelled()) {
             redirect($PAGE->url);
         } else if ($data = $mform->get_data()) {
             $component = $definitionsummaries[$definition]['component'];
             $area = $definitionsummaries[$definition]['area'];
             // Purge the stores removing stale data before we alter the sharing option.
-            \cache_helper::purge_stores_used_by_definition($component, $area);
+            cache_helper::purge_stores_used_by_definition($component, $area);
-            $writer = \cache_config_writer::instance();
+            $writer = config_writer::instance();
             $sharing = array_sum(array_keys($data->sharing));
             $userinputsharingkey = $data->userinputsharingkey;
             $writer->set_definition_sharing($definition, $sharing, $userinputsharingkey);
             redirect($PAGE->url);
+        }
         $PAGE->navbar->add(get_string('updatedefinitionsharing', 'cache'), $PAGE->url);
-        return array('form' => $mform, 'title' => $title);
+        return ['form' => $mform, 'title' => $title];
+    }
     public function action_editmodemappings(): array {
         global $PAGE;
         $storeinstancesummaries = $this->get_store_instance_summaries();
         $defaultmodestores = $this->get_default_mode_stores();
-        $mform = new \cache_mode_mappings_form(null, $storeinstancesummaries);
+        $mform = new cache_mode_mappings_form(null, $storeinstancesummaries);
-        $mform->set_data(array(
+        $mform->set_data([
-            'mode_'.cache_store::MODE_APPLICATION => key($defaultmodestores[cache_store::MODE_APPLICATION]),
+            'mode_' . store::MODE_APPLICATION => key($defaultmodestores[store::MODE_APPLICATION]),
-            'mode_'.cache_store::MODE_SESSION => key($defaultmodestores[cache_store::MODE_SESSION]),
+            'mode_' . store::MODE_SESSION => key($defaultmodestores[store::MODE_SESSION]),
-            'mode_'.cache_store::MODE_REQUEST => key($defaultmodestores[cache_store::MODE_REQUEST]),
+            'mode_' . store::MODE_REQUEST => key($defaultmodestores[store::MODE_REQUEST]),
-        ));
+        ]);
         if ($mform->is_cancelled()) {
             redirect($PAGE->url);
         } else if ($data = $mform->get_data()) {
-            $mappings = array(
+            $mappings = [
-                cache_store::MODE_APPLICATION => array($data->{'mode_'.cache_store::MODE_APPLICATION}),
+                store::MODE_APPLICATION => [$data->{'mode_' . store::MODE_APPLICATION}],
-                cache_store::MODE_SESSION => array($data->{'mode_'.cache_store::MODE_SESSION}),
+                store::MODE_SESSION => [$data->{'mode_' . store::MODE_SESSION}],
-                cache_store::MODE_REQUEST => array($data->{'mode_'.cache_store::MODE_REQUEST}),
+                store::MODE_REQUEST => [$data->{'mode_' . store::MODE_REQUEST}],
-            );
+            ];
-            $writer = cache_config_writer::instance();
+            $writer = config_writer::instance();
             $writer->set_mode_mappings($mappings);
             redirect($PAGE->url);
         }
-        return array('form' => $mform);
+        return ['form' => $mform];
+    }
     public function action_purgedefinition() {
         global $PAGE;
         require_sesskey();
         $id = required_param('definition', PARAM_SAFEPATH);
-        list($component, $area) = explode('/', $id, 2);
+        [$component, $area] = explode('/', $id, 2);
-        $factory = cache_factory::instance();
+        $factory = factory::instance();
         $definition = $factory->create_definition($component, $area);
         if ($definition->has_required_identifiers()) {
             // We will have to purge the stores used by this definition.
             cache_helper::purge_stores_used_by_definition($component, $area);
         $message = get_string('purgexdefinitionsuccess', 'cache', [
                     'name' => $definition->get_name(),
                     'component' => $component,
                     'area' => $area,
                 ]);
-        $purgeagainlink = \html_writer::link(new \moodle_url('/cache/admin.php', [
+        $purgeagainlink = html_writer::link(
+            new url('/cache/admin.php', [
-                'action' => 'purgedefinition', 'sesskey' => sesskey(), 'definition' => $id]),
+                'action' => 'purgedefinition', 'sesskey' => sesskey(), 'definition' => $id, ]),
-                get_string('purgeagain', 'cache'));
+            get_string('purgeagain', 'cache')
+        );
         redirect($PAGE->url, $message . ' ' . $purgeagainlink, 5);
+    }
     /**
         require_sesskey();
         $store = required_param('store', PARAM_TEXT);
         cache_helper::purge_store($store);
         $message = get_string('purgexstoresuccess', 'cache', ['store' => $store]);
+        $purgeagainlink = html_writer::link(
-        $purgeagainlink = \html_writer::link(new \moodle_url('/cache/admin.php', [
+            new url('/cache/admin.php', [
-                'action' => 'purgestore', 'sesskey' => sesskey(), 'store' => $store]),
+                'action' => 'purgestore', 'sesskey' => sesskey(), 'store' => $store, ]),
+            get_string('purgeagain', 'cache')
-                get_string('purgeagain', 'cache'));
+        );
         redirect($PAGE->url, $message . ' ' . $purgeagainlink, 5);
+    }
         $lock = required_param('lock', PARAM_ALPHANUMEXT);
         $mform = $this->get_add_lock_form($lock);
         if ($mform->is_cancelled()) {
             redirect($PAGE->url);
         } else if ($data = $mform->get_data()) {
-            $factory = cache_factory::instance();
+            $factory = factory::instance();
             $config = $factory->create_config_instance(true);
             $name = $data->name;
             $data = $this->get_lock_configuration_from_data($lock, $data);
             $config->add_lock_instance($name, $lock, $data);
             redirect($PAGE->url, get_string('addlocksuccess', 'cache', $name), 5);
+        }
-        return array('form' => $mform);
+        return ['form' => $mform];
+    }
     /**
             $notification = get_string('deletelockhasuses', 'cache');
+        }
         if ($notifysuccess) {
             if (!$confirm) {
                 $title = get_string('confirmlockdeletion', 'cache');
-                $params = array('lock' => $lock, 'confirm' => 1, 'action' => $action, 'sesskey' => sesskey());
+                $params = ['lock' => $lock, 'confirm' => 1, 'action' => $action, 'sesskey' => sesskey()];
-                $url = new \moodle_url($PAGE->url, $params);
+                $url = new url($PAGE->url, $params);
-                $button = new \single_button($url, get_string('deletelock', 'cache'));
+                $button = new single_button($url, get_string('deletelock', 'cache'));
                 $PAGE->set_title($title);
                 $PAGE->set_heading($SITE->fullname);
                 echo $OUTPUT->header();
                 echo $OUTPUT->confirm($confirmation, $button, $PAGE->url);
                 echo $OUTPUT->footer();
                 exit;
             } else {
                 require_sesskey();
-                $writer = cache_config_writer::instance();
+                $writer = config_writer::instance();
                 $writer->delete_lock_instance($lock);
                 redirect($PAGE->url, get_string('deletelocksuccess', 'cache'), 5);
+            }
         } else {
             redirect($PAGE->url, $notification, null, notification::NOTIFY_ERROR);
+     *
      * @param \core_cache\output\renderer $renderer the renderer to use to generate the page.
      * @return string the HTML for the admin page.
      */
     public function generate_admin_page(\core_cache\output\renderer $renderer): string {
-        $context = \context_system::instance();
+        $context = context_system::instance();
         $html = '';
         $storepluginsummaries = $this->get_store_plugin_summaries();
         $storeinstancesummaries = $this->get_store_instance_summaries();
         $html .= $renderer->store_instance_summariers($storeinstancesummaries, $storepluginsummaries);
         $html .= $renderer->definition_summaries($definitionsummaries, $context);
         $html .= $renderer->lock_summaries($locks);
         $html .= $renderer->additional_lock_actions();
-        $applicationstore = join(', ', $defaultmodestores[cache_store::MODE_APPLICATION]);
+        $applicationstore = join(', ', $defaultmodestores[store::MODE_APPLICATION]);
-        $sessionstore = join(', ', $defaultmodestores[cache_store::MODE_SESSION]);
+        $sessionstore = join(', ', $defaultmodestores[store::MODE_SESSION]);
-        $requeststore = join(', ', $defaultmodestores[cache_store::MODE_REQUEST]);
+        $requeststore = join(', ', $defaultmodestores[store::MODE_REQUEST]);
-        $editurl = new \moodle_url('/cache/admin.php', array('action' => 'editmodemappings'));
+        $editurl = new url('/cache/admin.php', ['action' => 'editmodemappings']);
         $html .= $renderer->mode_mappings($applicationstore, $sessionstore, $requeststore, $editurl);
      * @return array Details of cache usage
      */
     public function get_usage(int $samplekeys): array {
         $results = [];
-        $factory = cache_factory::instance();
+        $factory = factory::instance();
         // Check the caches we already have an instance of, so we don't make another one...
         $got = $factory->get_caches_in_use();
         foreach ($config->get_definitions() as $configdetails) {
             if (!array_key_exists($configdetails['component'] . '/' .  $configdetails['area'], $gotid)) {
                 // Where possible (if it doesn't need identifiers), make an instance of the cache, otherwise
                 // we can't get the store instances for it (and it won't show up in the list).
                 if (empty($configdetails['requireidentifiers'])) {
-                    \cache::make($configdetails['component'], $configdetails['area']);
+                    cache::make($configdetails['component'], $configdetails['area']);
+                }
+            }
             $definition = $factory->create_definition($configdetails['component'], $configdetails['area']);
             $stores = $factory->get_store_instances_in_use($definition);
             // Create object for results about this cache definition.
             $currentresult = (object)['cacheid' => $definition->get_id(), 'stores' => []];
             $results[$currentresult->cacheid] = $currentresult;
-            /** @var cache_store $store */
+            /** @var store $store */
             foreach ($stores as $store) {
                 // Skip static cache.
                 if ($store instanceof \cachestore_static) {

Proyectos de Subversion Moodle

(root)/cache/classes/local/administration_display_helper.php – Rev 1 → 1441