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         $options = array(get_string('no'), get_string('yes'));
  70         $mform->addElement('select', 'hidepicture', get_string('hidepicture'), $options);
  71
  72         $mform->addElement('filepicker', 'imagefile', get_string('newpicture', 'group'));
  73         $mform->addHelpButton('imagefile', 'newpicture', 'group');
  74
  75         $mform->addElement('hidden','id');
  76         $mform->setType('id', PARAM_INT);
  77
  78         $mform->addElement('hidden','courseid');
  79         $mform->setType('courseid', PARAM_INT);
  80
  81         $this->add_action_buttons();
  82     }
  83
  84     /**
  85      * Form validation
  86      *
  87      * @param array $data
  88      * @param array $files
  89      * @return array $errors An array of errors
  90      */
  91     function validation($data, $files) {
  92         global $COURSE, $DB, $CFG;
  93
  94         $errors = parent::validation($data, $files);
  95
  96         $name = trim($data['name']);
  97         if (isset($data['idnumber'])) {
  98             $idnumber = trim($data['idnumber']);
  99         } else {
 100             $idnumber = '';
 101         }
 102         if ($data['id'] and $group = $DB->get_record('groups', array('id'=>$data['id']))) {
 103             if (core_text::strtolower($group->name) != core_text::strtolower($name)) {
 104                 if (groups_get_group_by_name($COURSE->id,  $name)) {
 105                     $errors['name'] = get_string('groupnameexists', 'group', $name);
 106                 }
 107             }
 108             if (!empty($idnumber) && $group->idnumber != $idnumber) {
 109                 if (groups_get_group_by_idnumber($COURSE->id, $idnumber)) {
 110                     $errors['idnumber']= get_string('idnumbertaken');
 111                 }
 112             }
 113
 114             if ($data['enrolmentkey'] != '') {
 115                 $errmsg = '';
 116                 if (!empty($CFG->groupenrolmentkeypolicy) && $group->enrolmentkey !== $data['enrolmentkey']
 117                         && !check_password_policy($data['enrolmentkey'], $errmsg)) {
 118                     // Enforce password policy when the password is changed.
 119                     $errors['enrolmentkey'] = $errmsg;
 120                 } else {
 121                     // Prevent twice the same enrolment key in course groups.
 122                     $sql = "SELECT id FROM {groups} WHERE id <> :groupid AND courseid = :courseid AND enrolmentkey = :key";
 123                     $params = array('groupid' => $data['id'], 'courseid' => $COURSE->id, 'key' => $data['enrolmentkey']);
 124                     if ($DB->record_exists_sql($sql, $params)) {
 125                         $errors['enrolmentkey'] = get_string('enrolmentkeyalreadyinuse', 'group');
 126                     }
 127                 }
 128             }
 129
 130         } else if (groups_get_group_by_name($COURSE->id, $name)) {
 131             $errors['name'] = get_string('groupnameexists', 'group', $name);
 132         } else if (!empty($idnumber) && groups_get_group_by_idnumber($COURSE->id, $idnumber)) {
 133             $errors['idnumber']= get_string('idnumbertaken');
 134         } else if ($data['enrolmentkey'] != '') {
 135             $errmsg = '';
 136             if (!empty($CFG->groupenrolmentkeypolicy) && !check_password_policy($data['enrolmentkey'], $errmsg)) {
 137                 // Enforce password policy.
 138                 $errors['enrolmentkey'] = $errmsg;
 139             } else if ($DB->record_exists('groups', array('courseid' => $COURSE->id, 'enrolmentkey' => $data['enrolmentkey']))) {
 140                 // Prevent the same enrolment key from being used multiple times in course groups.
 141                 $errors['enrolmentkey'] = get_string('enrolmentkeyalreadyinuse', 'group');
 142             }
 143         }
 144
 145         return $errors;
 146     }
 147
 148     /**
 149      * Get editor options for this form
 150      *
 151      * @return array An array of options
 152      */
 153     function get_editor_options() {
 154         return $this->_customdata['editoroptions'];
 155     }
 156 }