Actions

API17

Difference between revisions of "JUser"

From Joomla! Documentation

(Layout updates)
(Updated to r1448:247ba8d88526)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
=={{JVer|11.1}} JUser==
 +
===Description===
 +
{{Description:JUser}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[Description:JUser|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JUser|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
{{Description:JUser}}
 
===Defined in===
 
libraries/joomla/user/user.php
 
* see source code in [[jplatform:user/user.php|BitBucket]]
 
===Subpackage===
 
[[Subpackage User/11.1|User]]
 
===Extends===
 
[[JObject/11.1|JObject]]
 
===Extended by===
 
 
===Methods===
 
===Methods===
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 +
!Visibility
 
!Method name
 
!Method name
 
!Description
 
!Description
 
|-
 
|-
 +
|public
 
|[[JUser::__construct/11.1|__construct]]
 
|[[JUser::__construct/11.1|__construct]]
 
|Constructor activating the default information of the language.  
 
|Constructor activating the default information of the language.  
 
|-
 
|-
 +
|public
 
|[[JUser::authorise/11.1|authorise]]
 
|[[JUser::authorise/11.1|authorise]]
 
|Method to check  object authorisation against an access control object and optionally an access extension object.  
 
|Method to check  object authorisation against an access control object and optionally an access extension object.  
 
|-
 
|-
 +
|public
 
|[[JUser::authorisedLevels/11.1|authorisedLevels]]
 
|[[JUser::authorisedLevels/11.1|authorisedLevels]]
 
|
 
|
 
|-
 
|-
 +
|public
 
|[[JUser::authorize/11.1|authorize]]
 
|[[JUser::authorize/11.1|authorize]]
 
|
 
|
 
|-
 
|-
 +
|public
 
|[[JUser::bind/11.1|bind]]
 
|[[JUser::bind/11.1|bind]]
 
|Method to bind an associative array of data to a user object.  
 
|Method to bind an associative array of data to a user object.  
 
|-
 
|-
 +
|public
 
|[[JUser::defParam/11.1|defParam]]
 
|[[JUser::defParam/11.1|defParam]]
 
|Method to set a default parameter if it does not exist.  
 
|Method to set a default parameter if it does not exist.  
 
|-
 
|-
 +
|public
 
|[[JUser::delete/11.1|delete]]
 
|[[JUser::delete/11.1|delete]]
 
|Method to delete the  object from the database.  
 
|Method to delete the  object from the database.  
 
|-
 
|-
 +
|public
 
|[[JUser::getAuthorisedCategories/11.1|getAuthorisedCategories]]
 
|[[JUser::getAuthorisedCategories/11.1|getAuthorisedCategories]]
 
|Method to return a list of all categories that a user has permission for a given action.  
 
|Method to return a list of all categories that a user has permission for a given action.  
 
|-
 
|-
 +
|public
 
|[[JUser::getAuthorisedGroups/11.1|getAuthorisedGroups]]
 
|[[JUser::getAuthorisedGroups/11.1|getAuthorisedGroups]]
 
|Gets an array of the authorised user groups.  
 
|Gets an array of the authorised user groups.  
 
|-
 
|-
 +
|public
 
|[[JUser::getAuthorisedViewLevels/11.1|getAuthorisedViewLevels]]
 
|[[JUser::getAuthorisedViewLevels/11.1|getAuthorisedViewLevels]]
 
|Gets an array of the authorised access levels for the user.  
 
|Gets an array of the authorised access levels for the user.  
 
|-
 
|-
 +
|public
 
|[[JUser::getParam/11.1|getParam]]
 
|[[JUser::getParam/11.1|getParam]]
 
|Method to get a parameter value.  
 
|Method to get a parameter value.  
 
|-
 
|-
 +
|public
 
|[[JUser::getParameters/11.1|getParameters]]
 
|[[JUser::getParameters/11.1|getParameters]]
 
|Method to get the user parameters.  
 
|Method to get the user parameters.  
 
|-
 
|-
 +
|public
 
|[[JUser::load/11.1|load]]
 
|[[JUser::load/11.1|load]]
 
|Method to load a  object by user id number.  
 
|Method to load a  object by user id number.  
 
|-
 
|-
 +
|public
 
|[[JUser::save/11.1|save]]
 
|[[JUser::save/11.1|save]]
 
|Method to save the  object to the database.  
 
|Method to save the  object to the database.  
 
|-
 
|-
 +
|public
 
|[[JUser::setLastVisit/11.1|setLastVisit]]
 
|[[JUser::setLastVisit/11.1|setLastVisit]]
 
|Pass through method to the table for setting the last visit date.  
 
|Pass through method to the table for setting the last visit date.  
 
|-
 
|-
 +
|public
 
|[[JUser::setParam/11.1|setParam]]
 
|[[JUser::setParam/11.1|setParam]]
 
|Method to set a parameter.  
 
|Method to set a parameter.  
 
|-
 
|-
 +
|public
 
|[[JUser::setParameters/11.1|setParameters]]
 
|[[JUser::setParameters/11.1|setParameters]]
 
|Method to get the user parameters.  
 
|Method to get the user parameters.  
 
|-
 
|-
 +
|public static
 
|[[JUser::getInstance/11.1|getInstance]]
 
|[[JUser::getInstance/11.1|getInstance]]
 
|Returns the global User object, only creating it if it doesn't already exist.  
 
|Returns the global User object, only creating it if it doesn't already exist.  
 
|-
 
|-
 +
|public static
 
|[[JUser::getTable/11.1|getTable]]
 
|[[JUser::getTable/11.1|getTable]]
 
|Method to get the user table object.  
 
|Method to get the user table object.  
 
|-
 
|-
 
|}
 
|}
 +
* '''Defined in''' libraries/joomla/user/user.php
 +
* '''Extends''' [[JObject/11.1|JObject]]
 
===Importing===
 
===Importing===
 
<source lang="php">jimport( 'joomla.user.user' );</source>
 
<source lang="php">jimport( 'joomla.user.user' );</source>
 
===See also===
 
===See also===
* JUser source code in [[jplatform:user/user.php|BitBucket]]
+
* {{JVer|11.1}} '''JUser source code''' on [[jplatform:user/user.php|BitBucket]]
* [[JUser|Other versions of this class]]
+
* {{JVer|11.1}} Subpackage [[Subpackage User/11.1|User]]
 +
* [[JUser|Other versions of JUser]]
 
{{SeeAlso:JUser}}
 
{{SeeAlso:JUser}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JUser|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JUser|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Examples===
+
===User contributed notes===
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 93: Line 110:
 
category=ClassExample
 
category=ClassExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JUser]]</noinclude>
 
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JUser]]</noinclude>

Revision as of 17:10, 27 April 2011

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 JUser

Description

Description:JUser [Edit Descripton]

Methods

Visibility Method name Description
public __construct Constructor activating the default information of the language.
public authorise Method to check object authorisation against an access control object and optionally an access extension object.
public authorisedLevels
public authorize
public bind Method to bind an associative array of data to a user object.
public defParam Method to set a default parameter if it does not exist.
public delete Method to delete the object from the database.
public getAuthorisedCategories Method to return a list of all categories that a user has permission for a given action.
public getAuthorisedGroups Gets an array of the authorised user groups.
public getAuthorisedViewLevels Gets an array of the authorised access levels for the user.
public getParam Method to get a parameter value.
public getParameters Method to get the user parameters.
public load Method to load a object by user id number.
public save Method to save the object to the database.
public setLastVisit Pass through method to the table for setting the last visit date.
public setParam Method to set a parameter.
public setParameters Method to get the user parameters.
public static getInstance Returns the global User object, only creating it if it doesn't already exist.
public static getTable Method to get the user table object.
  • Defined in libraries/joomla/user/user.php
  • Extends JObject

Importing

jimport( 'joomla.user.user' );

See also

SeeAlso:JUser [Edit See Also]

User contributed notes

<CodeExamplesForm />