on-demand release 2.7rc2+
[moodle.git] / mod / forum / mod_form.php
CommitLineData
535e0ab6 1<?php
8f685009
SH
2
3// This file is part of Moodle - http://moodle.org/
4//
5// Moodle is free software: you can redistribute it and/or modify
6// it under the terms of the GNU General Public License as published by
7// the Free Software Foundation, either version 3 of the License, or
8// (at your option) any later version.
9//
10// Moodle is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13// GNU General Public License for more details.
14//
15// You should have received a copy of the GNU General Public License
16// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
17
18/**
01030f1b 19 * @package mod_forum
8f685009
SH
20 * @copyright Jamie Pratt <me@jamiep.org>
21 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22 */
23
bfebaf64
MD
24if (!defined('MOODLE_INTERNAL')) {
25 die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page
26}
27
23a7718b 28require_once ($CFG->dirroot.'/course/moodleform_mod.php');
e24b7f85 29
f07b9627 30class mod_forum_mod_form extends moodleform_mod {
535e0ab6 31
2ee60b49 32 function definition() {
c18269c7 33 global $CFG, $COURSE, $DB;
535e0ab6 34
2ee60b49 35 $mform =& $this->_form;
535e0ab6 36
37//-------------------------------------------------------------------------------
38 $mform->addElement('header', 'general', get_string('general', 'form'));
39
26de8d35 40 $mform->addElement('text', 'name', get_string('forumname', 'forum'), array('size'=>'64'));
8eb1d25f 41 if (!empty($CFG->formatstringstriptags)) {
fbe9f668 42 $mform->setType('name', PARAM_TEXT);
8eb1d25f 43 } else {
b8ea3041 44 $mform->setType('name', PARAM_CLEANHTML);
8eb1d25f 45 }
2ee60b49 46 $mform->addRule('name', null, 'required', null, 'client');
b230cac1 47 $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
535e0ab6 48
fbe9f668 49 $this->add_intro_editor(true, get_string('forumintro', 'forum'));
65bcf17b 50
f1b0908b 51 $forumtypes = forum_get_forum_types();
2f1e464a 52 core_collator::asort($forumtypes, core_collator::SORT_STRING);
fbe9f668 53 $mform->addElement('select', 'type', get_string('forumtype', 'forum'), $forumtypes);
530d2d72 54 $mform->addHelpButton('type', 'forumtype', 'forum');
2ee60b49 55 $mform->setDefault('type', 'general');
535e0ab6 56
fbe9f668
FM
57 // Attachments and word count.
58 $mform->addElement('header', 'attachmentswordcounthdr', get_string('attachmentswordcount', 'forum'));
535e0ab6 59
367b977d 60 $choices = get_max_upload_sizes($CFG->maxbytes, $COURSE->maxbytes, 0, $CFG->forum_maxbytes);
535e0ab6 61 $choices[1] = get_string('uploadnotallowed');
535e0ab6 62 $mform->addElement('select', 'maxbytes', get_string('maxattachmentsize', 'forum'), $choices);
530d2d72 63 $mform->addHelpButton('maxbytes', 'maxattachmentsize', 'forum');
2ee60b49 64 $mform->setDefault('maxbytes', $CFG->forum_maxbytes);
535e0ab6 65
3db7b878 66 $choices = array(0,1,2,3,4,5,6,7,8,9,10,20,50,100);
30a9aff5 67 $mform->addElement('select', 'maxattachments', get_string('maxattachments', 'forum'), $choices);
530d2d72 68 $mform->addHelpButton('maxattachments', 'maxattachments', 'forum');
30a9aff5 69 $mform->setDefault('maxattachments', $CFG->forum_maxattachments);
70
506522d5
FM
71 $mform->addElement('selectyesno', 'displaywordcount', get_string('displaywordcount', 'forum'));
72 $mform->addHelpButton('displaywordcount', 'displaywordcount', 'forum');
73 $mform->setDefault('displaywordcount', 0);
fbe9f668
FM
74
75 // Subscription and tracking.
76 $mform->addElement('header', 'subscriptionandtrackinghdr', get_string('subscriptionandtracking', 'forum'));
77
78 $options = array();
79 $options[FORUM_CHOOSESUBSCRIBE] = get_string('subscriptionoptional', 'forum');
80 $options[FORUM_FORCESUBSCRIBE] = get_string('subscriptionforced', 'forum');
81 $options[FORUM_INITIALSUBSCRIBE] = get_string('subscriptionauto', 'forum');
82 $options[FORUM_DISALLOWSUBSCRIBE] = get_string('subscriptiondisabled','forum');
83 $mform->addElement('select', 'forcesubscribe', get_string('subscriptionmode', 'forum'), $options);
84 $mform->addHelpButton('forcesubscribe', 'subscriptionmode', 'forum');
85
86 $options = array();
87 $options[FORUM_TRACKING_OPTIONAL] = get_string('trackingoptional', 'forum');
88 $options[FORUM_TRACKING_OFF] = get_string('trackingoff', 'forum');
20e6782f 89 if ($CFG->forum_allowforcedreadtracking) {
bd8f5d45 90 $options[FORUM_TRACKING_FORCED] = get_string('trackingon', 'forum');
20e6782f 91 }
fbe9f668
FM
92 $mform->addElement('select', 'trackingtype', get_string('trackingtype', 'forum'), $options);
93 $mform->addHelpButton('trackingtype', 'trackingtype', 'forum');
20e6782f 94 $default = $CFG->forum_trackingtype;
bd8f5d45 95 if ((!$CFG->forum_allowforcedreadtracking) && ($default == FORUM_TRACKING_FORCED)) {
20e6782f
EM
96 $default = FORUM_TRACKING_OPTIONAL;
97 }
98 $mform->setDefault('trackingtype', $default);
506522d5 99
535e0ab6 100 if ($CFG->enablerssfeeds && isset($CFG->forum_enablerssfeeds) && $CFG->forum_enablerssfeeds) {
a02c77dc 101//-------------------------------------------------------------------------------
807cf3d0 102 $mform->addElement('header', 'rssheader', get_string('rss'));
535e0ab6 103 $choices = array();
104 $choices[0] = get_string('none');
105 $choices[1] = get_string('discussions', 'forum');
106 $choices[2] = get_string('posts', 'forum');
107 $mform->addElement('select', 'rsstype', get_string('rsstype'), $choices);
530d2d72 108 $mform->addHelpButton('rsstype', 'rsstype', 'forum');
535e0ab6 109
110 $choices = array();
111 $choices[0] = '0';
112 $choices[1] = '1';
113 $choices[2] = '2';
114 $choices[3] = '3';
115 $choices[4] = '4';
116 $choices[5] = '5';
117 $choices[10] = '10';
118 $choices[15] = '15';
119 $choices[20] = '20';
120 $choices[25] = '25';
121 $choices[30] = '30';
122 $choices[40] = '40';
123 $choices[50] = '50';
124 $mform->addElement('select', 'rssarticles', get_string('rssarticles'), $choices);
530d2d72 125 $mform->addHelpButton('rssarticles', 'rssarticles', 'forum');
cf626656 126 $mform->disabledIf('rssarticles', 'rsstype', 'eq', '0');
535e0ab6 127 }
128
a02c77dc 129//-------------------------------------------------------------------------------
807cf3d0 130 $mform->addElement('header', 'blockafterheader', get_string('blockafter', 'forum'));
2ee60b49 131 $options = array();
535e0ab6 132 $options[0] = get_string('blockperioddisabled','forum');
133 $options[60*60*24] = '1 '.get_string('day');
134 $options[60*60*24*2] = '2 '.get_string('days');
135 $options[60*60*24*3] = '3 '.get_string('days');
136 $options[60*60*24*4] = '4 '.get_string('days');
137 $options[60*60*24*5] = '5 '.get_string('days');
138 $options[60*60*24*6] = '6 '.get_string('days');
139 $options[60*60*24*7] = '1 '.get_string('week');
530d2d72
DM
140 $mform->addElement('select', 'blockperiod', get_string('blockperiod', 'forum'), $options);
141 $mform->addHelpButton('blockperiod', 'blockperiod', 'forum');
535e0ab6 142
2ee60b49 143 $mform->addElement('text', 'blockafter', get_string('blockafter', 'forum'));
144 $mform->setType('blockafter', PARAM_INT);
145 $mform->setDefault('blockafter', '0');
146 $mform->addRule('blockafter', null, 'numeric', null, 'client');
530d2d72 147 $mform->addHelpButton('blockafter', 'blockafter', 'forum');
2ee60b49 148 $mform->disabledIf('blockafter', 'blockperiod', 'eq', 0);
9c03bbaa 149
9c03bbaa 150 $mform->addElement('text', 'warnafter', get_string('warnafter', 'forum'));
2ee60b49 151 $mform->setType('warnafter', PARAM_INT);
152 $mform->setDefault('warnafter', '0');
153 $mform->addRule('warnafter', null, 'numeric', null, 'client');
530d2d72 154 $mform->addHelpButton('warnafter', 'warnafter', 'forum');
2ee60b49 155 $mform->disabledIf('warnafter', 'blockperiod', 'eq', 0);
9c03bbaa 156
103e7cba 157 $coursecontext = context_course::instance($COURSE->id);
67fbfe8b 158 plagiarism_get_form_elements_module($mform, $coursecontext, 'mod_forum');
103e7cba 159
a02c77dc 160//-------------------------------------------------------------------------------
16306628
AD
161
162 $this->standard_grading_coursemodule_elements();
163
42f103be 164 $this->standard_coursemodule_elements();
a23f0aaf 165//-------------------------------------------------------------------------------
2ee60b49 166// buttons
a23f0aaf 167 $this->add_action_buttons();
535e0ab6 168
2ee60b49 169 }
535e0ab6 170
4ba2221a 171 function definition_after_data() {
4050572d 172 parent::definition_after_data();
173 $mform =& $this->_form;
174 $type =& $mform->getElement('type');
175 $typevalue = $mform->getElementValue('type');
176
d24206d6 177 //we don't want to have these appear as possible selections in the form but
178 //we want the form to display them if they are set.
4ba2221a 179 if ($typevalue[0]=='news') {
d24206d6 180 $type->addOption(get_string('namenews', 'forum'), 'news');
530d2d72 181 $mform->addHelpButton('type', 'namenews', 'forum');
d24206d6 182 $type->freeze();
183 $type->setPersistantFreeze(true);
184 }
4ba2221a 185 if ($typevalue[0]=='social') {
d24206d6 186 $type->addOption(get_string('namesocial', 'forum'), 'social');
535e0ab6 187 $type->freeze();
188 $type->setPersistantFreeze(true);
189 }
02f8f37d 190
2ee60b49 191 }
535e0ab6 192
4ba2221a 193 function data_preprocessing(&$default_values) {
55d95d90
AD
194 parent::data_preprocessing($default_values);
195
4e781c7b 196 // Set up the completion checkboxes which aren't part of standard data.
197 // We also make the default value (if you turn on the checkbox) for those
198 // numbers to be 1, this will not apply unless checkbox is ticked.
199 $default_values['completiondiscussionsenabled']=
200 !empty($default_values['completiondiscussions']) ? 1 : 0;
4ba2221a 201 if (empty($default_values['completiondiscussions'])) {
4e781c7b 202 $default_values['completiondiscussions']=1;
203 }
204 $default_values['completionrepliesenabled']=
205 !empty($default_values['completionreplies']) ? 1 : 0;
4ba2221a 206 if (empty($default_values['completionreplies'])) {
4e781c7b 207 $default_values['completionreplies']=1;
208 }
209 $default_values['completionpostsenabled']=
210 !empty($default_values['completionposts']) ? 1 : 0;
4ba2221a 211 if (empty($default_values['completionposts'])) {
4e781c7b 212 $default_values['completionposts']=1;
213 }
2ee60b49 214 }
e24b7f85 215
4454447d 216 function add_completion_rules() {
4e781c7b 217 $mform =& $this->_form;
218
219 $group=array();
220 $group[] =& $mform->createElement('checkbox', 'completionpostsenabled', '', get_string('completionposts','forum'));
221 $group[] =& $mform->createElement('text', 'completionposts', '', array('size'=>3));
222 $mform->setType('completionposts',PARAM_INT);
223 $mform->addGroup($group, 'completionpostsgroup', get_string('completionpostsgroup','forum'), array(' '), false);
4e781c7b 224 $mform->disabledIf('completionposts','completionpostsenabled','notchecked');
225
226 $group=array();
227 $group[] =& $mform->createElement('checkbox', 'completiondiscussionsenabled', '', get_string('completiondiscussions','forum'));
228 $group[] =& $mform->createElement('text', 'completiondiscussions', '', array('size'=>3));
229 $mform->setType('completiondiscussions',PARAM_INT);
230 $mform->addGroup($group, 'completiondiscussionsgroup', get_string('completiondiscussionsgroup','forum'), array(' '), false);
4e781c7b 231 $mform->disabledIf('completiondiscussions','completiondiscussionsenabled','notchecked');
232
233 $group=array();
234 $group[] =& $mform->createElement('checkbox', 'completionrepliesenabled', '', get_string('completionreplies','forum'));
235 $group[] =& $mform->createElement('text', 'completionreplies', '', array('size'=>3));
236 $mform->setType('completionreplies',PARAM_INT);
237 $mform->addGroup($group, 'completionrepliesgroup', get_string('completionrepliesgroup','forum'), array(' '), false);
4e781c7b 238 $mform->disabledIf('completionreplies','completionrepliesenabled','notchecked');
239
240 return array('completiondiscussionsgroup','completionrepliesgroup','completionpostsgroup');
241 }
242
243 function completion_rule_enabled($data) {
244 return (!empty($data['completiondiscussionsenabled']) && $data['completiondiscussions']!=0) ||
245 (!empty($data['completionrepliesenabled']) && $data['completionreplies']!=0) ||
246 (!empty($data['completionpostsenabled']) && $data['completionposts']!=0);
247 }
248
49f6e5f4 249 function get_data() {
4ba2221a 250 $data = parent::get_data();
251 if (!$data) {
4e781c7b 252 return false;
253 }
254 // Turn off completion settings if the checkboxes aren't ticked
a9f5fc15 255 if (!empty($data->completionunlocked)) {
256 $autocompletion = !empty($data->completion) && $data->completion==COMPLETION_TRACKING_AUTOMATIC;
257 if (empty($data->completiondiscussionsenabled) || !$autocompletion) {
258 $data->completiondiscussions = 0;
259 }
260 if (empty($data->completionrepliesenabled) || !$autocompletion) {
261 $data->completionreplies = 0;
262 }
263 if (empty($data->completionpostsenabled) || !$autocompletion) {
264 $data->completionposts = 0;
265 }
4e781c7b 266 }
267 return $data;
268 }
535e0ab6 269}
1adbd2c3 270