Roles
List of examples:
Roles
Creating a new role
// Creates a new role object
RoleInfo newRole = new RoleInfo()
{
// Sets the role properties
RoleDisplayName = "New role",
RoleName = "NewRole",
SiteID = SiteContext.CurrentSiteID
};
// Verifies that the role is unique for the current site
if (!RoleInfoProvider.RoleExists(newRole.RoleName, SiteContext.CurrentSiteName))
{
// Saves the role to the database
RoleInfoProvider.SetRoleInfo(newRole);
}
else
{
// A role with the same name already exists on the site
}
Updating an existing role
// Gets the role
RoleInfo updateRole = RoleInfoProvider.GetRoleInfo("NewRole", SiteContext.CurrentSiteID);
if (updateRole != null)
{
// Updates the role's properties
updateRole.RoleDisplayName = updateRole.RoleDisplayName.ToLowerCSafe();
// Saves the changes to the database
RoleInfoProvider.SetRoleInfo(updateRole);
}
Updating multiple roles
// Gets all roles whose name starts with 'NewRole'
var roles = RoleInfoProvider.GetRoles().WhereStartsWith("RoleName", "NewRole");
// Loops through individual roles
foreach (RoleInfo modifyRole in roles)
{
// Updates the role properties
modifyRole.RoleDisplayName = modifyRole.RoleDisplayName.ToUpper();
// Saves the changes
RoleInfoProvider.SetRoleInfo(modifyRole);
}
Deleting a role
// Gets the role
RoleInfo deleteRole = RoleInfoProvider.GetRoleInfo("NewRole", SiteContext.CurrentSiteID);
if (deleteRole != null)
{
// Deletes the role
RoleInfoProvider.DeleteRoleInfo(deleteRole);
}
Global roles
Creating a new global role
// Creates a new role object
RoleInfo newRole = new RoleInfo()
{
// Sets the role properties
// All roles that omit the 'SiteID' property are treated as global by the system
RoleDisplayName = "New role",
RoleName = "NewRole"
};
// When retrieving global roles, prefix their code name with the dot character.
// The prefix ensures the system only retrieves global roles (in case a role with a matching
// code name also exists as a site role)
if (!RoleInfoProvider.RoleExists("." + newRole.RoleName, String.Empty))
{
// Saves the global role to the database
RoleInfoProvider.SetRoleInfo(newRole);
}
Updating an existing global role
// Gets the global role to update.
// When retrieving global roles, prefix their code name with the dot character.
// The prefix tells the system to only retrieve global roles (in case a role with a matching
// code name also exists as a site role)
RoleInfo updateRole = RoleInfoProvider.GetRoleInfo("." + "NewRole", String.Empty);
if (updateRole != null)
{
// Updates the role's properties
updateRole.RoleDisplayName = updateRole.RoleDisplayName.ToLowerCSafe();
// Saves the changes to the database
RoleInfoProvider.SetRoleInfo(updateRole);
}
User-role relationships
Checking if a user is in a role
// Gets the user
UserInfo user = UserInfoProvider.GetUserInfo("Username");
bool checkGlobalRoles = true;
bool checkMembership = true;
// Checks whether the user is assigned to a role with the "Rolename" code name
// The role can be assigned for the current site, as a global role, or indirectly through a membership
bool result = user.IsInRole("Rolename", SiteContext.CurrentSiteName, checkGlobalRoles, checkMembership);
Getting all roles of a user
// Gets the user
UserInfo user = UserInfoProvider.GetUserInfo("Username");
if (user != null)
{
// Gets the user's roles
var userRoleIDs = UserRoleInfoProvider.GetUserRoles().Column("RoleID").WhereEquals("UserID", user.UserID);
var roles = RoleInfoProvider.GetRoles().WhereIn("RoleID", userRoleIDs);
// Loops through the roles
foreach (RoleInfo role in roles)
{
// Process the role
}
}
Getting all users in a role
// Gets the role from the current site
RoleInfo role = RoleInfoProvider.GetRoleInfo("Rolename", SiteContext.CurrentSiteName);
if (role != null)
{
// Gets the role's users
var roleUserIDs = UserRoleInfoProvider.GetUserRoles().Column("UserID").WhereEquals("RoleID", role.RoleID);
var users = UserInfoProvider.GetUsers().WhereIn("UserID", roleUserIDs);
// Loops through the users
foreach (UserInfo user in users)
{
// Process the user
}
}
Adding a user to a role
// Gets the user
UserInfo user = UserInfoProvider.GetUserInfo("Username");
// Gets the role
RoleInfo role = RoleInfoProvider.GetRoleInfo("Rolename", SiteContext.CurrentSiteName);
if ((user != null) && (role != null))
{
// Adds the user to the role
UserInfoProvider.AddUserToRole(user.UserName, role.RoleName, SiteContext.CurrentSiteName);
}
Removing a user from a role
// Gets the user
UserInfo user = UserInfoProvider.GetUserInfo("Username");
// Gets the role
RoleInfo role = RoleInfoProvider.GetRoleInfo("Rolename", SiteContext.CurrentSiteName);
if ((user != null) && (role != null))
{
// Removes the user from the role
UserInfoProvider.RemoveUserFromRole(user.UserName, role.RoleName, SiteContext.CurrentSiteName);
}
Role permissions
Assigning a module permission to a role
// Gets the module permission
PermissionNameInfo permission = PermissionNameInfoProvider.GetPermissionNameInfo("Read", "CMS.Content", null);
// Gets the role
RoleInfo role = RoleInfoProvider.GetRoleInfo("Rolename", SiteContext.CurrentSiteID);
if ((permission != null) && (role != null))
{
// Creates an object representing the role-permission relationship
RolePermissionInfo newRolePermission = new RolePermissionInfo
{
// Assigns the permission to the role
PermissionID = permission.PermissionId,
RoleID = role.RoleID
};
// Saves the role-permission relationship into the database
RolePermissionInfoProvider.SetRolePermissionInfo(newRolePermission);
}
Removing a module permission from a role
// Gets the module permission
PermissionNameInfo permission = PermissionNameInfoProvider.GetPermissionNameInfo("Read", "CMS.Content", null);
// Gets the role
RoleInfo role = RoleInfoProvider.GetRoleInfo("Rolename", SiteContext.CurrentSiteID);
if ((permission != null) && (role != null))
{
// Gets the object representing the role-permission relationship
RolePermissionInfo deleteRolePermission = RolePermissionInfoProvider.GetRolePermissionInfo(role.RoleID, permission.PermissionId);
if (deleteRolePermission != null)
{
// Removes the permission from the role
RolePermissionInfoProvider.DeleteRolePermissionInfo(deleteRolePermission);
}
}
UI personalization
Assigning a UI element to a role
// Gets the role
RoleInfo role = RoleInfoProvider.GetRoleInfo("Rolename", SiteContext.CurrentSiteID);
// Gets the UI element (the element representing the Design tab in the Pages application in this case)
UIElementInfo element = UIElementInfoProvider.GetUIElementInfo("CMS.Design", "Design");
if ((role != null) && (element != null))
{
// Creates an object representing the role-UI element relationship
RoleUIElementInfo newRoleElement = new RoleUIElementInfo
{
// Assigns the UI element to the role
RoleID = role.RoleID,
ElementID = element.ElementID
};
// Saves the new relationship to the database
RoleUIElementInfoProvider.SetRoleUIElementInfo(newRoleElement);
}
Removing a UI element from a role
// Gets the role
RoleInfo role = RoleInfoProvider.GetRoleInfo("Rolename", SiteContext.CurrentSiteID);
// Gets the UI element (the element representing the Design tab in the Pages application in this case)
UIElementInfo element = UIElementInfoProvider.GetUIElementInfo("CMS.Design", "Design");
if ((role != null) && (element != null))
{
// Gets the object representing the relationship between the role and the UI element
RoleUIElementInfo deleteRoleElement = RoleUIElementInfoProvider.GetRoleUIElementInfo(role.RoleID, element.ElementID);
if (deleteRoleElement != null)
{
// Removes the UI element from the role
RoleUIElementInfoProvider.DeleteRoleUIElementInfo(deleteRoleElement);
}
}