loncom/enrollment/localenroll.pm - diff

Return to localenroll.pm CVS log

Up to [LON-CAPA] / loncom / enrollment

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

version 1.18, 2007/02/26 20:52:55	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 491 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 507 sub allusers_info {	Line 513 sub allusers_info {
###############################	###############################
# sub get_userinfo	# sub get_userinfo
#	#
# Incoming data: four required arguments and two optional arguments	# Incoming data: four required arguments and additional optional arguments
# Retrieves institutional data for a single user either by username	# Two modes of operation:
# if $uname is included as second argument, or by ID if $id is	# (1) Retrieves institutional data for a single user either by username
# included as a third argument. Either (b) or (c) must be provided.	# 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	# (a) $dom - domain
# (b) $uname - username of user	# (b) $uname - username of user
# (c) $id - student/faculty ID of user	# (c) $id - student/faculty ID of user
Line 526 sub allusers_info {	Line 538 sub allusers_info {
# if a single ID matches multiple usernames.	# if a single ID matches multiple usernames.
# (f) $types - optional reference to array which contains	# (f) $types - optional reference to array which contains
# institutional types to check.	# 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' 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,
my $outcome = 'ok';	$srchby,$srchterm,$srchtype) = @_;
	my $outcome = 'unavailable';
return $outcome;	return $outcome;
}	}

Line 554 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.
#	#
###############################	###############################

sub inst_usertypes {	sub inst_usertypes {
my ($dom,$usertypes,$order) = @_;	my ($dom,$usertypes,$order) = @_;
	@{$order} = ();
	%{$usertypes} = ();
my $outcome = 'ok';	my $outcome = 'ok';
return $outcome;	return $outcome;
}	}

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

Removed from v.1.18
changed lines
	Added in v.1.24