Référence de la classe LoginModel

Graphe d'héritage de LoginModel:

Fonctions membres publiques
	getForm ($data=array(), $loadData=true)
	getMenuLanguage (int $id)
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 ()
	populateState ()
	preprocessForm (Form $form, $data, $group='user')
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)

Membres hérités additionnels
Fonctions membres publiques statiques hérités de BaseModel
static	addIncludePath ($path='', $prefix='')
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()
Attributs protégés statiques hérités de BaseModel
static	$paths

Description détaillée

Login model class for Users.

Depuis

1.6

Documentation des fonctions membres

getForm()

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

Method to get the login 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, et Joomla\CMS\MVC\Model\loadForm().

getMenuLanguage()

getMenuLanguage

(

int

$id

)

Returns the language for the given menu id.

Paramètres

int

$id

The menu id

Renvoie

string

Depuis

4.2.0

Références $db, $id, $query, Joomla\Database\getDatabase(), ParameterType\INTEGER, et Multilanguage\isEnabled().

loadFormData()

loadFormData ( )

protected

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

Renvoie

array The default data is an empty array.

Depuis

1.6

Exceptions

Références $app, $data, $input, $return, Factory\getApplication(), Uri\isInternal(), et Joomla\CMS\MVC\Model\preprocessData().

populateState()

populateState ( )

protected

Method to auto-populate the model state.

Calling getState in this method will result in recursion.

Renvoie

void

Depuis

1.6

Exceptions

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

preprocessForm()

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

protected

Override Joomla::preprocessForm to ensure the correct plugin group is loaded.

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, et Joomla\CMS\MVC\Model\preprocessForm().

---

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

• components/com_users/src/Model/LoginModel.php