Difference between revisions of "JAccess"
From Joomla! Documentation
m (→User contributed notes: moving preparation) |
m (preparing for archive only) |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
=={{JVer|11.1}} JAccess== | =={{JVer|11.1}} JAccess== | ||
===Description=== | ===Description=== | ||
| − | + | ||
| − | + | ||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
| Line 14: | Line 12: | ||
|- | |- | ||
|public static | |public static | ||
| − | |[[JAccess::check | + | |[[API17:JAccess::check|check]] |
|Method to check if a user is authorised to perform an action, optionally on an asset. | |Method to check if a user is authorised to perform an action, optionally on an asset. | ||
|- | |- | ||
|public static | |public static | ||
| − | |[[JAccess::checkGroup | + | |[[API17:JAccess::checkGroup|checkGroup]] |
|Method to check if a group is authorised to perform an action, optionally on an asset. | |Method to check if a group is authorised to perform an action, optionally on an asset. | ||
|- | |- | ||
|public static | |public static | ||
| − | |[[JAccess::getActions | + | |[[API17:JAccess::getActions|getActions]] |
|Method to return a list of actions for which permissions can be set given a component and section. | |Method to return a list of actions for which permissions can be set given a component and section. | ||
|- | |- | ||
|public static | |public static | ||
| − | |[[JAccess::getAssetRules | + | |[[API17:JAccess::getAssetRules|getAssetRules]] |
|Method to return the object for an asset. | |Method to return the object for an asset. | ||
|- | |- | ||
|public static | |public static | ||
| − | |[[JAccess::getAuthorisedViewLevels | + | |[[API17:JAccess::getAuthorisedViewLevels|getAuthorisedViewLevels]] |
|Method to return a list of view levels for which the user is authorised. | |Method to return a list of view levels for which the user is authorised. | ||
|- | |- | ||
|public static | |public static | ||
| − | |[[JAccess::getGroupsByUser | + | |[[API17:JAccess::getGroupsByUser|getGroupsByUser]] |
|Method to return a list of user groups mapped to a user. | |Method to return a list of user groups mapped to a user. | ||
|- | |- | ||
|public static | |public static | ||
| − | |[[JAccess::getUsersByGroup | + | |[[API17:JAccess::getUsersByGroup|getUsersByGroup]] |
|Method to return a list of user Ids contained in a Group. | |Method to return a list of user Ids contained in a Group. | ||
|- | |- | ||
|protected static | |protected static | ||
| − | |[[JAccess::getGroupPath | + | |[[API17:JAccess::getGroupPath|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). | |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). | ||
|- | |- | ||
| Line 51: | Line 49: | ||
===See also=== | ===See also=== | ||
* {{JVer|11.1}} '''JAccess source code''' on [[jplatform:access/access.php|BitBucket]] | * {{JVer|11.1}} '''JAccess source code''' on [[jplatform:access/access.php|BitBucket]] | ||
| − | * {{JVer|11.1}} Subpackage [[Subpackage Access | + | * {{JVer|11.1}} Subpackage [[API17:Subpackage Access|Access]] |
| − | * [[JAccess|Other versions of JAccess]] | + | * [[API17:JAccess|Other versions of JAccess]] |
| − | + | ||
| − | + | ||
| − | |||
| − | |||
===User contributed notes=== | ===User contributed notes=== | ||
| − | + | === Code Examples === | |
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=JAccess | category=JAccess | ||
| − | + | namespace=CodeExample | |
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
Latest revision as of 21:18, 24 March 2017
The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
JAccess[edit]
Description[edit]
Methods[edit]
| Visibility | Method name | Description |
|---|---|---|
| public static | check | Method to check if a user is authorised to perform an action, optionally on an asset. |
| public static | checkGroup | Method to check if a group is authorised to perform an action, optionally on an asset. |
| public static | getActions | Method to return a list of actions for which permissions can be set given a component and section. |
| public static | getAssetRules | Method to return the object for an asset. |
| public static | getAuthorisedViewLevels | Method to return a list of view levels for which the user is authorised. |
| public static | getGroupsByUser | Method to return a list of user groups mapped to a user. |
| public static | getUsersByGroup | Method to return a list of user Ids contained in a Group. |
| protected static | 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). |
- Defined in libraries/joomla/access/access.php
Importing[edit]
jimport( 'joomla.access.access' );See also[edit]
- JAccess source code on BitBucket
- Subpackage Access
- Other versions of JAccess
User contributed notes[edit]
Code Examples[edit]