diff doc/customizing.txt @ 5222:9bf221cebef3

Make properties method return only properties the user can search. See: https://sourceforge.net/p/roundup/mailman/roundup-devel/thread/20170405002844.2004B80690%40vm71.cs.umb.edu/#msg35769250 [Roundup-devel] Bug in context/properties, lists properties user can't search. The HTMLClass::properties() method returns a list of all properties. This is used when creating sort on/group by filters on index pages. However somewhere in the code, a user needs search permission on the property in order for it to be used for grouping or sorting. This means the user can choose to sort/group an index page by a property that they have no search permission for. As a result the sort/group is ignored. This is confusing. I have changed the properties method to only return properties the user has View/Search permissions on. I also added a new cansearch argument set by default to True. If set to False, all properties regardless of Search permission are returned. Doc updated to include the new default operation and mention the use of cansearch argument.
author John Rouillard <rouilj@ieee.org>
date Wed, 05 Apr 2017 21:38:32 -0400
parents 8d2c1c9a49e1
children 690ec4f438df
line wrap: on
line diff
--- a/doc/customizing.txt	Wed Apr 05 21:20:20 2017 -0400
+++ b/doc/customizing.txt	Wed Apr 05 21:38:32 2017 -0400
@@ -2354,7 +2354,8 @@
 Method      Description
 =========== =============================================================
 properties  return a `hyperdb property wrapper`_ for all of this class's
-            properties.
+            properties that are searchable by the user. You can use
+            the argument cansearch=False to get all properties.
 list        lists all of the active (not retired) items in the class.
 csv         return the items of this class as a chunk of CSV text.
 propnames   lists the names of the properties of this class.

Roundup Issue Tracker: http://roundup-tracker.org/