Class FOFTableBehavior

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

FOFTableBehavior

Direct known subclasses

FOFTableBehaviorAssets, FOFTableBehaviorContenthistory, FOFTableBehaviorTags

Abstract
Package: FrameworkOnFramework\table
Copyright: Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 2.1
CodeCoverageIgnore
Located at fof/table/behavior.php

Methods summary

`public boolean`	# `onBeforeBind( FOFTable & $table, array & $data )` This event runs before binding data to the table This event runs before binding data to the table Parameters `$table` `FOFTable` - &$table The table which calls this event `$data` `array` - &$data The data to bind Returns `boolean` - True on success
`public boolean`	# `onAfterBind( FOFTable & $table, object\|array & $src )` The event which runs after binding data to the table The event which runs after binding data to the table Parameters `$table` `FOFTable` - &$table The table which calls this event `$src` `object\|array` - &$src The data to bind Returns `boolean` - True on success
`public`	# `onAfterLoad( FOFTable & $table, boolean & $result )` The event which runs after loading a record from the database The event which runs after loading a record from the database Parameters `$table` `FOFTable` - &$table The table which calls this event `$result` `boolean` - &$result Did the load succeeded?
`public boolean`	# `onBeforeStore( FOFTable & $table, boolean $updateNulls )` The event which runs before storing (saving) data to the database The event which runs before storing (saving) data to the database Parameters `$table` `FOFTable` - &$table The table which calls this event `$updateNulls` `boolean` - $updateNulls Should nulls be saved as nulls (true) or just skipped over (false)? Returns `boolean` - True to allow saving
`public boolean`	# `onAfterStore( FOFTable & $table )` The event which runs after storing (saving) data to the database The event which runs after storing (saving) data to the database Parameters `$table` `FOFTable` - &$table The table which calls this event Returns `boolean` - True to allow saving without an error
`public boolean`	# `onBeforeMove( FOFTable & $table, boolean $updateNulls )` The event which runs before moving a record The event which runs before moving a record Parameters `$table` `FOFTable` - &$table The table which calls this event `$updateNulls` `boolean` - $updateNulls Should nulls be saved as nulls (true) or just skipped over (false)? Returns `boolean` - True to allow moving
`public boolean`	# `onAfterMove( FOFTable & $table )` The event which runs after moving a record The event which runs after moving a record Parameters `$table` `FOFTable` - &$table The table which calls this event Returns `boolean` - True to allow moving without an error
`public boolean`	# `onBeforeReorder( FOFTable & $table, string $where = '' )` The event which runs before reordering a table The event which runs before reordering a table Parameters `$table` `FOFTable` - &$table The table which calls this event `$where` `string` - $where The WHERE clause of the SQL query to run on reordering (record filter) Returns `boolean` - True to allow reordering
`public boolean`	# `onAfterReorder( FOFTable & $table )` The event which runs after reordering a table The event which runs after reordering a table Parameters `$table` `FOFTable` - &$table The table which calls this event Returns `boolean` - True to allow the reordering to complete without an error
`public boolean`	# `onBeforeDelete( FOFTable & $table, integer $oid )` The event which runs before deleting a record The event which runs before deleting a record Parameters `$table` `FOFTable` - &$table The table which calls this event `$oid` `integer` - $oid The PK value of the record to delete Returns `boolean` - True to allow the deletion
`public boolean`	# `onAfterDelete( FOFTable & $table, integer $oid )` The event which runs after deleting a record The event which runs after deleting a record Parameters `$table` `FOFTable` - &$table The table which calls this event `$oid` `integer` - $oid The PK value of the record which was deleted Returns `boolean` - True to allow the deletion without errors
`public boolean`	# `onBeforeHit( FOFTable & $table, integer $oid, boolean $log )` The event which runs before hitting a record The event which runs before hitting a record Parameters `$table` `FOFTable` - &$table The table which calls this event `$oid` `integer` - $oid The PK value of the record to hit `$log` `boolean` - $log Should we log the hit? Returns `boolean` - True to allow the hit
`public boolean`	# `onAfterHit( FOFTable & $table, integer $oid )` The event which runs after hitting a record The event which runs after hitting a record Parameters `$table` `FOFTable` - &$table The table which calls this event `$oid` `integer` - $oid The PK value of the record which was hit Returns `boolean` - True to allow the hitting without errors
`public boolean`	# `onBeforeCopy( FOFTable & $table, integer $oid )` The even which runs before copying a record The even which runs before copying a record Parameters `$table` `FOFTable` - &$table The table which calls this event `$oid` `integer` - $oid The PK value of the record being copied Returns `boolean` - True to allow the copy to take place
`public boolean`	# `onAfterCopy( FOFTable & $table, integer $oid )` The even which runs after copying a record The even which runs after copying a record Parameters `$table` `FOFTable` - &$table The table which calls this event `$oid` `integer` - $oid The PK value of the record which was copied (not the new one) Returns `boolean` - True to allow the copy without errors
`public boolean`	# `onBeforePublish( FOFTable & $table, integer\|array & $cid, integer $publish )` The event which runs before a record is (un)published The event which runs before a record is (un)published Parameters `$table` `FOFTable` - &$table The table which calls this event `$cid` `integer\|array` - &$cid The PK IDs of the records being (un)published `$publish` `integer` - $publish 1 to publish, 0 to unpublish Returns `boolean` - True to allow the (un)publish to proceed
`public boolean`	# `onAfterReset( FOFTable & $table )` The event which runs after the object is reset to its default values. The event which runs after the object is reset to its default values. Parameters `$table` `FOFTable` - &$table The table which calls this event Returns `boolean` - True to allow the reset to complete without errors
`public boolean`	# `onBeforeReset( FOFTable & $table )` The even which runs before the object is reset to its default values. The even which runs before the object is reset to its default values. Parameters `$table` `FOFTable` - &$table The table which calls this event Returns `boolean` - True to allow the reset to complete

Methods inherited from FOFUtilsObservableEvent

__construct(), update()

Methods inherited from FOFUtilsObject

__toString(), def(), get(), getError(), getErrors(), getProperties(), set(), setError(), setProperties()

Magic methods summary

Properties summary

Properties inherited from FOFUtilsObservableEvent

$_subject

Properties inherited from FOFUtilsObject

$_errors

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFTableBehavior

Direct known subclasses

Methods summary

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Methods inherited from FOFUtilsObservableEvent

Methods inherited from FOFUtilsObject

Magic methods summary

Properties summary

Properties inherited from FOFUtilsObservableEvent

Properties inherited from FOFUtilsObject