Changes between Version 63 and Version 64 of S3/FilterForms

Timestamp:

08/30/19 09:36:21 (6 years ago)

Author:

Fran Boon

Comment:

Default Filters

S3/FilterForms

@@ -230 +230 @@
 
   ''Note'': if formstyle returns a TR, a list of TRs or a TAG[""] of TRs, then the filter form will be rendered as a TABLE - otherwise as DIV.
+
+==== Default Filters ====
+A !FilterForm can be instructed to set it's status to default values for the convenience of interactive users. This allows their initial view to be filtered, yet allow them to unfilter to whatever their security permissions, or any other 'hard' filter allows.
+
+To instruct a FilterForm to NOT implement the default filters, add {{{?default_filters=0}}} to the URL.
+
+Example: Filter Staff by a User's (Branch) Organisation, add this to the controller:
+{{{
+def user_org_default_filter(selector, tablename=None):
+    auth = current.auth
+    user_org_id = auth.is_logged_in() and auth.user.organisation_id
+    if user_org_id:
+        return user_org_id
+    else:
+        # no default
+        return {}
+
+from s3 import s3_set_default_filter
+s3_set_default_filter("~.organisation_id",
+                      user_org_default_filter,
+                      tablename = "hrm_human_resource")
+}}}
 == Development ==