Référence de la classe PlgUserJoomla

Graphe d'héritage de PlgUserJoomla:

Fonctions membres publiques
	onContentPrepareForm ($form, $data)
	onUserAfterDelete ($user, $success, $msg)
	onUserAfterSave ($user, $isnew, $success, $msg)
	onUserLogin ($user, $options=array())
	onUserLogout ($user, $options=array())

Fonctions membres protégées
	_getUser ($user, $options=array())

Attributs protégés
	$app
	$db

Description détaillée

Joomla User plugin

Depuis

1.5

Documentation des fonctions membres

_getUser()

_getUser (   $user,   $options = array()  )

protected

This method will return a user object

If options['autoregister'] is true, if the user doesn't exist yet they will be created

Paramètres

array	$user	Holds the user data.
array	$options	Array holding options (remember, autoregister, group).

Renvoie

User

Depuis

1.5

Références $id, $options, $params, $user, et User\getInstance().

onContentPrepareForm()

onContentPrepareForm	(		$form,
			$data
	)

Set as required the passwords fields when mail to user is set to No

Paramètres

JForm	$form	The form to be altered.
mixed	$data	The associated data for the form.

Renvoie

boolean

Depuis

3.9.2

Références $data, $form, et $name.

onUserAfterDelete()

onUserAfterDelete	(		$user,
			$success,
			$msg
	)

Remove all sessions for the user name

Method is called after user data is deleted from the database

Paramètres

array	$user	Holds the user data
boolean	$success	True if user was successfully stored in the database
string	$msg	Message

Renvoie

boolean

Depuis

1.6

Références $query, et $user.

onUserAfterSave()

onUserAfterSave	(		$user,
			$isnew,
			$success,
			$msg
	)

Utility method to act on a user after it has been saved.

This method sends a registration email to new users created in the backend.

Paramètres

array	$user	Holds the new user data.
boolean	$isnew	True if a new user is stored.
boolean	$success	True if user was successfully stored in the database.
string	$msg	Message.

Renvoie

void

Depuis

1.6

Look for user language. Priority:

1. User frontend language
2. User backend language

Références $lang, $user, Factory\getLanguage(), Factory\getMailer(), JPATH_ADMINISTRATOR, et Uri\root().

onUserLogin()

onUserLogin	(		$user,
			$options = array()
	)

This method should handle any login logic and report back to the subject

Paramètres

array	$user	Holds the user data
array	$options	Array holding options (remember, autoregister, group)

Renvoie

boolean True on success

Depuis

1.5

Références $options, $query, $user, Factory\getSession(), et true.

onUserLogout()

onUserLogout	(		$user,
			$options = array()
	)

This method should handle any logout logic and report back to the subject

Paramètres

array	$user	Holds the user data.
array	$options	Array holding options (client, ...).

Renvoie

boolean True on success

Depuis

1.5

Références $clientId, $options, $user, Factory\getSession(), Factory\getUser(), et null.

Documentation des champs

$app

$app

protected

$db

$db

protected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• plugins/user/joomla/joomla.php