Difference between revisions of "JAccess::checkGroup"
From Joomla! Documentation
m (→User contributed notes: moving preparation) |
m (preparing for archive only) |
||
(2 intermediate revisions by the same user not shown) | |||
Line 4: | Line 4: | ||
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. | ||
− | + | ||
− | + | ||
− | |||
− | |||
<source lang="php"> | <source lang="php"> | ||
public static function checkGroup ( | public static function checkGroup ( | ||
Line 42: | Line 40: | ||
* '''Since''' {{JVer|11.1 }} | * '''Since''' {{JVer|11.1 }} | ||
* '''Referenced by''' | * '''Referenced by''' | ||
− | ** [[JFormFieldRules::getInput | + | ** [[API17:JFormFieldRules::getInput|JFormFieldRules::getInput]] |
− | ** [[JUser::save | + | ** [[API17:JUser::save|JUser::save]] |
− | ** [[JHtmlAccess::usergroups | + | ** [[API17:JHtmlAccess::usergroups|JHtmlAccess::usergroups]] |
===See also=== | ===See also=== | ||
* {{JVer|11.1}} '''JAccess::checkGroup source code''' on [[jplatform:access/access.php#cl-71|BitBucket]] | * {{JVer|11.1}} '''JAccess::checkGroup source code''' on [[jplatform:access/access.php#cl-71|BitBucket]] | ||
− | * {{JVer|11.1}} Class [[JAccess | + | * {{JVer|11.1}} Class [[API17:JAccess|JAccess]] |
− | * {{JVer|11.1}} Subpackage [[Subpackage_Access | + | * {{JVer|11.1}} Subpackage [[API17:Subpackage_Access|Access]] |
− | * [[JAccess::checkGroup|Other versions of JAccess::checkGroup]] | + | * [[API17:JAccess::checkGroup|Other versions of JAccess::checkGroup]] |
− | + | ||
− | + | ||
− | |||
− | |||
===User contributed notes=== | ===User contributed notes=== | ||
− | + | === Code Examples === | |
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=JAccess::checkGroup | category=JAccess::checkGroup | ||
− | + | namespace=CodeExample | |
category=MethodExample | category=MethodExample | ||
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::checkGroup[edit]
Description[edit]
Method to check if a group is authorised to perform an action, optionally on an asset.
public static function checkGroup (
$groupId
$action
$asset=null
)
Parameter | Type | Default | Description |
---|---|---|---|
$groupId | integer | The path to the group for which to check authorisation. | |
$action | string | The name of the action to authorise. | |
$asset | mixed | null | Integer asset id or the name of the asset as a string. Defaults to the global asset node. |
- Returns boolean True if authorised.
- Defined on line 79 of libraries/joomla/access/access.php
- Since
- Referenced by
See also[edit]
- JAccess::checkGroup source code on BitBucket
- Class JAccess
- Subpackage Access
- Other versions of JAccess::checkGroup
User contributed notes[edit]
Code Examples[edit]