Class UsersModelGroup

Description

User group model.

  • since: 1.6

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

JObject
   |
   --JModelLegacy
      |
      --JModelForm
         |
         --JModelAdmin
            |
            --UsersModelGroup
Variable Summary
Method Summary
 boolean delete (array &$pks)
 JForm getForm ([array $data = array()], [boolean $loadData = true])
 JTable getTable ([type $type = 'Usergroup'], [string $prefix = 'JTable'], [array $config = array()])
 mixed loadFormData ()
 void preprocessForm (JForm $form, mixed $data, [ $groups = ''])
 boolean save (array $data)
Variables
string $event_after_save = 'onUserAfterSaveGroup' (line 25)
  • var: The event to trigger after saving the data.
  • since: 1.6
  • access: protected

Redefinition of:
JModelAdmin::$event_after_save
The event to trigger after saving the data.
string $event_before_save = 'onUserBeforeSaveGroup' (line 31)
  • var: The event to trigger after before the data.
  • since: 1.6
  • access: protected

Redefinition of:
JModelAdmin::$event_before_save
The event to trigger before saving the data.

Inherited Variables

Inherited from JModelAdmin

JModelAdmin::$event_after_delete
JModelAdmin::$event_before_delete
JModelAdmin::$event_change_state
JModelAdmin::$text_prefix

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
Methods
delete (line 199)

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.
getForm (line 56)

Method to get the record 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: 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.
getTable (line 42)

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

  • return: A database object
  • since: 1.6
  • access: public
JTable getTable ([type $type = 'Usergroup'], [string $prefix = 'JTable'], [array $config = array()])
  • type $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:
JModelLegacy::getTable()
Method to get a table object, load it if necessary.
loadFormData (line 74)

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.
preprocessForm (line 97)

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, [ $groups = ''])
  • object A $form: form object.
  • mixed $data: The data expected for the form.
  • $groups

Redefinition of:
JModelForm::preprocessForm()
Method to allow derived classes to preprocess the form.
save (line 115)

Method to save the form data.

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

Inherited Methods

Inherited From JModelAdmin

 JModelAdmin::__construct()
 JModelAdmin::batch()
 JModelAdmin::batchAccess()
 JModelAdmin::batchCopy()

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

Documentation generated on Tue, 19 Nov 2013 15:04:05 +0100 by phpDocumentor 1.4.3