Changes between Version 30 and Version 31 of S3/S3REST/s3_rest_controller

Timestamp:

10/24/10 05:51:55 (15 years ago)

Author:

Dominic König

Comment:

--

S3/S3REST/s3_rest_controller

@@ -67 +67 @@
 === Callbacks ===
 
+For every DB table, you can define functions to be invoked upon certain CRUD events. Those "callbacks" can be:
+
+  - a single callable (function, lambda, callable object)
+  - a list of callables, which are invoked in list order
+  - a dict of callables, where the tablename is used as key to find the callable to be invoked
+  - a dict of lists of callables, where the tablename is used as key to find the list of callables to be executed in list order
+
+The return value of the callables, if any, is ignored.
+
+==== Validation Callbacks ====
+
+After successful submission of a create/update form (=the input data have successfully passed the field validation), you can define extra form validation methods to be invoked by using:
+
+{{{
+s3xrc.model.configure(table, create_onvalidation=callback)
+}}}
+{{{
+s3xrc.model.configure(table, update_onvalidation=callback)
+}}}
+
+where:
+
+  - '''table''' is the respective DB table
+  - '''callable''' is the callback setting, see [#Callbacks Callbacks]
+
+If either of {{{create_onvalidation}}} or {{{update_onvalidation}}} is not set, then the {{{onvalidation}}} setting is tried:
+
+{{{
+s3xrc.model.configure(table, onvalidation=callback)
+}}}
+
+This allows you to define a common onvalidation callback for both ''create'' and ''update''.
+
+Onvalidation callbacks are meant to allow form data validation, where any validation errors are to be put directly into the form as:
+
+{{{
+form.errors[fieldname] = error_msg
+}}}
+
+where:
+
+  - '''fieldname''' is the field containing the invalid value
+  - '''error_msg''' is the error message to be displayed in the form close to that field
+
+The callables receive the form as first and only parameter, and their return values will be ignored.
+
+'''Important:'''
+  On-validation callbacks are also invoked in non-interactive data imports, where multiple records are being processed in one and the same request. Therefore the callback '''must not redirect'''!
+
+==== On-accept Callbacks ====
+
+==== On-Delete Callback ====
 === Pagination ===