Propel API
Class

SoftDeleteBehavior

class SoftDeleteBehavior extends Behavior

Gives a model class the ability to remain in database even when the user deletes object Uses an additional column storing the deletion date And an additional condition for every read query to only consider rows with no deletion date

Methods

setName($name)

from Behavior
getName()

from Behavior
setTable(Table $table)

from Behavior
getTable()

from Behavior
setDatabase(Database $database)

from Behavior
getDatabase()

from Behavior
addParameter(array $attribute)

Add a parameter Expects an associative array looking like array('name' => 'foo', 'value' => bar)

from Behavior
setParameters(array $parameters)

Overrides the behavior parameters Expects an associative array looking like array('foo' => 'bar')

from Behavior
array getParameters()

Get the associative array of parameters

from Behavior
getParameter($name)

from Behavior
setTableModificationOrder($tableModificationOrder $tableModificationOrder)

Define when this behavior must execute its modifyTable() relative to other behaviors.

from Behavior
integer getTableModificationOrder()

Get when this behavior must execute its modifyTable() relative to other behaviors.

from Behavior
modifyDatabase()

This method is automatically called on database behaviors when the database model is finished Propagate the behavior to the tables of the database Override this method to have a database behavior do something special

from Behavior
modifyTable()

Add the deleted_column to the current table

setTableModified($bool)

from Behavior
isTableModified()

from Behavior
string renderTemplate(string $filename, array $vars = array(), string $templateDir = '/templates/')

Use Propel's simple templating system to render a PHP file using variables passed as arguments.

from Behavior
ColumnMap getColumnForParameter(string $param)

Retrieve a column object using a name stored in the behavior parameters Useful for table behaviors

from Behavior
appendXml(DOMNode $node)

from Behavior
getTableModifier()

from Behavior
getObjectBuilderModifier()

from Behavior
getQueryBuilderModifier()

from Behavior
getPeerBuilderModifier()

from Behavior
getTableMapBuilderModifier()

from Behavior
hasAdditionalBuilders()

from Behavior
getAdditionalBuilders()

from Behavior
objectMethods($builder)

addObjectForceDelete($script)

addObjectUndelete($script)

preDelete($builder)

queryAttributes()

queryMethods($builder)

addQueryIncludeDeleted($script)

addQuerySoftDelete($script)

addQueryForceDelete($script)

addQueryForceDeleteAll($script)

addQueryUnDelete($script)

addQueryEnableSoftDelete($script)

addQueryDisableSoftDelete($script)

addQueryIsSoftDeleteEnabled($script)

preSelectQuery($builder)

preDeleteQuery($builder)

staticMethods($builder)

addPeerEnableSoftDelete($script)

addPeerDisableSoftDelete($script)

addPeerIsSoftDeleteEnabled($script)

addPeerDoSoftDelete($script)

addPeerDoDelete2($script)

addPeerDoSoftDeleteAll($script)

addPeerDoDeleteAll2($script)

preSelect($builder)

peerFilter($script)

Details

in Behavior at line 33
public setName($name)

Parameters

$name

in Behavior at line 38
public getName()

in Behavior at line 43
public setTable(Table $table)

Parameters

Table $table

in Behavior at line 48
public getTable()

in Behavior at line 53
public setDatabase(Database $database)

Parameters

Database $database

in Behavior at line 58
public getDatabase()

in Behavior at line 69
public addParameter(array $attribute)

Add a parameter Expects an associative array looking like array('name' => 'foo', 'value' => bar)

Parameters

array $attribute associative array with name and value keys

in Behavior at line 81
public setParameters(array $parameters)

Overrides the behavior parameters Expects an associative array looking like array('foo' => 'bar')

Parameters

array $parameters associative array

in Behavior at line 90
public array getParameters()

Get the associative array of parameters

Return Value

array

in Behavior at line 95
public getParameter($name)

Parameters

$name

in Behavior at line 106
public setTableModificationOrder($tableModificationOrder $tableModificationOrder)

Define when this behavior must execute its modifyTable() relative to other behaviors.

The bigger the value, the later the behavior is executed. Default is 50.

Parameters

$tableModificationOrder $tableModificationOrder integer

in Behavior at line 117
public integer getTableModificationOrder()

Get when this behavior must execute its modifyTable() relative to other behaviors.

The bigger the value, the later the behavior is executed. Default is 50.

Return Value

integer

in Behavior at line 127
public modifyDatabase()

This method is automatically called on database behaviors when the database model is finished Propagate the behavior to the tables of the database Override this method to have a database behavior do something special

at line 30
public modifyTable()

Add the deleted_column to the current table

in Behavior at line 144
public setTableModified($bool)

Parameters

$bool

in Behavior at line 149
public isTableModified()

in Behavior at line 164
public string renderTemplate(string $filename, array $vars = array(), string $templateDir = '/templates/')

Use Propel's simple templating system to render a PHP file using variables passed as arguments.

Parameters

string $filename The template file name, relative to the behavior's dirname
array $vars An associative array of argumens to be rendered
string $templateDir The name of the template subdirectory

Return Value

string The rendered template

in Behavior at line 205
public ColumnMap getColumnForParameter(string $param)

Retrieve a column object using a name stored in the behavior parameters Useful for table behaviors

Parameters

string $param Name of the parameter storing the column name

Return Value

ColumnMap The column of the table supporting the behavior

in Behavior at line 222
public appendXml(DOMNode $node)

Parameters

DOMNode $node

See also

parent::appendXml(DOMNode)

in Behavior at line 236
public getTableModifier()

in Behavior at line 241
public getObjectBuilderModifier()

in Behavior at line 246
public getQueryBuilderModifier()

in Behavior at line 251
public getPeerBuilderModifier()

in Behavior at line 256
public getTableMapBuilderModifier()

in Behavior at line 261
public hasAdditionalBuilders()

in Behavior at line 266
public getAdditionalBuilders()

at line 45
public objectMethods($builder)

Parameters

$builder

at line 53
public addObjectForceDelete($script)

Parameters

$script

at line 73
public addObjectUndelete($script)

Parameters

$script

at line 89
public preDelete($builder)

Parameters

$builder

at line 110
public queryAttributes()

at line 117
public queryMethods($builder)

Parameters

$builder

at line 133
public addQueryIncludeDeleted($script)

Parameters

$script

at line 152
public addQuerySoftDelete($script)

Parameters

$script

at line 169
public addQueryForceDelete($script)

Parameters

$script

at line 186
public addQueryForceDeleteAll($script)

Parameters

$script

at line 202
public addQueryUnDelete($script)

Parameters

$script

at line 219
public addQueryEnableSoftDelete($script)

Parameters

$script

at line 232
public addQueryDisableSoftDelete($script)

Parameters

$script

at line 245
public addQueryIsSoftDeleteEnabled($script)

Parameters

$script

at line 260
public preSelectQuery($builder)

Parameters

$builder

at line 271
public preDeleteQuery($builder)

Parameters

$builder

at line 282
public staticMethods($builder)

Parameters

$builder

at line 298
public addPeerEnableSoftDelete($script)

Parameters

$script

at line 313
public addPeerDisableSoftDelete($script)

Parameters

$script

at line 326
public addPeerIsSoftDeleteEnabled($script)

Parameters

$script

at line 340
public addPeerDoSoftDelete($script)

Parameters

$script

at line 391
public addPeerDoDelete2($script)

Parameters

$script

at line 414
public addPeerDoSoftDeleteAll($script)

Parameters

$script

at line 440
public addPeerDoDeleteAll2($script)

Parameters

$script

at line 462
public preSelect($builder)

Parameters

$builder

at line 473
public peerFilter($script)

Parameters

$script