Class UsersModelUser

Description

User model.

  • since: 1.6

Located in /administrator/components/com_users/models/user.php (line 23)

JObject
   |
   --JModel
      |
      --JModelForm
         |
         --JModelAdmin
            |
            --UsersModelUser
Direct descendents
Class Description
AdminModelProfile User model.
Method Summary
boolean activate (array &$pks)
boolean batch (array $commands, array $pks, array $contexts)
boolean batchUser (integer $group_id, array $user_ids, string $action)
boolean block (array &$pks, [integer $value = 1])
boolean delete (array &$pks)
array getAssignedGroups ([integer $userId = null])
mixed getForm ([array $data = array()], [boolean $loadData = true])
array getGroups ()
mixed getItem ([integer $pk = null])
JTable getTable ([string $type = 'User'], [string $prefix = 'JTable'], [array $config = array()])
mixed loadFormData ()
void preprocessForm (JForm $form, mixed $data, [string $group = 'user'])
boolean save (array $data)
Variables
Methods
activate (line 398)

Method to activate user records.

  • return: True on success.
  • since: 1.6
boolean activate (array &$pks)
  • array &$pks: The ids of the items to activate.
batch (line 487)

Method to perform batch operations on an item or a set of items.

  • return: Returns true on success, false on failure.
  • since: 2.5
  • access: public
boolean batch (array $commands, array $pks, array $contexts)
  • array $commands: An array of commands to perform.
  • array $pks: An array of item ids.
  • array $contexts: An array of item contexts.

Redefinition of:
JModelAdmin::batch()
Method to perform batch operations on an item or a set of items.
batchUser (line 541)

Perform batch operations

  • return: True on success, false on failure
  • since: 1.6
  • access: public
boolean batchUser (integer $group_id, array $user_ids, string $action)
  • integer $group_id: The group ID which assignments are being edited
  • array $user_ids: An array of user IDs on which to operate
  • string $action: The action to perform
block (line 287)

Method to block user records.

  • return: True on success.
  • since: 1.6
boolean block (array &$pks, [integer $value = 1])
  • array &$pks: The ids of the items to publish.
  • integer $value: The value of the published state
delete (line 211)

Method to delete rows.

  • return: Returns true on success, false on failure.
  • since: 1.6
  • access: public
boolean delete (array &$pks)
  • array &$pks: An array of item ids.

Redefinition of:
JModelAdmin::delete()
Method to delete one or more records.
getAssignedGroups (line 676)

Gets the groups this object is assigned to

  • return: An array of assigned groups
  • since: 1.6
  • access: public
array getAssignedGroups ([integer $userId = null])
  • integer $userId: The user ID to retrieve the groups for
getForm (line 76)

Method to get the record form.

  • return: A JForm object on success, false on failure
  • since: 1.6
  • access: public
mixed 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.

Redefined in descendants as:
getGroups (line 653)

Gets the available groups.

  • return: An array of groups
  • since: 1.6
  • access: public
array getGroups ()
getItem (line 52)

Method to get a single record.

  • return: Object on success, false on failure.
  • since: 1.6
  • access: public
mixed getItem ([integer $pk = null])
  • integer $pk: The id of the primary key.

Redefinition of:
JModelAdmin::getItem()
Method to get a single record.

Redefined in descendants as:
getTable (line 36)

Returns a reference to the a Table object, always creating it.

  • return: A database object
  • since: 1.6
  • access: public
JTable getTable ([string $type = 'User'], [string $prefix = 'JTable'], [array $config = array()])
  • string $type: The table type to instantiate
  • string $prefix: A prefix for the table class name. Optional.
  • array $config: Configuration array for model. Optional.

Redefinition of:
JModel::getTable()
Method to get a table object, load it if necessary.
loadFormData (line 98)

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.

Redefined in descendants as:
preprocessForm (line 137)

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

Method to save the form data.

  • return: True on success.
  • since: 1.6
  • access: public
boolean save (array $data)
  • array $data: The form data.

Redefinition of:
JModelAdmin::save()
Method to save the form data.

Redefined in descendants as:

Inherited Methods

Inherited From JModelAdmin

JModelAdmin::__construct()
JModelAdmin::batch()
JModelAdmin::batchAccess()
JModelAdmin::batchCopy()
JModelAdmin::batchLanguage()
JModelAdmin::batchMove()
JModelAdmin::canDelete()
JModelAdmin::canEditState()
JModelAdmin::checkin()
JModelAdmin::checkout()
JModelAdmin::delete()
JModelAdmin::generateNewTitle()
JModelAdmin::getItem()
JModelAdmin::getReorderConditions()
JModelAdmin::populateState()
JModelAdmin::prepareTable()
JModelAdmin::publish()
JModelAdmin::reorder()
JModelAdmin::save()
JModelAdmin::saveorder()

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 14:00:26 -0500 by phpDocumentor 1.4.4