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(string $name)
Sets the name of the Behavior |
from Behavior | |
| string |
getName()
Returns the name of the Behavior |
from Behavior |
|
setTable(Table $table)
Sets the table this behavior is applied to |
from Behavior | |
| Table |
getTable()
Returns the table this behavior is applied to |
from Behavior |
|
setDatabase(Database $database)
Sets the database this behavior is applied to |
from Behavior | |
| Database |
getDatabase()
Returns the table this behavior is applied to if behavior is applied to <database> element. |
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 38
public
setName(string $name)
Sets the name of the Behavior
in Behavior at line 48
public string
getName()
Returns the name of the Behavior
in Behavior at line 58
public
setTable(Table $table)
Sets the table this behavior is applied to
in Behavior at line 68
public Table
getTable()
Returns the table this behavior is applied to
in Behavior at line 78
public
setDatabase(Database $database)
Sets the database this behavior is applied to
in Behavior at line 88
public Database
getDatabase()
Returns the table this behavior is applied to if behavior is applied to <database> element.
in Behavior at line 99
public
addParameter(array $attribute)
Add a parameter Expects an associative array looking like array('name' => 'foo', 'value' => bar)
in Behavior at line 111
public
setParameters(array $parameters)
Overrides the behavior parameters Expects an associative array looking like array('foo' => 'bar')
in Behavior at line 120
public array
getParameters()
Get the associative array of parameters
in Behavior at line 125
public
getParameter($name)
in Behavior at line 140
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 151
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 161
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 181
public
setTableModified($bool)
in Behavior at line 186
public
isTableModified()
in Behavior at line 203
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 245
public ColumnMap
getColumnForParameter(string $param)
Retrieve a column object using a name stored in the behavior parameters Useful for table behaviors