Class PortalController

PoralController provides business layer of poatal.

Inheritance
System.Object
ServiceLocator<IPortalController, PortalController>
PortalController
Implements
Inherited Members
Namespace: DotNetNuke.Entities.Portals
Assembly: DotNetNuke.dll
Syntax
public class PortalController : ServiceLocator<IPortalController, PortalController>, IPortalController
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

Fields

| Improve this Doc View Source

HttpContextKeyPortalSettingsDictionary

PoralController provides business layer of poatal.

Declaration
protected const string HttpContextKeyPortalSettingsDictionary = null
Field Value
Type Description
System.String
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

Methods

| Improve this Doc View Source

AddPortalAlias(Int32, String)

Creates a new portal alias.

Declaration
public void AddPortalAlias(int portalId, string portalAlias)
Parameters
Type Name Description
System.Int32 portalId

Id of the portal.
System.String portalAlias

Portal Alias to be created.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

AddPortalDictionary(Int32, Int32)

Adds the portal dictionary.

Declaration
public static void AddPortalDictionary(int portalId, int tabId)
Parameters
Type Name Description
System.Int32 portalId

The portal id.
System.Int32 tabId

The tab id.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

CheckDesktopModulesInstalled(XPathNavigator)

Checks the desktop modules whether is installed.

Declaration
public static string CheckDesktopModulesInstalled(XPathNavigator nav)
Parameters
Type Name Description
XPathNavigator nav

The nav.
Returns
Type Description
System.String

Empty string if the module hasn't been installed, otherwise return the friendly name.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

CopyPageTemplate(String, String)

Copies the page template.

Declaration
public void CopyPageTemplate(string templateFile, string mappedHomeDirectory)
Parameters
Type Name Description
System.String templateFile

The template file.
System.String mappedHomeDirectory

The mapped home directory.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

CreateChildPortalFolder(String)

Creates the root folder for a child portal.

Declaration
public static string CreateChildPortalFolder(string childPath)
Parameters
Type Name Description
System.String childPath

The child path.
Returns
Type Description
System.String

If the method executed successful, it will return NullString, otherwise return error message.
Remarks

If call this method, it will create the specific folder if the folder doesn't exist; and will copy subhost.aspx to the folder if there is no 'Default.aspx'.

Examples
string childPhysicalPath = Server.MapPath(childPath);
message = PortalController.CreateChildPortalFolder(childPhysicalPath);
| Improve this Doc View Source

CreatePortal(String, UserInfo, String, String, IPortalTemplateInfo, String, String, String, String, Boolean)

Creates the portal.

Declaration
public int CreatePortal(string portalName, UserInfo adminUser, string description, string keyWords, IPortalTemplateInfo template, string homeDirectory, string portalAlias, string serverPath, string childPath, bool isChildPortal)
Parameters
Type Name Description
System.String portalName

Name of the portal.
UserInfo adminUser

The obj admin user.
System.String description

The description.
System.String keyWords

The key words.
IPortalTemplateInfo template
System.String homeDirectory

The home directory.
System.String portalAlias

The portal alias.
System.String serverPath

The server path.
System.String childPath

The child path.
System.Boolean isChildPortal

if set to true means the portal is child portal.
Returns
Type Description
System.Int32

Portal id.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

CreatePortal(String, UserInfo, String, String, PortalController.PortalTemplateInfo, String, String, String, String, Boolean)

PoralController provides business layer of poatal.

Declaration
public int CreatePortal(string portalName, UserInfo adminUser, string description, string keyWords, PortalController.PortalTemplateInfo template, string homeDirectory, string portalAlias, string serverPath, string childPath, bool isChildPortal)
Parameters
Type Name Description
System.String portalName
UserInfo adminUser
System.String description
System.String keyWords
PortalController.PortalTemplateInfo template
System.String homeDirectory
System.String portalAlias
System.String serverPath
System.String childPath
System.Boolean isChildPortal
Returns
Type Description
System.Int32
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

CreatePortal(String, UserInfo, String, String, String, String, String, String, String, String, Boolean)

PoralController provides business layer of poatal.

Declaration
public int CreatePortal(string portalName, UserInfo adminUser, string description, string keyWords, string templatePath, string templateFile, string homeDirectory, string portalAlias, string serverPath, string childPath, bool isChildPortal)
Parameters
Type Name Description
System.String portalName
UserInfo adminUser
System.String description
System.String keyWords
System.String templatePath
System.String templateFile
System.String homeDirectory
System.String portalAlias
System.String serverPath
System.String childPath
System.Boolean isChildPortal
Returns
Type Description
System.Int32
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

CreatePortal(String, Int32, String, String, IPortalTemplateInfo, String, String, String, String, Boolean)

Creates the portal.

Declaration
public int CreatePortal(string portalName, int adminUserId, string description, string keyWords, IPortalTemplateInfo template, string homeDirectory, string portalAlias, string serverPath, string childPath, bool isChildPortal)
Parameters
Type Name Description
System.String portalName

Name of the portal.
System.Int32 adminUserId

The obj admin user.
System.String description

The description.
System.String keyWords

The key words.
IPortalTemplateInfo template
System.String homeDirectory

The home directory.
System.String portalAlias

The portal alias.
System.String serverPath

The server path.
System.String childPath

The child path.
System.Boolean isChildPortal

if set to true means the portal is child portal.
Returns
Type Description
System.Int32

Portal id.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

CreatePortal(String, Int32, String, String, PortalController.PortalTemplateInfo, String, String, String, String, Boolean)

PoralController provides business layer of poatal.

Declaration
public int CreatePortal(string portalName, int adminUserId, string description, string keyWords, PortalController.PortalTemplateInfo template, string homeDirectory, string portalAlias, string serverPath, string childPath, bool isChildPortal)
Parameters
Type Name Description
System.String portalName
System.Int32 adminUserId
System.String description
System.String keyWords
PortalController.PortalTemplateInfo template
System.String homeDirectory
System.String portalAlias
System.String serverPath
System.String childPath
System.Boolean isChildPortal
Returns
Type Description
System.Int32
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

CreatePortal(String, String, String, String, String, String, String, String, String, String, String, String, String, String, Boolean)

PoralController provides business layer of poatal.

Declaration
public int CreatePortal(string portalName, string firstName, string lastName, string username, string password, string email, string description, string keyWords, string templatePath, string templateFile, string homeDirectory, string portalAlias, string serverPath, string childPath, bool isChildPortal)
Parameters
Type Name Description
System.String portalName
System.String firstName
System.String lastName
System.String username
System.String password
System.String email
System.String description
System.String keyWords
System.String templatePath
System.String templateFile
System.String homeDirectory
System.String portalAlias
System.String serverPath
System.String childPath
System.Boolean isChildPortal
Returns
Type Description
System.Int32
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

DeleteExpiredPortals(String)

Deletes all expired portals.

Declaration
public static void DeleteExpiredPortals(string serverPath)
Parameters
Type Name Description
System.String serverPath

The server path.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

DeletePortal(PortalInfo, String)

Deletes the portal.

Declaration
public static string DeletePortal(PortalInfo portal, string serverPath)
Parameters
Type Name Description
PortalInfo portal

The portal.
System.String serverPath

The server path.
Returns
Type Description
System.String

If the method executed successful, it will return NullString, otherwise return error message.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

DeletePortalFolder(String, String)

Delete the child portal folder and try to remove its parent when parent folder is empty.

Declaration
public static void DeletePortalFolder(string serverPath, string portalFolder)
Parameters
Type Name Description
System.String serverPath

the server path.
System.String portalFolder

the child folder path.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

DeletePortalInfo(Int32)

PoralController provides business layer of poatal.

Declaration
public void DeletePortalInfo(int portalId)
Parameters
Type Name Description
System.Int32 portalId
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

DeletePortalSetting(Int32, String, String)

Deletes the portal setting in this language.

Declaration
public static void DeletePortalSetting(int portalID, string settingName, string cultureCode)
Parameters
Type Name Description
System.Int32 portalID

The portal ID.
System.String settingName

Name of the setting.
System.String cultureCode

The culture code.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

DeletePortalSetting(Int32, String)

Deletes the portal setting (neutral and for all languages).

Declaration
public static void DeletePortalSetting(int portalID, string settingName)
Parameters
Type Name Description
System.Int32 portalID

The portal ID.
System.String settingName

Name of the setting.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

DeletePortalSettings(Int32, String)

Deletes all portal settings by portal id and for a given language (Null: all languages and neutral settings).

Declaration
public static void DeletePortalSettings(int portalID, string cultureCode)
Parameters
Type Name Description
System.Int32 portalID

The portal ID.
System.String cultureCode
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

DeletePortalSettings(Int32)

Deletes all portal settings by portal id.

Declaration
public static void DeletePortalSettings(int portalID)
Parameters
Type Name Description
System.Int32 portalID

The portal ID.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetActivePortalLanguage(Int32)

function provides the language for portalinfo requests in case where language has not been installed yet, will return the core install default of en-us.

Declaration
public static string GetActivePortalLanguage(int portalID)
Parameters
Type Name Description
System.Int32 portalID
Returns
Type Description
System.String

The language identifier.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetAvailablePortalTemplates()

Get all the available portal templates grouped by culture.

Declaration
public IList<PortalController.PortalTemplateInfo> GetAvailablePortalTemplates()
Returns
Type Description
IList<PortalController.PortalTemplateInfo>

List of PortalTemplateInfo objects.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetCurrentPortalSettings()

PoralController provides business layer of poatal.

Declaration
public static PortalSettings GetCurrentPortalSettings()
Returns
Type Description
PortalSettings
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetEffectivePortalId(Int32)

PoralController provides business layer of poatal.

Declaration
public static int GetEffectivePortalId(int portalId)
Parameters
Type Name Description
System.Int32 portalId
Returns
Type Description
System.Int32
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetEncryptedString(String, Int32, String)

takes in a text value, decrypts it with a FIPS compliant algorithm and returns the value.

Declaration
public static string GetEncryptedString(string settingName, int portalID, string passPhrase)
Parameters
Type Name Description
System.String settingName

the setting to read.
System.Int32 portalID
System.String passPhrase

the pass phrase used for encryption/decryption.
Returns
Type Description
System.String

The decrypted setting value.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetExpiredPortals()

Gets all expired portals.

Declaration
public static ArrayList GetExpiredPortals()
Returns
Type Description
ArrayList

all expired portals as array list.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetFactory()

Gets the service locator factory.

Declaration
protected override Func<IPortalController> GetFactory()
Returns
Type Description
Func<IPortalController>

A factory function.
Overrides
DotNetNuke.Framework.ServiceLocator<DotNetNuke.Entities.Portals.IPortalController, DotNetNuke.Entities.Portals.PortalController>.GetFactory()
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetPortal(Guid)

Gets the portal.

Declaration
public PortalInfo GetPortal(Guid uniqueId)
Parameters
Type Name Description
Guid uniqueId

The unique id.
Returns
Type Description
PortalInfo

Portal info.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetPortal(Int32, String)

Gets information of a portal.

Declaration
public PortalInfo GetPortal(int portalId, string cultureCode)
Parameters
Type Name Description
System.Int32 portalId

Id of the portal.
System.String cultureCode

The culture code.
Returns
Type Description
PortalInfo

The PortalInfo instance or null.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetPortal(Int32)

Gets information of a portal.

Declaration
public PortalInfo GetPortal(int portalId)
Parameters
Type Name Description
System.Int32 portalId

Id of the portal.
Returns
Type Description
PortalInfo

PortalInfo object with portal definition.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetPortalDefaultLanguage(Int32)

return the current DefaultLanguage value from the Portals table for the requested Portalid.

Declaration
public static string GetPortalDefaultLanguage(int portalID)
Parameters
Type Name Description
System.Int32 portalID
Returns
Type Description
System.String

The language identifier.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetPortalDictionary()

Gets the portal dictionary.

Declaration
public static Dictionary<int, int> GetPortalDictionary()
Returns
Type Description
Dictionary<System.Int32, System.Int32>

portal dictionary. the dictionary's Key -> Value is: TabId -> PortalId.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetPortalFolder(String)

Get the portal folder froma child portal alias.

Declaration
public static string GetPortalFolder(string alias)
Parameters
Type Name Description
System.String alias

portal alias.
Returns
Type Description
System.String

folder path of the child portal.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetPortalList(String)

Get portals in specific culture.

Declaration
public List<PortalInfo> GetPortalList(string cultureCode)
Parameters
Type Name Description
System.String cultureCode

The culture code.
Returns
Type Description
List<PortalInfo>

A of PortalInfo instances.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetPortals()

Gets information from all portals.

Declaration
public ArrayList GetPortals()
Returns
Type Description
ArrayList

ArrayList of PortalInfo objects.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetPortalsByName(String, Int32, Int32, ref Int32)

GetPortalsByName gets all the portals whose name matches a provided filter expression.

Declaration
public static ArrayList GetPortalsByName(string nameToMatch, int pageIndex, int pageSize, ref int totalRecords)
Parameters
Type Name Description
System.String nameToMatch

The email address to use to find a match.
System.Int32 pageIndex

The page of records to return.
System.Int32 pageSize

The size of the page.
System.Int32 totalRecords

The total no of records that satisfy the criteria.
Returns
Type Description
ArrayList

An ArrayList of PortalInfo objects.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetPortalsByUser(Int32)

PoralController provides business layer of poatal.

Declaration
public static ArrayList GetPortalsByUser(int userId)
Parameters
Type Name Description
System.Int32 userId
Returns
Type Description
ArrayList
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetPortalSetting(String, Int32, String, String)

Gets the portal setting for a specific language (or neutral).

Declaration
public static string GetPortalSetting(string settingName, int portalID, string defaultValue, string cultureCode)
Parameters
Type Name Description
System.String settingName

Name of the setting.
System.Int32 portalID

The portal ID.
System.String defaultValue

The default value.
System.String cultureCode

culture code of the language to retrieve (not empty).
Returns
Type Description
System.String

Returns setting's value if portal contains the specific setting in specified language or neutral, otherwise return defaultValue.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetPortalSetting(String, Int32, String)

Gets the portal setting.

Declaration
public static string GetPortalSetting(string settingName, int portalID, string defaultValue)
Parameters
Type Name Description
System.String settingName

Name of the setting.
System.Int32 portalID

The portal ID.
System.String defaultValue

The default value.
Returns
Type Description
System.String

Returns setting's value if portal contains the specific setting, otherwise return defaultValue.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetPortalSettingAsBoolean(String, Int32, Boolean, String)

Gets the portal setting as boolean for a specific language (or neutral).

Declaration
public static bool GetPortalSettingAsBoolean(string key, int portalID, bool defaultValue, string cultureCode)
Parameters
Type Name Description
System.String key

The key.
System.Int32 portalID

The portal ID.
System.Boolean defaultValue

default value.
System.String cultureCode

culture code of the language to retrieve (not empty).
Returns
Type Description
System.Boolean

Returns setting's value if portal contains the specific setting in specified language or neutral, otherwise return defaultValue.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetPortalSettingAsBoolean(String, Int32, Boolean)

Gets the portal setting as boolean.

Declaration
public static bool GetPortalSettingAsBoolean(string key, int portalID, bool defaultValue)
Parameters
Type Name Description
System.String key

The key.
System.Int32 portalID

The portal ID.
System.Boolean defaultValue

default value.
Returns
Type Description
System.Boolean

Returns setting's value if portal contains the specific setting, otherwise return defaultValue.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetPortalSettingAsDouble(String, Int32, Double)

Gets the portal setting as double.

Declaration
public static double GetPortalSettingAsDouble(string key, int portalId, double defaultValue)
Parameters
Type Name Description
System.String key

The key.
System.Int32 portalId

The portal Id.
System.Double defaultValue

The default value.
Returns
Type Description
System.Double

Returns setting's value if portal contains the specific setting, otherwise return defaultValue.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetPortalSettingAsInteger(String, Int32, Int32, String)

Gets the portal setting as integer for a specific language (or neutral).

Declaration
public static int GetPortalSettingAsInteger(string key, int portalID, int defaultValue, string cultureCode)
Parameters
Type Name Description
System.String key

The key.
System.Int32 portalID

The portal ID.
System.Int32 defaultValue

The default value.
System.String cultureCode

culture code of the language to retrieve (not empty).
Returns
Type Description
System.Int32

Returns setting's value if portal contains the specific setting (for specified lang, otherwise return defaultValue.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetPortalSettingAsInteger(String, Int32, Int32)

Gets the portal setting as integer.

Declaration
public static int GetPortalSettingAsInteger(string key, int portalID, int defaultValue)
Parameters
Type Name Description
System.String key

The key.
System.Int32 portalID

The portal ID.
System.Int32 defaultValue

The default value.
Returns
Type Description
System.Int32

Returns setting's value if portal contains the specific setting, otherwise return defaultValue.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetPortalSettings(Int32, String)

Gets the portal settings dictionary.

Declaration
public Dictionary<string, string> GetPortalSettings(int portalId, string cultureCode)
Parameters
Type Name Description
System.Int32 portalId

The portal ID.
System.String cultureCode

The culture code.
Returns
Type Description
Dictionary<System.String, System.String>

portal settings.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetPortalSettings(Int32)

Gets the portal settings dictionary.

Declaration
public Dictionary<string, string> GetPortalSettings(int portalId)
Parameters
Type Name Description
System.Int32 portalId

The portal ID.
Returns
Type Description
Dictionary<System.String, System.String>

portal settings.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetPortalSettingsDictionary(Int32)

PoralController provides business layer of poatal.

Declaration
public static Dictionary<string, string> GetPortalSettingsDictionary(int portalId)
Parameters
Type Name Description
System.Int32 portalId
Returns
Type Description
Dictionary<System.String, System.String>
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetPortalSpaceUsedBytes(Int32)

Gets the portal space used bytes.

Declaration
public long GetPortalSpaceUsedBytes(int portalId)
Parameters
Type Name Description
System.Int32 portalId

The portal id.
Returns
Type Description
System.Int64

Space used in bytes.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

GetPortalTemplate(String, String)

Load info for a portal template.

Declaration
public PortalController.PortalTemplateInfo GetPortalTemplate(string templatePath, string cultureCode)
Parameters
Type Name Description
System.String templatePath

Full path to the portal template.
System.String cultureCode

the culture code if any for the localization of the portal template.
Returns
Type Description
PortalController.PortalTemplateInfo

A portal template.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

HasSpaceAvailable(Int32, Int64)

Verifies if there's enough space to upload a new file on the given portal.

Declaration
public bool HasSpaceAvailable(int portalId, long fileSizeBytes)
Parameters
Type Name Description
System.Int32 portalId

Id of the portal.
System.Int64 fileSizeBytes

Size of the file being uploaded.
Returns
Type Description
System.Boolean

True if there's enough space available to upload the file.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

IncrementCrmVersion(Int32)

PoralController provides business layer of poatal.

Declaration
public static void IncrementCrmVersion(int portalID)
Parameters
Type Name Description
System.Int32 portalID
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

IncrementOverridingPortalsCrmVersion()

PoralController provides business layer of poatal.

Declaration
public static void IncrementOverridingPortalsCrmVersion()
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

IsChildPortal(PortalInfo, String)

Determines whether the portal is child portal.

Declaration
public static bool IsChildPortal(PortalInfo portal, string serverPath)
Parameters
Type Name Description
PortalInfo portal

The portal.
System.String serverPath

The server path.
Returns
Type Description
System.Boolean

true if the portal is child portal; otherwise, false.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

IsMemberOfPortalGroup(Int32)

PoralController provides business layer of poatal.

Declaration
public static bool IsMemberOfPortalGroup(int portalId)
Parameters
Type Name Description
System.Int32 portalId
Returns
Type Description
System.Boolean
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

MapLocalizedSpecialPages(Int32, String)

Remaps the Special Pages such as Home, Profile, Search to their localized versions.

Declaration
public void MapLocalizedSpecialPages(int portalId, string cultureCode)
Parameters
Type Name Description
System.Int32 portalId
System.String cultureCode
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

ParseTemplate(Int32, PortalController.PortalTemplateInfo, Int32, PortalTemplateModuleAction, Boolean)

Processess a template file for the new portal.

Declaration
public void ParseTemplate(int portalId, PortalController.PortalTemplateInfo template, int administratorId, PortalTemplateModuleAction mergeTabs, bool isNewPortal)
Parameters
Type Name Description
System.Int32 portalId

PortalId of the new portal.
PortalController.PortalTemplateInfo template

The template.
System.Int32 administratorId

UserId for the portal administrator. This is used to assign roles to this user.
PortalTemplateModuleAction mergeTabs

Flag to determine whether Module content is merged.
System.Boolean isNewPortal

Flag to determine is the template is applied to an existing portal or a new one.
Remarks

The roles and settings nodes will only be processed on the portal template file.

| Improve this Doc View Source

ParseTemplate(Int32, String, String, Int32, PortalTemplateModuleAction, Boolean, out LocaleCollection)

PoralController provides business layer of poatal.

Declaration
public void ParseTemplate(int portalId, string templatePath, string templateFile, int administratorId, PortalTemplateModuleAction mergeTabs, bool isNewPortal, out LocaleCollection localeCollection)
Parameters
Type Name Description
System.Int32 portalId
System.String templatePath
System.String templateFile
System.Int32 administratorId
PortalTemplateModuleAction mergeTabs
System.Boolean isNewPortal
LocaleCollection localeCollection
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

ParseTemplate(Int32, String, String, Int32, PortalTemplateModuleAction, Boolean)

PoralController provides business layer of poatal.

Declaration
public void ParseTemplate(int portalId, string templatePath, string templateFile, int administratorId, PortalTemplateModuleAction mergeTabs, bool isNewPortal)
Parameters
Type Name Description
System.Int32 portalId
System.String templatePath
System.String templateFile
System.Int32 administratorId
PortalTemplateModuleAction mergeTabs
System.Boolean isNewPortal
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

ProcessResourceFileExplicit(String, String)

Processes the resource file for the template file selected.

Declaration
public void ProcessResourceFileExplicit(string portalPath, string resoureceFile)
Parameters
Type Name Description
System.String portalPath

New portal's folder.
System.String resoureceFile

full path to the resource file.
Remarks

The resource file is a zip file with the same name as the selected template file and with an extension of .resources (to disable this file being downloaded). For example: for template file "portal.template" a resource file "portal.template.resources" can be defined.

| Improve this Doc View Source

RemovePortalLocalization(Int32, String, Boolean)

Removes the related PortalLocalization record from the database, adds optional clear cache.

Declaration
public void RemovePortalLocalization(int portalId, string cultureCode, bool clearCache = true)
Parameters
Type Name Description
System.Int32 portalId
System.String cultureCode
System.Boolean clearCache
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

UpdateEncryptedString(Int32, String, String, String)

takes in a text value, encrypts it with a FIPS compliant algorithm and stores.

Declaration
public static void UpdateEncryptedString(int portalID, string settingName, string settingValue, string passPhrase)
Parameters
Type Name Description
System.Int32 portalID

The portal ID.
System.String settingName

host settings key.
System.String settingValue

host settings value.
System.String passPhrase

pass phrase to allow encryption/decryption.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

UpdatePortalDefaultLanguage(Int32, String)

set the required DefaultLanguage in the Portals table for a particular portal saves having to update an entire PortalInfo object.

Declaration
public static void UpdatePortalDefaultLanguage(int portalID, string cultureCode)
Parameters
Type Name Description
System.Int32 portalID
System.String cultureCode
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

UpdatePortalExpiry(Int32, String)

Updates the portal expiry.

Declaration
public void UpdatePortalExpiry(int portalId, string cultureCode)
Parameters
Type Name Description
System.Int32 portalId

The portal id.
System.String cultureCode

The culture code.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

UpdatePortalExpiry(Int32)

PoralController provides business layer of poatal.

Declaration
public void UpdatePortalExpiry(int portalId)
Parameters
Type Name Description
System.Int32 portalId
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

UpdatePortalInfo(PortalInfo, Boolean)

PoralController provides business layer of poatal.

Declaration
public void UpdatePortalInfo(PortalInfo portal, bool clearCache)
Parameters
Type Name Description
PortalInfo portal
System.Boolean clearCache
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

UpdatePortalInfo(PortalInfo)

Updates basic portal information.

Declaration
public void UpdatePortalInfo(PortalInfo portal)
Parameters
Type Name Description
PortalInfo portal
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

UpdatePortalSetting(Int32, String, String, Boolean, String, Boolean)

Updates a language specific or neutral portal setting and optionally clears it from the cache. All overloaded methors will not encrypt the setting value. Therefore, call this method whenever there is a need to encrypt the setting value before storing it in the datanbase.

Declaration
public static void UpdatePortalSetting(int portalID, string settingName, string settingValue, bool clearCache, string cultureCode, bool isSecure)
Parameters
Type Name Description
System.Int32 portalID

The portal ID.
System.String settingName

Name of the setting.
System.String settingValue

The setting value.
System.Boolean clearCache

if set to true [clear cache].
System.String cultureCode

culture code for language specific settings, null string ontherwise.
System.Boolean isSecure

When true it encrypt the value before storing it in the database.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

UpdatePortalSetting(Int32, String, String, Boolean, String)

Updates a language specific or neutral portal setting and optionally clears it from the cache.

Declaration
public static void UpdatePortalSetting(int portalID, string settingName, string settingValue, bool clearCache, string cultureCode)
Parameters
Type Name Description
System.Int32 portalID

The portal ID.
System.String settingName

Name of the setting.
System.String settingValue

The setting value.
System.Boolean clearCache

if set to true [clear cache].
System.String cultureCode

culture code for language specific settings, null string ontherwise.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

UpdatePortalSetting(Int32, String, String, Boolean)

Updates a single neutral (not language specific) portal setting, optionally without clearing the cache.

Declaration
public static void UpdatePortalSetting(int portalID, string settingName, string settingValue, bool clearCache)
Parameters
Type Name Description
System.Int32 portalID

The portal ID.
System.String settingName

Name of the setting.
System.String settingValue

The setting value.
System.Boolean clearCache

if set to true [clear cache].
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

UpdatePortalSetting(Int32, String, String, String)

Updates a language specific or neutral portal setting and clears it from the cache.

Declaration
public static void UpdatePortalSetting(int portalID, string settingName, string settingValue, string cultureCode)
Parameters
Type Name Description
System.Int32 portalID

The portal ID.
System.String settingName

Name of the setting.
System.String settingValue

The setting value.
System.String cultureCode

culture code for language specific settings, null string ontherwise.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

UpdatePortalSetting(Int32, String, String)

Updates a single neutral (not language specific) portal setting and clears it from the cache.

Declaration
public static void UpdatePortalSetting(int portalID, string settingName, string settingValue)
Parameters
Type Name Description
System.Int32 portalID

The portal ID.
System.String settingName

Name of the setting.
System.String settingValue

The setting value.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

Explicit Interface Implementations

| Improve this Doc View Source

IPortalController.GetCurrentPortalSettings()

Gets the current portal settings.

Declaration
PortalSettings IPortalController.GetCurrentPortalSettings()
Returns
Type Description
PortalSettings

portal settings.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

IPortalController.GetCurrentSettings()

Gets the current portal settings.

Declaration
IPortalSettings IPortalController.GetCurrentSettings()
Returns
Type Description
IPortalSettings

portal settings.
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

IPortalController.UpdatePortalSetting(Int32, String, String, Boolean, String, Boolean)

Adds or Updates or Deletes a portal setting value.

Declaration
void IPortalController.UpdatePortalSetting(int portalID, string settingName, string settingValue, bool clearCache, string cultureCode, bool isSecure)
Parameters
Type Name Description
System.Int32 portalID
System.String settingName
System.String settingValue
System.Boolean clearCache
System.String cultureCode
System.Boolean isSecure
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

| Improve this Doc View Source

IPortalController.UpdatePortalSetting(Int32, String, String, Boolean, String)

PoralController provides business layer of poatal.

Declaration
void IPortalController.UpdatePortalSetting(int portalID, string settingName, string settingValue, bool clearCache, string cultureCode)
Parameters
Type Name Description
System.Int32 portalID
System.String settingName
System.String settingValue
System.Boolean clearCache
System.String cultureCode
Remarks

DotNetNuke supports the concept of virtualised sites in a single install. This means that multiple sites, each potentially with multiple unique URL's, can exist in one instance of DotNetNuke i.e. one set of files and one database.

Implements

Extension Methods