Class BannersTableBanner

Description

Banner table

  • since: 1.5

Located in /administrator/components/com_banners/tables/banner.php (line 17)

JObject
   |
   --JTable
      |
      --BannersTableBanner
Method Summary
BannersTableBanner __construct ( &$_db)
null|string bind ( $array, [ $ignore = array()], array $hash)
boolean check ()
void clicks ()
boolean publish ([mixed $pks = null], [integer $state = 1], [integer $userId = 0])
boolean stick ([mixed $pks = null], [integer $state = 1], [integer $userId = 0])
void store ([boolean $updateNulls = false])
Variables
Methods
Constructor __construct (line 24)

Constructor

  • since: 1.5
BannersTableBanner __construct ( &$_db)
  • &$_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 84)

Overloaded bind function

  • return: null is operation was satisfactory, otherwise returns an error
  • see: JTable:bind
  • since: 1.5
  • access: public
null|string bind ( $array, [ $ignore = array()], array $hash)
  • array $hash: named array
  • $array
  • $ignore

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

Overloaded check function

  • see: JTable::check
  • since: 1.5
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.
clicks (line 31)
void clicks ()
publish (line 205)

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, 2=archived, -2=trashed]
  • 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.
stick (line 272)

Method to set the sticky 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 stick ([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 sticky state. eg. [0 = unsticked, 1 = sticked]
  • integer $userId: The user id of the user performing the operation.
store (line 122)

method to store a row

void store ([boolean $updateNulls = false])
  • boolean $updateNulls: True to update fields even if they are null.

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::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:52:33 -0500 by phpDocumentor 1.4.4