API17:JAccess
From Joomla! Documentation
(Difference between revisions)
(Bulk upload by Doxiki2) |
m (→User contributed notes: bad link repair) |
||
| (2 intermediate revisions by one user not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| + | =={{JVer|11.1}} JAccess== | ||
| + | ===Description=== | ||
| + | {{Description:JAccess}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[Description:JAccess|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JAccess|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| + | !Visibility | ||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
| + | |public static | ||
|[[JAccess::check/11.1|check]] | |[[JAccess::check/11.1|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 | ||
|[[JAccess::checkGroup/11.1|checkGroup]] | |[[JAccess::checkGroup/11.1|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 | ||
|[[JAccess::getActions/11.1|getActions]] | |[[JAccess::getActions/11.1|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 | ||
|[[JAccess::getAssetRules/11.1|getAssetRules]] | |[[JAccess::getAssetRules/11.1|getAssetRules]] | ||
|Method to return the object for an asset. | |Method to return the object for an asset. | ||
|- | |- | ||
| + | |public static | ||
|[[JAccess::getAuthorisedViewLevels/11.1|getAuthorisedViewLevels]] | |[[JAccess::getAuthorisedViewLevels/11.1|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 | ||
|[[JAccess::getGroupsByUser/11.1|getGroupsByUser]] | |[[JAccess::getGroupsByUser/11.1|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 | ||
|[[JAccess::getUsersByGroup/11.1|getUsersByGroup]] | |[[JAccess::getUsersByGroup/11.1|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 | ||
|[[JAccess::getGroupPath/11.1|getGroupPath]] | |[[JAccess::getGroupPath/11.1|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). | ||
|- | |- | ||
|} | |} | ||
| + | * '''Defined in''' libraries/joomla/access/access.php | ||
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.access.access' );</source> | <source lang="php">jimport( 'joomla.access.access' );</source> | ||
===See also=== | ===See also=== | ||
| − | * [[JAccess|Other versions of | + | * {{JVer|11.1}} '''JAccess source code''' on [[jplatform:access/access.php|BitBucket]] |
| + | * {{JVer|11.1}} Subpackage [[Subpackage Access/11.1|Access]] | ||
| + | * [[JAccess|Other versions of JAccess]] | ||
{{SeeAlso:JAccess}} | {{SeeAlso:JAccess}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JAccess|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JAccess|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | === | + | ===User contributed notes=== |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 57: | Line 65: | ||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
| − | <noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JAccess]]</noinclude> | + | <noinclude>[[Category:Platform JClasses]][[Category:Platform 11.1]][[Category:JAccess]]</noinclude> |
Revision as of 13:27, 29 August 2012
JAccess
Description
Description:JAccess [Edit Descripton]
Methods
| 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
jimport( 'joomla.access.access' );
See also
- JAccess source code on BitBucket
- Subpackage Access
- Other versions of JAccess
SeeAlso:JAccess [Edit See Also]
User contributed notes
<CodeExamplesForm />
