Actions

API17

Difference between revisions of "JAccess::checkGroup"

From Joomla! Documentation

(Layout updates)
m (moving preparation)
 
(3 intermediate revisions by 2 users 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>
===Since===
 
{{JVer|11.1 }}
 
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public static JAccess::checkGroup ($groupId, $action, $asset=null)
+
public static function checkGroup (
 +
        $groupId
 +
        $action
 +
        $asset=null
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 37: Line 38:
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' boolean True if authorised.
boolean True if authorised.
+
* '''Defined''' on line 79 of libraries/joomla/access/access.php
===Defined in===
+
* '''Since''' {{JVer|11.1 }}
libraries/joomla/access/access.php (line 79)
+
* '''Referenced by'''
* see source code in [[jplatform:access/access.php#cl-79|BitBucket]]
+
** [[API17:JFormFieldRules::getInput|JFormFieldRules::getInput]]
===Referenced by===
+
** [[API17:JUser::save|JUser::save]]
* [[JFormFieldRules::getInput/11.1|JFormFieldRules::getInput]]
+
** [[API17:JHtmlAccess::usergroups|JHtmlAccess::usergroups]]
* [[JUser::save/11.1|JUser::save]]
+
* [[JHtmlAccess::usergroups/11.1|JHtmlAccess::usergroups]]
+
 
===See also===
 
===See also===
 +
* {{JVer|11.1}} '''JAccess::checkGroup source code''' on [[jplatform:access/access.php#cl-71|BitBucket]]
 +
* {{JVer|11.1}} Class [[API17:JAccess|JAccess]]
 +
* {{JVer|11.1}} Subpackage [[API17:Subpackage_Access|Access]]
 +
* [[API17: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>
* [[JAccess/11.1|JAccess]]
+
===User contributed notes===
* [[JAccess::checkGroup|Other versions of this method]]
+
{{SeeAlso:JAccess::checkGroup}}
+
===Examples===
+
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 61: Line 62:
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
<noinclude>[[Category:JAccess]][[Category:JAccess::checkGroup]]</noinclude>
+
<noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude>

Latest revision as of 19:33, 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::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.

See also

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

SeeAlso:JAccess::checkGroup [Edit See Also]

User contributed notes

<CodeExamplesForm />