Accessing the current user object - Revision history

Robbiej: Added deprecation notice and link to Joomla Manual

2024-11-27T10:19:01Z

Added deprecation notice and link to Joomla Manual

← Older revision		Revision as of 10:19, 27 November 2024
Line 1:		Line 1:
			{{Warning\|This page has been superseded and is no longer maintained. Please go to [https://manual.joomla.org/docs/general-concepts/user/ Joomla Manual ] instead}}

	{{version/tutor\|2.5,3.x}}		{{version/tutor\|2.5,3.x}}
	== Overview ==		== Overview ==

Cmb: Several markup changes.

2022-12-15T00:39:23Z

Several markup changes.

Show changes

Robbiej: Another point re deleting users

2019-12-18T12:19:38Z

Another point re deleting users

← Older revision		Revision as of 12:19, 18 December 2019
Line 183:		Line 183:
	$user->delete();		$user->delete();
	</source>		</source>
	~~This~~ operation triggers the events [[Plugin/Events/User#onUserBeforeDelete\|onUserBeforeDelete]] and [[Plugin/Events/User#onUserAfterDelete\|onUserAfterDelete]] so that plugins can ~~deleted~~ any related user data. However, if the user has, for example, created articles or is associated with a contact record then the references to the user's id in those records will remain.		Related records in other user tables (such as in #__user_usergroup_map which holds the mapping to user groups and in #__messages which holds user-user messages) are deleted as well, and this operation triggers the events [[Plugin/Events/User#onUserBeforeDelete\|onUserBeforeDelete]] and [[Plugin/Events/User#onUserAfterDelete\|onUserAfterDelete]] so that plugins can also delete any related user data. However, if the user has, for example, created articles or is associated with a contact record then the references to the user's id in those records will remain.

	== Sample Module Code ==		== Sample Module Code ==

Robbiej: Included reference to plugins triggered and delete user not changing eg content, contact records.

2019-12-18T11:51:10Z

Included reference to plugins triggered and delete user not changing eg content, contact records.

← Older revision		Revision as of 11:51, 18 December 2019
Line 157:		Line 157:
	Note that the editing of user data is managed within the Joomla admin Users functionality (com_users component), where there are many checks performed to ensure that users can perform only operations which they are authorised to perform. For example, general users may not grant themselves additional privileges. '''If you use the User APIs then the vast majority of these validations are not performed, so you will likely have to build in additional validation checks yourself.'''		Note that the editing of user data is managed within the Joomla admin Users functionality (com_users component), where there are many checks performed to ensure that users can perform only operations which they are authorised to perform. For example, general users may not grant themselves additional privileges. '''If you use the User APIs then the vast majority of these validations are not performed, so you will likely have to build in additional validation checks yourself.'''

	The User class uses the Joomla Table class to perform CRUD operations at the database level.		The User class uses the Joomla Table class to perform CRUD operations at the database level. Operations which change the User record will cause [[Plugin/Events/User\|Plugin User Events]] to be raised.

	[[File:User_db.jpg\|User Database-related methods]]		[[File:User_db.jpg\|User Database-related methods]]
Line 183:		Line 183:
	$user->delete();		$user->delete();
	</source>		</source>
			This operation triggers the events [[Plugin/Events/User#onUserBeforeDelete\|onUserBeforeDelete]] and [[Plugin/Events/User#onUserAfterDelete\|onUserAfterDelete]] so that plugins can deleted any related user data. However, if the user has, for example, created articles or is associated with a contact record then the references to the user's id in those records will remain.

	== Sample Module Code ==		== Sample Module Code ==

Robbiej: Added link to API Guides

2019-12-13T17:04:34Z

Added link to API Guides

← Older revision		Revision as of 17:04, 13 December 2019
Line 1:		Line 1:
	{{version/tutor\|2.5,3.x}}		{{version/tutor\|2.5,3.x}}
	== Overview ==		== Overview ==
			This is one of a series of [[API Guides]], which aim to help you understand how to use the Joomla APIs through providing detailed explanations and sample code which you can easily install and run.

	This page describes the functionality associated with the Joomla <tt>User</tt> class, accessible via the <tt>User</tt> API. At the bottom of the page there is also the code of a module which you can install to demonstrate some of this functionality.		This page describes the functionality associated with the Joomla <tt>User</tt> class, accessible via the <tt>User</tt> API. At the bottom of the page there is also the code of a module which you can install to demonstrate some of this functionality.

Wilsonge: Add missing lang attributes

2019-10-27T22:08:40Z

Add missing lang attributes

← Older revision		Revision as of 22:08, 27 October 2019
Line 135:		Line 135:
	You call getAuthorisedCategories() passing in the component and the action you want to perform, and the method returns an array of category ids on which this user can perform the action. For example:		You call getAuthorisedCategories() passing in the component and the action you want to perform, and the method returns an array of category ids on which this user can perform the action. For example:

	<source>		<source lang="php">
	$user->getAuthorisedCategories('com_content', 'core.delete')		$user->getAuthorisedCategories('com_content', 'core.delete')
	</source>		</source>
Line 178:		Line 178:
	=== Deleting Records ===		=== Deleting Records ===
	To delete a user record you first load it from the database then use the <tt>delete()</tt> method:		To delete a user record you first load it from the database then use the <tt>delete()</tt> method:
	<source>		<source lang="php">
	$user = Factory::getUser($userid);		$user = Factory::getUser($userid);
	$user->delete();		$user->delete();

Robbiej: some typos fixed

2019-08-27T10:02:49Z

some typos fixed

← Older revision		Revision as of 10:02, 27 August 2019
Line 29:		Line 29:
	If no user is logged on then Factory::getUser() returns a "blank" user object, with the id field set to 0 (zero).		If no user is logged on then Factory::getUser() returns a "blank" user object, with the id field set to 0 (zero).

	To get information about any other registered user you can call the function with a user 'id' or username, e.g. for user with id 99;		To get information about any other registered user you can call the function with a user <tt>id</tt> or <tt>username</tt>, e.g. for user with <tt>id</tt> 99;

	<source lang="php">		<source lang="php">
Line 47:		Line 47:
	With regard to the admin Users functionality, generally the data items in the fixed fields are in the first tab in the admin Users / Edit form (currently named "Account Details"), and the attributes stored in the params are visible in a subsidiary tab (currently named "Basic Settings").		With regard to the admin Users functionality, generally the data items in the fixed fields are in the first tab in the admin Users / Edit form (currently named "Account Details"), and the attributes stored in the params are visible in a subsidiary tab (currently named "Basic Settings").

	These are the ~~relevant~~ properties automatically generated on a call to getUser(), in the order defined in the API		These are the properties automatically generated on a call to getUser(), in the order defined in the API documentation
	* id - The unique, numerical user id. ~~Use~~ this ~~when referencing~~ the user record ~~in other database tables~~.		* id - The unique, numerical user id. (In other Joomla database tables this id is used as the foreign key to point to the associated user record).
	* name - The name of the user. (e.g. Vint Cerf)		* name - The name of the user. (e.g. Vint Cerf)
	* username - The login/screen name of the user. (e.g. shmuffin1979)		* username - The login/screen name of the user. (e.g. shmuffin1979)
Line 67:		Line 67:

	The user attributes which are stored in the params field in the database, and which are available via <tt>$user->getParam()</tt> are the following.		The user attributes which are stored in the params field in the database, and which are available via <tt>$user->getParam()</tt> are the following.
	admin_style – the id of the template on the back end.		* admin_style – the id of the template on the back end.
	admin_language – the language tag of the language on the back end		* admin_language – the language tag of the language on the back end
	language – the language tag of the language on the front end		* language – the language tag of the language on the front end
	editor – the preferred editor		* editor – the preferred editor
	timezone – the user's selected timezone (~~ohe~~ of the standard PHP timezones). The timezone is also available via <tt>getTimezone()</tt>.		* timezone – the user's selected timezone (one of the standard PHP timezones). The timezone is also available via <tt>getTimezone()</tt>.

	For example, to get the user's preferred front-end language call the <tt>getParam()</tt> member function of the user object, passing in the name of the parameter you want (ie 'language') along with a default value in case it is blank.		For example, to get the user's preferred front-end language call the <tt>getParam()</tt> member function of the user object, passing in the name of the parameter you want (ie 'language') along with a default value in case it is blank.
Line 88:		Line 88:

	<source lang="php">		<source lang="php">
	$user = JFactory::getUser();		$user = JFactory::getUser();

	if ($user->guest) {		if ($user->guest) {
	echo "<p>You must login to see the content. I want your email address.</p>";		echo "<p>You must login to see the content. I want your email address.</p>";
	} else {		} else {
	echo "<p>You are logged in, you can see the content.</p>";		echo "<p>You are logged in, you can see the content.</p>";
	}		}
	</source>		</source>

Line 258:		Line 258:
	$option = $input->get('option', "", "cmd");		$option = $input->get('option', "", "cmd");
	$view = $input->get('view', "", "string");		$view = $input->get('view', "", "string");
	$id = $input->get('id', "", "int");		$id = $input->get('id', 0, "int");

	if ($option == "com_content" && $view == "article")		if ($option == "com_content" && $view == "article")

Robbiej: check for content language

2019-08-26T21:21:51Z

check for content language

← Older revision		Revision as of 21:21, 26 August 2019
Line 284:		Line 284:
	When you visit a site web page then you should see the module in your selected position. The module does the following:		When you visit a site web page then you should see the module in your selected position. The module does the following:
	* gets the user object, and displays the user's name, email address and preferred front-end language. You define the user to select by either logging in, or by specifying a parameter to the URL <tt>username=XXX</tt> (replacing XXX by a valid username on the system).		* gets the user object, and displays the user's name, email address and preferred front-end language. You define the user to select by either logging in, or by specifying a parameter to the URL <tt>username=XXX</tt> (replacing XXX by a valid username on the system).
	* if you specify a URL parameter eg <tt>userlanguage=es-ES</tt> the code will set this language (Peninsular Spanish in this instance) as the preferred front-end language of the user.		* if you specify a URL parameter eg <tt>userlanguage=es-ES</tt> the code will set this language (Peninsular Spanish in this instance) as the preferred front-end language of the user (provided this language is installed on the system as a Content Language).
	* if you navigate to a page which displays a single article, then the code will output whether this user may edit that article or not.		* if you navigate to a page which displays a single article, then the code will output whether this user may edit that article or not.

Robbiej: Added database operations and sample module code

2019-08-26T21:19:58Z

Added database operations and sample module code

Show changes

Robbiej: Several items updated/added

2019-08-26T20:47:37Z

Several items updated/added

Show changes