Class UsersModelNote

Description

User note model.

  • since: 2.5

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

JObject
   |
   --JModelLegacy
      |
      --JModelForm
         |
         --JModelAdmin
            |
            --UsersModelNote
Variable Summary
 string $typeAlias
Method Summary
 mixed getForm ([array $data = array()], [boolean $loadData = true])
 mixed getItem ([integer $pk = null])
 JTable getTable ([string $name = 'Note'], [string $prefix = 'UsersTable'], [array $options = array()])
 mixed loadFormData ()
 void populateState ()
Variables
Methods
getForm (line 40)

Method to get the record form.

  • return: A JForm object on success, false on failure
  • since: 2.5
  • access: public
mixed 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.
getItem (line 61)

Method to get a single record.

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

Method to get a table object, load it if necessary.

  • return: The table object
  • since: 2.5
  • access: public
JTable getTable ([string $name = 'Note'], [string $prefix = 'UsersTable'], [array $options = array()])
  • string $name: The table name. Optional.
  • string $prefix: The class prefix. Optional.
  • array $options: Configuration array for model. Optional.

Redefinition of:
JModelLegacy::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.
populateState (line 138)

Method to auto-populate the model state.

Note. Calling getState in this method will result in recursion.

  • since: 2.5
  • access: protected
void populateState ()

Redefinition of:
JModelLegacy::populateState()
Method to auto-populate the model state.

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:09:37 +0100 by phpDocumentor 1.4.3