MDL-29794 Initial support for re-using a shared grading form
[moodle.git] / grade / import / grade_import_form.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 if (!defined('MOODLE_INTERNAL')) {
19     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
20 }
22 require_once $CFG->libdir.'/formslib.php';
23 require_once($CFG->libdir.'/gradelib.php');
25 class grade_import_form extends moodleform {
26     function definition (){
27         global $COURSE;
29         $mform =& $this->_form;
31         if (isset($this->_customdata)) {  // hardcoding plugin names here is hacky
32             $features = $this->_customdata;
33         } else {
34             $features = array();
35         }
37         // course id needs to be passed for auth purposes
38         $mform->addElement('hidden', 'id', optional_param('id', 0, PARAM_INT));
39         $mform->setType('id', PARAM_INT);
40         $mform->addElement('header', 'general', get_string('importfile', 'grades'));
41         // file upload
42         $mform->addElement('filepicker', 'userfile', get_string('file'));
43         $mform->addRule('userfile', null, 'required');
44         $textlib = textlib_get_instance();
45         $encodings = $textlib->get_encodings();
46         $mform->addElement('select', 'encoding', get_string('encoding', 'grades'), $encodings);
48         if (!empty($features['includeseparator'])) {
49             $radio = array();
50             $radio[] = &MoodleQuickForm::createElement('radio', 'separator', null, get_string('septab', 'grades'), 'tab');
51             $radio[] = &MoodleQuickForm::createElement('radio', 'separator', null, get_string('sepcomma', 'grades'), 'comma');
52             $mform->addGroup($radio, 'separator', get_string('separator', 'grades'), ' ', false);
53             $mform->setDefault('separator', 'comma');
54         }
56         if (!empty($features['verbosescales'])) {
57             $options = array(1=>get_string('yes'), 0=>get_string('no'));
58             $mform->addElement('select', 'verbosescales', get_string('verbosescales', 'grades'), $options);
59         }
61         $options = array('10'=>10, '20'=>20, '100'=>100, '1000'=>1000, '100000'=>100000);
62         $mform->addElement('select', 'previewrows', get_string('rowpreviewnum', 'grades'), $options); // TODO: localize
63         $mform->setType('previewrows', PARAM_INT);
64         $mform->addElement('hidden', 'groupid', groups_get_course_group($COURSE));
65         $mform->setType('groupid', PARAM_INT);
66         $this->add_action_buttons(false, get_string('uploadgrades', 'grades'));
67     }
68 }
70 class grade_import_mapping_form extends moodleform {
72     function definition () {
73         global $CFG, $COURSE;
74         $mform =& $this->_form;
76         // this is an array of headers
77         $header = $this->_customdata['header'];
78         // course id
80         $mform->addElement('header', 'general', get_string('identifier', 'grades'));
81         $mapfromoptions = array();
83         if ($header) {
84             foreach ($header as $i=>$h) {
85                 $mapfromoptions[$i] = s($h);
86             }
87         }
88         $mform->addElement('select', 'mapfrom', get_string('mapfrom', 'grades'), $mapfromoptions);
90         $maptooptions = array('userid'=>'userid', 'username'=>'username', 'useridnumber'=>'useridnumber', 'useremail'=>'useremail', '0'=>'ignore');
91         $mform->addElement('select', 'mapto', get_string('mapto', 'grades'), $maptooptions);
93         $mform->addElement('header', 'general', get_string('mappings', 'grades'));
95         // add a comment option
97         $comments = array();
98         if ($gradeitems = $this->_customdata['gradeitems']) {
99             foreach ($gradeitems as $itemid => $itemname) {
100                 $comments['feedback_'.$itemid] = 'comments for '.$itemname;
101             }
102         }
104         if ($header) {
105             $i = 0; // index
106             foreach ($header as $h) {
107                 $h = trim($h);
108                 // this is what each header maps to
109                 $mform->addElement('selectgroups', 'mapping_'.$i, s($h),
110                     array('others'=>array('0'=>'ignore', 'new'=>'new gradeitem'),
111                     'gradeitems'=>$gradeitems,
112                     'comments'=>$comments));
113                 $i++;
114             }
115         }
117         // course id needs to be passed for auth purposes
118         $mform->addElement('hidden', 'map', 1);
119         $mform->setType('map', PARAM_INT);
120         $mform->addElement('hidden', 'id');
121         $mform->setType('id', PARAM_INT);
122         $mform->addElement('hidden', 'importcode');
123         $mform->setType('importcode', PARAM_FILE);
124         $mform->addElement('hidden', 'verbosescales', 1);
125         $mform->setType('separator', PARAM_ALPHA);
126         $mform->addElement('hidden', 'separator', 'comma');
127         $mform->setType('verbosescales', PARAM_INT);
128         $mform->addElement('hidden', 'groupid', groups_get_course_group($COURSE));
129         $mform->setType('groupid', PARAM_INT);
130         $this->add_action_buttons(false, get_string('uploadgrades', 'grades'));
132     }