Class WeblinksTableWeblink

Description

Weblink Table class

  • since: 1.5

Located in /administrator/components/com_weblinks/tables/weblink.php (line 19)

JObject
   |
   --JTable
      |
      --WeblinksTableWeblink
Method Summary
 WeblinksTableWeblink __construct (JDatabaseDriver &$db)
 boolean bind (mixed $array, [mixed $ignore = ''])
 boolean check ()
 boolean publish ([mixed $pks = null], [integer $state = 1], [integer $userId = 0])
 boolean store ([boolean $updateNulls = false])
Variables
Methods
Constructor __construct (line 26)

Constructor

  • access: public
WeblinksTableWeblink __construct (JDatabaseDriver &$db)

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.
bind (line 42)

Overloaded bind function to pre-process the params.

  • return: True on success.
  • see: JTable:bind
  • since: 1.5
  • access: public
boolean bind (mixed $array, [mixed $ignore = ''])
  • mixed $array: An associative array or object to bind to the JTable instance.
  • mixed $ignore: An optional array or space separated list of properties to ignore while binding.

Redefinition of:
JTable::bind()
Method to bind an associative array or object to the JTable instance.This method only binds properties that are publicly accessible and optionally takes an array of properties to ignore when binding.
check (line 132)

Overloaded check method to ensure data integrity.

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

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.0.4
  • 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.
store (line 75)

Overload the store method for the Weblinks table.

  • return: True on success, false on failure.
  • since: 1.6
  • access: public
boolean store ([boolean $updateNulls = false])
  • boolean $updateNulls: Toggle whether null values should be updated.

Redefinition of:
JTable::store()
Method to store a row in the database from the JTable instance properties.

Inherited Methods

Inherited From JTable

 JTable::__construct()
 JTable::addIncludePath()
 JTable::appendPrimaryKeys()
 JTable::attachObserver()
 JTable::bind()
 JTable::check()
 JTable::checkIn()
 JTable::checkOut()
 JTable::delete()
 JTable::getDbo()
 JTable::getFields()
 JTable::getInstance()
 JTable::getKeyName()
 JTable::getNextOrder()
 JTable::getObserverOfClass()
 JTable::getPrimaryKey()
 JTable::getRules()
 JTable::getTableName()
 JTable::hasPrimaryKey()
 JTable::hit()
 JTable::isCheckedOut()
 JTable::load()
 JTable::move()
 JTable::publish()
 JTable::reorder()
 JTable::reset()
 JTable::save()
 JTable::setDBO()
 JTable::setRules()
 JTable::store()
 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()

Documentation generated on Tue, 19 Nov 2013 15:18:28 +0100 by phpDocumentor 1.4.3