Rest model class for Users.

• since: 1.6

Located in /components/com_users/models/login.php (line 19)

JObject
   |
   --JModelLegacy
      |
      --JModelForm
         |
         --UsersModelLogin

Inherited Variables

Inherited from JModelForm

JModelForm::$_forms

Inherited from JModelLegacy

JModelLegacy::$event_clean_cache
JModelLegacy::$name
JModelLegacy::$option
JModelLegacy::$state
JModelLegacy::$_db
JModelLegacy::$__state_set

Inherited from JObject

JObject::$_errors

getForm (line 32)

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.

• return: A JForm object on success, false on failure
• since: 1.6
• access: public

JForm getForm ([array $data = array()], [boolean $loadData = true])

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

---

Redefinition of:

JModelForm::getForm()

Abstract method for getting the form from the model.

loadFormData (line 50)

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

• return: The default data is an empty array.
• since: 1.6
• access: protected

array loadFormData ()

---

Redefinition of:

JModelForm::loadFormData()

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

populateState (line 85)

Method to auto-populate the model state.

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

• since: 1.6
• access: protected

void populateState ()

---

Redefinition of:

JModelLegacy::populateState()

Method to auto-populate the model state.

preprocessForm (line 106)

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

• since: 1.6
• throws: Exception if there is an error in the form event.
• access: protected

void preprocessForm (JForm $form, mixed $data, [string $group = 'user'])

• 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").

---

Redefinition of:

JModelForm::preprocessForm()

Method to allow derived classes to preprocess the form.

Inherited Methods

Inherited From JModelForm

JModelForm::checkin()
JModelForm::checkout()
JModelForm::getForm()
JModelForm::loadForm()
JModelForm::loadFormData()
JModelForm::preprocessData()
JModelForm::preprocessForm()
JModelForm::validate()

Inherited From JModelLegacy

JModelLegacy::__construct()
JModelLegacy::addIncludePath()
JModelLegacy::addTablePath()
JModelLegacy::cleanCache()
JModelLegacy::getDbo()
JModelLegacy::getInstance()
JModelLegacy::getName()
JModelLegacy::getState()
JModelLegacy::getTable()
JModelLegacy::loadHistory()
JModelLegacy::populateState()
JModelLegacy::setDbo()
JModelLegacy::setState()
JModelLegacy::_createFileName()
JModelLegacy::_createTable()
JModelLegacy::_getList()
JModelLegacy::_getListCount()

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::__toString()