Class UsersModelProfile

Description

Profile model class for Users.

  • since: 1.6

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

JObject
   |
   --JModel
      |
      --JModelForm
         |
         --UsersModelProfile
Variable Summary
object The $data
Method Summary
boolean checkin ([integer $userId = null])
boolean checkout ([integer $userId = null])
mixed getData ()
JForm getForm ([array $data = array()], [boolean $loadData = true])
mixed loadFormData ()
void populateState ()
void preprocessForm (JForm $form, mixed $data, [ $group = 'user'])
mixed save (array $data)
Variables
object The $data (line 27)
  • var: user profile data.
  • since: 1.6
  • access: protected

Inherited Variables

Inherited from JModelForm

JModelForm::$_forms

Inherited from JModel

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

Inherited from JObject

JObject::$_errors
Methods
checkin (line 36)

Method to check in a user.

  • return: True on success, false on failure.
  • since: 1.6
  • access: public
boolean checkin ([integer $userId = null])
  • integer $userId: The id of the row to check out.

Redefinition of:
JModelForm::checkin()
Method to checkin a row.
checkout (line 62)

Method to check out a user for editing.

  • return: True on success, false on failure.
  • since: 1.6
  • access: public
boolean checkout ([integer $userId = null])
  • integer $userId: The id of the row to check out.

Redefinition of:
JModelForm::checkout()
Method to check-out a row for editing.
getData (line 93)

Method to get the profile form data.

The base form data is loaded and then an event is fired for users plugins to extend the data.

  • return: Data object on success, false on failure.
  • since: 1.6
  • access: public
mixed getData ()
getForm (line 147)

Method to get the profile 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 174)

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

  • return: The data for the form.
  • since: 1.6
  • access: protected
mixed loadFormData ()

Redefinition of:
JModelForm::loadFormData()
Method to get the data that should be injected in the form.
populateState (line 206)

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

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.
save (line 229)

Method to save the form data.

  • return: The user id on success, false on failure.
  • since: 1.6
  • access: public
mixed save (array $data)
  • array $data: The form 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:58:53 -0500 by phpDocumentor 1.4.4