Class UsersModelReset

Description

Rest model class for Users.

  • since: 1.5

Located in /components/com_users/models/reset.php (line 21)

JObject
   |
   --JModel
      |
      --JModelForm
         |
         --UsersModelReset
Method Summary
boolean checkResetLimit (JUser $user)
JForm getForm ([array $data = array()], [boolean $loadData = true])
JForm getResetCompleteForm ([array $data = array()], [boolean $loadData = true])
JForm getResetConfirmForm ([array $data = array()], [boolean $loadData = true])
void populateState ()
void preprocessForm (JForm $form, mixed $data, [ $group = 'user'])
void processResetComplete ( $data)
void processResetConfirm ( $data)
void processResetRequest ( $data)
Variables
Methods
checkResetLimit (line 408)

Method to check if user reset limit has been exceeded within the allowed time period.

  • return: true if user can do the reset, false if limit exceeded
  • since: 2.5
  • access: public
boolean checkResetLimit (JUser $user)
  • JUser $user: the user doing the password reset
getForm (line 31)

Method to get the password reset request form.

  • return: A JForm object on success, false on failure
  • since: 1.6
  • access: public
JForm getForm ([array $data = array()], [boolean $loadData = true])
  • array $data: Data for the form.
  • 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.
getResetCompleteForm (line 50)

Method to get the password reset complete form.

  • return: A JForm object on success, false on failure
  • since: 1.6
  • access: public
JForm getResetCompleteForm ([array $data = array()], [boolean $loadData = true])
  • array $data: Data for the form.
  • boolean $loadData: True if the form is to load its own data (default case), false if not.
getResetConfirmForm (line 69)

Method to get the password reset confirm form.

  • return: A JForm object on success, false on failure
  • since: 1.6
  • access: public
JForm getResetConfirmForm ([array $data = array()], [boolean $loadData = true])
  • array $data: Data for the form.
  • boolean $loadData: True if the form is to load its own data (default case), false if not.
populateState (line 100)

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

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

  • throws: Exception if there is an error in the form event.
  • since: 1.6
  • access: protected
void preprocessForm (JForm $form, mixed $data, [ $group = 'user'])
  • object A $form: form object.
  • mixed $data: The data expected for the form.
  • $group

Redefinition of:
JModelForm::preprocessForm()
Method to allow derived classes to preprocess the form.
processResetComplete (line 112)
  • since: 1.6
void processResetComplete ( $data)
  • $data
processResetConfirm (line 190)
  • since: 1.6
void processResetConfirm ( $data)
  • $data
processResetRequest (line 277)

Method to start the password reset process.

  • since: 1.6
  • access: public
void processResetRequest ( $data)
  • $data

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:59:11 -0500 by phpDocumentor 1.4.4