Changeset 4562

Timestamp:

06/25/08 19:24:01 (7 months ago)

Author:

jwage

Message:

Added documentation for #1170

Files:

• branches/0.11/manual/docs/en/plugins.txt (modified) (2 diffs)

branches/0.11/manual/docs/en/plugins.txt

@@ -225 +225 @@
 </code>
 
-Now lets put the plugin in action:
-
-<code type="php">
+Now lets put the plugin in action.
+
+Note: You are required to enable DQL callbacks in order for all executed queries to have the dql callbacks 
+executed on them. In the SoftDelete behavior they are used to filter the select statements to exclude all 
+records where the deleted flag is set with an additional WHERE condition.
+
+<code type="php">
+// Enable dql callbacks.
+Doctrine_Manager::getInstance()->setAttribute('use_dql_callbacks', true);
 
 // save a new record
@@ -236 +242 @@
 $record->delete();
 var_dump($record->deleted); // true
+
+// Querying for records excludes deleted records automatically.
+$q = Doctrine_Query::create()
+        ->from('SoftDeleteTest t');
+
+echo $q->count(); // This would be 0, it would exclude the record saved above because the delete flag was set
+// The following SQL would have been executed to get this count
+// SELECT COUNT(DISTINCT s.name) AS num_results FROM soft_delete_test s WHERE s.deleted = ? GROUP BY s.name
+
+echo $q->getSql(); // SELECT s.name AS s__name, s.something AS s__something, s.deleted AS s__deleted FROM soft_delete_test s WHERE s.deleted = ?
 </code>