Implemented preferences.php (previously attsettings.php)

danmarsden · Jul 8, 2011 · 276c604 · 276c604
1 parent 9d8c2e8
commit 276c604
Show file tree

Hide file tree

Showing 8 changed files with 337 additions and 23 deletions.
diff --git a/attforblock.js b/attforblock.js
diff --git a/locallib.php b/locallib.php
@@ -85,6 +85,11 @@ public function can_change_preferences() {
         return $this->canchangepreferences;
     }
 
+    public function require_change_preferences_capability() {
+        require_capability('mod/attforblock:changepreferences', $this->context);
+    }
+
+
     public function can_export() {
         if (is_null($this->canexport))
             $this->canexport = has_capability('mod/attforblock:export', $this->context);
@@ -320,6 +325,29 @@ public function get_significant_params() {
     }
 }
 
+class att_preferences_page_params {
+    const ACTION_ADD              = 1;
+    const ACTION_DELETE           = 2;
+    const ACTION_HIDE             = 3;
+    const ACTION_SHOW             = 4;
+    const ACTION_SAVE             = 5;
+
+    /** @var int view mode of taking attendance page*/
+    public $action;
+
+    public $statusid;
+
+    public function get_significant_params() {
+        $params = array();
+
+        if (isset($this->action)) $params['action'] = $this->action;
+        if (isset($this->statusid)) $params['statusid'] = $this->statusid;
+
+        return $params;
+    }
+}
+
+
 
 class attforblock {
     const SESSION_COMMON        = 0;
@@ -562,9 +590,9 @@ public function url_export() {
     /**
      * @return moodle_url of attsettings.php for attendance instance
      */
-    public function url_settings() {
-        $params = array('id' => $this->cm->id);
-        return new moodle_url('/mod/attforblock/attsettings.php', $params);
+    public function url_preferences($params=array()) {
+        $params = array_merge(array('id' => $this->cm->id), $params);
+        return new moodle_url('/mod/attforblock/preferences.php', $params);
     }
 
     /**
@@ -1042,6 +1070,59 @@ public function update_sessions_duration($sessionsids, $duration) {
         }
         // TODO: log
     }
+
+    public function remove_status($statusid) {
+        global $DB;
+
+        $DB->set_field('attendance_statuses', 'deleted', 1, array('id' => $statusid));
+    }
+
+    public function add_status($acronym, $description, $grade) {
+        global $DB;
+
+        if ($acronym && $description) {
+            $rec = new stdClass();
+            $rec->courseid = $this->course->id;
+            $rec->attendanceid = $this->id;
+            $rec->acronym = $acronym;
+            $rec->description = $description;
+            $rec->grade = $grade;
+            $DB->insert_record('attendance_statuses', $rec);
+
+            // TODO: log
+            //add_to_log($course->id, 'attendance', 'setting added', 'mod/attforblock/attsettings.php?course='.$course->id, $user->lastname.' '.$user->firstname);
+        } else {
+            print_error('cantaddstatus', 'attforblock', $this->url_preferences());
+        }
+    }
+
+    public function update_status($statusid, $acronym, $description, $grade, $visible) {
+        global $DB;
+
+        $updated = array();
+
+        $status = new stdClass();
+        $status->id = $statusid;
+        if ($acronym) {
+            $status->acronym = $acronym;
+            $updated[] = $acronym;
+        }
+        if ($description) {
+            $status->description = $description;
+            $updated[] = $description;
+        }
+        if (isset($grade)) {
+            $status->grade = $grade;
+            $updated[] = $grade;
+        }
+        if (isset($visible)) {
+            $status->visible = $visible;
+            $updated[] = $visible ? get_string('show') : get_string('hide');
+        }
+        $DB->update_record('attendance_statuses', $status);
+
+        // TODO: log
+    }
 }
 
 
@@ -1154,4 +1235,10 @@ function update_all_users_grades($attid, $course, $context) {
                         $attid, 0, $grades);
 }
 
+function has_logs_for_status($statusid) {
+    global $DB;
+
+    return $DB->count_records('attendance_log', array('statusid'=> $statusid)) > 0;
+}
+
 ?>
diff --git a/module.js b/module.js
@@ -0,0 +1,27 @@
+M.mod_attforblock = {}
+
+M.mod_attforblock.init_manage = function(Y) {
+
+    Y.on('click', function(e) {
+        if (e.target.get('checked'))
+            checkall();
+        else
+            checknone();
+    }, '#cb_selector' );
+
+};
+
+M.mod_attforblock.set_preferences_action = function(action) {
+    var item = document.getElementById('preferencesaction');
+    if (item) {
+        item.setAttribute('value', action);
+    }
+    else {
+        item = document.getElementById('preferencesform');
+        var input = document.createElement("input");
+        input.setAttribute("type", "hidden");
+        input.setAttribute("name", "action");
+        input.setAttribute("value", action);
+        item.appendChild(input);
+    }
+};
diff --git a/preferences.php b/preferences.php
@@ -0,0 +1,98 @@
+<?php
+
+/**
+ * Manage attendance settings
+ *
+ * @package    mod
+ * @subpackage attforblock
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+require_once(dirname(__FILE__).'/../../config.php');
+require_once(dirname(__FILE__).'/locallib.php');
+
+$pageparams = new att_preferences_page_params();
+
+$id                         = required_param('id', PARAM_INT);
+$pageparams->action         = optional_param('action', NULL, PARAM_INT);
+$pageparams->statusid       = optional_param('statusid', NULL, PARAM_INT);
+
+$cm             = get_coursemodule_from_id('attforblock', $id, 0, false, MUST_EXIST);
+$course         = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);
+$att            = $DB->get_record('attforblock', array('id' => $cm->instance), '*', MUST_EXIST);
+
+require_login($course, true, $cm);
+
+$att = new attforblock($att, $cm, $course, $PAGE->context, $pageparams);
+
+$att->perm->require_change_preferences_capability();
+
+$PAGE->set_url($att->url_preferences());
+$PAGE->set_title($course->shortname. ": ".$att->name.' - '.get_string('settings', 'attforblock'));
+$PAGE->set_heading($course->fullname);
+$PAGE->set_cacheable(true);
+$PAGE->set_button($OUTPUT->update_module_button($cm->id, 'attforblock'));
+$PAGE->navbar->add(get_string('settings', 'attforblock'));
+
+switch ($att->pageparams->action) {
+    case att_preferences_page_params::ACTION_ADD:
+        $newacronym			= optional_param('newacronym', null, PARAM_MULTILANG);
+        $newdescription		= optional_param('newdescription', null, PARAM_MULTILANG);
+        $newgrade			= optional_param('newgrade', 0, PARAM_INT);
+
+        $att->add_status($newacronym, $newdescription, $newgrade);
+        break;
+    case att_preferences_page_params::ACTION_DELETE:
+        if (has_logs_for_status($att->pageparams->statusid))
+            print_error('cantdeletestatus', 'attforblock', "attsettings.php?id=$id");
+
+        $confirm    = optional_param('confirm', NULL, PARAM_INT);
+        if (isset($confirm)) {
+            $att->remove_status($att->pageparams->statusid);
+            redirect($att->url_preferences(), get_string('statusdeleted','attforblock'));
+        }
+
+        $statuses = $att->get_statuses();
+        $status = $statuses[$att->pageparams->statusid];
+        $message = get_string('deletecheckfull', '', get_string('variable', 'attforblock'));
+        $message .= str_repeat(html_writer::empty_tag('br'), 2);
+        $message .= $status->acronym.': '.($status->description ? $status->description : get_string('nodescription', 'attforblock'));
+        $params = array_merge($att->pageparams->get_significant_params(), array('confirm' => 1));
+        echo $OUTPUT->header();
+        echo $OUTPUT->heading(get_string('attendanceforthecourse','attforblock').' :: ' .$course->fullname);
+        echo $OUTPUT->confirm($message, $att->url_preferences($params), $att->url_preferences());
+        echo $OUTPUT->footer();
+        exit;
+    case att_preferences_page_params::ACTION_HIDE:
+        $att->update_status($att->pageparams->statusid, null, null, null, 0);
+        break;
+    case att_preferences_page_params::ACTION_SHOW:
+        $att->update_status($att->pageparams->statusid, null, null, null, 1);
+        break;
+    case att_preferences_page_params::ACTION_SAVE:
+        $acronym 		= required_param('acronym', PARAM_MULTILANG);
+        $description	= required_param('description', PARAM_MULTILANG);
+        $grade			= required_param('grade', PARAM_INT);
+
+        foreach ($acronym as $id => $v) {
+            $att->update_status($id, $acronym[$id], $description[$id], $grade[$id], null);
+        }
+        update_all_users_grades($att->id, $att->course, $att->context);
+        break;
+}
+
+$output = $PAGE->get_renderer('mod_attforblock');
+$tabs = new attforblock_tabs($att, attforblock_tabs::TAB_PREFERENCES);
+$prefdata = new attforblock_preferences_data($att);
+
+/// Output starts here
+
+echo $output->header();
+echo $output->heading(get_string('attendanceforthecourse','attforblock').' :: ' .$course->fullname);
+echo $output->render($tabs);
+echo $output->render($prefdata);
+
+echo $output->footer();
+
+?>
diff --git a/renderables.php b/renderables.php
@@ -20,11 +20,11 @@
  *
  */
 class attforblock_tabs implements renderable {
-    const TAB_SESSIONS  = 1;
-    const TAB_ADD       = 2;
-    const TAB_REPORT    = 3;
-    const TAB_EXPORT    = 4;
-    const TAB_SETTINGS  = 5;
+    const TAB_SESSIONS      = 1;
+    const TAB_ADD           = 2;
+    const TAB_REPORT        = 3;
+    const TAB_EXPORT        = 4;
+    const TAB_PREFERENCES   = 5;
 
     public $currenttab;
 
@@ -71,7 +71,7 @@ public function get_tabs() {
         }
 
         if ($this->att->perm->can_change_preferences()) {
-            $toprow[] = new tabobject(self::TAB_SETTINGS, $this->att->url_settings()->out(),
+            $toprow[] = new tabobject(self::TAB_PREFERENCES, $this->att->url_preferences()->out(),
                         get_string('settings','attforblock'));
         }
 
@@ -482,6 +482,27 @@ public function url($params=array()) {
 
 }
 
+class attforblock_preferences_data implements renderable {
+    public $statuses;
+
+    private $att;
+
+    public function __construct(attforblock $att) {
+        $this->statuses = $att->get_statuses(false);
+
+        foreach ($this->statuses as $st) $st->haslogs = has_logs_for_status ($st->id);
+
+        $this->att = $att;
+    }
+
+    public function url($params=array(), $significant_params=TRUE) {
+        if ($significant_params)
+            $params = array_merge($this->att->pageparams->get_significant_params(), $params);
+
+        return $this->att->url_preferences($params);
+    }
+}
+
 class url_helpers {
     public static function url_take($att, $sessionid, $grouptype) {
         $params = array('sessionid' => $sessionid);