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)
in Behavior at line 38
public
getName()
in Behavior at line 43
public
setTable(Table $table)
in Behavior at line 48
public
getTable()
in Behavior at line 53
public
setDatabase(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)
in Behavior at line 81
public
setParameters(array $parameters)
Overrides the behavior parameters Expects an associative array looking like array('foo' => 'bar')
in Behavior at line 90
public array
getParameters()
Get the associative array of parameters
in Behavior at line 95
public
getParameter($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.
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.
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)
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.
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