Référence de la classe RegistrationModel

Graphe d'héritage de RegistrationModel:

Fonctions membres publiques
	__construct ($config=array(), MVCFactoryInterface $factory=null, FormFactoryInterface $formFactory=null)
	getUserIdFromToken ($token)
	activate ($token)
	getData ()
	getForm ($data=array(), $loadData=true)
	register ($temp)
Fonctions membres publiques hérités de FormModel
	__construct ($config=array(), MVCFactoryInterface $factory=null, FormFactoryInterface $formFactory=null)
	checkin ($pk=null)
	checkout ($pk=null)
	validate ($form, $data, $group=null)
Fonctions membres publiques hérités de BaseDatabaseModel
	__construct ($config=array(), MVCFactoryInterface $factory=null)
	getTable ($name='', $prefix='', $options=array())
	isCheckedOut ($item)
	getDbo ()
	setDbo (DatabaseInterface $db=null)
	__get ($name)
Fonctions membres publiques hérités de BaseModel
	__construct ($config=array())
	getName ()
Fonctions membres publiques hérités de CMSObject
	__construct ($properties=null)
	__toString ()
	def ($property, $default=null)
	get ($property, $default=null)
	getProperties ($public=true)
	getError ($i=null, $toString=true)
	getErrors ()
	set ($property, $value=null)
	setProperties ($properties)
	setError ($error)
Fonctions membres publiques hérités de StatefulModelInterface
	getState ($property=null, $default=null)
	setState ($property, $value=null)
Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)
Fonctions membres publiques hérités de CurrentUserInterface
	setCurrentUser (User $currentUser)
Fonctions membres publiques hérités de CacheControllerFactoryAwareInterface
	setCacheControllerFactory (CacheControllerFactoryInterface $factory)
Fonctions membres publiques hérités de DatabaseAwareInterface
	setDatabase (DatabaseInterface $db)
Fonctions membres publiques hérités de FormFactoryAwareInterface
	setFormFactory (FormFactoryInterface $factory)

Fonctions membres protégées
	loadFormData ()
	preprocessForm (Form $form, $data, $group='user')
	populateState ()
Fonctions membres protégées hérités de BaseDatabaseModel
	_getList ($query, $limitstart=0, $limit=0)
	_getListCount ($query)
	_createTable ($name, $prefix='Table', $config=array())
	bootComponent ($component)
	dispatchEvent (EventInterface $event)

Attributs protégés
	$data
Attributs protégés hérités de FormModel
	$events_map = null
Attributs protégés hérités de BaseDatabaseModel
	$option = null
	$event_clean_cache = null
Attributs protégés hérités de BaseModel
	$name
Attributs protégés hérités de CMSObject
	$_errors = array()

Membres hérités additionnels
Fonctions membres publiques statiques hérités de BaseModel
static	addIncludePath ($path='', $prefix='')
Attributs protégés statiques hérités de BaseModel
static	$paths

Description détaillée

Registration model class for Users.

Depuis

1.6

Documentation des constructeurs et destructeur

__construct()

__construct	(		$config = array(),
		MVCFactoryInterface	$factory = null,
		FormFactoryInterface	$formFactory = null
	)

Constructor.

Paramètres

array	$config	An array of configuration options (name, state, dbo, table_path, ignore_request).
MVCFactoryInterface	$factory	The factory.
FormFactoryInterface	$formFactory	The form factory.

Voir également

Depuis

3.2

Références $config, et Symfony\Contracts\Service\__construct().

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 $app, $data, $db, $query, $return, $rows, $user, $userId, Text\_(), Log\add(), MailTemplate\addTemplateData(), Uri\base(), elseif, UserHelper\genRandomPassword(), Factory\getApplication(), Joomla\Database\getDatabase(), ApplicationHelper\getHash(), ComponentHelper\getParams(), Factory\getUser(), PluginHelper\importPlugin(), Route\link(), Text\sprintf(), Route\TLS_FORCE, Route\TLS_IGNORE, et Log\WARNING.

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

Exceptions

Références $app, $data, $form, $key, $params, $temp, $this, $val, elseif, Factory\getApplication(), ComponentHelper\getParams(), PluginHelper\importPlugin(), 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

Form A Form object on success, false on failure

Depuis

1.6

Implémente FormModelInterface.

Références $form, Multilanguage\isEnabled(), et Joomla\CMS\MVC\Model\loadForm().

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, $query, Joomla\Database\getDatabase(), et Text\sprintf().

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, Factory\getLanguage(), Multilanguage\isEnabled(), et Joomla\CMS\MVC\Model\preprocessData().

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

Exceptions

Références $app, $params, Factory\getApplication(), et Joomla\CMS\MVC\Model\setState().

preprocessForm()

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

protected

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

Paramètres

Form	$form	A Form 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

Références $data, $form, ComponentHelper\getParams(), et Joomla\CMS\MVC\Model\preprocessForm().

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

Exceptions

Références $app, $data, $db, $message, $params, $query, $return, $rows, $subject, $temp, $user, Text\_(), Log\add(), MailTemplate\addTemplateData(), elseif, PunycodeHelper\emailToPunycode(), UserHelper\genRandomPassword(), Factory\getApplication(), Joomla\Database\getDatabase(), ApplicationHelper\getHash(), ComponentHelper\getParams(), Factory\getUser(), PluginHelper\importPlugin(), ParameterType\INTEGER, Route\link(), Uri\root(), Text\sprintf(), Route\TLS_FORCE, Route\TLS_IGNORE, et Log\WARNING.

Documentation des champs

$data

$data

protected

---

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

• RegistrationModel.php