Actions

API17

Difference between revisions of "JAccess"

From Joomla! Documentation

(Layout updates)
m (moving preparation)
 
(4 intermediate revisions by 2 users 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>
{{Description:JAccess}}
 
===Defined in===
 
libraries/joomla/access/access.php
 
* see source code in [[jplatform:access/access.php|BitBucket]]
 
===Subpackage===
 
[[Subpackage Access/11.1|Access]]
 
===Extends===
 
===Extended by===
 
 
===Methods===
 
===Methods===
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 +
!Visibility
 
!Method name
 
!Method name
 
!Description
 
!Description
 
|-
 
|-
|[[JAccess::check/11.1|check]]
+
|public static
 +
|[[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.  
 
|-
 
|-
|[[JAccess::checkGroup/11.1|checkGroup]]
+
|public static
 +
|[[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.  
 
|-
 
|-
|[[JAccess::getActions/11.1|getActions]]
+
|public static
 +
|[[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.  
 
|-
 
|-
|[[JAccess::getAssetRules/11.1|getAssetRules]]
+
|public static
 +
|[[API17:JAccess::getAssetRules|getAssetRules]]
 
|Method to return the  object for an asset.  
 
|Method to return the  object for an asset.  
 
|-
 
|-
|[[JAccess::getAuthorisedViewLevels/11.1|getAuthorisedViewLevels]]
+
|public static
 +
|[[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.  
 
|-
 
|-
|[[JAccess::getGroupsByUser/11.1|getGroupsByUser]]
+
|public static
 +
|[[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.  
 
|-
 
|-
|[[JAccess::getUsersByGroup/11.1|getUsersByGroup]]
+
|public static
 +
|[[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.  
 
|-
 
|-
|[[JAccess::getGroupPath/11.1|getGroupPath]]
+
|protected static
 +
|[[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).  
 
|-
 
|-
 
|}
 
|}
 +
* '''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 source code in [[jplatform:access/access.php|BitBucket]]
+
* {{JVer|11.1}} '''JAccess source code''' on [[jplatform:access/access.php|BitBucket]]
* [[JAccess|Other versions of this class]]
+
* {{JVer|11.1}} Subpackage [[API17:Subpackage Access|Access]]
 +
* [[API17: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>
===Examples===
+
===User contributed notes===
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 59: 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 11.1]][[Category:Archived pages API17]]</noinclude>

Latest revision as of 19:31, 11 May 2013

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Joomla 11.1 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

  • Joomla 11.1 JAccess source code on BitBucket
  • Joomla 11.1 Subpackage Access
  • Other versions of JAccess

SeeAlso:JAccess [Edit See Also]

User contributed notes

<CodeExamplesForm />