group/group_form.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17
  18 /**
  19  * A form for the creation and editing of groups.
  20  *
  21  * @copyright 2006 The Open University, N.D.Freear AT open.ac.uk, J.White AT open.ac.uk
  22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  * @package   core_group
  24  */
  25
  26 defined('MOODLE_INTERNAL') || die;
  27
  28 require_once($CFG->dirroot.'/lib/formslib.php');
  29
  30 /**
  31  * Group form class
  32  *
  33  * @copyright 2006 The Open University, N.D.Freear AT open.ac.uk, J.White AT open.ac.uk
  34  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35  * @package   core_group
  36  */
  37 class group_form extends moodleform {
  38
  39     /**
  40      * Definition of the form
  41      */
  42     function definition () {
  43         global $USER, $CFG, $COURSE;
  44         $coursecontext = context_course::instance($COURSE->id);
  45
  46         $mform =& $this->_form;
  47         $editoroptions = $this->_customdata['editoroptions'];
  48
  49         $mform->addElement('header', 'general', get_string('general', 'form'));
  50
  51         $mform->addElement('text','name', get_string('groupname', 'group'),'maxlength="254" size="50"');
  52         $mform->addRule('name', get_string('required'), 'required', null, 'client');
  53         $mform->setType('name', PARAM_TEXT);
  54
  55         $mform->addElement('text','idnumber', get_string('idnumbergroup'), 'maxlength="100" size="10"');
  56         $mform->addHelpButton('idnumber', 'idnumbergroup');
  57         $mform->setType('idnumber', PARAM_RAW);
  58         if (!has_capability('moodle/course:changeidnumber', $coursecontext)) {
  59             $mform->hardFreeze('idnumber');
  60         }
  61
  62         $mform->addElement('editor', 'description_editor', get_string('groupdescription', 'group'), null, $editoroptions);
  63         $mform->setType('description_editor', PARAM_RAW);
  64
  65         $mform->addElement('passwordunmask', 'enrolmentkey', get_string('enrolmentkey', 'group'), 'maxlength="254" size="24"', get_string('enrolmentkey', 'group'));
  66         $mform->addHelpButton('enrolmentkey', 'enrolmentkey', 'group');
  67         $mform->setType('enrolmentkey', PARAM_RAW);
  68
  69         $mform->addElement('static', 'currentpicture', get_string('currentpicture'));
  70
  71         $mform->addElement('checkbox', 'deletepicture', get_string('delete'));
  72         $mform->setDefault('deletepicture', 0);
  73
  74         $options = array(get_string('no'), get_string('yes'));
  75         $mform->addElement('select', 'hidepicture', get_string('hidepicture'), $options);
  76
  77         $mform->addElement('filepicker', 'imagefile', get_string('newpicture', 'group'));
  78         $mform->addHelpButton('imagefile', 'newpicture', 'group');
  79
  80         $mform->addElement('hidden','id');
  81         $mform->setType('id', PARAM_INT);
  82
  83         $mform->addElement('hidden','courseid');
  84         $mform->setType('courseid', PARAM_INT);
  85
  86         $this->add_action_buttons();
  87     }
  88
  89     /**
  90      * Extend the form definition after the data has been parsed.
  91      */
  92     public function definition_after_data() {
  93         global $COURSE, $DB;
  94
  95         $mform = $this->_form;
  96         $groupid = $mform->getElementValue('id');
  97
  98         if ($group = $DB->get_record('groups', array('id' => $groupid))) {
  99
 100             // Print picture.
 101             if (!($pic = print_group_picture($group, $COURSE->id, true, true, false))) {
 102                 $pic = get_string('none');
 103                 if ($mform->elementExists('deletepicture')) {
 104                     $mform->removeElement('deletepicture');
 105                 }
 106             }
 107             $imageelement = $mform->getElement('currentpicture');
 108             $imageelement->setValue($pic);
 109         } else {
 110             if ($mform->elementExists('currentpicture')) {
 111                 $mform->removeElement('currentpicture');
 112             }
 113             if ($mform->elementExists('deletepicture')) {
 114                 $mform->removeElement('deletepicture');
 115             }
 116         }
 117
 118     }
 119
 120     /**
 121      * Form validation
 122      *
 123      * @param array $data
 124      * @param array $files
 125      * @return array $errors An array of errors
 126      */
 127     function validation($data, $files) {
 128         global $COURSE, $DB, $CFG;
 129
 130         $errors = parent::validation($data, $files);
 131
 132         $name = trim($data['name']);
 133         if (isset($data['idnumber'])) {
 134             $idnumber = trim($data['idnumber']);
 135         } else {
 136             $idnumber = '';
 137         }
 138         if ($data['id'] and $group = $DB->get_record('groups', array('id'=>$data['id']))) {
 139             if (core_text::strtolower($group->name) != core_text::strtolower($name)) {
 140                 if (groups_get_group_by_name($COURSE->id,  $name)) {
 141                     $errors['name'] = get_string('groupnameexists', 'group', $name);
 142                 }
 143             }
 144             if (!empty($idnumber) && $group->idnumber != $idnumber) {
 145                 if (groups_get_group_by_idnumber($COURSE->id, $idnumber)) {
 146                     $errors['idnumber']= get_string('idnumbertaken');
 147                 }
 148             }
 149
 150             if ($data['enrolmentkey'] != '') {
 151                 $errmsg = '';
 152                 if (!empty($CFG->groupenrolmentkeypolicy) && $group->enrolmentkey !== $data['enrolmentkey']
 153                         && !check_password_policy($data['enrolmentkey'], $errmsg)) {
 154                     // Enforce password policy when the password is changed.
 155                     $errors['enrolmentkey'] = $errmsg;
 156                 } else {
 157                     // Prevent twice the same enrolment key in course groups.
 158                     $sql = "SELECT id FROM {groups} WHERE id <> :groupid AND courseid = :courseid AND enrolmentkey = :key";
 159                     $params = array('groupid' => $data['id'], 'courseid' => $COURSE->id, 'key' => $data['enrolmentkey']);
 160                     if ($DB->record_exists_sql($sql, $params)) {
 161                         $errors['enrolmentkey'] = get_string('enrolmentkeyalreadyinuse', 'group');
 162                     }
 163                 }
 164             }
 165
 166         } else if (groups_get_group_by_name($COURSE->id, $name)) {
 167             $errors['name'] = get_string('groupnameexists', 'group', $name);
 168         } else if (!empty($idnumber) && groups_get_group_by_idnumber($COURSE->id, $idnumber)) {
 169             $errors['idnumber']= get_string('idnumbertaken');
 170         } else if ($data['enrolmentkey'] != '') {
 171             $errmsg = '';
 172             if (!empty($CFG->groupenrolmentkeypolicy) && !check_password_policy($data['enrolmentkey'], $errmsg)) {
 173                 // Enforce password policy.
 174                 $errors['enrolmentkey'] = $errmsg;
 175             } else if ($DB->record_exists('groups', array('courseid' => $COURSE->id, 'enrolmentkey' => $data['enrolmentkey']))) {
 176                 // Prevent the same enrolment key from being used multiple times in course groups.
 177                 $errors['enrolmentkey'] = get_string('enrolmentkeyalreadyinuse', 'group');
 178             }
 179         }
 180
 181         return $errors;
 182     }
 183
 184     /**
 185      * Get editor options for this form
 186      *
 187      * @return array An array of options
 188      */
 189     function get_editor_options() {
 190         return $this->_customdata['editoroptions'];
 191     }
 192 }