[BACK]Return to localenroll.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / enrollment

Diff for /loncom/enrollment/localenroll.pm between versions 1.22 and 1.26

version 1.22, 2007/08/25 18:35:17 version 1.26, 2007/09/12 19:50:47
Line 496  sub instcode_defaults { Line 496  sub instcode_defaults {
 #                keys will be unique IDs (student or faculty/staff ID)  #                keys will be unique IDs (student or faculty/staff ID)
 #                values will be either: scalar (username) or an array   #                values will be either: scalar (username) or an array 
 #                if a single ID matches multiple usernames.  #                if a single ID matches multiple usernames.
 # returns 1 parameter - ('ok' or other value).  # returns 1 parameter - 'ok' if no processing error, or other value 
   #                       if an error occurred.
 # side effects - populates the $instusers and $instids refs to hashes.  # side effects - populates the $instusers and $instids refs to hashes.
 #                with information for all users from all available   #                with information for all users from all available 
 #                institutional datafeeds.  #                institutional datafeeds.
Line 512  sub allusers_info { Line 513  sub allusers_info {
 ###############################  ###############################
 # sub get_userinfo  # sub get_userinfo
 #  #
 # Incoming data: four required arguments and additional optional argumenta  # Incoming data: four required arguments and additional optional arguments
 # Two modes of operation:  # Two modes of operation:
 # (1) Retrieves institutional data for a single user either by username  # (1) Retrieves institutional data for a single user either by username
 #     if $uname is included as second argument, or by ID if $id is   #     if $uname is included as second argument, or by ID if $id is 
Line 546  sub allusers_info { Line 547  sub allusers_info {
 # (i) $srchtype - optional. Allowed values: contains, begins (defaults  # (i) $srchtype - optional. Allowed values: contains, begins (defaults
 #                to exact match otherwise).  #                to exact match otherwise).
 #  #
 # returns 1 parameter - ('ok' or other value).  # returns 1 parameter - 'ok' if no processing error, or other value 
   #                       if an error occurred.
 # side effects - populates the $instusers and $instids refs to hashes.  # side effects - populates the $instusers and $instids refs to hashes.
 #                with information for specified username, or specified  #                with information for specified username, or specified
 #                id, if fifth argument provided, from all available, or   #                id, if fifth argument provided, from all available, or 
 #                specified (e.g., faculty only) institutional datafeeds,  #                specified (e.g., faculty only) institutional datafeeds,
 #                if sixth argument provided.  #                if sixth argument provided.
   #
   # WARNING: You need to set $outcome to 'ok' once you have customized
   #          this routine to communicate with an instititional 
   #          directory data source, otherwise institutional directory 
   #          searches will always be reported as being unavailable
   #          in domain $dom.
   #
 ###############################  ###############################
   
 sub get_userinfo {  sub get_userinfo {
     my ($dom,$uname,$id,$instusers,$instids,$types,      my ($dom,$uname,$id,$instusers,$instids,$types,
         $srchby,$srchterm,$srchtype) = @_;          $srchby,$srchterm,$srchtype) = @_;
     my $outcome = 'ok';      my $outcome = 'unavailable';
     return $outcome;      return $outcome;
 }  }
   
Line 574  sub get_userinfo { Line 583  sub get_userinfo {
 #              which institutional types should be shown  #              which institutional types should be shown
 #              when displaying data tables (e.g., default quotas      #              when displaying data tables (e.g., default quotas    
 #              or updateable user fields (see domainprefs.pm)   #              or updateable user fields (see domainprefs.pm) 
 # returns 1 parameter - ('ok' or other value).  # returns 1 parameter - 'ok' if no processing error, or other value 
   #                        if an error occurred.
 #  #
 ###############################  ###############################
   
Line 587  sub inst_usertypes { Line 597  sub inst_usertypes {
 }  }
   
 ###############################  ###############################
   # sub username_rules
   #
   # Incoming data: three arguments 
   # (a) $dom - domain
   # (b) $ruleshash - reference to hash containing rules
   #                  (a hash of a hash)
   #                  keys of top level hash are short names  
   #                   (e.g., netid, noncredit) 
   #                  for each key, value is a hash
   #                      desc => long name for rule  
   #                      rule => description of rule
   #                      authtype => (krb5,krb4,int, or loc)
   #                                 authentication type for rule 
   #                      authparm => authentication parameter for rule
   #                      authparmfixed => 1 if authparm used when
   #                          creating user for rule must be authparm  
   #                      authmsg => Message to display describing 
   #                                 authentication to use for this rule
   #
   # (c) $rulesorder - reference to array containing rule names 
   #                   in order to be displayed
   
   #
   #  returns 'ok' if no processing error.
   #
   ############################### 
   
   sub username_rules {
       my ($dom,$ruleshash,$rulesorder) = @_;
       my $outcome;
       return $outcome;
   }
   
   ###############################
   # sub username_check 
   #
   # Incoming data: four arguments
   # (a) $dom - domain (scalar) 
   # (b) $uname - username to compare against rules (scalar)
   # (c) $to_check (reference to array of rule names to check)
   # (d) $resultshash (reference to hash of results)
   #                    hash of results for rule checked
   #                   - keys are rule names
   #                   - values are: 1 or 0 (for matched or unmatched) 
   #
   # returns 'ok' if no processing error.
   #
   ###############################
   
   sub username_check {
       my ($dom,$uname,$to_check,$resultshash) = @_;
       my $outcome;
       return $outcome; 
   }
   
   ###############################
 # sub AUTOLOAD  # sub AUTOLOAD
 #  #
 # Incoming data: none  # Incoming data: none
Removed from v.1.22  
changed lines
  Added in v.1.26

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>