Class UsersModelLogin

Description

Rest model class for Users.

  • since: 1.6

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

JObject
   |
   --JModel
      |
      --JModelForm
         |
         --UsersModelLogin
Method Summary
JForm getForm ([array $data = array()], [boolean $loadData = true])
array loadFormData ()
void populateState ()
void preprocessForm (JForm $form, mixed $data, [string $group = 'user'])
Variables
Methods
getForm (line 33)

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 80)

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:
JModel::populateState()
Method to auto-populate the model state.
preprocessForm (line 98)

Method to allow derived classes to preprocess the form.

  • throws: Exception if there is an error in the form event.
  • since: 1.6
  • access: protected
void preprocessForm (JForm $form, mixed $data, [string $group = 'user'])
  • object A $form: form 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::preprocessForm()
JModelForm::validate()

Inherited From JModel

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

Inherited From JObject

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

Documentation generated on Mon, 25 Jun 2012 13:56:28 -0500 by phpDocumentor 1.4.4