API17

Difference between revisions of "JUser::getAuthorisedCategories"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
(Updated to r1448:247ba8d88526)
(One intermediate revision by the same user not shown)
Line 8: Line 8:
 
<nowiki>[</nowiki>[[Description:JUser::getAuthorisedCategories|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JUser::getAuthorisedCategories|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Since===
 
{{JVer|11.1 }}
 
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public JUser->getAuthorisedCategories ($component, $action)
+
public function getAuthorisedCategories (
 +
        $component
 +
        $action
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 32: Line 32:
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' array List of categories that this group can do this action to (empty array if none). Categories must be published.
array List of categories that this group can do this action to (empty array if none). Categories must be published.
+
* '''Defined''' on line 325 of libraries/joomla/user/user.php
===Defined in===
+
* '''Since''' {{JVer|11.1 }}
libraries/joomla/user/user.php
 
===Referenced by===
 
 
===See also===
 
===See also===
 +
* {{JVer|11.1}} '''JUser::getAuthorisedCategories source code''' on [[jplatform:user/user.php#cl-317|BitBucket]]
 +
* {{JVer|11.1}} Class [[JUser/11.1|JUser]]
 +
* {{JVer|11.1}} Subpackage [[Subpackage_User/11.1|User]]
 +
* [[JUser::getAuthorisedCategories|Other versions of JUser::getAuthorisedCategories]]
 +
{{SeeAlso:JUser::getAuthorisedCategories}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JUser::getAuthorisedCategories|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JUser::getAuthorisedCategories|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
* [[JUser/11.1|JUser]]
+
===User contributed notes===
* [[JUser::getAuthorisedCategories|Other versions of this method]]
 
{{SeeAlso:JUser::getAuthorisedCategories}}
 
===Examples===
 
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 52: Line 52:
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:JUser]][[Category:JUser::getAuthorisedCategories]]</noinclude>
 
<noinclude>[[Category:JUser]][[Category:JUser::getAuthorisedCategories]]</noinclude>

Revision as of 21:54, 27 April 2011

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.

Joomla 11.1 JUser::getAuthorisedCategories[edit]

Description[edit]

Method to return a list of all categories that a user has permission for a given action.

Template:Description:JUser::getAuthorisedCategories [Edit Descripton]

public function getAuthorisedCategories (
        $component
        $action
)
Parameter Type Default Description
$component string The component from which to retrieve the categories
$action string The name of the section within the component from which to retrieve the actions.
  • Returns array List of categories that this group can do this action to (empty array if none). Categories must be published.
  • Defined on line 325 of libraries/joomla/user/user.php
  • Since Joomla 11.1

See also[edit]

Template:SeeAlso:JUser::getAuthorisedCategories [Edit See Also]

User contributed notes[edit]

<CodeExamplesForm />