course/editsection_form.php

   1 <?php
   2
   3 if (!defined('MOODLE_INTERNAL')) {
   4     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
   5 }
   6
   7 require_once($CFG->libdir.'/formslib.php');
   8 require_once($CFG->libdir.'/filelib.php');
   9 require_once($CFG->libdir.'/completionlib.php');
  10 require_once($CFG->libdir.'/gradelib.php');
  11
  12 /**
  13  * Default form for editing course section
  14  *
  15  * Course format plugins may specify different editing form to use
  16  */
  17 class editsection_form extends moodleform {
  18
  19     function definition() {
  20
  21         $mform  = $this->_form;
  22         $course = $this->_customdata['course'];
  23
  24         $mform->addElement('header', 'generalhdr', get_string('general'));
  25
  26         $elementgroup = array();
  27         $elementgroup[] = $mform->createElement('text', 'name', '', array('size' => '30'));
  28         $elementgroup[] = $mform->createElement('checkbox', 'usedefaultname', '', get_string('sectionusedefaultname'));
  29         $mform->addGroup($elementgroup, 'name_group', get_string('sectionname'), ' ', false);
  30
  31         $mform->setDefault('usedefaultname', true);
  32         $mform->setType('name', PARAM_TEXT);
  33         $mform->disabledIf('name','usedefaultname','checked');
  34
  35         /// Prepare course and the editor
  36
  37         $mform->addElement('editor', 'summary_editor', get_string('summary'), null, $this->_customdata['editoroptions']);
  38         $mform->addHelpButton('summary_editor', 'summary');
  39         $mform->setType('summary_editor', PARAM_RAW);
  40
  41         $mform->addElement('hidden', 'id');
  42         $mform->setType('id', PARAM_INT);
  43
  44         // additional fields that course format has defined
  45         $courseformat = course_get_format($course);
  46         $formatoptions = $courseformat->section_format_options(true);
  47         if (!empty($formatoptions)) {
  48             $elements = $courseformat->create_edit_form_elements($mform, true);
  49         }
  50
  51         $mform->_registerCancelButton('cancel');
  52     }
  53
  54     public function definition_after_data() {
  55         global $CFG, $DB;
  56
  57         $mform  = $this->_form;
  58         $course = $this->_customdata['course'];
  59         $context = context_course::instance($course->id);
  60
  61         if (!empty($CFG->enableavailability)) {
  62             $mform->addElement('header', 'availabilityconditions', get_string('availabilityconditions', 'condition'));
  63             $mform->setExpanded('availabilityconditions', false);
  64             // String used by conditions more than once
  65             $strcondnone = get_string('none', 'condition');
  66             // Grouping conditions - only if grouping is enabled at site level
  67             if (!empty($CFG->enablegroupmembersonly)) {
  68                 $options = array();
  69                 $options[0] = get_string('none');
  70                 if ($groupings = $DB->get_records('groupings', array('courseid' => $course->id))) {
  71                     foreach ($groupings as $grouping) {
  72                         $options[$grouping->id] = format_string(
  73                                 $grouping->name, true, array('context' => $context));
  74                     }
  75                 }
  76                 $mform->addElement('select', 'groupingid', get_string('groupingsection', 'group'), $options);
  77                 $mform->addHelpButton('groupingid', 'groupingsection', 'group');
  78             }
  79
  80             // Available from/to defaults to midnight because then the display
  81             // will be nicer where it tells users when they can access it (it
  82             // shows only the date and not time).
  83             $date = usergetdate(time());
  84             $midnight = make_timestamp($date['year'], $date['mon'], $date['mday']);
  85
  86             // Date and time conditions.
  87             $mform->addElement('date_time_selector', 'availablefrom',
  88                     get_string('availablefrom', 'condition'),
  89                     array('optional' => true, 'defaulttime' => $midnight));
  90             $mform->addElement('date_time_selector', 'availableuntil',
  91                     get_string('availableuntil', 'condition'),
  92                     array('optional' => true, 'defaulttime' => $midnight));
  93
  94             // Conditions based on grades
  95             $gradeoptions = array();
  96             $items = grade_item::fetch_all(array('courseid' => $course->id));
  97             $items = $items ? $items : array();
  98             foreach ($items as $id => $item) {
  99                 $gradeoptions[$id] = $item->get_name();
 100             }
 101             asort($gradeoptions);
 102             $gradeoptions = array(0 => $strcondnone) + $gradeoptions;
 103
 104             $grouparray = array();
 105             $grouparray[] = $mform->createElement('select', 'conditiongradeitemid', '', $gradeoptions);
 106             $grouparray[] = $mform->createElement('static', '', '',
 107                     ' ' . get_string('grade_atleast', 'condition').' ');
 108             $grouparray[] = $mform->createElement('text', 'conditiongrademin', '', array('size' => 3));
 109             $grouparray[] = $mform->createElement('static', '', '',
 110                     '% ' . get_string('grade_upto', 'condition') . ' ');
 111             $grouparray[] = $mform->createElement('text', 'conditiongrademax', '', array('size' => 3));
 112             $grouparray[] = $mform->createElement('static', '', '', '%');
 113             $group = $mform->createElement('group', 'conditiongradegroup',
 114                     get_string('gradecondition', 'condition'), $grouparray);
 115
 116             // Get full version (including condition info) of section object
 117             $ci = new condition_info_section($this->_customdata['cs']);
 118             $fullcs = $ci->get_full_section();
 119             $count = count($fullcs->conditionsgrade) + 1;
 120
 121             // Grade conditions
 122             $this->repeat_elements(array($group), $count, array(
 123                 'conditiongradegroup[conditiongrademin]' => array('type' => PARAM_RAW),
 124                 'conditiongradegroup[conditiongrademax]' => array('type' => PARAM_RAW)
 125                 ), 'conditiongraderepeats', 'conditiongradeadds', 2, get_string('addgrades', 'condition'), true);
 126             $mform->addHelpButton('conditiongradegroup[0]', 'gradecondition', 'condition');
 127
 128             // Conditions based on user fields
 129             $operators = condition_info::get_condition_user_field_operators();
 130             $useroptions = condition_info::get_condition_user_fields(array('context' => $context));
 131             asort($useroptions);
 132
 133             $useroptions = array(0 => $strcondnone) + $useroptions;
 134             $grouparray = array();
 135             $grouparray[] =& $mform->createElement('select', 'conditionfield', '', $useroptions);
 136             $grouparray[] =& $mform->createElement('select', 'conditionfieldoperator', '', $operators);
 137             $grouparray[] =& $mform->createElement('text', 'conditionfieldvalue');
 138             $group = $mform->createElement('group', 'conditionfieldgroup', get_string('userfield', 'condition'), $grouparray);
 139
 140             $fieldcount = count($fullcs->conditionsfield) + 1;
 141
 142             $this->repeat_elements(array($group), $fieldcount,  array(
 143                 'conditionfieldgroup[conditionfieldvalue]' => array('type' => PARAM_RAW)),
 144                 'conditionfieldrepeats', 'conditionfieldadds', 2, get_string('adduserfields', 'condition'), true);
 145             $mform->addHelpButton('conditionfieldgroup[0]', 'userfield', 'condition');
 146
 147             // Conditions based on completion
 148             $completion = new completion_info($course);
 149             if ($completion->is_enabled()) {
 150                 $completionoptions = array();
 151                 $modinfo = get_fast_modinfo($course);
 152                 foreach ($modinfo->cms as $id => $cm) {
 153                     // Add each course-module if it:
 154                     // (a) has completion turned on
 155                     // (b) does not belong to current course-section
 156                     if ($cm->completion && ($fullcs->id != $cm->section)) {
 157                         $completionoptions[$id] = $cm->name;
 158                     }
 159                 }
 160                 asort($completionoptions);
 161                 $completionoptions = array(0 => $strcondnone) +
 162                         $completionoptions;
 163
 164                 $completionvalues = array(
 165                     COMPLETION_COMPLETE => get_string('completion_complete', 'condition'),
 166                     COMPLETION_INCOMPLETE => get_string('completion_incomplete', 'condition'),
 167                     COMPLETION_COMPLETE_PASS => get_string('completion_pass', 'condition'),
 168                     COMPLETION_COMPLETE_FAIL => get_string('completion_fail', 'condition'));
 169
 170                 $grouparray = array();
 171                 $grouparray[] = $mform->createElement('select', 'conditionsourcecmid', '',
 172                         $completionoptions);
 173                 $grouparray[] = $mform->createElement('select', 'conditionrequiredcompletion', '',
 174                         $completionvalues);
 175                 $group = $mform->createElement('group', 'conditioncompletiongroup',
 176                         get_string('completioncondition', 'condition'), $grouparray);
 177
 178                 $count = count($fullcs->conditionscompletion) + 1;
 179                 $this->repeat_elements(array($group), $count, array(),
 180                         'conditioncompletionrepeats', 'conditioncompletionadds', 2,
 181                         get_string('addcompletions', 'condition'), true);
 182                 $mform->addHelpButton('conditioncompletiongroup[0]',
 183                         'completionconditionsection', 'condition');
 184             }
 185
 186             // Availability conditions - set up form values
 187             if (!empty($CFG->enableavailability)) {
 188                 $num = 0;
 189                 foreach ($fullcs->conditionsgrade as $gradeitemid => $minmax) {
 190                     $groupelements = $mform->getElement(
 191                             'conditiongradegroup[' . $num . ']')->getElements();
 192                     $groupelements[0]->setValue($gradeitemid);
 193                     $groupelements[2]->setValue(is_null($minmax->min) ? '' :
 194                             format_float($minmax->min, 5, true, true));
 195                     $groupelements[4]->setValue(is_null($minmax->max) ? '' :
 196                             format_float($minmax->max, 5, true, true));
 197                     $num++;
 198                 }
 199
 200                 $num = 0;
 201                 foreach ($fullcs->conditionsfield as $fieldid => $data) {
 202                     $groupelements = $mform->getElement(
 203                             'conditionfieldgroup[' . $num . ']')->getElements();
 204                     $groupelements[0]->setValue($fieldid);
 205                     $groupelements[1]->setValue(is_null($data->operator) ? '' :
 206                             $data->operator);
 207                     $groupelements[2]->setValue(is_null($data->value) ? '' :
 208                             $data->value);
 209                     $num++;
 210                 }
 211
 212                 if ($completion->is_enabled()) {
 213                     $num = 0;
 214                     foreach ($fullcs->conditionscompletion as $othercmid => $state) {
 215                         $groupelements = $mform->getElement('conditioncompletiongroup[' . $num . ']')->getElements();
 216                         $groupelements[0]->setValue($othercmid);
 217                         $groupelements[1]->setValue($state);
 218                         $num++;
 219                     }
 220                 }
 221             }
 222
 223             // Do we display availability info to students?
 224             $showhide = array(
 225                 CONDITION_STUDENTVIEW_SHOW => get_string('showavailabilitysection_show', 'condition'),
 226                 CONDITION_STUDENTVIEW_HIDE => get_string('showavailabilitysection_hide', 'condition'));
 227             $mform->addElement('select', 'showavailability',
 228                     get_string('showavailabilitysection', 'condition'), $showhide);
 229         }
 230
 231         $this->add_action_buttons();
 232     }
 233
 234     public function validation($data, $files) {
 235         $errors = parent::validation($data, $files);
 236         // Conditions: Don't let them set dates which make no sense
 237         if (array_key_exists('availablefrom', $data) &&
 238                 $data['availablefrom'] && $data['availableuntil'] &&
 239                 $data['availablefrom'] >= $data['availableuntil']) {
 240             $errors['availablefrom'] = get_string('badavailabledates', 'condition');
 241         }
 242
 243         // Conditions: Verify that the grade conditions are numbers, and make sense.
 244         if (array_key_exists('conditiongradegroup', $data)) {
 245             foreach ($data['conditiongradegroup'] as $i => $gradedata) {
 246                 if ($gradedata['conditiongrademin'] !== '' &&
 247                         !is_numeric(unformat_float($gradedata['conditiongrademin']))) {
 248                     $errors["conditiongradegroup[{$i}]"] = get_string('gradesmustbenumeric', 'condition');
 249                     continue;
 250                 }
 251                 if ($gradedata['conditiongrademax'] !== '' &&
 252                         !is_numeric(unformat_float($gradedata['conditiongrademax']))) {
 253                     $errors["conditiongradegroup[{$i}]"] = get_string('gradesmustbenumeric', 'condition');
 254                     continue;
 255                 }
 256                 if ($gradedata['conditiongrademin'] !== '' && $gradedata['conditiongrademax'] !== '' &&
 257                         unformat_float($gradedata['conditiongrademax']) <= unformat_float($gradedata['conditiongrademin'])) {
 258                     $errors["conditiongradegroup[{$i}]"] = get_string('badgradelimits', 'condition');
 259                     continue;
 260                 }
 261                 if ($gradedata['conditiongrademin'] === '' && $gradedata['conditiongrademax'] === '' &&
 262                         $gradedata['conditiongradeitemid']) {
 263                     $errors["conditiongradegroup[{$i}]"] = get_string('gradeitembutnolimits', 'condition');
 264                     continue;
 265                 }
 266                 if (($gradedata['conditiongrademin'] !== '' || $gradedata['conditiongrademax'] !== '') &&
 267                         !$gradedata['conditiongradeitemid']) {
 268                     $errors["conditiongradegroup[{$i}]"] = get_string('gradelimitsbutnoitem', 'condition');
 269                     continue;
 270                 }
 271             }
 272         }
 273
 274         // Conditions: Verify that the user profile field has not been declared more than once
 275         if (array_key_exists('conditionfieldgroup', $data)) {
 276             // Array to store the existing fields
 277             $arrcurrentfields = array();
 278             // Error message displayed if any condition is declared more than once. We use lang string because
 279             // this way we don't actually generate the string unless there is an error.
 280             $stralreadydeclaredwarning = new lang_string('fielddeclaredmultipletimes', 'condition');
 281             foreach ($data['conditionfieldgroup'] as $i => $fielddata) {
 282                 if ($fielddata['conditionfield'] == 0) { // Don't need to bother if none is selected
 283                     continue;
 284                 }
 285                 if (in_array($fielddata['conditionfield'], $arrcurrentfields)) {
 286                     $errors["conditionfieldgroup[{$i}]"] = $stralreadydeclaredwarning->out();
 287                 }
 288                 // Add the field to the array
 289                 $arrcurrentfields[] = $fielddata['conditionfield'];
 290             }
 291         }
 292
 293         return $errors;
 294     }
 295
 296     /**
 297      * Load in existing data as form defaults
 298      *
 299      * @param stdClass|array $default_values object or array of default values
 300      */
 301     function set_data($default_values) {
 302         if (!is_object($default_values)) {
 303             // we need object for file_prepare_standard_editor
 304             $default_values = (object)$default_values;
 305         }
 306         $editoroptions = $this->_customdata['editoroptions'];
 307         $default_values = file_prepare_standard_editor($default_values, 'summary', $editoroptions,
 308                 $editoroptions['context'], 'course', 'section', $default_values->id);
 309         $default_values->usedefaultname = (is_null($default_values->name));
 310         parent::set_data($default_values);
 311     }
 312
 313     /**
 314      * Return submitted data if properly submitted or returns NULL if validation fails or
 315      * if there is no submitted data.
 316      *
 317      * @return object submitted data; NULL if not valid or not submitted or cancelled
 318      */
 319     function get_data() {
 320         $data = parent::get_data();
 321         if ($data !== null) {
 322             $editoroptions = $this->_customdata['editoroptions'];
 323             if (!empty($data->usedefaultname)) {
 324                 $data->name = null;
 325             }
 326             $data = file_postupdate_standard_editor($data, 'summary', $editoroptions,
 327                     $editoroptions['context'], 'course', 'section', $data->id);
 328             $course = $this->_customdata['course'];
 329             foreach (course_get_format($course)->section_format_options() as $option => $unused) {
 330                 // fix issue with unset checkboxes not being returned at all
 331                 if (!isset($data->$option)) {
 332                     $data->$option = null;
 333                 }
 334             }
 335         }
 336         return $data;
 337     }
 338 }