PHPXRef 0.7.1 : moodle-2.8 : /group/autogroup

[Summary view] [Print] [Text view]
   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   * Auto group form
  20   *
  21   * @package    core_group
  22   * @copyright  2007 mattc-catalyst (http://moodle.com)
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  if (!defined('MOODLE_INTERNAL')) {
  26      die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
  27  }
  28  
  29  require_once($CFG->dirroot.'/lib/formslib.php');
  30  require_once($CFG->dirroot.'/cohort/lib.php');
  31  
  32  /**
  33   * Auto group form class
  34   *
  35   * @package    core_group
  36   * @copyright  2007 mattc-catalyst (http://moodle.com)
  37   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  38   */
  39  class autogroup_form extends moodleform {
  40  
  41      /**
  42       * Form Definition
  43       */
  44      function definition() {
  45          global $CFG, $COURSE;
  46  
  47          $mform =& $this->_form;
  48  
  49          $mform->addElement('header', 'autogroup', get_string('general'));
  50  
  51          $mform->addElement('text', 'namingscheme', get_string('namingscheme', 'group'));
  52          $mform->addHelpButton('namingscheme', 'namingscheme', 'group');
  53          $mform->addRule('namingscheme', get_string('required'), 'required', null, 'client');
  54          $mform->setType('namingscheme', PARAM_TEXT);
  55          // There must not be duplicate group names in course.
  56          $template = get_string('grouptemplate', 'group');
  57          $gname = groups_parse_name($template, 0);
  58          if (!groups_get_group_by_name($COURSE->id, $gname)) {
  59              $mform->setDefault('namingscheme', $template);
  60          }
  61  
  62          $options = array('groups' => get_string('numgroups', 'group'),
  63                           'members' => get_string('nummembers', 'group'));
  64          $mform->addElement('select', 'groupby', get_string('groupby', 'group'), $options);
  65  
  66          $mform->addElement('text', 'number', get_string('number', 'group'),'maxlength="4" size="4"');
  67          $mform->setType('number', PARAM_INT);
  68          $mform->addRule('number', null, 'numeric', null, 'client');
  69          $mform->addRule('number', get_string('required'), 'required', null, 'client');
  70  
  71          $mform->addElement('header', 'groupmembershdr', get_string('groupmembers', 'group'));
  72          $mform->setExpanded('groupmembershdr', true);
  73  
  74          $options = array(0=>get_string('all'));
  75          $options += $this->_customdata['roles'];
  76          $mform->addElement('select', 'roleid', get_string('selectfromrole', 'group'), $options);
  77  
  78          $student = get_archetype_roles('student');
  79          $student = reset($student);
  80  
  81          if ($student and array_key_exists($student->id, $options)) {
  82              $mform->setDefault('roleid', $student->id);
  83          }
  84  
  85          if ($cohorts = cohort_get_available_cohorts(context_course::instance($COURSE->id), COHORT_WITH_ENROLLED_MEMBERS_ONLY)) {
  86              $options = array(0 => get_string('anycohort', 'cohort'));
  87              foreach ($cohorts as $c) {
  88                  $options[$c->id] = format_string($c->name, true, context::instance_by_id($c->contextid));
  89              }
  90              $mform->addElement('select', 'cohortid', get_string('selectfromcohort', 'cohort'), $options);
  91              $mform->setDefault('cohortid', '0');
  92          } else {
  93              $mform->addElement('hidden','cohortid');
  94              $mform->setType('cohortid', PARAM_INT);
  95              $mform->setConstant('cohortid', '0');
  96          }
  97  
  98          if ($groupings = groups_get_all_groupings($COURSE->id)) {
  99              $options = array();
 100              $options[0] = get_string('none');
 101              foreach ($groupings as $grouping) {
 102                  $options[$grouping->id] = format_string($grouping->name);
 103              }
 104              $mform->addElement('select', 'groupingid', get_string('selectfromgrouping', 'group'), $options);
 105              $mform->setDefault('groupingid', 0);
 106              $mform->disabledIf('groupingid', 'notingroup', 'checked');
 107          } else {
 108              $mform->addElement('hidden', 'groupingid');
 109              $mform->setType('groupingid', PARAM_INT);
 110              $mform->setConstant('groupingid', 0);
 111          }
 112  
 113          if ($groups = groups_get_all_groups($COURSE->id)) {
 114              $options = array();
 115              $options[0] = get_string('none');
 116              foreach ($groups as $group) {
 117                  $options[$group->id] = format_string($group->name);
 118              }
 119              $mform->addElement('select', 'groupid', get_string('selectfromgroup', 'group'), $options);
 120              $mform->setDefault('groupid', 0);
 121              $mform->disabledIf('groupid', 'notingroup', 'checked');
 122          } else {
 123              $mform->addElement('hidden', 'groupid');
 124              $mform->setType('groupid', PARAM_INT);
 125              $mform->setConstant('groupid', 0);
 126          }
 127  
 128          $options = array('no'        => get_string('noallocation', 'group'),
 129                           'random'    => get_string('random', 'group'),
 130                           'firstname' => get_string('byfirstname', 'group'),
 131                           'lastname'  => get_string('bylastname', 'group'),
 132                           'idnumber'  => get_string('byidnumber', 'group'));
 133          $mform->addElement('select', 'allocateby', get_string('allocateby', 'group'), $options);
 134          $mform->setDefault('allocateby', 'random');
 135  
 136          $mform->addElement('checkbox', 'nosmallgroups', get_string('nosmallgroups', 'group'));
 137          $mform->disabledIf('nosmallgroups', 'groupby', 'noteq', 'members');
 138  
 139          $mform->addElement('checkbox', 'notingroup', get_string('notingroup', 'group'));
 140          $mform->disabledIf('notingroup', 'groupingid', 'neq', 0);
 141          $mform->disabledIf('notingroup', 'groupid', 'neq', 0);
 142  
 143          $mform->addElement('header', 'groupinghdr', get_string('grouping', 'group'));
 144  
 145          $options = array('0' => get_string('nogrouping', 'group'),
 146                           '-1'=> get_string('newgrouping', 'group'));
 147          if ($groupings = groups_get_all_groupings($COURSE->id)) {
 148              foreach ($groupings as $grouping) {
 149                  $options[$grouping->id] = strip_tags(format_string($grouping->name));
 150              }
 151          }
 152          $mform->addElement('select', 'grouping', get_string('createingrouping', 'group'), $options);
 153          if ($groupings) {
 154              $mform->setDefault('grouping', '-1');
 155          }
 156  
 157          $mform->addElement('text', 'groupingname', get_string('groupingname', 'group'), $options);
 158          $mform->setType('groupingname', PARAM_TEXT);
 159          $mform->disabledIf('groupingname', 'grouping', 'noteq', '-1');
 160  
 161          $mform->addElement('hidden','courseid');
 162          $mform->setType('courseid', PARAM_INT);
 163  
 164          $mform->addElement('hidden','seed');
 165          $mform->setType('seed', PARAM_INT);
 166  
 167          $buttonarray = array();
 168          $buttonarray[] = &$mform->createElement('submit', 'preview', get_string('preview'));
 169          $buttonarray[] = &$mform->createElement('submit', 'submitbutton', get_string('submit'));
 170          $buttonarray[] = &$mform->createElement('cancel');
 171          $mform->addGroup($buttonarray, 'buttonar', '', array(' '), false);
 172          $mform->closeHeaderBefore('buttonar');
 173      }
 174  
 175      /**
 176       * Performs validation of the form information
 177       *
 178       * @param array $data
 179       * @param array $files
 180       * @return array $errors An array of $errors
 181       */
 182      function validation($data, $files) {
 183          global $CFG, $COURSE;
 184          $errors = parent::validation($data, $files);
 185  
 186          if ($data['allocateby'] != 'no') {
 187              $source = array();
 188              if ($data['cohortid']) {
 189                  $source['cohortid'] = $data['cohortid'];
 190              }
 191              if ($data['groupingid']) {
 192                  $source['groupingid'] = $data['groupingid'];
 193              }
 194              if ($data['groupid']) {
 195                  $source['groupid'] = $data['groupid'];
 196              }
 197              if (!$users = groups_get_potential_members($data['courseid'], $data['roleid'], $source)) {
 198                  $errors['roleid'] = get_string('nousersinrole', 'group');
 199              }
 200  
 201             /// Check the number entered is sane
 202              if ($data['groupby'] == 'groups') {
 203                  $usercnt = count($users);
 204  
 205                  if ($data['number'] > $usercnt || $data['number'] < 1) {
 206                      $errors['number'] = get_string('toomanygroups', 'group', $usercnt);
 207                  }
 208              }
 209          }
 210  
 211          //try to detect group name duplicates
 212          $name = groups_parse_name(trim($data['namingscheme']), 0);
 213          if (groups_get_group_by_name($COURSE->id, $name)) {
 214              $errors['namingscheme'] = get_string('groupnameexists', 'group', $name);
 215          }
 216  
 217          // check grouping name duplicates
 218          if ( isset($data['grouping']) && $data['grouping'] == '-1') {
 219              $name = trim($data['groupingname']);
 220              if (empty($name)) {
 221                  $errors['groupingname'] = get_string('required');
 222              } else if (groups_get_grouping_by_name($COURSE->id, $name)) {
 223                  $errors['groupingname'] = get_string('groupingnameexists', 'group', $name);
 224              }
 225          }
 226  
 227         /// Check the naming scheme
 228          if ($data['groupby'] == 'groups' and $data['number'] == 1) {
 229              // we can use the name as is because there will be only one group max
 230          } else {
 231              $matchcnt = preg_match_all('/[#@]{1,1}/', $data['namingscheme'], $matches);
 232              if ($matchcnt != 1) {
 233                  $errors['namingscheme'] = get_string('badnamingscheme', 'group');
 234              }
 235          }
 236  
 237          return $errors;
 238      }
 239  }
PHP Cross Reference of moodle-2.8

/group/ -> autogroup_form.php (source)
