MDL-37535 block_section_links: now uses component for settings.

blocks/section_links/block_section_links.php

@@ -55,8 +55,7 @@ function get_content() {
         if(isset($this->config)){
             $config = $this->config;
         } else{
-            // TODO: Move these config settings to proper ones using component name
-            $config = get_config('blocks/section_links');
+            $config = get_config('block_section_links');
         }
 
         if ($this->content !== NULL) {
@@ -146,13 +145,6 @@ function get_content() {
     function instance_allow_config() {
         return true;
     }
-    function before_delete() {
-        global $DB;
-        // TODO: Move these config settings to proper ones using component name
-        $DB->delete_records('config_plugins', array('plugin' => 'blocks/section_links'));
-        // Have to manually purge the cache as well
-        cache_helper::invalidate_by_definition('core', 'config', array(), 'blocks/section_links');
-    }
 
     function has_config() {
         return true;

blocks/section_links/config_instance.html

@@ -37,7 +37,7 @@
 if(isset($this->config)){
     $config = $this->config;
 } else{
-    $config = get_config('blocks/section_links');
+    $config = get_config('block_section_links');
 }
 
 $selected = array();

blocks/section_links/db/upgrade.php

@@ -0,0 +1,80 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * This file keeps track of upgrades to the section links block
+ *
+ * Sometimes, changes between versions involve alterations to database structures
+ * and other major things that may break installations.
+ *
+ * The upgrade function in this file will attempt to perform all the necessary
+ * actions to upgrade your older installation to the current version.
+ *
+ * If there's something it cannot do itself, it will tell you what you need to do.
+ *
+ * The commands in here will all be database-neutral, using the methods of
+ * database_manager class
+ *
+ * Please do not forget to use upgrade_set_timeout()
+ * before any action that may take longer time to finish.
+ *
+ * @since 2.5
+ * @package block_section_links
+ * @copyright 2013 Sam Hemelryk
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+/**
+ * Upgrade code for the section links block.
+ *
+ * @global moodle_database $DB
+ * @param int $oldversion
+ * @param object $block
+ */
+function xmldb_block_section_links_upgrade($oldversion, $block) {
+    global $DB;
+
+    // Moodle v2.3.0 release upgrade line
+    // Put any upgrade step following this
+
+    // Moodle v2.4.0 release upgrade line
+    // Put any upgrade step following this
+
+    // Moodle v2.5.0 release upgrade line
+    // Put any upgrade step following this
+
+    if ($oldversion < 2013012200.00) {
+
+        $oldplugin = 'blocks/section_links';
+        $newplugin = 'block_section_links';
+
+        // Use the proper API here... thats what we should be doing as it ensures any caches etc are cleared
+        // along the way!
+        // It may be quicker to just write an SQL statement but that would be reckless.
+        $config = get_config($oldplugin);
+        if (!empty($config)) {
+            foreach ($config as $name => $value) {
+                set_config($name, $value, $newplugin);
+                unset_config($name, $oldplugin);
+            }
+        }
+
+        // Main savepoint reached.
+        upgrade_block_savepoint(true, 2013012200.00, 'block_section_links');
+    }
+
+    return true;
+}

blocks/section_links/settings.php

@@ -25,8 +25,6 @@
 defined('MOODLE_INTERNAL') || die;
 
 if ($ADMIN->fulltree) {
-    $configs = array();
-
     $numberofsections = array();
 
     for ($i = 1; $i < 53; $i++){
@@ -42,17 +40,12 @@
                       2 => array(40,5));
 
     for($i = 1; $i < 3; $i++){
-        $configs[] = new admin_setting_configselect('numsections'.$i, get_string('numsections'.$i, 'block_section_links'),
+        $settings->add(new admin_setting_configselect('block_section_links/numsections'.$i, get_string('numsections'.$i, 'block_section_links'),
                             get_string('numsectionsdesc'.$i, 'block_section_links'),
-                            $selected[$i][0], $numberofsections);
+                            $selected[$i][0], $numberofsections));
 
-        $configs[] = new admin_setting_configselect('incby'.$i, get_string('incby'.$i, 'block_section_links'),
+        $settings->add(new admin_setting_configselect('block_section_links/incby'.$i, get_string('incby'.$i, 'block_section_links'),
                             get_string('incbydesc'.$i, 'block_section_links'),
-                            $selected[$i][1], $increments);
-    }
-
-    foreach ($configs as $config) {
-        $config->plugin = 'blocks/section_links';
-        $settings->add($config);
+                            $selected[$i][1], $increments));
     }
 }

blocks/section_links/version.php

@@ -25,6 +25,6 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$plugin->version   = 2012112900;        // The current plugin version (Date: YYYYMMDDXX)
+$plugin->version   = 2013012200;        // The current plugin version (Date: YYYYMMDDXX)
 $plugin->requires  = 2012112900;        // Requires this Moodle version
 $plugin->component = 'block_section_links'; // Full name of the plugin (used for diagnostics)