Update 'view.php'

Added new explanations about some variables and codes

view.php

@@ -1,80 +1,76 @@
 <?php
-// This file is part of
+// This file is part of LInE contributions to Free Education, Private Data
+// LInE (Laboratory of Informatics in Education)
+// http://www.usp.br/line
 //
-// Moodle is free software: you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation, either version 3 of the License, or
-// (at your option) any later version.
+// Moodle is free software: you can redistribute it or modify it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 //
-// Moodle is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU General Public License for more details.
+// Moodle is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 //
-// You should have received a copy of the GNU General Public License
-// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+// You should have received a copy of the GNU General Public License along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-require_once(dirname(dirname(dirname(__FILE__))).'/config.php');
-require_once(dirname(__FILE__).'/lib.php');
-require_once($CFG->libdir.'/filelib.php');
+require_once(dirname(dirname(dirname(__FILE__))) . '/config.php');
+require_once(dirname(__FILE__) . '/lib.php');
+require_once($CFG->libdir . '/filelib.php');
 require_once('locallib.php');
 require_once('libs/student_viewlib.php');
 require_once('libs/teacher_viewlib.php');
 
-global $DB;
-$id = optional_param('id', 0, PARAM_INT); // Course_module ID.
-$g  = optional_param('g', 0, PARAM_INT);  // Gradeimporter instance ID, should be named as the first character of the module.
-$action = optional_param('action', 0, PARAM_INT);
-$fileid   = optional_param('fileid', 0, PARAM_INT);
-$filename   = optional_param('filename', 'a', PARAM_TEXT);
-
-
-
-if ($id) {
-  // ABC
-  if (! $cm = get_coursemodule_from_id('gradeimporter', $id)) {
-    error('Course Module ID was incorrect');
-  }
-  $cm;
-
-  if (! $course = $DB->get_record('course', array('id' => $cm->course))) {
-    error('Course is misconfigured');
-  }
-
+global $DB; // Moodle variable to access data base
+
+// Get parameter passed through HTTP by Moodle
+$id       = optional_param('id', 0, PARAM_INT); // Course_module ID.
+$g        = optional_param('g', 0, PARAM_INT);  // Gradeimporter instance ID, should be named as the first character of the module.
+$action   = optional_param('action', 0, PARAM_INT);
+$fileid   = optional_param('fileid', 0, PARAM_INT); // to download an specific file
+$filename = optional_param('filename', 'a', PARAM_TEXT);
+
+if ($id) { // is $id defined?
+  if (! $cm = get_coursemodule_from_id('gradeimporter', $id)) { // get object from table "coursemodule"
+    error('Course Module ID was incorrect'); //TODO precisa internacionalizar
+    }
+  if (! $course = $DB->get_record('course', array('id' => $cm->course))) { // get object from table "course"
+    error('Course is misconfigured'); //TODO precisa internacionalizar
+    }
   if (! $gradeimporter = $DB->get_record('gradeimporter', array('id' => $cm->instance))) {
-    error('Course module is incorrect');
+    error('Course module is incorrect'); //TODO precisa internacionalizar
+    }
   }
-} else if ($g) {
+else
+if ($g) {
   if (! $gradeimporter = $DB->get_record('gradeimporter', array('id' => $g))) {
-    error('Course module is incorrect');
-  }
+    error('Course module is incorrect'); //TODO precisa internacionalizar
+    }
   if (! $course = $DB->get_record('course', array('id' => $gradeimporter->course))) {
-    error('Course is misconfigured');
-  }
+    error('Course is misconfigured'); //TODO precisa internacionalizar
+    }
   if (! $cm = get_coursemodule_from_instance('gradeimporter', $gradeimporter->id, $course->id)) {
-    error('Course Module ID was incorrect');
+    error('Course Module ID was incorrect'); //TODO precisa internacionalizar
+    }
+  }
+else {
+  error('You must specify a course_module ID or an instance ID'); //TODO precisa internacionalizar
   }
-} else {
-  error('You must specify a course_module ID or an instance ID');
-}
 
 require_login($course, true, $cm);
 
 $context = context_module::instance($cm->id);
 
-
-
 if ($action == 1 && has_capability('mod/gradeimporter:view', $context)) {
   // Download feedback file.
   $fs = get_file_storage();
   $file = $fs->get_file($context->id, 'mod_gradeimporter', 'gradeimporter_feedback', $fileid, '/', $filename);
   if ($file) {
     send_stored_file($file, 86400, 0, true);
+    }
   }
-} else if ($action == 2 && has_capability('mod/gradeimporter:edit', $context)) {
+else
+if ($action == 2 && has_capability('mod/gradeimporter:edit', $context)) {
   // Download students csv with their id.
-  exportcsv($context);
-}
+  exportCSV($context);
+  }
 
 
 // Print the page header.
@@ -85,51 +81,51 @@ $PAGE->set_heading(format_string($course->fullname));
 $PAGE->set_context($context);
 
 $output = $PAGE->get_renderer('mod_folder');
-echo $output->header();
+print $output->header();
 
 $heading = get_string('displayingview', 'gradeimporter', $gradeimporter->name);
 
-echo $output->heading($heading);
+print $output->heading($heading);
 
 
 // Button to add new submission.
 if (has_capability('mod/gradeimporter:edit', $context)) {
   $url = new moodle_url('/mod/gradeimporter/forms/submission/submission.php');
-  $newbutton = '<form action="'. $url . '">'.
-      '<input type="hidden" name="id" value="'. $gradeimporter->id .'" />'.
-      '<input type="hidden" name="cmid" value="'.$cm->id.'" />'.
-      '<input type="submit" Value="'.get_string('newsubmission', 'gradeimporter').'" />'.
-      '</form>';
-  echo $newbutton;
+  $newbutton = '<form action="'. $url . '">' . "\n" .
+    '<input type="hidden" name="id" value="'. $gradeimporter->id .'" />' . "\n" .
+    '<input type="hidden" name="cmid" value="'.$cm->id.'" />' . "\n" .
+    '<input type="submit" Value="'.get_string('newsubmission', 'gradeimporter').'" />' . "\n" .
+    '</form>' . "\n";
+  print $newbutton;
 
   $url = new moodle_url("/mod/gradeimporter/view.php", array('id' => $id, 'cmid' => $cm->id, 'action' => 2));
-  $newbutton = '<form action="'. $url . '">'.
-    '<input type="hidden" name="id" value="'. $id .'" />'.
-    '<input type="hidden" name="cmid" value="'.$cm->id.'" />'.
-    '<input type="hidden" name="action" value="2" />'.
-    '<input type="submit" Value="'.get_string('downloadconfigcsv', 'gradeimporter').'" />'.
-    '</form>';
-  echo $newbutton;
-}
+  $newbutton = '<form action="'. $url . '">'. "\n" .
+    '<input type="hidden" name="id" value="'. $id .'" />' . "\n" .
+    '<input type="hidden" name="cmid" value="'.$cm->id.'" />' . "\n" .
+    '<input type="hidden" name="action" value="2" />' . "\n" .
+    '<input type="submit" Value="' . get_string('downloadconfigcsv', 'gradeimporter') . '" />' . "\n" .
+    '</form>' . "\n";
+  print $newbutton;
+  }
 
-// Tabela com as notas vem aqui.
+// Table of this instance are bellow: students, grades and file
 
 require_once($CFG->libdir . '/tablelib.php');
-require_once(dirname(__FILE__).'/locallib.php');
+require_once(dirname(__FILE__) . '/locallib.php');
 
 if (has_capability('mod/gradeimporter:edit', $context)) {
   // Loads teacher view.
   // get_teacher_view($cm->id, $gradeimporter->id);
   $teacherview = new Teacherview($cm->id, $gradeimporter->id);
   $teachertable = $teacherview->make_table();
-  echo $teachertable;
-} else {
+  print $teachertable;
+  } 
+else {
   // Load student view
-
   // Query database to find student feedbacks
-  $feedbacks = query_feedbacks($gradeimporter->id);
+  $feedbacks = query_feedbacks($cm->id, $gradeimporter->id);
   make_feedback_table($feedbacks, $cm->id);
-}
+  }
 
 // Finishes the page!
-echo $output->footer();
+print $output->footer();