Class MessagesTableMessage

Description

Message Table class

  • since: 1.5

Located in /administrator/components/com_messages/tables/message.php (line 20)

JObject
   |
   --JTable
      |
      --MessagesTableMessage
Method Summary
MessagesTableMessage __construct (database &$db)
boolean check ()
boolean publish ([mixed $pks = null], [integer $state = 1], [integer $userId = 0])
Variables
Methods
Constructor __construct (line 27)

Constructor

MessagesTableMessage __construct (database &$db)
  • database &$db: A database connector object

Redefinition of:
JTable::__construct()
Object constructor to set table and key fields. In most cases this will be overridden by child classes to explicitly set the table and key fields for a particular database table.
check (line 37)

Validation and filtering.

boolean check ()

Redefinition of:
JTable::check()
Method to perform sanity checks on the JTable instance properties to ensure they are safe to store in the database. Child classes should override this method to make sure the data they are storing in the database is safe and as expected before storage.
publish (line 77)

Method to set the publishing state for a row or list of rows in the database table. The method respects checked out rows by other users and will attempt to checkin rows that it can after adjustments are made.

  • return: True on success.
  • since: 1.6
  • access: public
boolean publish ([mixed $pks = null], [integer $state = 1], [integer $userId = 0])
  • mixed $pks: An optional array of primary key values to update. If not set the instance property value is used.
  • integer $state: The publishing state. eg. [0 = unpublished, 1 = published]
  • integer $userId: The user id of the user performing the operation.

Redefinition of:
JTable::publish()
Method to set the publishing state for a row or list of rows in the database table. The method respects checked out rows by other users and will attempt to checkin rows that it can after adjustments are made.

Inherited Methods

Inherited From JTable

JTable::__construct()
JTable::addIncludePath()
JTable::bind()
JTable::canDelete()
JTable::check()
JTable::checkIn()
JTable::checkOut()
JTable::delete()
JTable::getDbo()
JTable::getFields()
JTable::getInstance()
JTable::getKeyName()
JTable::getNextOrder()
JTable::getRules()
JTable::getTableName()
JTable::hit()
JTable::isCheckedOut()
JTable::load()
JTable::move()
JTable::publish()
JTable::reorder()
JTable::reset()
JTable::save()
JTable::setDBO()
JTable::setRules()
JTable::store()
JTable::toXML()
JTable::_getAssetName()
JTable::_getAssetParentId()
JTable::_getAssetTitle()
JTable::_lock()
JTable::_unlock()

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:57:18 -0500 by phpDocumentor 1.4.4