\JAccess

Class that handles all access authorisation routines.

Synopsis

class JAccess {

• // members
• protected  $viewLevels;
• protected  $assetRules;
• protected  $userGroups;
• protected  $userGroupPaths;
• protected  $groupsByUser;
• // methods
• public static void clearStatics()
• public static boolean check()
• public static boolean checkGroup()
• protected static mixed getGroupPath()
• public static JAccessRules getAssetRules()
• public static array getGroupsByUser()
• public static array getUsersByGroup()
• public static array getAuthorisedViewLevels()
• public static array getActions()
• public static boolean|array getActionsFromFile()
• public static boolean|array getActionsFromData()
}


Tasks

Tasks

Line	Task
144	$rootId doesn't seem to be used!
292	Uncouple this from JComponentHelper and allow for a configuration setting or value injection.
368+	This method should move somewhere else

Members

protected

• $assetRules — array
  Array of rules for the asset
• $groupsByUser — array
  Array of cached groups by user.
• $userGroupPaths — array
  Array of user group paths.
• $userGroups — array
  Array of user groups.
• $viewLevels — array
  Array of view levels

Methods

protected

• getGroupPath() — Gets the parent groups that a leaf group belongs to in its branch back to the root of the tree (including the leaf group id).

public

• check() — Method to check if a user is authorised to perform an action, optionally on an asset.
• checkGroup() — Method to check if a group is authorised to perform an action, optionally on an asset.
• clearStatics() — Method for clearing static caches.
• getActions() — Method to return a list of actions for which permissions can be set given a component and section.
• getActionsFromData() — Method to return a list of actions from a string or from an xml for which permissions can be set.
• getActionsFromFile() — Method to return a list of actions from a file for which permissions can be set.
• getAssetRules() — Method to return the JAccessRules object for an asset. The returned object can optionally hold only the rules explicitly set for the asset or the summation of all inherited rules from parent assets and explicit rules.
• getAuthorisedViewLevels() — Method to return a list of view levels for which the user is authorised.
• getGroupsByUser() — Method to return a list of user groups mapped to a user. The returned list can optionally hold only the groups explicitly mapped to the user or all groups both explicitly mapped and inherited by the user.
• getUsersByGroup() — Method to return a list of user Ids contained in a Group