Changes between Version 53 and Version 54 of S3/S3REST/s3_rest_controller

Timestamp:

01/27/11 22:27:43 (14 years ago)

Author:

Dominic König

Comment:

--

S3/S3REST/s3_rest_controller

@@ -310 +310 @@
 == Advanced Options ==
 
+=== Pre-populating Create-Forms ===
+
+Create-forms can be pre-populated with data by one of these 3 methods:
+
+  1. model defaults (standard)
+  2. values from another record in the database
+  3. values provided by the controller
+
+Model defaults are defined per field and can be set as {{{db.my_table.field.default = value}}} at any time before the REST method is applied (even in the pre-process).
+
+Values from another record in the database can be used via a URL query like:
+
+  - /my/resource/create?from_record=''id''&from_fields=''fieldname1'',''fieldname2'',...
+
+The ''id'' of the original record can also be specified as ''tablename.id'', if the original record is in another table. Additionally, fieldnames can be specified as ''fieldname$original_fieldname'' to map between different fieldnames.
+
+To pre-populate Create-forms from the controller, you can specify the variable {{{populate}}} in the arguments of {{{s3_rest_controller}}}:
+
+{{{
+output = s3_rest_controller(prefix, resourcename,
+                            populate=dict(fieldname1=value1,
+                                          fieldname2=value2))
+return output
+}}}
+
+Instead of a {{{dict}}}, you can also pass a callable object as {{{populate}}}. This will be executed with the current {{{S3Request}}} and the names arguments of {{{s3_rest_controller}}} in order to produce the field/value {{{dict}}}:
+
+{{{
+def populate(r, **attr):
+    """
+    Helper function to pre-populate create-forms
+
+    """
+
+    # some code to produce the data
+    # ...
+
+    # return the dict
+    return dict(fieldname1=value1,
+                fieldname2=value2)
+
+output = s3_rest_controller(prefix, resourcename,
+                            populate=populate)
+
+return output
+}}}
+
+Note that {{{populate}}} will only be applied in {{{GET}}} requests and only if no record_id is specified. That means, if it uses a separate form to generate the data, you need to revert the request into {{{GET}}} in order to have the create-form pre-populated:
+
+{{{
+data = None
+form = FORM(...some form...)
+output = dict(helper_form=form)
+if form.accepts(request.vars, session, formname="helper_form"):
+    output = dict() # remove the helper form
+    data = Storage(...) # some code to extract the data from the helper form
+if data:
+    request.env.request_method = "GET" # revert to GET if data available
+
+_output = s3_rest_controller(prefix, resourcename, populate=data)
+
+if isinstance(_output, dict):
+    output.update(_output)
+else:
+    output = _output
+
+return output
+}}}
+
+NB: This construction could be used e.g. to loop in an OCR client into a REST controller. The helper form would then be a file upload form which is displayed alongside with the normal create-form - so the user can either enter data manually and submit the create-form, or first submit a file to pre-populate the create form, and then edit the data and submit the create-form.
 === Pre-Process ===