[LON-CAPA-cvs] cvs: loncom /interface lonfeedback.pm

[albertel]

albertel		Fri May 20 13:04:31 2005 EDT

  Modified files:              
    /loncom/interface	lonfeedback.pm 
  Log:
  - xhtmlizing and adding docs
  
  
Index: loncom/interface/lonfeedback.pm
diff -u loncom/interface/lonfeedback.pm:1.162 loncom/interface/lonfeedback.pm:1.163
--- loncom/interface/lonfeedback.pm:1.162	Mon Apr 11 11:33:46 2005
+++ loncom/interface/lonfeedback.pm	Fri May 20 13:04:30 2005
@@ -1,7 +1,7 @@
 # The LearningOnline Network
 # Feedback
 #
-# $Id: lonfeedback.pm,v 1.162 2005/04/11 15:33:46 albertel Exp $
+# $Id: lonfeedback.pm,v 1.163 2005/05/20 17:04:30 albertel Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -2375,17 +2375,48 @@
     return '';
 }
 
+=pod 
+
+=over 4
+
+=item *
+
+decide_receiver($feedurl,$author,$question,$course,$policy,$defaultflag);
+
+Arguments
+  $feedurl - /res/ url of resource (only need if $author is true)
+  $author,$question,$course,$policy - all true/false parameters
+    if true will attempt to find the addresses of user that should receive
+    this type of feedback (author - feedback to author of resource $feedurl,
+    $question 'Resource Content Questions', $course 'Course Content Question',
+    $policy 'Course Policy')
+    (Additionally it also checks $env for whether the corresponding form.<name>
+    element exists, for ease of use in a html response context)
+   
+  $defaultflag - (internal should be left blank) if true gather addresses 
+                 that aren't for a section even if I have a section
+                 (used for reccursion internally, first we look for
+                 addresses for our specific section then we recurse
+                 and look for non section addresses)
+
+Returns
+  $typestyle - string of html text, describing what addresses were found
+  %to - a hash, which keys are addresses of users to send messages to
+        the keys will look like   name:domain
+
+=cut
+
 sub decide_receiver {
   my ($feedurl,$author,$question,$course,$policy,$defaultflag) = @_;
   my $typestyle='';
   my %to=();
   if ($env{'form.author'}||$author) {
-    $typestyle.='Submitting as Author Feedback<br>';
+    $typestyle.='Submitting as Author Feedback<br />';
     $feedurl=~/^\/res\/(\w+)\/(\w+)\//;
     $to{$2.':'.$1}=1;
   }
   if ($env{'form.question'}||$question) {
-    $typestyle.='Submitting as Question<br>';
+    $typestyle.='Submitting as Question<br />';
     foreach (split(/\,/,
 		   $env{'course.'.$env{'request.course.id'}.'.question.email'})
 	     ) {