Changes between Version 17 and Version 18 of S3/S3ResourceFilter

Timestamp:

05/11/12 10:49:23 (13 years ago)

Author:

Fran Boon

Comment:

S3QueryField -> S3FieldSelector

S3/S3ResourceFilter

@@ -44 +44 @@
 == Field Selectors ==
 
-S3ResourceQuery instances are based on S3QueryField field selectors. A field selector is a string with the so-called "list_fields syntax":
+S3ResourceQuery instances are based on S3FieldSelector, which is a string with the so-called "list_fields syntax":
 
 {{{
@@ -54 +54 @@
   - '''field''' is the name of the field or a virtual field in the table addressed by ''alias'' (plus ''foreign key'' where present).
 
-To access fields in a table which is linked via a link table, replace the fkey by the link table name and add left and right key if needed:
+To access fields in a table which is linked via a link table, replace the fkey by the link table name and add left and right key if not already specified by add_component:
 {{{
 alias.{{lkey:}linktable{:rkey}$}field
@@ -65 +65 @@
 
 lkey and rkey ''can'' be omitted if they are not ambiguous, i.e. if there's only one option each.
+
 == URL queries ==
 
@@ -116 +117 @@
 == Extending filters at the back-end ==
 
-S3QueryField instances can also be generated at the back-end, simply by:
+S3FieldSelector instances can also be generated at the back-end, simply by:
 
 {{{
-selector = S3QueryField(<field selector>)
+selector = S3FieldSelector(<field selector>)
 }}}
 
@@ -125 +126 @@
 
 {{{
-afilter = S3QueryField("person.first_name") == "Dominic"
-bfilter = ~(S3QueryField("person.first_name").like("Dominic"))  # negation by ~ operator
+afilter = S3FieldSelector("person.first_name") == "Dominic"
+bfilter = ~(S3FieldSelector("person.first_name").like("Dominic"))  # negation by ~ operator
 }}}
 
@@ -147 +148 @@
 
 {{{
-cfilter = (S3QueryField("person.first_name") == "Dominic") & (S3QueryField("contact.value") == "dominic@nursix.org")
+cfilter = (S3FieldSelector("person.first_name") == "Dominic") & (S3FieldSelector("contact.value") == "dominic@nursix.org")
 }}}
 
@@ -155 +156 @@
 
 {{{
-myfilter = S3QueryField("person.first_name") == "Dominic"
+myfilter = S3FieldSelector("person.first_name") == "Dominic"
 resource.add_filter(myfilter)
 }}}