Référence de la classe UsersModelProfile

Graphe d'héritage de UsersModelProfile:

Fonctions membres publiques
	__construct ($config=array())
	checkin ($userId=null)
	checkout ($userId=null)
	getData ()
	getForm ($data=array(), $loadData=true)
	save ($data)
	getTwofactorform ($userId=null)
	getOtpConfig ($userId=null)

Fonctions membres protégées
	loadFormData ()
	preprocessForm (JForm $form, $data, $group='user')
	populateState ()

Attributs protégés
	$data

Description détaillée

Profile model class for Users.

Depuis

1.6

Documentation des constructeurs et destructeur

__construct()

__construct

(

$config = array()

)

Constructor

Paramètres

array

$config

An array of configuration options (name, state, dbo, table_path, ignore_request).

Depuis

3.2

Exceptions

Exception

Références $config, JPATH_ADMINISTRATOR, et JLoader\register().

Documentation des fonctions membres

checkin()

checkin

(

$userId = null

)

Method to check in a user.

Paramètres

integer

$userId

The id of the row to check out.

Renvoie

boolean True on success, false on failure.

Depuis

1.6

Références $userId.

checkout()

checkout

(

$userId = null

)

Method to check out a user for editing.

Paramètres

integer

$userId

The id of the row to check out.

Renvoie

boolean True on success, false on failure.

Depuis

1.6

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

getData()

getData

(

)

Method to get the profile form data.

The base form data is loaded and then an event is fired for users plugins to extend the data.

Renvoie

mixed Data object on success, false on failure.

Depuis

1.6

Références $data, $userId, et null.

getForm()

getForm	(		$data = array(),
			$loadData = true
	)

Method to get the profile form.

The base form is loaded from XML and then an event is fired for users plugins to extend the form with extra fields.

Paramètres

array	$data	An optional array of data for the form to interrogate.
boolean	$loadData	True if the form is to load its own data (default case), false if not.

Renvoie

JForm A JForm object on success, false on failure

Depuis

1.6

Références $form.

getOtpConfig()

getOtpConfig

(

$userId = null

)

Returns the one time password (OTP) – a.k.a. two factor authentication – configuration for a particular user.

Paramètres

integer

$userId

The numeric ID of the user

Renvoie

stdClass An object holding the OTP configuration for this user

Depuis

3.2

Références $userId, et UsersModelUser\getOtpConfig().

getTwofactorform()

getTwofactorform

(

$userId = null

)

Gets the configuration forms for all two-factor authentication methods in an array.

Paramètres

integer

$userId

The user ID to load the forms for (optional)

Renvoie

array

Depuis

3.2

Références $userId, FOFPlatform\getInstance(), et UsersModelUser\getOtpConfig().

loadFormData()

loadFormData ( )

protected

Method to get the data that should be injected in the form.

Renvoie

mixed The data for the form.

Depuis

1.6

Références $data.

populateState()

populateState ( )

protected

Method to auto-populate the model state.

Note. Calling getState in this method will result in recursion.

Renvoie

void

Depuis

1.6

Références $params, et $userId.

preprocessForm()

preprocessForm ( JForm  $form,   $data,   $group = 'user'  )

protected

Override preprocessForm to load the user plugin group instead of content.

Paramètres

JForm	$form	A JForm object.
mixed	$data	The data expected for the form.
string	$group	The name of the plugin group to import (defaults to "content").

Renvoie

void

Exceptions

Exception

if there is an error in the form event.

Depuis

1.6

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

save()

save

(

$data

)

Method to save the form data.

Paramètres

array

$data

The form data.

Renvoie

mixed The user id on success, false on failure.

Depuis

1.6

Références $data, $user, $userId, et FOFPlatform\getInstance().

Documentation des champs

$data

$data

protected

---

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

• components/com_users/models/profile.php