Private Message model.

• since: 1.6

Located in /administrator/components/com_messages/models/message.php (line 19)

JObject
   |
   --JModelLegacy
      |
      --JModelForm
         |
         --JModelAdmin
            |
            --MessagesModelMessage

mixed $item (line 24)

message

• access: protected

Inherited Variables

Inherited from JModelAdmin

JModelAdmin::$event_after_delete
JModelAdmin::$event_after_save
JModelAdmin::$event_before_delete
JModelAdmin::$event_before_save
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

delete (line 58)

Check that recipient user is the one trying to delete and then call parent delete method

• return: True if successful, false if an error occurs.
• since: 3.1
• access: public

boolean delete (array &$pks)

• array &$pks: An array of record primary keys.

getForm (line 177)

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: 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 107)

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.

getTable (line 95)

Returns a Table object, always creating it.

• return: A database object
• since: 1.6
• access: public

JTable getTable ([type $type = 'Message'], [string $prefix = 'MessagesTable'], [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 195)

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

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:

JModelLegacy::populateState()

Method to auto-populate the model state.

publish (line 220)

Checks that the current user matches the message recipient and calls the parent publish method

• return: True on success.
• since: 3.1
• access: public

boolean publish (array &$pks, [integer $value = 1])

• array &$pks: A list of the primary keys to change.
• integer $value: The value of the published state.

save (line 254)

Method to save the form data.

• return: True on success.
• 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()