[LON-CAPA-cvs] cvs: loncom /enrollment localenroll.pm

[raeburn]

raeburn		Wed Jul 25 16:43:49 2007 EDT

  Modified files:              
    /loncom/enrollment	localenroll.pm 
  Log:
  - Additional arguments accepted by get_userinfo() - $searchby, $searchterm, $searchtype. to allow searching of institutional directory by username, last name, or last name, first name for $srchterm.
  
  - This search functionality to be available in loncreateuser (if permitted by domain settings).
  
  - Documentation updated
  
  
Index: loncom/enrollment/localenroll.pm
diff -u loncom/enrollment/localenroll.pm:1.20 loncom/enrollment/localenroll.pm:1.21
--- loncom/enrollment/localenroll.pm:1.20	Mon May 14 16:15:23 2007
+++ loncom/enrollment/localenroll.pm	Wed Jul 25 16:43:48 2007
@@ -1,6 +1,6 @@
 # functions to glue school database system into Lon-CAPA for 
 # automated enrollment
-# $Id: localenroll.pm,v 1.20 2007/05/14 20:15:23 raeburn Exp $
+# $Id: localenroll.pm,v 1.21 2007/07/25 20:43:48 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -512,7 +512,7 @@
 ###############################
 # sub get_userinfo
 #
-# Incoming data: four required arguments and two optional arguments
+# Incoming data: four required arguments and t optional arguments
 # Retrieves institutional data for a single user either by username
 # if $uname is included as second argument, or by ID if $id is 
 # included as a third argument.  Either (b) or (c) must be provided. 
@@ -531,6 +531,13 @@
 #                 if a single ID matches multiple usernames.
 # (f) $types - optional reference to array which contains 
 #              institutional types to check.
+# (g) $srchby - optional if $uname or $id defined, otherwise required.
+#               Allowed values include: 1. lastfirst, 2. last, 3. uname
+#               corresponding to searches by 1. lastname,firstname;
+#               2. lastname; 3. username
+# (h) $srchterm - optional if $uname or $id defined, otherwise required
+#                String to search for.
+# (i) $srchtype - optional. Allowed value: contains
 #
 # returns 1 parameter - ('ok' or other value).
 # side effects - populates the $instusers and $instids refs to hashes.
@@ -541,7 +548,8 @@
 ###############################
 
 sub get_userinfo {
-    my ($dom,$uname,$id,$instusers,$instids,$types) = @_;
+    my ($dom,$uname,$id,$instusers,$instids,$types,
+        $srchby,$srchterm,$srchtype) = @_;
     my $outcome = 'ok';
     return $outcome;
 }