Merge pull request #4052 from ahoefling/host_settings_dictionary

Updated IHostSettingsService to use IDictionary instead of Dictionary
dnnsoftware · Sep 5, 2020 · 9ed0f16 · 9ed0f16
2 parents 4173b94 + ea10342
commit 9ed0f16
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 8 deletions.
diff --git a/DNN Platform/DotNetNuke.Abstractions/Application/IHostSettingsService.cs b/DNN Platform/DotNetNuke.Abstractions/Application/IHostSettingsService.cs
@@ -92,13 +92,13 @@ public interface IHostSettingsService
         /// Gets all host settings.
         /// </summary>
         /// <returns>host setting.</returns>
-        Dictionary<string, IConfigurationSetting> GetSettings();
+        IDictionary<string, IConfigurationSetting> GetSettings();
 
         /// <summary>
         /// Gets all host settings as dictionary.
         /// </summary>
         /// <returns>host setting's value.</returns>
-        Dictionary<string, string> GetSettingsDictionary();
+        IDictionary<string, string> GetSettingsDictionary();
 
         /// <summary>
         /// Gets the setting value by the specific key.
@@ -140,7 +140,7 @@ public interface IHostSettingsService
         /// Updates the specified settings.
         /// </summary>
         /// <param name="settings">The settings.</param>
-        void Update(Dictionary<string, string> settings);
+        void Update(IDictionary<string, string> settings);
 
         /// <summary>
         /// Updates the setting for a specified key.

diff --git a/DNN Platform/Library/Entities/Controllers/HostController.cs b/DNN Platform/Library/Entities/Controllers/HostController.cs
@@ -116,7 +116,7 @@ public int GetInteger(string key, int defaultValue)
         }
 
         /// <inheritdoc/>
-        Dictionary<string, IConfigurationSetting> IHostSettingsService.GetSettings()
+        IDictionary<string, IConfigurationSetting> IHostSettingsService.GetSettings()
         {
             return CBO.GetCachedObject<Dictionary<string, IConfigurationSetting>>(
                                             new CacheItemArgs(
@@ -128,9 +128,10 @@ Dictionary<string, IConfigurationSetting> IHostSettingsService.GetSettings()
         }
 
         /// <inheritdoc/>
-        public Dictionary<string, string> GetSettingsDictionary()
+        IDictionary<string, string> IHostSettingsService.GetSettingsDictionary()
         {
-            return this.GetSettings().ToDictionary(c => c.Key, c => c.Value.Value);
+            return ((IHostSettingsService)this).GetSettings()
+                .ToDictionary(c => c.Key, c => c.Value.Value);
         }
 
         /// <inheritdoc/>
@@ -162,7 +163,7 @@ public string GetString(string key, string defaultValue)
         }
 
         /// <inheritdoc/>
-        public void Update(Dictionary<string, string> settings)
+        void IHostSettingsService.Update(IDictionary<string, string> settings)
         {
             foreach (KeyValuePair<string, string> settingKvp in settings)
             {

diff --git a/DNN Platform/Library/Obsolete/HostController.cs b/DNN Platform/Library/Obsolete/HostController.cs
@@ -32,14 +32,18 @@ public partial class HostController : ComponentBase<IHostController, HostControl
             }
         }
 
-        /// <inheritdoc/>
         [Obsolete("Deprecated in 9.7.1. Scheduled for removal in v11.0.0, use DotNetNuke.Abstractions.IHostSettingsService instead.")]
         public Dictionary<string, ConfigurationSetting> GetSettings() =>
             ((IHostSettingsService)this).GetSettings()
                 .Where(setting => setting.Value is ConfigurationSetting)
                 .Select(setting => new KeyValuePair<string, ConfigurationSetting>(setting.Key, (ConfigurationSetting)setting.Value))
                 .ToDictionary(setting => setting.Key, setting => setting.Value);
 
+        [Obsolete("Deprecated in 9.7.1. Scheduled for removal in v11.0.0, use DotNetNuke.Abstractions.IHostSettingsService instead.")]
+        public Dictionary<string, string> GetSettingsDictionary() =>
+            ((IHostSettingsService)this).GetSettingsDictionary()
+                .ToDictionary(setting => setting.Key, setting => setting.Value);
+
         /// <inheritdoc/>
         [Obsolete("Deprecated in 9.7.1. Scheduled for removal in v11.0.0, use DotNetNuke.Abstractions.IHostSettingsService instead.")]
         public void Update(ConfigurationSetting config) =>
@@ -49,5 +53,9 @@ public void Update(ConfigurationSetting config) =>
         [Obsolete("Deprecated in 9.7.1. Scheduled for removal in v11.0.0, use DotNetNuke.Abstractions.IHostSettingsService instead.")]
         public void Update(ConfigurationSetting config, bool clearCache) =>
             ((IHostSettingsService)this).Update(config, clearCache);
+
+        [Obsolete("Deprecated in 9.7.1. Scheduled for removal in v11.0.0, use DotNetNuke.Abstractions.IHostSettingsService instead.")]
+        public void Update(Dictionary<string, string> settings) =>
+            ((IHostSettingsService)this).Update(settings);
     }
 }