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