mod/choice/mod_form.php

   1 <?php
   2 if (!defined('MOODLE_INTERNAL')) {
   3     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
   4 }
   5
   6 require_once ($CFG->dirroot.'/course/moodleform_mod.php');
   7
   8 class mod_choice_mod_form extends moodleform_mod {
   9
  10     function definition() {
  11         global $CFG, $CHOICE_SHOWRESULTS, $CHOICE_PUBLISH, $CHOICE_DISPLAY, $DB;
  12
  13         $mform    =& $this->_form;
  14
  15 //-------------------------------------------------------------------------------
  16         $mform->addElement('header', 'general', get_string('general', 'form'));
  17
  18         $mform->addElement('text', 'name', get_string('choicename', 'choice'), array('size'=>'64'));
  19         if (!empty($CFG->formatstringstriptags)) {
  20             $mform->setType('name', PARAM_TEXT);
  21         } else {
  22             $mform->setType('name', PARAM_CLEANHTML);
  23         }
  24         $mform->addRule('name', null, 'required', null, 'client');
  25         $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
  26
  27         $this->standard_intro_elements(get_string('description', 'choice'));
  28
  29         $mform->addElement('select', 'display', get_string("displaymode","choice"), $CHOICE_DISPLAY);
  30
  31         //-------------------------------------------------------------------------------
  32         $mform->addElement('header', 'optionhdr', get_string('options', 'choice'));
  33
  34         $mform->addElement('selectyesno', 'allowupdate', get_string("allowupdate", "choice"));
  35
  36         $mform->addElement('selectyesno', 'allowmultiple', get_string('allowmultiple', 'choice'));
  37         if ($this->_instance) {
  38             if ($DB->count_records('choice_answers', array('choiceid' => $this->_instance)) > 0) {
  39                 // Prevent user from toggeling the number of allowed answers once there are submissions.
  40                 $mform->freeze('allowmultiple');
  41             }
  42         }
  43
  44         $mform->addElement('selectyesno', 'limitanswers', get_string('limitanswers', 'choice'));
  45         $mform->addHelpButton('limitanswers', 'limitanswers', 'choice');
  46
  47         $repeatarray = array();
  48         $repeatarray[] = $mform->createElement('text', 'option', get_string('optionno', 'choice'));
  49         $repeatarray[] = $mform->createElement('text', 'limit', get_string('limitno', 'choice'));
  50         $repeatarray[] = $mform->createElement('hidden', 'optionid', 0);
  51
  52         if ($this->_instance){
  53             $repeatno = $DB->count_records('choice_options', array('choiceid'=>$this->_instance));
  54             $repeatno += 2;
  55         } else {
  56             $repeatno = 5;
  57         }
  58
  59         $repeateloptions = array();
  60         $repeateloptions['limit']['default'] = 0;
  61         $repeateloptions['limit']['disabledif'] = array('limitanswers', 'eq', 0);
  62         $repeateloptions['limit']['rule'] = 'numeric';
  63         $repeateloptions['limit']['type'] = PARAM_INT;
  64
  65         $repeateloptions['option']['helpbutton'] = array('choiceoptions', 'choice');
  66         $mform->setType('option', PARAM_CLEANHTML);
  67
  68         $mform->setType('optionid', PARAM_INT);
  69
  70         $this->repeat_elements($repeatarray, $repeatno,
  71                     $repeateloptions, 'option_repeats', 'option_add_fields', 3, null, true);
  72
  73         // Make the first option required
  74         if ($mform->elementExists('option[0]')) {
  75             $mform->addRule('option[0]', get_string('atleastoneoption', 'choice'), 'required', null, 'client');
  76         }
  77
  78 //-------------------------------------------------------------------------------
  79         $mform->addElement('header', 'availabilityhdr', get_string('availability'));
  80         $mform->addElement('date_time_selector', 'timeopen', get_string("choiceopen", "choice"),
  81             array('optional' => true));
  82
  83         $mform->addElement('date_time_selector', 'timeclose', get_string("choiceclose", "choice"),
  84             array('optional' => true));
  85
  86         $mform->addElement('advcheckbox', 'showpreview', get_string('showpreview', 'choice'));
  87         $mform->addHelpButton('showpreview', 'showpreview', 'choice');
  88         $mform->disabledIf('showpreview', 'timeopen[enabled]');
  89
  90 //-------------------------------------------------------------------------------
  91         $mform->addElement('header', 'resultshdr', get_string('results', 'choice'));
  92
  93         $mform->addElement('select', 'showresults', get_string("publish", "choice"), $CHOICE_SHOWRESULTS);
  94
  95         $mform->addElement('select', 'publish', get_string("privacy", "choice"), $CHOICE_PUBLISH);
  96         $mform->disabledIf('publish', 'showresults', 'eq', 0);
  97
  98         $mform->addElement('selectyesno', 'showunanswered', get_string("showunanswered", "choice"));
  99
 100         $mform->addElement('selectyesno', 'includeinactive', get_string('includeinactive', 'choice'));
 101         $mform->setDefault('includeinactive', 0);
 102
 103 //-------------------------------------------------------------------------------
 104         $this->standard_coursemodule_elements();
 105 //-------------------------------------------------------------------------------
 106         $this->add_action_buttons();
 107     }
 108
 109     function data_preprocessing(&$default_values){
 110         global $DB;
 111         if (!empty($this->_instance) && ($options = $DB->get_records_menu('choice_options',array('choiceid'=>$this->_instance), 'id', 'id,text'))
 112                && ($options2 = $DB->get_records_menu('choice_options', array('choiceid'=>$this->_instance), 'id', 'id,maxanswers')) ) {
 113             $choiceids=array_keys($options);
 114             $options=array_values($options);
 115             $options2=array_values($options2);
 116
 117             foreach (array_keys($options) as $key){
 118                 $default_values['option['.$key.']'] = $options[$key];
 119                 $default_values['limit['.$key.']'] = $options2[$key];
 120                 $default_values['optionid['.$key.']'] = $choiceids[$key];
 121             }
 122
 123         }
 124
 125     }
 126
 127     /**
 128      * Allows module to modify the data returned by form get_data().
 129      * This method is also called in the bulk activity completion form.
 130      *
 131      * Only available on moodleform_mod.
 132      *
 133      * @param stdClass $data the form data to be modified.
 134      */
 135     public function data_postprocessing($data) {
 136         parent::data_postprocessing($data);
 137         // Set up completion section even if checkbox is not ticked
 138         if (!empty($data->completionunlocked)) {
 139             if (empty($data->completionsubmit)) {
 140                 $data->completionsubmit = 0;
 141             }
 142         }
 143     }
 144
 145     /**
 146      * Enforce validation rules here
 147      *
 148      * @param array $data array of ("fieldname"=>value) of submitted data
 149      * @param array $files array of uploaded files "element_name"=>tmp_file_path
 150      * @return array
 151      **/
 152     public function validation($data, $files) {
 153         $errors = parent::validation($data, $files);
 154
 155         // Check open and close times are consistent.
 156         if ($data['timeopen'] && $data['timeclose'] &&
 157                 $data['timeclose'] < $data['timeopen']) {
 158             $errors['timeclose'] = get_string('closebeforeopen', 'choice');
 159         }
 160
 161         return $errors;
 162     }
 163
 164     function add_completion_rules() {
 165         $mform =& $this->_form;
 166
 167         $mform->addElement('checkbox', 'completionsubmit', '', get_string('completionsubmit', 'choice'));
 168         // Enable this completion rule by default.
 169         $mform->setDefault('completionsubmit', 1);
 170         return array('completionsubmit');
 171     }
 172
 173     function completion_rule_enabled($data) {
 174         return !empty($data['completionsubmit']);
 175     }
 176 }
 177