mod/forum/mod_form.php

   1 <?php
   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 /**
  19  * @package   mod_forum
  20  * @copyright Jamie Pratt <me@jamiep.org>
  21  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  22  */
  23
  24 if (!defined('MOODLE_INTERNAL')) {
  25     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
  26 }
  27
  28 require_once ($CFG->dirroot.'/course/moodleform_mod.php');
  29
  30 class mod_forum_mod_form extends moodleform_mod {
  31
  32     function definition() {
  33         global $CFG, $COURSE, $DB;
  34
  35         $mform    =& $this->_form;
  36
  37 //-------------------------------------------------------------------------------
  38         $mform->addElement('header', 'general', get_string('general', 'form'));
  39
  40         $mform->addElement('text', 'name', get_string('forumname', 'forum'), array('size'=>'64'));
  41         if (!empty($CFG->formatstringstriptags)) {
  42             $mform->setType('name', PARAM_TEXT);
  43         } else {
  44             $mform->setType('name', PARAM_CLEANHTML);
  45         }
  46         $mform->addRule('name', null, 'required', null, 'client');
  47         $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
  48
  49         $this->standard_intro_elements(get_string('forumintro', 'forum'));
  50
  51         $forumtypes = forum_get_forum_types();
  52         core_collator::asort($forumtypes, core_collator::SORT_STRING);
  53         $mform->addElement('select', 'type', get_string('forumtype', 'forum'), $forumtypes);
  54         $mform->addHelpButton('type', 'forumtype', 'forum');
  55         $mform->setDefault('type', 'general');
  56
  57         // Attachments and word count.
  58         $mform->addElement('header', 'attachmentswordcounthdr', get_string('attachmentswordcount', 'forum'));
  59
  60         $choices = get_max_upload_sizes($CFG->maxbytes, $COURSE->maxbytes, 0, $CFG->forum_maxbytes);
  61         $choices[1] = get_string('uploadnotallowed');
  62         $mform->addElement('select', 'maxbytes', get_string('maxattachmentsize', 'forum'), $choices);
  63         $mform->addHelpButton('maxbytes', 'maxattachmentsize', 'forum');
  64         $mform->setDefault('maxbytes', $CFG->forum_maxbytes);
  65
  66         $choices = array(
  67             0 => 0,
  68             1 => 1,
  69             2 => 2,
  70             3 => 3,
  71             4 => 4,
  72             5 => 5,
  73             6 => 6,
  74             7 => 7,
  75             8 => 8,
  76             9 => 9,
  77             10 => 10,
  78             20 => 20,
  79             50 => 50,
  80             100 => 100
  81         );
  82         $mform->addElement('select', 'maxattachments', get_string('maxattachments', 'forum'), $choices);
  83         $mform->addHelpButton('maxattachments', 'maxattachments', 'forum');
  84         $mform->setDefault('maxattachments', $CFG->forum_maxattachments);
  85
  86         $mform->addElement('selectyesno', 'displaywordcount', get_string('displaywordcount', 'forum'));
  87         $mform->addHelpButton('displaywordcount', 'displaywordcount', 'forum');
  88         $mform->setDefault('displaywordcount', 0);
  89
  90         // Subscription and tracking.
  91         $mform->addElement('header', 'subscriptionandtrackinghdr', get_string('subscriptionandtracking', 'forum'));
  92
  93         $options = array();
  94         $options[FORUM_CHOOSESUBSCRIBE] = get_string('subscriptionoptional', 'forum');
  95         $options[FORUM_FORCESUBSCRIBE] = get_string('subscriptionforced', 'forum');
  96         $options[FORUM_INITIALSUBSCRIBE] = get_string('subscriptionauto', 'forum');
  97         $options[FORUM_DISALLOWSUBSCRIBE] = get_string('subscriptiondisabled','forum');
  98         $mform->addElement('select', 'forcesubscribe', get_string('subscriptionmode', 'forum'), $options);
  99         $mform->addHelpButton('forcesubscribe', 'subscriptionmode', 'forum');
 100
 101         $options = array();
 102         $options[FORUM_TRACKING_OPTIONAL] = get_string('trackingoptional', 'forum');
 103         $options[FORUM_TRACKING_OFF] = get_string('trackingoff', 'forum');
 104         if ($CFG->forum_allowforcedreadtracking) {
 105             $options[FORUM_TRACKING_FORCED] = get_string('trackingon', 'forum');
 106         }
 107         $mform->addElement('select', 'trackingtype', get_string('trackingtype', 'forum'), $options);
 108         $mform->addHelpButton('trackingtype', 'trackingtype', 'forum');
 109         $default = $CFG->forum_trackingtype;
 110         if ((!$CFG->forum_allowforcedreadtracking) && ($default == FORUM_TRACKING_FORCED)) {
 111             $default = FORUM_TRACKING_OPTIONAL;
 112         }
 113         $mform->setDefault('trackingtype', $default);
 114
 115         if ($CFG->enablerssfeeds && isset($CFG->forum_enablerssfeeds) && $CFG->forum_enablerssfeeds) {
 116 //-------------------------------------------------------------------------------
 117             $mform->addElement('header', 'rssheader', get_string('rss'));
 118             $choices = array();
 119             $choices[0] = get_string('none');
 120             $choices[1] = get_string('discussions', 'forum');
 121             $choices[2] = get_string('posts', 'forum');
 122             $mform->addElement('select', 'rsstype', get_string('rsstype'), $choices);
 123             $mform->addHelpButton('rsstype', 'rsstype', 'forum');
 124             if (isset($CFG->forum_rsstype)) {
 125                 $mform->setDefault('rsstype', $CFG->forum_rsstype);
 126             }
 127
 128             $choices = array();
 129             $choices[0] = '0';
 130             $choices[1] = '1';
 131             $choices[2] = '2';
 132             $choices[3] = '3';
 133             $choices[4] = '4';
 134             $choices[5] = '5';
 135             $choices[10] = '10';
 136             $choices[15] = '15';
 137             $choices[20] = '20';
 138             $choices[25] = '25';
 139             $choices[30] = '30';
 140             $choices[40] = '40';
 141             $choices[50] = '50';
 142             $mform->addElement('select', 'rssarticles', get_string('rssarticles'), $choices);
 143             $mform->addHelpButton('rssarticles', 'rssarticles', 'forum');
 144             $mform->disabledIf('rssarticles', 'rsstype', 'eq', '0');
 145             if (isset($CFG->forum_rssarticles)) {
 146                 $mform->setDefault('rssarticles', $CFG->forum_rssarticles);
 147             }
 148         }
 149
 150         $mform->addElement('header', 'discussionlocking', get_string('discussionlockingheader', 'forum'));
 151         $options = [
 152             0               => get_string('discussionlockingdisabled', 'forum'),
 153             1   * DAYSECS   => get_string('numday', 'core', 1),
 154             1   * WEEKSECS  => get_string('numweek', 'core', 1),
 155             2   * WEEKSECS  => get_string('numweeks', 'core', 2),
 156             30  * DAYSECS   => get_string('nummonth', 'core', 1),
 157             60  * DAYSECS   => get_string('nummonths', 'core', 2),
 158             90  * DAYSECS   => get_string('nummonths', 'core', 3),
 159             180 * DAYSECS   => get_string('nummonths', 'core', 6),
 160             1   * YEARSECS  => get_string('numyear', 'core', 1),
 161         ];
 162         $mform->addElement('select', 'lockdiscussionafter', get_string('lockdiscussionafter', 'forum'), $options);
 163         $mform->addHelpButton('lockdiscussionafter', 'lockdiscussionafter', 'forum');
 164         $mform->disabledIf('lockdiscussionafter', 'type', 'eq', 'single');
 165
 166 //-------------------------------------------------------------------------------
 167         $mform->addElement('header', 'blockafterheader', get_string('blockafter', 'forum'));
 168         $options = array();
 169         $options[0] = get_string('blockperioddisabled','forum');
 170         $options[60*60*24]   = '1 '.get_string('day');
 171         $options[60*60*24*2] = '2 '.get_string('days');
 172         $options[60*60*24*3] = '3 '.get_string('days');
 173         $options[60*60*24*4] = '4 '.get_string('days');
 174         $options[60*60*24*5] = '5 '.get_string('days');
 175         $options[60*60*24*6] = '6 '.get_string('days');
 176         $options[60*60*24*7] = '1 '.get_string('week');
 177         $mform->addElement('select', 'blockperiod', get_string('blockperiod', 'forum'), $options);
 178         $mform->addHelpButton('blockperiod', 'blockperiod', 'forum');
 179
 180         $mform->addElement('text', 'blockafter', get_string('blockafter', 'forum'));
 181         $mform->setType('blockafter', PARAM_INT);
 182         $mform->setDefault('blockafter', '0');
 183         $mform->addRule('blockafter', null, 'numeric', null, 'client');
 184         $mform->addHelpButton('blockafter', 'blockafter', 'forum');
 185         $mform->disabledIf('blockafter', 'blockperiod', 'eq', 0);
 186
 187         $mform->addElement('text', 'warnafter', get_string('warnafter', 'forum'));
 188         $mform->setType('warnafter', PARAM_INT);
 189         $mform->setDefault('warnafter', '0');
 190         $mform->addRule('warnafter', null, 'numeric', null, 'client');
 191         $mform->addHelpButton('warnafter', 'warnafter', 'forum');
 192         $mform->disabledIf('warnafter', 'blockperiod', 'eq', 0);
 193
 194         $coursecontext = context_course::instance($COURSE->id);
 195         plagiarism_get_form_elements_module($mform, $coursecontext, 'mod_forum');
 196
 197 //-------------------------------------------------------------------------------
 198
 199         $this->standard_grading_coursemodule_elements();
 200
 201         $this->standard_coursemodule_elements();
 202 //-------------------------------------------------------------------------------
 203 // buttons
 204         $this->add_action_buttons();
 205
 206     }
 207
 208     function definition_after_data() {
 209         parent::definition_after_data();
 210         $mform     =& $this->_form;
 211         $type      =& $mform->getElement('type');
 212         $typevalue = $mform->getElementValue('type');
 213
 214         //we don't want to have these appear as possible selections in the form but
 215         //we want the form to display them if they are set.
 216         if ($typevalue[0]=='news') {
 217             $type->addOption(get_string('namenews', 'forum'), 'news');
 218             $mform->addHelpButton('type', 'namenews', 'forum');
 219             $type->freeze();
 220             $type->setPersistantFreeze(true);
 221         }
 222         if ($typevalue[0]=='social') {
 223             $type->addOption(get_string('namesocial', 'forum'), 'social');
 224             $type->freeze();
 225             $type->setPersistantFreeze(true);
 226         }
 227
 228     }
 229
 230     function data_preprocessing(&$default_values) {
 231         parent::data_preprocessing($default_values);
 232
 233         // Set up the completion checkboxes which aren't part of standard data.
 234         // We also make the default value (if you turn on the checkbox) for those
 235         // numbers to be 1, this will not apply unless checkbox is ticked.
 236         $default_values['completiondiscussionsenabled']=
 237             !empty($default_values['completiondiscussions']) ? 1 : 0;
 238         if (empty($default_values['completiondiscussions'])) {
 239             $default_values['completiondiscussions']=1;
 240         }
 241         $default_values['completionrepliesenabled']=
 242             !empty($default_values['completionreplies']) ? 1 : 0;
 243         if (empty($default_values['completionreplies'])) {
 244             $default_values['completionreplies']=1;
 245         }
 246         // Tick by default if Add mode or if completion posts settings is set to 1 or more.
 247         if (empty($this->_instance) || !empty($default_values['completionposts'])) {
 248             $default_values['completionpostsenabled'] = 1;
 249         } else {
 250             $default_values['completionpostsenabled'] = 0;
 251         }
 252         if (empty($default_values['completionposts'])) {
 253             $default_values['completionposts']=1;
 254         }
 255     }
 256
 257     /**
 258      * Add custom completion rules.
 259      *
 260      * @return array Array of string IDs of added items, empty array if none
 261      */
 262     public function add_completion_rules() {
 263         $mform =& $this->_form;
 264
 265         $group=array();
 266         $group[] =& $mform->createElement('checkbox', 'completionpostsenabled', '', get_string('completionposts','forum'));
 267         $group[] =& $mform->createElement('text', 'completionposts', '', array('size'=>3));
 268         $mform->setType('completionposts',PARAM_INT);
 269         $mform->addGroup($group, 'completionpostsgroup', get_string('completionpostsgroup','forum'), array(' '), false);
 270         $mform->disabledIf('completionposts','completionpostsenabled','notchecked');
 271
 272         $group=array();
 273         $group[] =& $mform->createElement('checkbox', 'completiondiscussionsenabled', '', get_string('completiondiscussions','forum'));
 274         $group[] =& $mform->createElement('text', 'completiondiscussions', '', array('size'=>3));
 275         $mform->setType('completiondiscussions',PARAM_INT);
 276         $mform->addGroup($group, 'completiondiscussionsgroup', get_string('completiondiscussionsgroup','forum'), array(' '), false);
 277         $mform->disabledIf('completiondiscussions','completiondiscussionsenabled','notchecked');
 278
 279         $group=array();
 280         $group[] =& $mform->createElement('checkbox', 'completionrepliesenabled', '', get_string('completionreplies','forum'));
 281         $group[] =& $mform->createElement('text', 'completionreplies', '', array('size'=>3));
 282         $mform->setType('completionreplies',PARAM_INT);
 283         $mform->addGroup($group, 'completionrepliesgroup', get_string('completionrepliesgroup','forum'), array(' '), false);
 284         $mform->disabledIf('completionreplies','completionrepliesenabled','notchecked');
 285
 286         return array('completiondiscussionsgroup','completionrepliesgroup','completionpostsgroup');
 287     }
 288
 289     function completion_rule_enabled($data) {
 290         return (!empty($data['completiondiscussionsenabled']) && $data['completiondiscussions']!=0) ||
 291             (!empty($data['completionrepliesenabled']) && $data['completionreplies']!=0) ||
 292             (!empty($data['completionpostsenabled']) && $data['completionposts']!=0);
 293     }
 294
 295     /**
 296      * Allows module to modify the data returned by form get_data().
 297      * This method is also called in the bulk activity completion form.
 298      *
 299      * Only available on moodleform_mod.
 300      *
 301      * @param stdClass $data the form data to be modified.
 302      */
 303     public function data_postprocessing($data) {
 304         parent::data_postprocessing($data);
 305         // Turn off completion settings if the checkboxes aren't ticked
 306         if (!empty($data->completionunlocked)) {
 307             $autocompletion = !empty($data->completion) && $data->completion==COMPLETION_TRACKING_AUTOMATIC;
 308             if (empty($data->completiondiscussionsenabled) || !$autocompletion) {
 309                 $data->completiondiscussions = 0;
 310             }
 311             if (empty($data->completionrepliesenabled) || !$autocompletion) {
 312                 $data->completionreplies = 0;
 313             }
 314             if (empty($data->completionpostsenabled) || !$autocompletion) {
 315                 $data->completionposts = 0;
 316             }
 317         }
 318     }
 319 }
 320