Référence de la classe FinderTableFilter

Graphe d'héritage de FinderTableFilter:

Fonctions membres publiques
	__construct (&$db)
	bind ($array, $ignore='')
	check ()
	publish ($pks=null, $state=1, $userId=0)
	store ($updateNulls=false)

Description détaillée

Filter table class for the Finder package.

Depuis

2.5

Documentation des constructeurs et destructeur

__construct()

__construct

(

&

$db

)

Constructor

Paramètres

JDatabaseDriver

$db

JDatabaseDriver connector object.

Depuis

2.5

Références $db.

Documentation des fonctions membres

bind()

bind	(		$array,
			$ignore = ''
	)

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ètres

array	$array	Named array
mixed	$ignore	An optional array or space separated list of properties to ignore while binding. [optional]

Renvoie

mixed Null if operation was satisfactory, otherwise returns an error string

Depuis

2.5

check()

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.

Renvoie

boolean True if the instance is sane and able to be stored in the database.

Depuis

2.5

Références $params, et $title.

publish()

publish	(		$pks = null,
			$state = 1,
			$userId = 0
	)

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ètres

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]

Renvoie

boolean True on success.

Depuis

2.5

Références $query, $state, et $userId.

store()

store

(

$updateNulls = false

)

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ètres

boolean

$updateNulls

True to update fields even if they are null. [optional]

Renvoie

boolean True on success.

Depuis

2.5

Références $date, et $userId.

---

La documentation de cette classe a été générée à partir du fichier suivant :

• administrator/components/com_finder/tables/filter.php