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