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

Diff for /loncom/enrollment/localenroll.pm between versions 1.17 and 1.24

version 1.17, 2006/10/16 19:18:19 version 1.24, 2007/08/31 12:33:35
Line 31  use strict; Line 31  use strict;
 ################################  ################################
 # sub run  # sub run
 # set this to return 1 if you want the auto enrollment to run  # set this to return 1 if you want the auto enrollment to run
   #
   # Beginning with LON-CAPA version 2.4, use of this routine is
   # deprecated.  Whether or not Autoenroll.pl should run is set
   # by the Domain Coordinator via "Set domain configuration",
   # provided in the Domain Management section of the Main menu. 
 ################################  ################################
   
 sub run() {  sub run() {
Line 304  sub create_password { Line 309  sub create_password {
 #  #
 # Incoming data:  # Incoming data:
 # $dom (domain)  # $dom (domain)
 # $$instcodes{'43551dedcd43febmsul1'} = 'Title of course' (hash of courseIDs)  # $$instcodes{'43551dedcd43febmsul1'} = 'fs03nop590' (hash of courseIDs)
 #   # 
 # fs03nop590 would be split as follows  # fs03nop590 would be split as follows
 # @{$codetitles} = ("year","semester","department","number")  # @{$codetitles} = ("year","semester","department","number")
Line 474  sub instcode_defaults { Line 479  sub instcode_defaults {
     return 'ok';      return 'ok';
 }  }
   
   ###############################
   # sub allusers_info
   #
   # Incoming data: three arguments
   # (a) $dom - domain
   # (b) $instusers - reference to hash which will contain hashes, 
   #                 where keys will be usernames and value will be a 
   #                 hash of user information. Keys in the inner hash 
   #                 will be some or all of: lastname,firstname,
   #                 middlename, generation, id, inststatus - 
   #                 institutional status (e.g., faculty,staff,student)
   #                 Values are all scalars except inststatus,
   #                 which is an array.
   # (c) $instids - reference to hash which will contain ID numbers. 
   #                keys will be unique IDs (student or faculty/staff ID)
   #                values will be either: scalar (username) or an array 
   #                if a single ID matches multiple usernames.
   # 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.
   #                with information for all users from all available 
   #                institutional datafeeds.
   #
   ###############################
   
   sub allusers_info {
       my ($dom,$instusers,$instids) = @_;
       my $outcome = 'ok';
       return $outcome; 
   }
   
   ###############################
   # sub get_userinfo
   #
   # Incoming data: four required arguments and additional optional arguments
   # Two modes of operation:
   # (1) 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.
   #     (g), (h) and (i) will be undefined.
   # (2) Retrieves institutional user data from search of an institutional
   #     directory based on a search. (g) and (h) are required.
   #     (i) is optional. (b) and (c) will be undefined. 
   #
   # (a) $dom - domain
   # (b) $uname - username of user
   # (c) $id - student/faculty ID of user
   # (d) $instusers - reference to hash which will contain info for user
   #                 as key = value; keys will be one or all of:
   #                 lastname,firstname,middlename,generation,id,inststatus -
   #                 institutional status (e.g., faculty,staff,student)
   #                 Values are all scalars except inststatus,
   #                 which is an array.
   # (e) $instids - reference to hash which will contain ID numbers - 
   #                 keys will be unique IDs (student or faculty/staff ID)  
   #                 values will be either: scalar (username) or an array
   #                 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 values: contains, begins (defaults
   #                to exact match otherwise).
   #
   # 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.
   #                with information for specified username, or specified
   #                id, if fifth argument provided, from all available, or 
   #                specified (e.g., faculty only) institutional datafeeds,
   #                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 {
       my ($dom,$uname,$id,$instusers,$instids,$types,
           $srchby,$srchterm,$srchtype) = @_;
       my $outcome = 'unavailable';
       return $outcome;
   }
   
   ###############################
   # sub inst_usertypes 
   #
   # Incoming data: three arguments
   # (a) $dom - domain
   # (b) $usertypes - reference to hash which will contain 
   #                 key = value, where keys are institution 
   #                 affiliation types (e.g., Faculty, Student etc.)
   #                 and values are titles (e.g., Faculty/Academic Staff)
   # (c) $order - reference to array which will contain the order in
   #              which institutional types should be shown
   #              when displaying data tables (e.g., default quotas    
   #              or updateable user fields (see domainprefs.pm) 
   # returns 1 parameter - 'ok' if no processing error, or other value 
   #                        if an error occurred.
   #
   ###############################
   
   sub inst_usertypes {
       my ($dom,$usertypes,$order) = @_;
       @{$order} = ();
       %{$usertypes} = ();
       my $outcome = 'ok';
       return $outcome;
   }
   
 ###############################  ###############################
 # sub AUTOLOAD  # sub AUTOLOAD
Removed from v.1.17  
changed lines
  Added in v.1.24

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