Changes between Version 57 and Version 58 of S3/S3REST/s3_rest_controller

Timestamp:

02/15/11 12:41:06 (14 years ago)

Author:

Fran Boon

Comment:

--

S3/S3REST/s3_rest_controller

@@ -312 +312 @@
 === Filtering Lists ===
 
-You can filter lists by setting {{{response.s3.filter}}} to a filter query:
-
+You can filter lists in the controller by setting {{{response.s3.filter}}} to a filter query:
 {{{
     # This filters for females:
@@ -321 +320 @@
 }}}
 
+Note that this only takes effect in the main controller (not in prep or postp).
+
 Note that {{{response.s3.filter}}} affects both, the primary resource and components!
 
 In {{{prep}}}, you can also add filter queries using the {{{add_filter}}} method:
-
 {{{
     def prep(r):
         resource = r.resource
-        query = (db.pr_address.type==1) # Home addresses only
+        query = (db.pr_address.type == 1) # Home addresses only
         resource.add_filter(query)
         return True
@@ -337 +337 @@
 
 However, {{{add_filter}}} again affects both, primary and component records - so this example would:
-
 - only retrieve {{{person}}} records which have a type 1 {{{address}}} record
 - only retrieve the {{{address}}} records with type 1.
@@ -344 +343 @@
 
 To have the primary resource unfiltered, and filter only records in a particular component, you can use {{{add_component_filter}}}:
-
 {{{
     def prep(r):
         resource = r.resource
-        query = (db.pr_address.type==1) # Home addresses only
+        query = (db.pr_address.type == 1) # Home addresses only
         resource.add_component_filter("address", query)
         return True
@@ -357 +355 @@
 
 In this case, all {{{person}}} records would be selected - while only {{{address}}} records of type 1 would be retrieved.
-
-
 === Pre-populating Create-Forms ===