Class Access - list of methods

Method for clearing static caches.

• void

• 1.7.3

Method to check if a user is authorised to perform an action, optionally on an asset.

• int $userId Id of the user for which to check authorisation.
• string $action The name of the action to authorise.
• int|string $assetKey The asset key (asset id or asset name). null fallback to root asset.
• bool $preload Indicates whether preloading should be used.

• bool|null True if allowed, false for an explicit deny, null for an implicit deny.

• 1.7.0

Method to preload the Rules object for the given asset type.

• int|string|array $assetTypes The type or name of the asset (e.g. 'com_content.article', 'com_menus.menu.2'). Also accepts the asset id. An array of asset type or a special 'components' string to load all component assets.
• bool $reload Set to true to reload from database.

• bool True on success.

• 1.6

• This method will return void in 4.0.

Method to recursively retrieve the list of parent Asset IDs for a particular Asset.

• string $assetType The asset type, or the asset name, or the extension of the asset (e.g. 'com_content.article', 'com_menus.menu.2', 'com_contact').
• int $assetId The numeric asset id.

• array List of ancestor ids (includes original $assetId).

• 1.6

Method to retrieve the Asset Rule strings for this particular Asset Type and stores them for later usage in getAssetRules().

• string $assetType The asset type, or the asset name, or the extension of the asset (e.g. 'com_content.article', 'com_menus.menu.2', 'com_contact').
• bool $reload Reload the preloaded assets.

• void

• 1.6

Method to preload the Rules objects for all components.

• array Array of component names that were preloaded.

• 1.6

Method to check if a group is authorised to perform an action, optionally on an asset.

• int $groupId The path to the group for which to check authorisation.
• string $action The name of the action to authorise.
• int|string $assetKey The asset key (asset id or asset name). null fallback to root asset.
• bool $preload Indicates whether preloading should be used.

• bool True if authorised.

• 1.7.0

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).

• mixed $groupId An integer or array of integers representing the identities to check.

• mixed True if allowed, false for an explicit deny, null for an implicit deny.

• 1.7.0

Method to return the Rules 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.

• int|string $assetKey The asset key (asset id or asset name). null fallback to root asset.
• bool $recursive True to return the rules object with inherited rules.
• bool $recursiveParentAsset True to calculate the rule also based on inherited component/extension rules.
• bool $preload Indicates whether preloading should be used.

• \Joomla\CMS\Access\Rules Rules object for the asset.

• 1.7.0

• The non preloading code will be removed in 4.0. All asset rules should use asset preloading.

Method to clean the asset key to make sure we always have something.

• int|string $assetKey The asset key (asset id or asset name). null fallback to root asset.

• int|string Asset id or asset name.

• 3.7.0

Method to get the asset id from the asset key.

• int|string $assetKey The asset key (asset id or asset name).

• int The asset id.

• 3.7.0

Method to get the asset name from the asset key.

• int|string $assetKey The asset key (asset id or asset name).

• string The asset name (ex: com_content.article.8).

• 3.7.0

Method to get the extension name from the asset name.

• int|string $assetKey The asset key (asset id or asset name).

• string The extension name (ex: com_content).

• 1.6

Method to get the asset type from the asset name.

• int|string $assetKey The asset key (asset id or asset name).

• string The asset type (ex: com_content.article).

• 1.6

Method to return the title of a user group

• int $groupId Id of the group for which to get the title of.

• string The title of the group

• 3.5

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.

• int $userId Id of the user for which to get the list of groups.
• bool $recursive True to include inherited user groups.

• array List of user group ids to which the user is mapped.

• 1.7.0

Method to return a list of user Ids contained in a Group

• int $groupId The group Id
• bool $recursive Recursively include all child groups (optional)

• array

• 1.7.0

• This method should move somewhere else

Method to return a list of view levels for which the user is authorised.

• int $userId Id of the user for which to get the list of authorised view levels.

• array List of view levels for which the user is authorised.

• 1.7.0

Method to return a list of actions from a file for which permissions can be set.

• string $file The path to the XML file.
• string $xpath An optional xpath to search for the fields.

• bool|array False if case of error or the list of actions available.

• 3.0.0

Method to return a list of actions from a string or from an xml for which permissions can be set.

• string|\SimpleXMLElement $data The XML string or an XML element.
• string $xpath An optional xpath to search for the fields.

• bool|array False if case of error or the list of actions available.

• 3.0.0