Changes between Version 2 and Version 3 of IS_ONE_OF

Timestamp:

08/23/09 13:09:55 (16 years ago)

Author:

Dominic König

Comment:

--

IS_ONE_OF

@@ -3 +3 @@
 The IS_ONE_OF() validator is a custom version of web2py's IS_IN_DB() for foreign key lookups in a key table. In forms, the respective field will be rendered as a drop-down field.
 
-Other than IS_IN_DB, the IS_ONE_OF validator is deletion status sensitive, i.e. records in the key table that are flagged as 'deleted' will be ignored. Furthermore, it is possible to filter the key records by a type field (which should be int) for certain options.
+Other than IS_IN_DB, the IS_ONE_OF validator is deletion status sensitive, i.e. records in the key table that are flagged as 'deleted' will be ignored. 
+
+Furthermore, it is possible to filter the key records by a type field (which should be int) for certain options.
 
 Usage:
@@ -11 +13 @@
   - ''keyfield'' = Name of the key field
   - ''represent'' = how to build the option label (in drop-downs in forms) from the key entry, one of the following:
-    - string template, e.g. "%(first_name)s %(last_name)s"
-    - list of names of fields, e.g. ('first_name', 'last_name')
-    - function or lambda, e.g. lambda r: "%(first_name)s %(last_name)s" % dict(r)
-  - filterby=''"fieldname"'' = the type field (and int-field) to filter for
+    - string template, e.g. {{{"%(first_name)s %(last_name)s"}}}
+    - list or tuple of field names, e.g. {{{('first_name', 'last_name')}}}
+    - function or lambda, e.g. {{{lambda r: "%(first_name)s %(last_name)s" % dict(r)}}}
+  - filterby=''"fieldname"'' = the type field (int) to filter for
   - filter_opts=''"options"'' = a list or tuple of allowed values for the filterby-field
 
@@ -28 +30 @@
 
 db[table].pr_pe_id.requires = IS_NULL_OR(IS_ONE_OF(db,
-    'pr_pentity.id',
-    shn_pentity_represent,
-    filterby='opt_pr_pentity_class',
-    filter_opts=(1,)
+    'pr_pentity.id',                          # key table pr_pentity, key field id
+    shn_pentity_represent,                    # function to represent a pr_pentity entry as string
+    filterby='opt_pr_pentity_class',          # type field in the pr_pentity table
+    filter_opts=(1,)                          # select only entries with opt_pr_pentity_class in (1,) (select only persons)
     ))
 }}}