General cleanup

Coding style Whitespace Some changes to docblocks and comments Page URLs in teacher view
bostelm · May 21, 2016 · 9e10ba3 · 9e10ba3
1 parent b1eb865
commit 9e10ba3
Show file tree

Hide file tree

Showing 40 changed files with 319 additions and 373 deletions.
diff --git a/ajax.php b/ajax.php
@@ -3,8 +3,7 @@
 /**
  * Process ajax requests
  *
- * @package    mod
- * @subpackage scheduler
+ * @package    mod_scheduler
  * @copyright  2014 Henning Bostelmann and others (see README.txt)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/appointmentforms.php b/appointmentforms.php
@@ -41,10 +41,10 @@ protected function definition() {
         $mform = $this->_form;
         $scheduler = $this->appointment->get_scheduler();
 
-        // Seen tickbox
+        // Seen tickbox.
         $mform->addElement('checkbox', 'attended', get_string('attended', 'scheduler'));
 
-        // Grade
+        // Grade.
         if ($scheduler->scale != 0) {
             if ($this->editgrade) {
                 $gradechoices = $output->grading_choices($scheduler);

diff --git a/classes/event/appointment_base.php b/classes/event/appointment_base.php
@@ -1,25 +1,20 @@
 <?php
+
 /**
  * Base class for appointment-based events.
  *
- * @package    mod
- * @subpackage scheduler
+ * @package    mod_scheduler
  * @copyright  2014 Henning Bostelmann and others (see README.txt)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-
 namespace mod_scheduler\event;
 
 defined('MOODLE_INTERNAL') || die();
 
 /**
  * The mod_scheduler abstract base event class for appointment-based events.
  *
- * @package    mod
- * @subpackage scheduler
- * @copyright  2014 Henning Bostelmann and others (see README.txt)
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 abstract class appointment_base extends \core\event\base {
 

diff --git a/classes/event/appointment_list_viewed.php b/classes/event/appointment_list_viewed.php
@@ -1,11 +1,11 @@
 <?php
+
 /**
  * The mod_scheduler appointment list viewed event.
  *
  * Indicates that a teacher has viewed the list of appointments and slots.
  *
- * @package    mod
- * @subpackage scheduler
+ * @package    mod_scheduler
  * @copyright  2014 Henning Bostelmann and others (see README.txt)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/classes/event/booking_added.php b/classes/event/booking_added.php
@@ -1,16 +1,15 @@
 <?php
+
 /**
  * The mod_scheduler booking form added event.
  *
  * Indicates that a student has booked into a slot.
  *
- * @package    mod
- * @subpackage scheduler
+ * @package    mod_scheduler
  * @copyright  2014 Henning Bostelmann and others (see README.txt)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-
 namespace mod_scheduler\event;
 defined('MOODLE_INTERNAL') || die();
 

diff --git a/classes/event/booking_form_viewed.php b/classes/event/booking_form_viewed.php
@@ -1,11 +1,11 @@
 <?php
+
 /**
  * The mod_scheduler booking form viewed event.
  *
  * Indicates that a student has viewed the booking form.
  *
- * @package    mod
- * @subpackage scheduler
+ * @package    mod_scheduler
  * @copyright  2014 Henning Bostelmann and others (see README.txt)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/classes/event/booking_removed.php b/classes/event/booking_removed.php
@@ -1,11 +1,11 @@
 <?php
+
 /**
  * The mod_scheduler booking form removed event.
  *
  * Indicates that a student has removed their booking from a slot.
  *
- * @package    mod
- * @subpackage scheduler
+ * @package    mod_scheduler
  * @copyright  2014 Henning Bostelmann and others (see README.txt)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/classes/event/course_module_instance_list_viewed.php b/classes/event/course_module_instance_list_viewed.php
@@ -1,15 +1,15 @@
 <?php
+
 /**
  * The mod_scheduler course module viewed event.
  *
- * @package    mod
- * @subpackage scheduler
+ * @package    mod_scheduler
  * @copyright  2014 Henning Bostelmann and others (see README.txt)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-
 namespace mod_scheduler\event;
+
 defined('MOODLE_INTERNAL') || die();
 
 class course_module_instance_list_viewed extends \core\event\course_module_instance_list_viewed {

diff --git a/classes/event/scheduler_base.php b/classes/event/scheduler_base.php
@@ -1,23 +1,21 @@
 <?php
+
 /**
  * Base class for scheduler events.
  *
- * @package    mod
- * @subpackage scheduler
+ * @package    mod_scheduler
  * @copyright  2014 Henning Bostelmann and others (see README.txt)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-
 namespace mod_scheduler\event;
 
 defined('MOODLE_INTERNAL') || die();
 
 /**
  * The mod_scheduler abstract base event class.
  *
- * @package    mod
- * @subpackage scheduler
+ * @package    mod_scheduler
  * @copyright  2014 Henning Bostelmann and others (see README.txt)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/classes/event/slot_added.php b/classes/event/slot_added.php
@@ -1,17 +1,17 @@
 <?php
+
 /**
  * The mod_scheduler slot added event.
  *
  * Indicates that a teacher has added a slot.
  *
- * @package    mod
- * @subpackage scheduler
+ * @package    mod_scheduler
  * @copyright  2014 Henning Bostelmann and others (see README.txt)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-
 namespace mod_scheduler\event;
+
 defined('MOODLE_INTERNAL') || die();
 
 class slot_added extends slot_base {

diff --git a/classes/event/slot_base.php b/classes/event/slot_base.php
@@ -1,25 +1,20 @@
 <?php
+
 /**
  * Base class for slot-based events.
  *
- * @package    mod
- * @subpackage scheduler
+ * @package    mod_scheduler
  * @copyright  2014 Henning Bostelmann and others (see README.txt)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-
 namespace mod_scheduler\event;
 
 defined('MOODLE_INTERNAL') || die();
 
 /**
  * The mod_scheduler abstract base event class for slot-based events.
  *
- * @package    mod
- * @subpackage scheduler
- * @copyright  2014 Henning Bostelmann and others (see README.txt)
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 abstract class slot_base extends \core\event\base {
 

diff --git a/classes/event/slot_deleted.php b/classes/event/slot_deleted.php
@@ -1,17 +1,17 @@
 <?php
+
 /**
  * The mod_scheduler slot deleted event.
  *
  * Indicates that a teacher has deleted a slot.
  *
- * @package    mod
- * @subpackage scheduler
+ * @package    mod_scheduler
  * @copyright  2014 Henning Bostelmann and others (see README.txt)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-
 namespace mod_scheduler\event;
+
 defined('MOODLE_INTERNAL') || die();
 
 class slot_deleted extends slot_base {

diff --git a/datelist.php b/datelist.php
@@ -3,8 +3,7 @@
 /**
  * Shows a sortable list of appointments
  *
- * @package    mod
- * @subpackage scheduler
+ * @package    mod_scheduler
  * @copyright  2015 Henning Bostelmann and others (see README.txt)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -40,6 +39,8 @@
                 array('id' => $scheduler->cmid, 'what' => 'datelist', 'scope' => $scope, 'teacherid' => $teacherid));
 $returnurl = new moodle_url('/mod/scheduler/view.php', array('id' => $scheduler->cmid));
 
+$PAGE->set_url($taburl);
+
 echo $output->header();
 
 // Print top tabs.

diff --git a/db/access.php b/db/access.php
@@ -1,9 +1,9 @@
 <?php
+
 /**
  * Scheduler module capability definition
  *
- * @package    mod
- * @subpackage scheduler
+ * @package    mod_scheduler
  */
 
 $capabilities = array(

diff --git a/db/upgrade.php b/db/upgrade.php
@@ -35,7 +35,7 @@ function xmldb_scheduler_upgrade($oldversion=0) {
 
     if ($oldversion < 2011081302) {
 
-        // Rename description field to intro, and define field introformat to be added to scheduler
+        // Rename description field to intro, and define field introformat to be added to scheduler.
         $table = new xmldb_table('scheduler');
         $introfield = new xmldb_field('description', XMLDB_TYPE_TEXT, 'small', null, XMLDB_NOTNULL, null, null, 'name');
         $dbman->rename_field($table, $introfield, 'intro', false);
@@ -47,7 +47,7 @@ function xmldb_scheduler_upgrade($oldversion=0) {
             $dbman->add_field($table, $formatfield);
         }
 
-        // conditionally migrate to html format in intro
+        // Conditionally migrate to html format in intro.
         if ($CFG->texteditors !== 'textarea') {
             $rs = $DB->get_recordset('scheduler', array('introformat' => FORMAT_MOODLE),
                 '', 'id, intro, introformat');
@@ -60,15 +60,15 @@ function xmldb_scheduler_upgrade($oldversion=0) {
             $rs->close();
         }
 
-        // savepoint reached
+        // Savepoint reached.
         upgrade_mod_savepoint(true, 2011081302, 'scheduler');
     }
 
     /* ******************* 2.5 upgrade line ********************** */
 
     if ($oldversion < 2012102903) {
 
-        // Define fields notesformat and appointmentnote in respective tables
+        // Define fields notesformat and appointmentnote in respective tables.
         $table = new xmldb_table('scheduler_slots');
         $formatfield = new xmldb_field('notesformat', XMLDB_TYPE_INTEGER, '4', XMLDB_UNSIGNED,
             XMLDB_NOTNULL, null, '0', 'notes');
@@ -83,14 +83,14 @@ function xmldb_scheduler_upgrade($oldversion=0) {
             $dbman->add_field($table, $formatfield);
         }
 
-        // migrate html format
+        // Migrate html format.
         if ($CFG->texteditors !== 'textarea') {
             upgrade_set_timeout();
             $DB->set_field('scheduler_slots', 'notesformat', FORMAT_HTML);
             $DB->set_field('scheduler_appointment', 'appointmentnoteformat', FORMAT_HTML);
         }
 
-        // savepoint reached
+        // Savepoint reached.
         upgrade_mod_savepoint(true, 2012102903, 'scheduler');
     }
 

diff --git a/export.php b/export.php
@@ -23,6 +23,7 @@
 
 $actionurl = new moodle_url('/mod/scheduler/view.php', array('what' => 'export', 'id' => $scheduler->cmid));
 $returnurl = new moodle_url('/mod/scheduler/view.php', array('what' => 'view', 'id' => $scheduler->cmid));
+$PAGE->set_url($actionurl);
 $mform = new scheduler_export_form($actionurl, $scheduler);
 
 if ($mform->is_cancelled()) {

diff --git a/exportform.php b/exportform.php
@@ -4,8 +4,7 @@
  * Export settings form
  * (using Moodle formslib)
  *
- * @package    mod
- * @subpackage scheduler
+ * @package    mod_scheduler
  * @copyright  2015 Henning Bostelmann and others (see README.txt)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -32,10 +31,14 @@ protected function definition() {
         $mform->addElement('header', 'general', get_string('general', 'form'));
 
         $radios = array();
-        $radios[] = $mform->createElement('radio', 'content', '', get_string('onelineperslot', 'scheduler'), 'onelineperslot');
-        $radios[] = $mform->createElement('radio', 'content', '', get_string('onelineperappointment', 'scheduler'),  'onelineperappointment');
-        $radios[] = $mform->createElement('radio', 'content', '', get_string('appointmentsgrouped', 'scheduler'), 'appointmentsgrouped');
-        $mform->addGroup($radios, 'contentgroup', get_string('contentformat', 'scheduler'), null, false);
+        $radios[] = $mform->createElement('radio', 'content', '',
+                                          get_string('onelineperslot', 'scheduler'), 'onelineperslot');
+        $radios[] = $mform->createElement('radio', 'content', '',
+                                          get_string('onelineperappointment', 'scheduler'),  'onelineperappointment');
+        $radios[] = $mform->createElement('radio', 'content', '',
+                                          get_string('appointmentsgrouped', 'scheduler'), 'appointmentsgrouped');
+        $mform->addGroup($radios, 'contentgroup',
+                                          get_string('contentformat', 'scheduler'), null, false);
         $mform->setDefault('content', 'onelineperappointment');
         $mform->addHelpButton('contentgroup', 'contentformat', 'scheduler');
 
@@ -96,7 +99,7 @@ protected function definition() {
         $mform->addElement('select', 'pdforientation', get_string('pdforientation', 'scheduler'),  $selopt);
         $mform->disabledIf('pdforientation', 'outputformat', 'neq', 'pdf');
 
-        $buttonarray=array();
+        $buttonarray = array();
         $buttonarray[] = $mform->createElement('submit', 'preview', get_string('preview', 'scheduler'));
         $buttonarray[] = $mform->createElement('submit', 'submitbutton', get_string('createexport', 'scheduler'));
         $buttonarray[] = $mform->createElement('cancel');