C# Class Subtext.Framework.Configuration.Config

Static helper class used to access various configuration settings.

Datei anzeigen Open project: ayende/Subtext

Public Methods

Method	Description
AddBlogAlias ( BlogAlias alias ) : bool	Adds the blog alias to the system.
CreateBlog ( string title, string userName, string password, string host, string subfolder ) : bool	Creates an initial blog. This is a convenience method for allowing a user with a freshly installed blog to immediately gain access to the admin section to edit the blog.
CreateBlog ( string title, string userName, string password, string host, string subfolder, bool passwordAlreadyHashed ) : bool	Creates an initial blog. This is a convenience method for allowing a user with a freshly installed blog to immediately gain access to the admin section to edit the blog.
CreateBlog ( string title, string userName, string password, string host, string subfolder, int groupId ) : bool	Creates an initial blog. This is a convenience method for allowing a user with a freshly installed blog to immediately gain access to the admin section to edit the blog.
CreateBlog ( string title, string userName, string password, string host, string subfolder, int blogGroupId, bool passwordAlreadyHashed ) : bool	Creates an initial blog. This is a convenience method for allowing a user with a freshly installed blog to immediately gain access to the admin section to edit the blog.
DeleteBlogAlias ( BlogAlias alias ) : bool	Deletes the blog alias.
GetBlogAlias ( int id ) : BlogAlias	Gets the blog alias.
GetBlogGroup ( int id, bool activeOnly ) : BlogGroup	Gets the blog group by id.
GetBlogInfo ( string hostName, string subfolder ) : BlogInfo	Returns a BlogInfo instance containing the configuration settings for the blog specified by the Hostname and Application.
GetBlogInfo ( string hostName, string subfolder, bool strict ) : BlogInfo	Returns a BlogInfo instance containing the configuration settings for the blog specified by the Hostname and Application. Until Subtext supports multiple blogs again (if ever), this will always return the same instance.
GetBlogInfoFromDomainAlias ( string domainAlias, string subfolder, bool strict ) : BlogInfo	Returns a BlogInfo instance containing the configuration settings for the blog specified by the Domain Alias.
GetFileNotFoundPage ( ) : string	Gets the file not found page from web.config.
IsValidSubfolderName ( string subfolder ) : bool	Returns true if the specified subfolder name has a valid format. It may not start, nor end with ".". It may not contain any of the following invalid characters {}[]/\ @!#$%:^&*()?+\|"='<>;,
ListBlogGroups ( bool activeOnly ) : IList	Lists the blog groups in this installation.
UpdateBlogAlias ( BlogAlias alias ) : bool	Updates the blog alias.
UpdateConfigData ( BlogInfo info ) : void	Updates the database with the configuration data within the specified BlogInfo instance.

Method Details

AddBlogAlias() public static method

Adds the blog alias to the system.

public static AddBlogAlias ( BlogAlias alias ) : bool
alias	BlogAlias	The alias.
return	bool

CreateBlog() public static method

Creates an initial blog. This is a convenience method for allowing a user with a freshly installed blog to immediately gain access to the admin section to edit the blog.

public static CreateBlog ( string title, string userName, string password, string host, string subfolder ) : bool
title	string	Title of the blog
userName	string	Name of the user.
password	string	Password.
host	string
subfolder	string
return	bool

CreateBlog() public static method

Creates an initial blog. This is a convenience method for allowing a user with a freshly installed blog to immediately gain access to the admin section to edit the blog.

public static CreateBlog ( string title, string userName, string password, string host, string subfolder, bool passwordAlreadyHashed ) : bool
title	string	Title of the blog.
userName	string	Name of the user.
password	string	Password.
host	string
subfolder	string
passwordAlreadyHashed	bool	If true, the password has already been hashed.
return	bool

CreateBlog() public static method

Creates an initial blog. This is a convenience method for allowing a user with a freshly installed blog to immediately gain access to the admin section to edit the blog.

public static CreateBlog ( string title, string userName, string password, string host, string subfolder, int groupId ) : bool
title	string	Title of the blog
userName	string	Name of the user.
password	string	Password.
host	string
subfolder	string
groupId	int
return	bool

CreateBlog() public static method

Creates an initial blog. This is a convenience method for allowing a user with a freshly installed blog to immediately gain access to the admin section to edit the blog.

public static CreateBlog ( string title, string userName, string password, string host, string subfolder, int blogGroupId, bool passwordAlreadyHashed ) : bool
title	string	Title of the blog.
userName	string	Name of the user.
password	string	Password.
host	string
subfolder	string
blogGroupId	int
passwordAlreadyHashed	bool	If true, the password has already been hashed.
return	bool

DeleteBlogAlias() public static method

Deletes the blog alias.

public static DeleteBlogAlias ( BlogAlias alias ) : bool
alias	BlogAlias	The alias.
return	bool

GetBlogAlias() public static method

Gets the blog alias.

public static GetBlogAlias ( int id ) : BlogAlias
id	int	The id.
return	BlogAlias

GetBlogGroup() public static method

Gets the blog group by id.

public static GetBlogGroup ( int id, bool activeOnly ) : BlogGroup
id	int	The id.
activeOnly	bool	if set to true [active only].
return	Subtext.Framework.Components.BlogGroup

GetBlogInfo() public static method

Returns a BlogInfo instance containing the configuration settings for the blog specified by the Hostname and Application.

public static GetBlogInfo ( string hostName, string subfolder ) : BlogInfo
hostName	string	Hostname.
subfolder	string	Subfolder Name.
return	BlogInfo

GetBlogInfo() public static method

Returns a BlogInfo instance containing the configuration settings for the blog specified by the Hostname and Application.

Until Subtext supports multiple blogs again (if ever), this will always return the same instance.

public static GetBlogInfo ( string hostName, string subfolder, bool strict ) : BlogInfo
hostName	string	Hostname.
subfolder	string	Subfolder Name.
strict	bool	If false, then this will return a blog record if /// there is only one blog record, regardless if the subfolder and hostname match.
return	BlogInfo

GetBlogInfoFromDomainAlias() public static method

Returns a BlogInfo instance containing the configuration settings for the blog specified by the Domain Alias.

public static GetBlogInfoFromDomainAlias ( string domainAlias, string subfolder, bool strict ) : BlogInfo
domainAlias	string	Domain alias
subfolder	string	Sub Folder
strict	bool	Strict
return	BlogInfo

GetFileNotFoundPage() public static method

Gets the file not found page from web.config.

public static GetFileNotFoundPage ( ) : string
return	string

IsValidSubfolderName() public static method

Returns true if the specified subfolder name has a valid format. It may not start, nor end with ".". It may not contain any of the following invalid characters {}[]/\ @!#$%:^&*()?+|"='<>;,

public static IsValidSubfolderName ( string subfolder ) : bool
subfolder	string	subfolder.
return	bool

ListBlogGroups() public static method

Lists the blog groups in this installation.

public static ListBlogGroups ( bool activeOnly ) : IList
activeOnly	bool	if set to true [active only].
return	IList

UpdateBlogAlias() public static method

Updates the blog alias.

public static UpdateBlogAlias ( BlogAlias alias ) : bool
alias	BlogAlias	The alias.
return	bool

UpdateConfigData() public static method

Updates the database with the configuration data within the specified BlogInfo instance.

public static UpdateConfigData ( BlogInfo info ) : void
info	BlogInfo	Config.
return	void