[open-ils-commits] r15996 - trunk/Open-ILS/src/perlmods/OpenILS/Application (erickson)

[svn at svn.open-ils.org]

Author: erickson
Date: 2010-03-25 17:27:04 -0400 (Thu, 25 Mar 2010)
New Revision: 15996

Modified:
   trunk/Open-ILS/src/perlmods/OpenILS/Application/AppUtils.pm
Log:
Comment on undocumented interaction.

Modified: trunk/Open-ILS/src/perlmods/OpenILS/Application/AppUtils.pm
===================================================================
--- trunk/Open-ILS/src/perlmods/OpenILS/Application/AppUtils.pm	2010-03-25 20:30:12 UTC (rev 15995)
+++ trunk/Open-ILS/src/perlmods/OpenILS/Application/AppUtils.pm	2010-03-25 21:27:04 UTC (rev 15996)
@@ -1265,6 +1265,12 @@
 # that permission.  This means that if you call this method without an
 # authtoken param, you can get whatever org unit setting values you want.
 # API users beware.
+#
+# NOTE: If you supply an editor ($e) arg AND an auth token arg, the editor's
+# authtoken is checked, but the $auth arg is NOT checked.  To say that another
+# way, be sure NOT to pass an editor argument if you want your token checked.
+# Otherwise the auth arg is just a flag saying "check the editor".  
+
 sub ou_ancestor_setting {
     my( $self, $orgid, $name, $e, $auth ) = @_;
     $e = $e || OpenILS::Utils::CStoreEditor->new(