[LON-CAPA-cvs] cvs: loncom /interface londropadd.pm
jms
lon-capa-cvs-allow@mail.lon-capa.org
Mon, 17 Nov 2008 15:48:46 -0000
This is a MIME encoded message
--jms1226936926
Content-Type: text/plain
jms Mon Nov 17 15:48:46 2008 EDT
Modified files:
/loncom/interface londropadd.pm
Log:
Added/modified POD comments
--jms1226936926
Content-Type: text/plain
Content-Disposition: attachment; filename="jms-20081117154846.txt"
Index: loncom/interface/londropadd.pm
diff -u loncom/interface/londropadd.pm:1.174 loncom/interface/londropadd.pm:1.175
--- loncom/interface/londropadd.pm:1.174 Thu Sep 11 14:47:21 2008
+++ loncom/interface/londropadd.pm Mon Nov 17 15:48:46 2008
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Handler to drop and add students in courses
#
-# $Id: londropadd.pm,v 1.174 2008/09/11 14:47:21 bisitz Exp $
+# $Id: londropadd.pm,v 1.175 2008/11/17 15:48:46 jms Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -26,8 +26,23 @@
# http://www.lon-capa.org/
#
#
-###############################################################
-##############################################################
+
+=head1 NAME
+
+Apache::londropadd
+
+=head1 SYNOPSIS
+
+drop & add students
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+=head1 SUBROUTINES
+
+=over
+
+=cut
package Apache::londropadd;
@@ -42,8 +57,6 @@
use Apache::longroup;
use LONCAPA();
-###############################################################
-###############################################################
sub header {
my ($jscript,$loaditems) = @_;
my $start_page;
@@ -59,9 +72,14 @@
ENDHEAD
}
-###############################################################
-###############################################################
-# Drop student from all sections of a course, except optional $csec
+=pod
+
+=item modifystudent()
+
+ Drop student from all sections of a course, except optional $csec
+
+=cut
+
sub modifystudent {
my ($udom,$unam,$courseid,$csec,$desiredhost)=@_;
# if $csec is undefined, drop the student from all the courses matching
@@ -104,9 +122,14 @@
return $result;
}
-###############################################################
-###############################################################
-# build a domain and server selection form
+=pod
+
+=item domain_form()
+
+ build a domain and server selection form
+
+=cut
+
sub domain_form {
my ($defdom) = @_;
# Set up domain and server selection forms
@@ -135,9 +158,14 @@
return $result;
}
-###############################################################
-###############################################################
-# Menu Phase One
+=pod
+
+=item print_main_menu()
+
+ Menu Phase One
+
+=cut
+
sub print_main_menu {
my ($r,$permission)=@_;
#
@@ -224,13 +252,15 @@
return;
}
-###############################################################
-###############################################################
+
+
sub hidden_input {
my ($name,$value) = @_;
return '<input type="hidden" name="'.$name.'" value="'.$value.'" />'."\n";
}
+
+
sub print_upload_manager_header {
my ($r,$datatoken,$distotal,$krbdefdom)=@_;
my $javascript;
@@ -291,8 +321,10 @@
$javascript."\n".$javascript_validations.'</script>');
}
-###############################################################
-###############################################################
+
+
+
+
sub javascript_validations {
my ($mode,$krbdefdom,$curr_authtype,$curr_authfield,$domain)=@_;
my $authheader;
@@ -471,8 +503,9 @@
return $result;
}
-###############################################################
-###############################################################
+
+
+
sub upload_manager_javascript_forward_associate {
return(<<ENDPICK);
function verify(vf,sec_caller) {
@@ -564,8 +597,9 @@
ENDPICK
}
-###############################################################
-###############################################################
+
+
+
sub upload_manager_javascript_reverse_associate {
return(<<ENDPICK);
function verify(vf,sec_caller) {
@@ -619,8 +653,9 @@
ENDPICK
}
-###############################################################
-###############################################################
+
+
+
sub print_upload_manager_footer {
my ($r,$i,$keyfields,$defdom,$today,$halfyear)=@_;
@@ -673,8 +708,9 @@
return;
}
-###############################################################
-###############################################################
+
+
+
sub print_upload_manager_form {
my $r=shift;
@@ -748,8 +784,10 @@
&print_upload_manager_footer($r,$i,$keyfields,$defdom,$today,$halfyear);
}
-###############################################################
-###############################################################
+
+
+
+
sub enroll_single_student {
my ($r,$srcharray) = @_;
# Remove non alphanumeric values from section
@@ -961,9 +999,14 @@
return $result;
}
-##
-## Single student enrollment routines (some of them)
-##
+=pod
+
+=item get_student_username_domain_form()
+
+ Single student enrollment routines (some of them)
+
+=cut
+
sub get_student_username_domain_form {
my ($r,$elements,$response,$srch,$forcenewuser) = @_;
my $loaditems = {
@@ -1249,7 +1292,14 @@
return;
}
-# ========================================================= Menu Phase Two Drop
+=pod
+
+=item print_drop_menu()
+
+ Menu Phase Two Drop
+
+=cut
+
sub print_drop_menu {
my $r=shift;
$r->print("<h3>".&mt('Drop Students')."</h3>");
@@ -1264,7 +1314,15 @@
return;
}
-# ============================================== view classlist
+
+=pod
+
+=item print_html_classlist()
+
+ view classlist
+
+=cut
+
sub print_html_classlist {
my ($r,$mode,$permission) = @_;
if (! exists($env{'form.sortby'})) {
@@ -1354,7 +1412,15 @@
}
}
-# =================================================== Show student list to drop
+
+=pod
+
+=item show_class_list()
+
+ Show student list to drop
+
+=cut
+
sub show_class_list {
my ($r,$mode,$linkto,$statusmode,$classlist,$keylist)=@_;
my $cid=$env{'request.course.id'};
@@ -1756,9 +1822,14 @@
}
-#
-# print out form for modification of a single students data
-#
+=pod
+
+=item print_modify_student_form()
+
+ print out form for modification of a single students data
+
+=cut
+
sub print_modify_student_form {
my $r = shift();
&Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
@@ -1887,9 +1958,15 @@
return;
}
-#
-# modify a single students section
-#
+
+=pod
+
+=item modify_single_student()
+
+ modify a single students section
+
+=cut
+
sub modify_single_student {
my ($r) = @_;
#
@@ -2119,12 +2196,10 @@
return ($start,$end,$section);
}
-#################################################
-#################################################
=pod
-=item show_drop_list
+=item show_drop_list()
Display a list of students to drop
Inputs:
@@ -2144,8 +2219,6 @@
=cut
-#################################################
-#################################################
sub show_drop_list {
my ($r,$classlist,$keylist,$nosort)=@_;
my $cid=$env{'request.course.id'};
@@ -2305,9 +2378,15 @@
return;
}
-#
-# Print out the initial form to get the courselist file
-#
+
+=pod
+
+=item print_first_courselist_upload_form()
+
+ Print out the initial form to get the courselist file
+
+=cut
+
sub print_first_courselist_upload_form {
my $r=shift;
my $str;
@@ -2332,7 +2411,15 @@
return;
}
-# ================================================= Drop/Add from uploaded file
+
+=pod
+
+=item upfile_drop_add()
+
+ Drop/Add from uploaded file
+
+=cut
+
sub upfile_drop_add {
my $r=shift;
&Apache::loncommon::load_tmp_file($r);
@@ -2646,12 +2733,9 @@
return (\%permission,$allowed);
}
-###################################################################
-###################################################################
-
=pod
-=item &handler
+=item &handler()
The typical handler you see in all these modules. Takes $r, the
http request, as an argument.
@@ -2678,8 +2762,6 @@
=cut
-###################################################################
-###################################################################
sub handler {
my $r=shift;
if ($r->header_only) {
@@ -2890,10 +2972,12 @@
return OK;
}
-###################################################################
-###################################################################
1;
__END__
+=pod
+=back
+
+=cut
--jms1226936926--