mod/data/field.php

   1 <?php  // $Id$
   2 ///////////////////////////////////////////////////////////////////////////
   3 //                                                                       //
   4 // NOTICE OF COPYRIGHT                                                   //
   5 //                                                                       //
   6 // Moodle - Modular Object-Oriented Dynamic Learning Environment         //
   7 //          http://moodle.org                                            //
   8 //                                                                       //
   9 // Copyright (C) 2005 Martin Dougiamas  http://dougiamas.com             //
  10 //                                                                       //
  11 // This program is free software; you can redistribute it and/or modify  //
  12 // it under the terms of the GNU General Public License as published by  //
  13 // the Free Software Foundation; either version 2 of the License, or     //
  14 // (at your option) any later version.                                   //
  15 //                                                                       //
  16 // This program is distributed in the hope that it will be useful,       //
  17 // but WITHOUT ANY WARRANTY; without even the implied warranty of        //
  18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         //
  19 // GNU General Public License for more details:                          //
  20 //                                                                       //
  21 //          http://www.gnu.org/copyleft/gpl.html                         //
  22 //                                                                       //
  23 ///////////////////////////////////////////////////////////////////////////
  24
  25     require_once('../../config.php');
  26     require_once('lib.php');
  27
  28
  29     $id             = optional_param('id', 0, PARAM_INT);            // course module id
  30     $d              = optional_param('d', 0, PARAM_INT);             // database id
  31     $fid            = optional_param('fid', 0 , PARAM_INT);          // update field id
  32     $newtype        = optional_param('newtype','',PARAM_ALPHA);      // type of the new field
  33     $mode           = optional_param('mode','',PARAM_ALPHA);
  34     $defaultsort    = optional_param('defaultsort', 0, PARAM_INT);
  35     $defaultsortdir = optional_param('defaultsortdir', 0, PARAM_INT);
  36     $cancel         = optional_param('cancel', '');
  37
  38     if ($cancel) {
  39         $mode = 'list';
  40     }
  41
  42
  43     if ($id) {
  44         if (! $cm = get_coursemodule_from_id('data', $id)) {
  45             error('Course Module ID was incorrect');
  46         }
  47         if (! $course = get_record('course', 'id', $cm->course)) {
  48             error('Course is misconfigured');
  49         }
  50         if (! $data = get_record('data', 'id', $cm->instance)) {
  51             error('Course module is incorrect');
  52         }
  53
  54     } else {
  55         if (! $data = get_record('data', 'id', $d)) {
  56             error('Data ID is incorrect');
  57         }
  58         if (! $course = get_record('course', 'id', $data->course)) {
  59             error('Course is misconfigured');
  60         }
  61         if (! $cm = get_coursemodule_from_instance('data', $data->id, $course->id)) {
  62             error('Course Module ID was incorrect');
  63         }
  64     }
  65
  66     require_login($course->id, true, $cm);
  67
  68     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
  69     require_capability('mod/data:managetemplates', $context);
  70
  71     /************************************
  72      *        Data Processing           *
  73      ***********************************/
  74     switch ($mode) {
  75
  76         case 'add':    ///add a new field
  77             if (confirm_sesskey() and $fieldinput = data_submitted($CFG->wwwroot.'/mod/data/field.php')){
  78
  79                 //$fieldinput->name = data_clean_field_name($fieldinput->name);
  80
  81             /// Only store this new field if it doesn't already exist.
  82                 if (($fieldinput->name == '') or data_fieldname_exists($fieldinput->name, $data->id)) {
  83
  84                     $displaynoticebad = get_string('invalidfieldname','data');
  85
  86                 } else {
  87
  88                 /// Check for arrays and convert to a comma-delimited string
  89                     data_convert_arrays_to_strings($fieldinput);
  90
  91                 /// Create a field object to collect and store the data safely
  92                     $type = required_param('type', PARAM_FILE);
  93                     $field = data_get_field_new($type, $data);
  94
  95                     $field->define_field($fieldinput);
  96                     $field->insert_field();
  97
  98                 /// Update some templates
  99                     data_append_new_field_to_templates($data, stripslashes($fieldinput->name));
 100
 101                     add_to_log($course->id, 'data', 'fields add',
 102                                "field.php?d=$data->id&amp;mode=display&amp;fid=$fid", $fid, $cm->id);
 103
 104                     $displaynoticegood = get_string('fieldadded','data');
 105                 }
 106             }
 107             break;
 108
 109
 110         case 'update':    ///update a field
 111             if (confirm_sesskey() and $fieldinput = data_submitted($CFG->wwwroot.'/mod/data/field.php')){
 112
 113                 //$fieldinput->name = data_clean_field_name($fieldinput->name);
 114
 115                 if (($fieldinput->name == '') or data_fieldname_exists($fieldinput->name, $data->id, $fieldinput->fid)) {
 116
 117                     $displaynoticebad = get_string('invalidfieldname','data');
 118
 119                 } else {
 120                 /// Check for arrays and convert to a comma-delimited string
 121                     data_convert_arrays_to_strings($fieldinput);
 122
 123                 /// Create a field object to collect and store the data safely
 124                     $field = data_get_field_from_id($fid, $data);
 125                     $oldfieldname = $field->field->name;
 126
 127                     $field->field->name = $fieldinput->name;
 128                     $field->field->description = $fieldinput->description;
 129
 130                     for ($i=1; $i<=10; $i++) {
 131                         if (isset($fieldinput->{'param'.$i})) {
 132                             $field->field->{'param'.$i} = $fieldinput->{'param'.$i};
 133                         } else {
 134                             $field->field->{'param'.$i} = '';
 135                         }
 136                     }
 137
 138                     $field->update_field();
 139
 140                 /// Update the templates.
 141                     data_replace_field_in_templates($data, $oldfieldname, $field->field->name);
 142
 143                     add_to_log($course->id, 'data', 'fields update',
 144                                "field.php?d=$data->id&amp;mode=display&amp;fid=$fid", $fid, $cm->id);
 145
 146                     $displaynoticegood = get_string('fieldupdated','data');
 147                 }
 148             }
 149             break;
 150
 151
 152         case 'delete':    // Delete a field
 153             if (confirm_sesskey()){
 154
 155                 if ($confirm = optional_param('confirm', 0, PARAM_INT)) {
 156
 157
 158                     // Delete the field completely
 159                     if ($field = data_get_field_from_id($fid, $data)) {
 160                         $field->delete_field();
 161
 162                         // Update the templates.
 163                         data_replace_field_in_templates($data, $field->field->name, '');
 164
 165                         // Update the default sort field
 166                         if ($fid == $data->defaultsort) {
 167                             unset($rec);
 168                             $rec->id = $data->id;
 169                             $rec->defaultsort = 0;
 170                             $rec->defaultsortdir = 0;
 171                             if (!update_record('data', $rec)) {
 172                                 error('There was an error updating the database');
 173                             }
 174                         }
 175
 176                         add_to_log($course->id, 'data', 'fields delete',
 177                                    "field.php?d=$data->id", $field->field->name, $cm->id);
 178
 179                         $displaynoticegood = get_string('fielddeleted', 'data');
 180                     }
 181
 182                 } else {
 183
 184                     data_print_header($course,$cm,$data, false);
 185
 186                     // Print confirmation message.
 187                     $field = data_get_field_from_id($fid, $data);
 188
 189                     notice_yesno('<strong>'.$field->name().': '.$field->field->name.'</strong><br /><br />'. get_string('confirmdeletefield','data'),
 190                                  'field.php?d='.$data->id.'&amp;mode=delete&amp;fid='.$fid.'&amp;sesskey='.sesskey().'&amp;confirm=1',
 191                                  'field.php?d='.$data->id);
 192
 193                     print_footer($course);
 194                     exit;
 195                 }
 196             }
 197             break;
 198
 199
 200         case 'sort':    // Set the default sort parameters
 201             if (confirm_sesskey()) {
 202                 $rec->id = $data->id;
 203                 $rec->defaultsort = $defaultsort;
 204                 $rec->defaultsortdir = $defaultsortdir;
 205
 206                 if (update_record('data', $rec)) {
 207                     redirect($CFG->wwwroot.'/mod/data/field.php?d='.$data->id, get_string('changessaved'), 2);
 208                 } else {
 209                     error('There was an error updating the database');
 210                 }
 211                 exit;
 212             }
 213             break;
 214
 215         default:
 216             break;
 217     }
 218
 219
 220
 221 /// Print the browsing interface
 222
 223     ///get the list of possible fields (plugins)
 224     $directories = get_list_of_plugins('mod/data/field/');
 225     $menufield = array();
 226
 227     foreach ($directories as $directory){
 228         $menufield[$directory] = get_string($directory,'data');    //get from language files
 229     }
 230     asort($menufield);    //sort in alphabetical order
 231
 232
 233     if (($mode == 'new') && (!empty($newtype)) && confirm_sesskey()) {          ///  Adding a new field
 234         $CFG->pagepath='mod/data/field/'.$newtype;
 235         data_print_header($course,$cm,$data,'fields');
 236
 237         $field = data_get_field_new($newtype, $data);
 238         $field->display_edit_field();
 239
 240     } else if ($mode == 'display' && confirm_sesskey()) { /// Display/edit existing field
 241         $CFG->pagepath='mod/data/field/'.$newtype;
 242         data_print_header($course,$cm,$data,'fields');
 243
 244         $field = data_get_field_from_id($fid, $data);
 245         $field->display_edit_field();
 246
 247     } else {                                              /// Display the main listing of all fields
 248
 249         $CFG->pagepath='mod/data/field/'.$newtype;
 250         data_print_header($course,$cm,$data,'fields');
 251
 252
 253         if (!record_exists('data_fields','dataid',$data->id)) {
 254             notify(get_string('nofieldindatabase','data'));  // nothing in database
 255             notify(get_string('pleaseaddsome','data', 'preset.php?id='.$cm->id));      // link to presets
 256
 257         } else {    //else print quiz style list of fields
 258
 259             $table->head = array(get_string('fieldname','data'), get_string('type','data'), get_string('fielddescription', 'data'), get_string('action','data'));
 260             $table->align = array('left','left','left', 'center');
 261             $table->wrap = array(false,false,false,false);
 262
 263             if ($fff = get_records('data_fields','dataid',$data->id,'id')){
 264                 foreach ($fff as $ff) {
 265
 266                     $field = data_get_field($ff, $data);
 267
 268                     $table->data[] = array(
 269
 270                     '<a href="field.php?mode=display&amp;d='.$data->id.
 271                     '&amp;fid='.$field->field->id.'&amp;sesskey='.sesskey().'">'.$field->field->name.'</a>',
 272
 273                     $field->image().'&nbsp;'.get_string($field->type, 'data'),
 274
 275                     shorten_text($field->field->description, 30),
 276
 277                     '<a href="field.php?d='.$data->id.'&amp;mode=display&amp;fid='.$field->field->id.'&amp;sesskey='.sesskey().'">'.
 278                     '<img src="'.$CFG->pixpath.'/t/edit.gif" class="iconsmall" alt="'.get_string('edit').'" title="'.get_string('edit').'" /></a>'.
 279                     '&nbsp;'.
 280                     '<a href="field.php?d='.$data->id.'&amp;mode=delete&amp;fid='.$field->field->id.'&amp;sesskey='.sesskey().'">'.
 281                     '<img src="'.$CFG->pixpath.'/t/delete.gif" class="iconsmall" alt="'.get_string('delete').'" title="'.get_string('delete').'" /></a>'
 282
 283                     );
 284                 }
 285             }
 286             print_table($table);
 287         }
 288
 289
 290         echo '<div class="fieldadd">';
 291         echo '<label for="fieldform_jump">'.get_string('newfield','data').'</label>';
 292         popup_form($CFG->wwwroot.'/mod/data/field.php?d='.$data->id.'&amp;mode=new&amp;sesskey='.
 293                 sesskey().'&amp;newtype=', $menufield, 'fieldform', '', 'choose');
 294         helpbutton('fields', get_string('addafield','data'), 'data');
 295         echo '</div>';
 296
 297         echo '<div class="sortdefault">';
 298         echo '<form id="sortdefault" action="'.$CFG->wwwroot.'/mod/data/field.php" method="get">';
 299         echo '<div>';
 300         echo '<input type="hidden" name="d" value="'.$data->id.'" />';
 301         echo '<input type="hidden" name="mode" value="sort" />';
 302         echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
 303         echo '<label for="defaultsort">'.get_string('defaultsortfield','data').'</label>';
 304         echo '<select id="defaultsort" name="defaultsort">';
 305         if ($fields = get_records('data_fields','dataid',$data->id)) {
 306             echo '<optgroup label="'.get_string('fields', 'data').'">';
 307             foreach ($fields as $field) {
 308                 if ($data->defaultsort == $field->id) {
 309                     echo '<option value="'.$field->id.'" selected="selected">'.$field->name.'</option>';
 310                 } else {
 311                     echo '<option value="'.$field->id.'">'.$field->name.'</option>';
 312                 }
 313             }
 314             echo '</optgroup>';
 315         }
 316         $options = array();
 317         $options[DATA_TIMEADDED]    = get_string('timeadded', 'data');
 318 // TODO: we will need to change defaultsort db to unsinged to make these work in 2.0
 319 /*        $options[DATA_TIMEMODIFIED] = get_string('timemodified', 'data');
 320         $options[DATA_FIRSTNAME]    = get_string('authorfirstname', 'data');
 321         $options[DATA_LASTNAME]     = get_string('authorlastname', 'data');
 322         if ($data->approval and has_capability('mod/data:approve', $context)) {
 323             $options[DATA_APPROVED] = get_string('approved', 'data');
 324         }*/
 325         echo '<optgroup label="'.get_string('other', 'data').'">';
 326         foreach ($options as $key => $name) {
 327             if ($data->defaultsort == $key) {
 328                 echo '<option value="'.$key.'" selected="selected">'.$name.'</option>';
 329             } else {
 330                 echo '<option value="'.$key.'">'.$name.'</option>';
 331             }
 332         }
 333         echo '</optgroup>';
 334         echo '</select>';
 335
 336         $options = array(0 => get_string('ascending', 'data'),
 337                          1 => get_string('descending', 'data'));
 338         choose_from_menu($options, 'defaultsortdir', $data->defaultsortdir, '');
 339         echo '<input type="submit" value="'.get_string('save', 'data').'" />';
 340         echo '</div>';
 341         echo '</form>';
 342         echo '</div>';
 343
 344     }
 345
 346 /// Finish the page
 347     print_footer($course);
 348
 349
 350 ?>