Référence de la classe UsersModelRegistration

Graphe d'héritage de UsersModelRegistration:

Fonctions membres publiques
	__construct ($config=array())
	getUserIdFromToken ($token)
	activate ($token)
	getData ()
	getForm ($data=array(), $loadData=true)
	register ($temp)

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

Attributs protégés
	$data

Description détaillée

Registration 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.6

Exceptions

Exception

Références $config.

Documentation des fonctions membres

activate()

activate

(

$token

)

Method to activate a user account.

Paramètres

string

$token

The activation token.

Renvoie

mixed False on failure, user object on success.

Depuis

1.6

Références $config, $data, $db, $query, $return, $row, $rows, $user, $userId, et elseif.

getData()

getData

(

)

Method to get the registration 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 $app, $data, $dispatcher, $form, $key, $params, $results, elseif, JEventDispatcher\getInstance(), et null.

getForm()

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

Method to get the registration 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.

getUserIdFromToken()

getUserIdFromToken

(

$token

)

Method to get the user ID from the given token

Paramètres

string

$token

The activation token.

Renvoie

mixed False on failure, id of the user on success

Depuis

3.8.13

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

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 $app, et $params.

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

Depuis

1.6

Exceptions

Exception

if there is an error in the form event.

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

register()

register

(

$temp

)

Method to save the form data.

Paramètres

array

$temp

The form data.

Renvoie

mixed The user id on success, false on failure.

Depuis

1.6

Références $config, $data, $db, $params, $query, $return, $row, $rows, $user, et elseif.

Documentation des champs

$data

$data

protected

---

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

• models/registration.php