add documentation

This commit is contained in:
sbwalker 2024-07-21 09:18:41 -04:00
parent ef272dd6a8
commit 0fea8365b8

View File

@ -7,6 +7,7 @@ namespace Oqtane.Extensions
{ {
public static class HttpContextExtensions public static class HttpContextExtensions
{ {
// this method should only be used in scenarios where HttpContent exists (ie. within Controllers)
public static Alias GetAlias(this HttpContext context) public static Alias GetAlias(this HttpContext context)
{ {
if (context != null && context.Items.ContainsKey(Constants.HttpContextAliasKey)) if (context != null && context.Items.ContainsKey(Constants.HttpContextAliasKey))
@ -16,6 +17,7 @@ namespace Oqtane.Extensions
return null; return null;
} }
// this method should only be used in scenarios where HttpContent exists (ie. within Controllers)
public static Dictionary<string, string> GetSiteSettings(this HttpContext context) public static Dictionary<string, string> GetSiteSettings(this HttpContext context)
{ {
if (context != null && context.Items.ContainsKey(Constants.HttpContextSiteSettingsKey)) if (context != null && context.Items.ContainsKey(Constants.HttpContextSiteSettingsKey))