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