Changes between Version 74 and Version 75 of S3/S3REST/s3_rest_controller

Timestamp:

10/15/12 13:15:17 (12 years ago)

Author:

Dominic König

Comment:

--

S3/S3REST/s3_rest_controller

@@ -232 +232 @@
 The {{{onaccept}}} callbacks are meant to perform extra post-processing of the newly created/updated record (e.g. to update dependent records). The callback functions receive the respective {{{FORM}}} instance (with the input data being in {{{form.vars}}}) as first and only parameter, while their return value will be ignored.
 
-==== On-Delete Callback ====
-
-You can define methods to be invoked after a record has been deleted, by using:
-
-{{{
-s3db.configure(tablename, ondelete=callback)
+==== On-Delete-Cascade Callback ====
+
+You can specify callbacks to be invoked when a record is to be deleted:
+
+{{{
+s3db.configure(tablename, ondelete_cascade=callback)
 }}}
 
@@ -245 +245 @@
   - '''callable''' is the callback setting, see [#Callbacks Callbacks]
 
-The {{{ondelete}}} callbacks are meant to perform extra post-processing of the deleted record (e.g. to update dependent records). The callback functions receive the respective '''record''' as first and only parameter, while their return value will be ignored.
-
-Note:
-  At the time when the callback is invoked, the record is already deleted from the database.
+The {{{ondelete_cascade}}} callback is to perform cascade actions before deleting a record (e.g. to update or remove dependend records, or to release constraints that cannot be introspected). The hook will receive the ''record'' as its only parameter (note that it will only contain the record ID), its return value will be ignored.
+
+  '''Note:''' the ''record'' will only contain the record ID but no details
+
+==== On-Delete Callback ====
+
+You can also define callbacks to be invoked ''after'' a record has been deleted:
+
+{{{
+s3db.configure(tablename, ondelete=callback)
+}}}
+
+where:
+
+  - '''table''' is the respective DB table
+  - '''callable''' is the callback setting, see [#Callbacks Callbacks]
+
+The {{{ondelete}}} callbacks are meant to perform extra post-processing of the deleted record (e.g. updates to counters or other aggregates). The callback function will receive the respective ''record'' as its only parameter, while its return value will be ignored.
+
+  '''Note:''' at the time when the callback is invoked, the record is already deleted from the database.
+  '''Note:''' the ''record'' will only contain the record ID but no details
 
 === Pagination ===