Skip to content

Commit c70a8ba

Browse files
committed
Update deprecations for 9.13.1
Deprecate SkinPackageInfo.Skins, rename list to SkinPackageInfo.SkinsList
1 parent b9eb1ac commit c70a8ba

File tree

3 files changed

+76
-53
lines changed

3 files changed

+76
-53
lines changed

DNN Platform/Library/UI/Skins/SkinController.cs

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public partial class SkinController : ISkinService
3939
private static readonly Regex LdirRegex = new Regex("\\[l]", RegexOptions.IgnoreCase | RegexOptions.Compiled);
4040

4141
/// <inheritdoc cref="ISkinService.RootSkin" />
42-
[Obsolete($"Deprecated in DotNetNuke 10.0.0. Use {nameof(SkinType)}.{nameof(ISkinService.GetFolderName)} instead. Scheduled removal in v12.0.0.")]
42+
[Obsolete($"Deprecated in DotNetNuke 9.13.1. Use {nameof(SkinType)}.{nameof(ISkinService.GetFolderName)} instead. Scheduled removal in v12.0.0.")]
4343
public static string RootSkin
4444
{
4545
get
@@ -49,7 +49,7 @@ public static string RootSkin
4949
}
5050

5151
/// <inheritdoc cref="ISkinService.RootContainer" />
52-
[Obsolete($"Deprecated in DotNetNuke 10.0.0. Use {nameof(SkinType)}.{nameof(ISkinService.GetFolderName)} instead. Scheduled removal in v12.0.0.")]
52+
[Obsolete($"Deprecated in DotNetNuke 9.13.1. Use {nameof(SkinType)}.{nameof(ISkinService.GetFolderName)} instead. Scheduled removal in v12.0.0.")]
5353
public static string RootContainer
5454
{
5555
get
@@ -59,21 +59,21 @@ public static string RootContainer
5959
}
6060

6161
/// <inheritdoc cref="ISkinService.AddSkin" />
62-
[DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.AddSkin)} instead.")]
62+
[DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.AddSkin)} instead.")]
6363
public static partial int AddSkin(int skinPackageID, string skinSrc)
6464
{
6565
return DataProvider.Instance().AddSkin(skinPackageID, skinSrc);
6666
}
6767

6868
/// <inheritdoc cref="ISkinService.AddSkinPackage" />
69-
[DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.AddSkinPackage)} instead.")]
69+
[DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.AddSkinPackage)} instead.")]
7070
public static partial int AddSkinPackage(SkinPackageInfo skinPackage)
7171
{
7272
return AddSkinPackage((ISkinPackageInfo)skinPackage);
7373
}
7474

7575
/// <inheritdoc cref="ISkinService.CanDeleteSkinFolder" />
76-
[DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.CanDeleteSkinFolder)} instead.")]
76+
[DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.CanDeleteSkinFolder)} instead.")]
7777
public static partial bool CanDeleteSkin(string folderPath, string portalHomeDirMapPath)
7878
{
7979
string skinType;
@@ -126,14 +126,14 @@ public static partial bool CanDeleteSkin(string folderPath, string portalHomeDir
126126
}
127127

128128
/// <inheritdoc cref="ISkinService.DeleteSkin" />
129-
[DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.DeleteSkin)} instead.")]
129+
[DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.DeleteSkin)} instead.")]
130130
public static partial void DeleteSkin(int skinID)
131131
{
132132
DataProvider.Instance().DeleteSkin(skinID);
133133
}
134134

135135
/// <inheritdoc cref="ISkinService.DeleteSkinPackage" />
136-
[DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.DeleteSkinPackage)} instead.")]
136+
[DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.DeleteSkinPackage)} instead.")]
137137
public static partial void DeleteSkinPackage(SkinPackageInfo skinPackage)
138138
{
139139
DeleteSkinPackage((ISkinPackageInfo)skinPackage);
@@ -167,7 +167,7 @@ public static string FormatMessage(string title, string body, int level, bool is
167167
}
168168

169169
/// <inheritdoc cref="ISkinService.FormatSkinPath" />
170-
[DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.FormatSkinPath)} instead.")]
170+
[DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.FormatSkinPath)} instead.")]
171171
public static partial string FormatSkinPath(string skinSrc)
172172
{
173173
string strSkinSrc = skinSrc;
@@ -180,7 +180,7 @@ public static partial string FormatSkinPath(string skinSrc)
180180
}
181181

182182
/// <inheritdoc cref="ISkinService.FormatSkinSrc" />
183-
[DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.FormatSkinSrc)} instead.")]
183+
[DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.FormatSkinSrc)} instead.")]
184184
public static partial string FormatSkinSrc(string skinSrc, PortalSettings portalSettings)
185185
{
186186
return FormatSkinSrc(skinSrc, (IPortalSettings)portalSettings);
@@ -192,7 +192,7 @@ public static partial string FormatSkinSrc(string skinSrc, PortalSettings portal
192192
/// To get the default admin container for the portal use <see cref="IPortalSettings.DefaultAdminContainer"/> instead.
193193
/// </remarks>
194194
/// <returns>The global default admin container.</returns>
195-
[DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetDefaultSkinSrc)} instead.")]
195+
[DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetDefaultSkinSrc)} instead.")]
196196
public static partial string GetDefaultAdminContainer()
197197
{
198198
SkinDefaults defaultContainer = SkinDefaults.GetSkinDefaults(SkinDefaultType.ContainerInfo);
@@ -205,7 +205,7 @@ public static partial string GetDefaultAdminContainer()
205205
/// To get the default admin skin for the portal use <see cref="IPortalSettings.DefaultAdminSkin"/> instead.
206206
/// </remarks>
207207
/// <returns>The global default admin skin.</returns>
208-
[DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetDefaultSkinSrc)} instead.")]
208+
[DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetDefaultSkinSrc)} instead.")]
209209
public static partial string GetDefaultAdminSkin()
210210
{
211211
SkinDefaults defaultSkin = SkinDefaults.GetSkinDefaults(SkinDefaultType.SkinInfo);
@@ -218,7 +218,7 @@ public static partial string GetDefaultAdminSkin()
218218
/// To get the default skin for the portal use <see cref="IPortalSettings.DefaultPortalSkin"/> instead.
219219
/// </remarks>
220220
/// <returns>The global default skin.</returns>
221-
[DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetDefaultSkinSrc)} instead.")]
221+
[DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetDefaultSkinSrc)} instead.")]
222222
public static partial string GetDefaultPortalContainer()
223223
{
224224
SkinDefaults defaultContainer = SkinDefaults.GetSkinDefaults(SkinDefaultType.ContainerInfo);
@@ -231,36 +231,36 @@ public static partial string GetDefaultPortalContainer()
231231
/// To get the default skin for the portal use <see cref="IPortalSettings.DefaultPortalSkin"/> instead.
232232
/// </remarks>
233233
/// <returns>The global default skin.</returns>
234-
[DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetDefaultSkinSrc)} instead.")]
234+
[DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetDefaultSkinSrc)} instead.")]
235235
public static partial string GetDefaultPortalSkin()
236236
{
237237
SkinDefaults defaultSkin = SkinDefaults.GetSkinDefaults(SkinDefaultType.SkinInfo);
238238
return "[G]" + RootSkin + defaultSkin.Folder + defaultSkin.DefaultName;
239239
}
240240

241241
/// <inheritdoc cref="ISkinService.GetSkinByPackageID" />
242-
[DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetSkinPackageById)} instead.")]
242+
[DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetSkinPackageById)} instead.")]
243243
public static partial SkinPackageInfo GetSkinByPackageID(int packageID)
244244
{
245245
return CBO.FillObject<SkinPackageInfo>(DataProvider.Instance().GetSkinByPackageID(packageID));
246246
}
247247

248248
/// <inheritdoc cref="ISkinService.GetSkinPackage" />]
249-
[DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetSkinPackage)} instead.")]
249+
[DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetSkinPackage)} instead.")]
250250
public static partial SkinPackageInfo GetSkinPackage(int portalId, string skinName, string skinType)
251251
{
252252
return CBO.FillObject<SkinPackageInfo>(DataProvider.Instance().GetSkinPackage(portalId, skinName, skinType));
253253
}
254254

255255
/// <inheritdoc cref="ISkinService.GetSkinsInFolder" />
256-
[DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetSkinsInFolder)} instead.")]
256+
[DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetSkinsInFolder)} instead.")]
257257
public static partial List<KeyValuePair<string, string>> GetSkins(PortalInfo portalInfo, string skinRoot, SkinScope scope)
258258
{
259259
return GetSkins((IPortalInfo)portalInfo, skinRoot, scope);
260260
}
261261

262262
/// <inheritdoc cref="ISkinService.GetSkinsInFolder" />
263-
[DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetSkinsInFolder)} instead.")]
263+
[DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetSkinsInFolder)} instead.")]
264264
public static partial List<KeyValuePair<string, string>> GetSkins(IPortalInfo portalInfo, string skinRoot, SkinScope scope)
265265
{
266266
var skins = new List<KeyValuePair<string, string>>();
@@ -282,14 +282,14 @@ public static partial List<KeyValuePair<string, string>> GetSkins(IPortalInfo po
282282
}
283283

284284
/// <inheritdoc cref="ISkinService.IsGlobalSkin" />
285-
[DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.IsGlobalSkin)} instead.")]
285+
[DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.IsGlobalSkin)} instead.")]
286286
public static partial bool IsGlobalSkin(string skinSrc)
287287
{
288288
return skinSrc.Contains(Globals.HostPath);
289289
}
290290

291291
/// <inheritdoc cref="ISkinService.SetSkin" />
292-
[DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.SetSkin)} instead.")]
292+
[DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.SetSkin)} instead.")]
293293
public static partial void SetSkin(string skinRoot, int portalId, SkinType skinType, string skinSrc)
294294
{
295295
var selectedCultureCode = LocaleController.Instance.GetCurrentLocale(portalId).Code;
@@ -351,14 +351,14 @@ public static partial void SetSkin(string skinRoot, int portalId, SkinType skinT
351351
}
352352

353353
/// <inheritdoc cref="ISkinService.UpdateSkin" />
354-
[DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.UpdateSkin)} instead.")]
354+
[DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.UpdateSkin)} instead.")]
355355
public static partial void UpdateSkin(int skinID, string skinSrc)
356356
{
357357
DataProvider.Instance().UpdateSkin(skinID, skinSrc);
358358
}
359359

360360
/// <inheritdoc cref="ISkinService.UpdateSkinPackage" />
361-
[DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.UpdateSkin)} instead.")]
361+
[DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.UpdateSkin)} instead.")]
362362
public static partial void UpdateSkinPackage(SkinPackageInfo skinPackage)
363363
{
364364
UpdateSkinPackage((ISkinPackageInfo)skinPackage);

DNN Platform/Library/UI/Skins/SkinInfo.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ namespace DotNetNuke.UI.Skins
66
using System;
77

88
using DotNetNuke.Abstractions.Skins;
9-
using DotNetNuke.Internal.SourceGenerators;
109

1110
/// Project : DotNetNuke
1211
/// Class : SkinInfo

DNN Platform/Library/UI/Skins/SkinPackageInfo.cs

Lines changed: 55 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -24,53 +24,57 @@ namespace DotNetNuke.UI.Skins
2424
[Serializable]
2525
public class SkinPackageInfo : BaseEntityInfo, IHydratable, ISkinPackageInfo
2626
{
27-
private int packageID = Null.NullInteger;
28-
private int portalID = Null.NullInteger;
27+
private int packageId = Null.NullInteger;
28+
private int portalId = Null.NullInteger;
2929
private string skinName;
30-
private int skinPackageID = Null.NullInteger;
30+
private int skinPackageId = Null.NullInteger;
3131
private string skinType;
32-
private List<SkinInfo> skins = new List<SkinInfo>();
32+
private Dictionary<int, string> skins = new Dictionary<int, string>();
33+
private List<SkinInfo> skinsList = new List<SkinInfo>();
3334
private AbstractionList<ISkinInfo, SkinInfo> abstractSkins;
3435

3536
/// <inheritdoc cref="ISkinPackageInfo.PackageId"/>
37+
[Obsolete($"Deprecated in DotNetNuke 9.13.1. Use {nameof(ISkinPackageInfo)}.{nameof(ISkinPackageInfo.PackageId)} instead. Scheduled for removal in v11.0.0.")]
3638
public int PackageID
3739
{
3840
get
3941
{
40-
return this.packageID;
42+
return ((ISkinPackageInfo)this).PackageId;
4143
}
4244

4345
set
4446
{
45-
this.packageID = value;
47+
((ISkinPackageInfo)this).PackageId = value;
4648
}
4749
}
4850

4951
/// <inheritdoc cref="ISkinPackageInfo.SkinPackageId"/>
52+
[Obsolete($"Deprecated in DotNetNuke 9.13.1. Use {nameof(ISkinPackageInfo)}.{nameof(ISkinPackageInfo.SkinPackageId)} instead. Scheduled for removal in v11.0.0.")]
5053
public int SkinPackageID
5154
{
5255
get
5356
{
54-
return this.skinPackageID;
57+
return ((ISkinPackageInfo)this).SkinPackageId;
5558
}
5659

5760
set
5861
{
59-
this.skinPackageID = value;
62+
((ISkinPackageInfo)this).SkinPackageId = value;
6063
}
6164
}
6265

6366
/// <inheritdoc cref="ISkinPackageInfo.PortalId"/>
67+
[Obsolete($"Deprecated in DotNetNuke 9.13.1. Use {nameof(ISkinPackageInfo)}.{nameof(ISkinPackageInfo.PortalId)} instead. Scheduled for removal in v11.0.0.")]
6468
public int PortalID
6569
{
6670
get
6771
{
68-
return this.portalID;
72+
return ((ISkinPackageInfo)this).PortalId;
6973
}
7074

7175
set
7276
{
73-
this.portalID = value;
77+
((ISkinPackageInfo)this).PortalId = value;
7478
}
7579
}
7680

@@ -88,10 +92,11 @@ public string SkinName
8892
}
8993
}
9094

91-
/// <inheritdoc cref="ISkinPackageInfo.Skins"/>
95+
/// <summary>Gets or sets a dictionary mapping from <see cref="SkinInfo.SkinId"/> to <see cref="SkinInfo.SkinSrc"/>.</summary>
9296
[XmlIgnore]
9397
[JsonIgnore]
94-
public List<SkinInfo> Skins
98+
[Obsolete($"Deprecated in DotNetNuke 9.13.1. Use {nameof(ISkinPackageInfo)}.{nameof(ISkinPackageInfo.Skins)} instead. Scheduled for removal in v11.0.0.")]
99+
public Dictionary<int, string> Skins
95100
{
96101
get
97102
{
@@ -104,6 +109,22 @@ public List<SkinInfo> Skins
104109
}
105110
}
106111

112+
/// <inheritdoc cref="ISkinPackageInfo.Skins"/>
113+
[XmlIgnore]
114+
[JsonIgnore]
115+
public List<SkinInfo> SkinsList
116+
{
117+
get
118+
{
119+
return this.skinsList;
120+
}
121+
122+
set
123+
{
124+
this.skinsList = value;
125+
}
126+
}
127+
107128
/// <inheritdoc cref="ISkinPackageInfo.SkinType"/>
108129
public string SkinType
109130
{
@@ -123,12 +144,12 @@ public int KeyID
123144
{
124145
get
125146
{
126-
return this.SkinPackageID;
147+
return ((ISkinPackageInfo)this).SkinPackageId;
127148
}
128149

129150
set
130151
{
131-
this.SkinPackageID = value;
152+
((ISkinPackageInfo)this).SkinPackageId = value;
132153
}
133154
}
134155

@@ -137,17 +158,17 @@ public int KeyID
137158
[JsonIgnore]
138159
int ISkinPackageInfo.PackageId
139160
{
140-
get => this.PackageID;
141-
set => this.PackageID = value;
161+
get => this.packageId;
162+
set => this.packageId = value;
142163
}
143164

144165
/// <inheritdoc/>
145166
[XmlIgnore]
146167
[JsonIgnore]
147168
int ISkinPackageInfo.SkinPackageId
148169
{
149-
get => this.SkinPackageID;
150-
set => this.SkinPackageID = value;
170+
get => this.skinPackageId;
171+
set => this.skinPackageId = value;
151172
}
152173

153174
/// <inheritdoc/>
@@ -157,7 +178,7 @@ IObjectList<ISkinInfo> ISkinPackageInfo.Skins
157178
{
158179
get
159180
{
160-
return this.abstractSkins ??= new AbstractionList<ISkinInfo, SkinInfo>(this.Skins);
181+
return this.abstractSkins ??= new AbstractionList<ISkinInfo, SkinInfo>(this.SkinsList);
161182
}
162183
}
163184

@@ -175,16 +196,17 @@ SkinPackageType ISkinPackageInfo.SkinType
175196
[JsonIgnore]
176197
int ISkinPackageInfo.PortalId
177198
{
178-
get => this.PortalID;
179-
set => this.PortalID = value;
199+
get => this.portalId;
200+
set => this.portalId = value;
180201
}
181202

182203
/// <inheritdoc/>
183204
public void Fill(IDataReader dr)
184205
{
185-
this.SkinPackageID = Null.SetNullInteger(dr["SkinPackageID"]);
186-
this.PackageID = Null.SetNullInteger(dr["PackageID"]);
187-
this.SkinName = Null.SetNullString(dr["SkinName"]);
206+
var @this = (ISkinPackageInfo)this;
207+
@this.SkinPackageId = Null.SetNullInteger(dr["SkinPackageID"]);
208+
@this.PackageId = Null.SetNullInteger(dr["PackageID"]);
209+
@this.SkinName = Null.SetNullString(dr["SkinName"]);
188210
this.SkinType = Null.SetNullString(dr["SkinType"]);
189211

190212
// Call the base classes fill method to populate base class properties
@@ -194,15 +216,17 @@ public void Fill(IDataReader dr)
194216
{
195217
while (dr.Read())
196218
{
197-
int skinID = Null.SetNullInteger(dr["SkinID"]);
198-
if (skinID > Null.NullInteger)
219+
int skinId = Null.SetNullInteger(dr["SkinID"]);
220+
if (skinId > Null.NullInteger)
199221
{
200-
this.skins.Add(new SkinInfo
222+
var skinSrc = Null.SetNullString(dr["SkinSrc"]);
223+
this.skins[skinId] = skinSrc;
224+
this.skinsList.Add(new SkinInfo
201225
{
202-
SkinId = skinID,
203-
SkinSrc = Null.SetNullString(dr["SkinSrc"]),
204-
SkinPackageId = this.SkinPackageID,
205-
PortalId = this.PortalID,
226+
SkinId = skinId,
227+
SkinSrc = skinSrc,
228+
SkinPackageId = @this.SkinPackageId,
229+
PortalId = @this.PortalId,
206230
SkinRoot = SkinUtils.FromDatabaseName(this.SkinType) switch
207231
{
208232
SkinPackageType.Container => SkinController.RootContainer,

0 commit comments

Comments
 (0)