API17:JAccess::checkGroup
From Joomla! Documentation
(Difference between revisions)
(Bulk upload by Doxiki2) |
(Updated to r1448:247ba8d88526) |
||
| (One intermediate revision by one user not shown) | |||
| Line 8: | Line 8: | ||
<nowiki>[</nowiki>[[Description:JAccess::checkGroup|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JAccess::checkGroup|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
<source lang="php"> | <source lang="php"> | ||
| − | public static | + | public static function checkGroup ( |
| + | $groupId | ||
| + | $action | ||
| + | $asset=null | ||
| + | ) | ||
</source> | </source> | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 37: | Line 38: | ||
|- | |- | ||
|} | |} | ||
| − | + | * '''Returns''' boolean True if authorised. | |
| − | boolean True if authorised. | + | * '''Defined''' on line 79 of libraries/joomla/access/access.php |
| − | + | * '''Since''' {{JVer|11.1 }} | |
| − | libraries/joomla/access/access.php | + | * '''Referenced by''' |
| − | + | ** [[JFormFieldRules::getInput/11.1|JFormFieldRules::getInput]] | |
| − | * [[JFormFieldRules | + | ** [[JUser::save/11.1|JUser::save]] |
| − | * [[JUser | + | ** [[JHtmlAccess::usergroups/11.1|JHtmlAccess::usergroups]] |
| − | * [[JHtmlAccess | + | |
===See also=== | ===See also=== | ||
| + | * {{JVer|11.1}} '''JAccess::checkGroup source code''' on [[jplatform:access/access.php#cl-71|BitBucket]] | ||
| + | * {{JVer|11.1}} Class [[JAccess/11.1|JAccess]] | ||
| + | * {{JVer|11.1}} Subpackage [[Subpackage_Access/11.1|Access]] | ||
| + | * [[JAccess::checkGroup|Other versions of JAccess::checkGroup]] | ||
| + | {{SeeAlso:JAccess::checkGroup}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JAccess::checkGroup|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JAccess::checkGroup|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | + | ===User contributed notes=== | |
| − | + | ||
| − | + | ||
| − | === | + | |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 60: | Line 62: | ||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:JAccess]][[Category:JAccess::checkGroup]]</noinclude> | <noinclude>[[Category:JAccess]][[Category:JAccess::checkGroup]]</noinclude> | ||
Revision as of 20:07, 27 April 2011
JAccess::checkGroup
Description
Method to check if a group is authorised to perform an action, optionally on an asset.
Description:JAccess::checkGroup [Edit Descripton]
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
- JAccess::checkGroup source code on BitBucket
- Class JAccess
- Subpackage Access
- Other versions of JAccess::checkGroup
SeeAlso:JAccess::checkGroup [Edit See Also]
User contributed notes
<CodeExamplesForm />
