From ca82569b5b94e25bb92b5652b19c4cf29aca8b95 Mon Sep 17 00:00:00 2001
From: skodak <skodak>
Date: Wed, 29 Aug 2007 16:47:16 +0000
Subject: [PATCH] grade export form refactoring

---
 grade/export/grade_export_form.php         | 79 ++++++++++++----------
 grade/export/txt/grade_export_txt_form.php | 35 ----------
 grade/export/txt/index.php                 |  3 +-
 grade/export/xml/index.php                 |  2 +-
 4 files changed, 46 insertions(+), 73 deletions(-)
 delete mode 100755 grade/export/txt/grade_export_txt_form.php

diff --git a/grade/export/grade_export_form.php b/grade/export/grade_export_form.php
index 03dff894854..9c3f935009d 100755
--- a/grade/export/grade_export_form.php
+++ b/grade/export/grade_export_form.php
@@ -6,10 +6,10 @@ class grade_export_form extends moodleform {
         global $CFG, $COURSE, $USER;
 
         $mform =& $this->_form;
-        if (isset($this->_customdata['plugin'])) {  // hardcoding plugin names here is hacky
-            $plugin = $this->_customdata['plugin'];
+        if (isset($this->_customdata)) {  // hardcoding plugin names here is hacky
+            $features = $this->_customdata;
         } else {
-            $plugin = 'unknown';
+            $features = array();
         }
 
         $mform->addElement('header', 'options', get_string('options', 'grades'));
@@ -19,50 +19,59 @@ class grade_export_form extends moodleform {
         $mform->setHelpButton('export_letters', array(false, get_string('exportletters', 'grades'),
                 false, true, false, get_string("exportlettershelp", 'grades')));
 
-        $mform->addElement('header', 'publishing', get_string('publishing', 'grades'));
-        $options = array(get_string('nopublish', 'grades'), get_string('createnewkey', 'userkey'));
-        if ($keys = get_records_select('user_private_key', "script='grade/export' AND instance={$COURSE->id} AND userid={$USER->id}")) {
-            foreach ($keys as $key) {
-                $options[$key->value] = $key->value; // TODO: add ip, date, etc.??
-            }
+        $options = array('10'=>10, '20'=>20, '100'=>100, '1000'=>1000, '100000'=>100000);
+        $mform->addElement('select', 'previewrows', 'Preview rows', $options); // TODO: localize
+
+        if (!empty($features['includeseparator'])) {
+            $radio = array();
+            $radio[] = &MoodleQuickForm::createElement('radio', 'separator', null, get_string('septab', 'grades'), 'tab');
+            $radio[] = &MoodleQuickForm::createElement('radio', 'separator', null, get_string('sepcomma', 'grades'), 'comma');
+            $mform->addGroup($radio, 'separator', get_string('separator', 'grades'), ' ', false);
+            $mform->setDefault('separator', 'comma');
         }
-        $mform->addElement('select', 'key', get_string('userkey', 'userkey'), $options);
-        $mform->setHelpButton('key', array(false, get_string('userkey', 'userkey'),
-                false, true, false, get_string("userkeyhelp", 'grades')));
-        $mform->addElement('static', 'keymanagerlink', get_string('keymanager', 'userkey'),
-                '<a href="'.$CFG->wwwroot.'/grade/export/keymanager.php?id='.$COURSE->id.'">'.get_string('keymanager', 'userkey').'</a>');
 
-        $mform->addElement('text', 'iprestriction', get_string('keyiprestriction', 'userkey'), array('size'=>80));
-        $mform->setHelpButton('iprestriction', array(false, get_string('keyiprestriction', 'userkey'),
-                false, true, false, get_string("keyiprestrictionhelp", 'userkey')));
+        if (!empty($features['publishing'])) {
+            $mform->addElement('header', 'publishing', get_string('publishing', 'grades'));
+            $options = array(get_string('nopublish', 'grades'), get_string('createnewkey', 'userkey'));
+            if ($keys = get_records_select('user_private_key', "script='grade/export' AND instance={$COURSE->id} AND userid={$USER->id}")) {
+                foreach ($keys as $key) {
+                    $options[$key->value] = $key->value; // TODO: add more details - ip restriction, valid until ??
+                }
+            }
+            $mform->addElement('select', 'key', get_string('userkey', 'userkey'), $options);
+            $mform->setHelpButton('key', array(false, get_string('userkey', 'userkey'),
+                    false, true, false, get_string("userkeyhelp", 'grades')));
+            $mform->addElement('static', 'keymanagerlink', get_string('keymanager', 'userkey'),
+                    '<a href="'.$CFG->wwwroot.'/grade/export/keymanager.php?id='.$COURSE->id.'">'.get_string('keymanager', 'userkey').'</a>');
+    
+            $mform->addElement('text', 'iprestriction', get_string('keyiprestriction', 'userkey'), array('size'=>80));
+            $mform->setHelpButton('iprestriction', array(false, get_string('keyiprestriction', 'userkey'),
+                    false, true, false, get_string("keyiprestrictionhelp", 'userkey')));
+    
+            $mform->addElement('date_time_selector', 'validuntil', get_string('keyvaliduntil', 'userkey'), array('optional'=>true));
+            $mform->setHelpButton('validuntil', array(false, get_string('keyvaliduntil', 'userkey'),
+                    false, true, false, get_string("keyvaliduntilhelp", 'userkey')));
+            $mform->disabledIf('iprestriction', 'key', get_string('createnewkey', 'userkey'));
+            $mform->disabledIf('validuntil', 'key', get_string('createnewkey', 'userkey'));
+        }
 
-        $mform->addElement('date_time_selector', 'validuntil', get_string('keyvaliduntil', 'userkey'), array('optional'=>true));
-        $mform->setHelpButton('validuntil', array(false, get_string('keyvaliduntil', 'userkey'),
-                false, true, false, get_string("keyvaliduntilhelp", 'userkey')));
-        $mform->disabledIf('iprestriction', 'key', get_string('createnewkey', 'userkey'));
-        $mform->disabledIf('validuntil', 'key', get_string('createnewkey', 'userkey'));
-
-        $mform->addElement('header', 'general', get_string('gradeitemsinc', 'grades')); // TODO: localize
-
-        $mform->addElement('hidden', 'id', $COURSE->id);
+        $mform->addElement('header', 'gradeitems', get_string('gradeitemsinc', 'grades')); // TODO: localize
 
         if ($grade_items = grade_item::fetch_all(array('courseid'=>$COURSE->id))) {
             foreach ($grade_items as $grade_item) {
-                if ($plugin != 'xmlexport' || $grade_item->idnumber) {
-                    $mform->addElement('advcheckbox', 'itemids['.$grade_item->id.']', $grade_item->get_name());
-                    $mform->setDefault('itemids['.$grade_item->id.']', 1);
-
-                } else {
+                if (!empty($features['idnumberrequired']) and empty($grade_item->idnumber)) {
                     $mform->addElement('advcheckbox', 'itemids['.$grade_item->id.']', $grade_item->get_name(), get_string('noidnumber'));
                     $mform->hardFreeze('itemids['.$grade_item->id.']');
-                    $noidnumber = true;
+                    
+                } else {
+                    $mform->addElement('advcheckbox', 'itemids['.$grade_item->id.']', $grade_item->get_name());
+                    $mform->setDefault('itemids['.$grade_item->id.']', 1);
                 }
             }
         }
 
-        $options = array('10'=>10, '20'=>20, '100'=>100, '1000'=>1000, '100000'=>100000);
-        $mform->addElement('select', 'previewrows', 'Preview rows', $options); // TODO: localize
-        $mform->setType('previewrows', PARAM_INT);
+        $mform->addElement('hidden', 'id', $COURSE->id);
+
         $this->add_action_buttons(false, get_string('submit'));
     }
 }
diff --git a/grade/export/txt/grade_export_txt_form.php b/grade/export/txt/grade_export_txt_form.php
deleted file mode 100755
index c4795560e46..00000000000
--- a/grade/export/txt/grade_export_txt_form.php
+++ /dev/null
@@ -1,35 +0,0 @@
-<?php // $Id$
-require_once $CFG->libdir.'/formslib.php';
-
-class grade_export_txt_form extends moodleform {
-    function definition (){
-        global $CFG, $COURSE;
-
-        $mform =& $this->_form;
-
-        $mform->addElement('advcheckbox', 'export_letters', get_string('exportletters', 'grades'));
-        $mform->setDefault('export_letters', 0);
-        $mform->setHelpButton('export_letters', array(false, get_string('exportletters', 'grades'),
-                          false, true, false, get_string("exportlettershelp", 'grades')));
-
-        $mform->addElement('header', 'general', 'Gradeitems to be included'); // TODO: localize
-        $mform->addElement('hidden', 'id', $COURSE->id);
-        if ($grade_items = grade_item::fetch_all(array('courseid'=>$COURSE->id))) {
-            foreach ($grade_items as $grade_item) {
-                $mform->addElement('advcheckbox', 'itemids['.$grade_item->id.']', $grade_item->get_name());
-                $mform->setDefault('itemids['.$grade_item->id.']', 1);
-            }
-        }
-        $options = array('10'=>10, '20'=>20, '100'=>100, '1000'=>1000, '100000'=>100000);
-        $mform->addElement('select', 'previewrows', 'Preview rows', $options); // TODO: localize
-        $mform->setType('previewrows', PARAM_INT);
-        $radio = array();
-        $radio[] = &MoodleQuickForm::createElement('radio', 'separator', null, get_string('septab', 'grades'), 'tab');
-        $radio[] = &MoodleQuickForm::createElement('radio', 'separator', null, get_string('sepcomma', 'grades'), 'comma');
-        $mform->addGroup($radio, 'separator', get_string('separator', 'grades'), ' ', false);
-        $mform->setDefault('separator', 'comma');
-
-        $this->add_action_buttons(false, get_string('submit'));
-    }
-}
-?>
diff --git a/grade/export/txt/index.php b/grade/export/txt/index.php
index f65ff7694d4..ea9d909ada9 100755
--- a/grade/export/txt/index.php
+++ b/grade/export/txt/index.php
@@ -26,7 +26,6 @@
 require_once '../../../config.php';
 require_once $CFG->dirroot.'/grade/export/lib.php';
 require_once 'grade_export_txt.php';
-require_once 'grade_export_txt_form.php';
 
 $id       = required_param('id', PARAM_INT); // course id
 $feedback = optional_param('feedback', '', PARAM_ALPHA);
@@ -49,7 +48,7 @@ $navigation = grade_build_nav(__FILE__, $actionstr, array('courseid' => $course-
 print_header($course->shortname.': '.get_string('grades'), $course->fullname, $navigation);
 print_grade_plugin_selector($id, 'export', 'txt');
 
-$mform = new grade_export_txt_form();
+$mform = new grade_export_form(null, array('includeseparator'=>true));
 
 // process post information
 if ($data = $mform->get_data()) {
diff --git a/grade/export/xml/index.php b/grade/export/xml/index.php
index d4bdcdd7376..999ebb49e6e 100755
--- a/grade/export/xml/index.php
+++ b/grade/export/xml/index.php
@@ -48,7 +48,7 @@ $navigation = grade_build_nav(__FILE__, $actionstr, array('courseid' => $course-
 print_header($course->shortname.': '.get_string('grades'), $course->fullname, $navigation);
 print_grade_plugin_selector($id, 'export', 'xml');
 
-$mform = new grade_export_form(null, array('plugin'=>'xmlexport'));
+$mform = new grade_export_form(null, array('idnumberrequired'=>true, 'publishing'=>true));
 
 // process post information
 if ($data = $mform->get_data()) {