Changes between Version 49 and Version 50 of S3/S3Model/ComponentResources

Timestamp:

02/07/14 10:52:34 (11 years ago)

Author:

Dominic König

Comment:

--

S3/S3Model/ComponentResources

@@ -98 +98 @@
 === Filtered Components ===
 
-Component joins can be filtered, so that only a subset of the records in the component table forms the actual component:
+Component joins can be filtered to a subset of the records in the component table:
 
 {{{#!python
 s3db.add_components("org_organisation", 
                     org_office={"name": "headquarter",        # the component alias
-                                "joinby": "organisation_id"   # the foreign key
+                                "joinby": "organisation_id",  # the foreign key
                                 "filterby": "office_type_id", # the name of the field in the component table to filter by
-                                "filterfor": 4,               # the value(s) to filter for
-                               })
+                                "filterfor": [4],             # the value(s) to filter for
+                               },
+                   )
 }}}
 
 Currently only inclusive filters are supported.
 
-It is possible to link the same component table to the same master table more than once using different joins and/or filters.
-
+It is possible to link the same component table to the same master table more than once using different aliases with joins and/or filters:
+
+{{{#!python
+s3db.add_components("org_organisation", 
+                    org_office=(
+                                {"name": "headquarter",
+                                 "joinby": "organisation_id",
+                                 "filterby": "office_type_id",
+                                 "filterfor": [4],
+                                },
+                                {"name": "fieldoffice",
+                                 "joinby": "organisation_id",
+                                 "filterby": "office_type_id",
+                                 "filterfor": [5],
+                                },
+                               ),
+                   )
+}}}
 === Single / Multiple Component Records ===