Docs For Class FOFTableBehavior

FOFTableBehavior

Description

FrameworkOnFramework table behavior class. It defines the events which are called by a Table.

abstract:
since: 2.1

Located in /libraries/fof/table/behavior.php (line 18)

JObject
   |
   --JEvent
      |
      --FOFTableBehavior

Direct descendents

Class	Description
FOFTableBehaviorAssets	FrameworkOnFramework table behavior class for assets
FOFTableBehaviorTags	FrameworkOnFramework table behavior class for tags

Method Summary

boolean onAfterBind (FOFTable &$table, object|array &$src)

boolean onAfterCopy (FOFTable &$table, integer $oid)

boolean onAfterDelete (FOFTable &$table, integer $oid)

boolean onAfterHit (FOFTable &$table, integer $oid)

void onAfterLoad (FOFTable &$table, boolean &$result)

boolean onAfterMove (FOFTable &$table)

boolean onAfterReorder (FOFTable &$table)

boolean onAfterReset (FOFTable &$table)

boolean onAfterStore (FOFTable &$table)

boolean onBeforeBind (FOFTable &$table, array &$data)

boolean onBeforeCopy (FOFTable &$table, integer $oid)

boolean onBeforeDelete (FOFTable &$table, integer $oid)

boolean onBeforeHit (FOFTable &$table, integer $oid, boolean $log)

boolean onBeforeMove (FOFTable &$table, boolean $updateNulls)

boolean onBeforePublish (FOFTable &$table, integer|array &$cid, integer $publish)

boolean onBeforeReorder (FOFTable &$table, [string $where = ''])

boolean onBeforeReset (FOFTable &$table)

boolean onBeforeStore (FOFTable &$table, boolean $updateNulls)

Variables

Inherited Variables

Inherited from JEvent

JEvent::$_subject

Inherited from JObject

JObject::$_errors

Methods

onAfterBind (line 41)

The event which runs after binding data to the table

return: True on success
access: public

boolean onAfterBind (FOFTable &$table, object|array &$src)

FOFTable &$table: The table which calls this event
object|array &$src: The data to bind

Redefined in descendants as:

FOFTableBehaviorAssets::onAfterBind() : The event which runs after binding data to the table
FOFTableBehaviorTags::onAfterBind() : The event which runs after binding data to the table

onAfterCopy (line 208)

The even which runs after copying a record

return: True to allow the copy without errors
access: public

boolean onAfterCopy (FOFTable &$table, integer $oid)

FOFTable &$table: The table which calls this event
integer $oid: The PK value of the record which was copied (not the new one)

onAfterDelete (line 155)

The event which runs after deleting a record

return: True to allow the deletion without errors
access: public

boolean onAfterDelete (FOFTable &$table, integer $oid)

FOFTable &$table: The table which calls this event
integer $oid: The PK value of the record which was deleted

Redefined in descendants as:

FOFTableBehaviorTags::onAfterDelete() : The event which runs after deleting a record

onAfterHit (line 182)

The event which runs after hitting a record

return: True to allow the hitting without errors
access: public

boolean onAfterHit (FOFTable &$table, integer $oid)

FOFTable &$table: The table which calls this event
integer $oid: The PK value of the record which was hit

onAfterLoad (line 54)

The event which runs after loading a record from the database

access: public

void onAfterLoad (FOFTable &$table, boolean &$result)

FOFTable &$table: The table which calls this event
boolean &$result: Did the load succeeded?

onAfterMove (line 104)

The event which runs after moving a record

return: True to allow moving without an error
access: public

boolean onAfterMove (FOFTable &$table)

FOFTable &$table: The table which calls this event

onAfterReorder (line 129)

The event which runs after reordering a table

return: True to allow the reordering to complete without an error
access: public

boolean onAfterReorder (FOFTable &$table)

FOFTable &$table: The table which calls this event

onAfterReset (line 234)

The event which runs after the object is reset to its default values.

return: True to allow the reset to complete without errors
access: public

boolean onAfterReset (FOFTable &$table)

FOFTable &$table: The table which calls this event

onAfterStore (line 79)

The event which runs after storing (saving) data to the database

return: True to allow saving without an error
access: public

boolean onAfterStore (FOFTable &$table)

FOFTable &$table: The table which calls this event

onBeforeBind (line 28)

This event runs before binding data to the table

return: True on success
access: public

boolean onBeforeBind (FOFTable &$table, array &$data)

FOFTable &$table: The table which calls this event
array &$data: The data to bind

onBeforeCopy (line 195)

The even which runs before copying a record

return: True to allow the copy to take place
access: public

boolean onBeforeCopy (FOFTable &$table, integer $oid)

FOFTable &$table: The table which calls this event
integer $oid: The PK value of the record being copied

onBeforeDelete (line 142)

The event which runs before deleting a record

return: True to allow the deletion
access: public

boolean onBeforeDelete (FOFTable &$table, integer $oid)

FOFTable &$table: The table which calls this event
integer $oid: The PK value of the record to delete

Redefined in descendants as:

FOFTableBehaviorAssets::onBeforeDelete() : The event which runs before deleting a record

onBeforeHit (line 169)

The event which runs before hitting a record

return: True to allow the hit
access: public

boolean onBeforeHit (FOFTable &$table, integer $oid, boolean $log)

FOFTable &$table: The table which calls this event
integer $oid: The PK value of the record to hit
boolean $log: Should we log the hit?

onBeforeMove (line 92)

The event which runs before moving a record

return: True to allow moving
access: public

boolean onBeforeMove (FOFTable &$table, boolean $updateNulls)

FOFTable &$table: The table which calls this event
boolean $updateNulls: Should nulls be saved as nulls (true) or just skipped over (false)?

onBeforePublish (line 222)

The event which runs before a record is (un)published

return: True to allow the (un)publish to proceed
access: public

boolean onBeforePublish (FOFTable &$table, integer|array &$cid, integer $publish)

FOFTable &$table: The table which calls this event
integer|array &$cid: The PK IDs of the records being (un)published
integer $publish
:
1. to publish, 0 to unpublish

onBeforeReorder (line 117)

The event which runs before reordering a table

return: True to allow reordering
access: public

boolean onBeforeReorder (FOFTable &$table, [string $where = ''])

FOFTable &$table: The table which calls this event
string $where: The WHERE clause of the SQL query to run on reordering (record filter)

onBeforeReset (line 246)

The even which runs before the object is reset to its default values.

return: True to allow the reset to complete
access: public

boolean onBeforeReset (FOFTable &$table)

FOFTable &$table: The table which calls this event

onBeforeStore (line 67)

The event which runs before storing (saving) data to the database

return: True to allow saving
access: public

boolean onBeforeStore (FOFTable &$table, boolean $updateNulls)

FOFTable &$table: The table which calls this event
boolean $updateNulls: Should nulls be saved as nulls (true) or just skipped over (false)?

Redefined in descendants as:

FOFTableBehaviorAssets::onBeforeStore() : The event which runs before storing (saving) data to the database
FOFTableBehaviorTags::onBeforeStore() : The event which runs before storing (saving) data to the database

Inherited Methods

Inherited From JEvent

JEvent::__construct()
JEvent::update()

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 14:54:32 +0100 by phpDocumentor 1.4.3