[ Index ]

PHP Cross Reference of Joomla 2.5.4 DE

title

Body

[close]

/administrator/components/com_finder/tables/ -> filter.php (summary)

(no description)

Copyright: Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
License: GNU General Public License version 2 or later; see LICENSE
File Size: 242 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

FinderTableFilter:: (5 methods):
  __construct()
  bind()
  check()
  publish()
  store()


Class: FinderTableFilter  - X-Ref

Filter table class for the Finder package.

__construct(&$db)   X-Ref
Constructor

param: object  &$db  JDatabase connector object.

bind($array, $ignore = '')   X-Ref
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.

param: array  $array   Named array
param: mixed  $ignore  An optional array or space separated list of properties
return: mixed  Null if operation was satisfactory, otherwise returns an error string

check()   X-Ref
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: boolean  True if the instance is sane and able to be stored in the database.

publish($pks = null, $state = 1, $userId = 0)   X-Ref
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.

param: mixed    $pks     An array of primary key values to update.  If not
param: integer  $state   The publishing state. eg. [0 = unpublished, 1 = published] [optional]
param: integer  $userId  The user id of the user performing the operation. [optional]
return: boolean  True on success.

store($updateNulls = false)   X-Ref
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.

param: boolean  $updateNulls  True to update fields even if they are null. [optional]
return: boolean  True on success.



Generated: Tue Apr 3 11:40:28 2012 Cross-referenced by PHPXref 0.7.1