Class FinderTableFilter

Description

Filter table class for the Finder package.

  • since: 2.5

Located in /administrator/components/com_finder/tables/filter.php (line 19)

JObject
   |
   --JTable
      |
      --FinderTableFilter
Method Summary
 FinderTableFilter __construct (JDatabaseDriver &$db)
 mixed bind (array $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 28)

Constructor

  • since: 2.5
  • access: public
FinderTableFilter __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 46)

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.

  • return: Null if operation was satisfactory, otherwise returns an error string
  • since: 2.5
  • access: public
mixed bind (array $array, [mixed $ignore = ''])
  • array $array: Named array
  • mixed $ignore: An optional array or space separated list of properties to ignore while binding. [optional]

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

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.

  • return: True if the instance is sane and able to be stored in the database.
  • since: 2.5
  • 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 108)

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: 2.5
  • access: public
boolean publish ([mixed $pks = null], [integer $state = 1], [integer $userId = 0])
  • mixed $pks: An array of primary key values to update. If not set the instance property value is used. [optional]
  • integer $state: The publishing state. eg. [0 = unpublished, 1 = published] [optional]
  • integer $userId: The user id of the user performing the operation. [optional]

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

Method to store a row in the database from the JTable instance properties.

If a primary key value is set the row with that primary key value will be updated with the instance property values. If no primary key value is set a new row will be inserted into the database with the properties from the JTable instance.

  • return: True on success.
  • since: 2.5
  • access: public
boolean store ([boolean $updateNulls = false])
  • boolean $updateNulls: True to update fields even if they are null. [optional]

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:03:16 +0100 by phpDocumentor 1.4.3