Merge branch 'MDL-53674-30-eventmsg' of git://github.com/mudrd8mz/moodle into MOODLE_...
[moodle.git] / group / autogroup.php
blob8270ff326ccddff14a3972518f2f43a51fab10e1
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.
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/>.
18 /**
19 * Create and allocate users to groups
21 * @package core_group
22 * @copyright Matt Clarkson mattc@catalyst.net.nz
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26 require_once('../config.php');
27 require_once('lib.php');
28 require_once('autogroup_form.php');
30 if (!defined('AUTOGROUP_MIN_RATIO')) {
31 define('AUTOGROUP_MIN_RATIO', 0.7); // means minimum member count is 70% in the smallest group
34 $courseid = required_param('courseid', PARAM_INT);
35 $PAGE->set_url('/group/autogroup.php', array('courseid' => $courseid));
37 if (!$course = $DB->get_record('course', array('id'=>$courseid))) {
38 print_error('invalidcourseid');
41 // Make sure that the user has permissions to manage groups.
42 require_login($course);
44 $context = context_course::instance($courseid);
45 require_capability('moodle/course:managegroups', $context);
47 $returnurl = $CFG->wwwroot.'/group/index.php?id='.$course->id;
49 $strgroups = get_string('groups');
50 $strparticipants = get_string('participants');
51 $strautocreategroups = get_string('autocreategroups', 'group');
53 $PAGE->set_title($strgroups);
54 $PAGE->set_heading($course->fullname. ': '.$strgroups);
55 $PAGE->set_pagelayout('admin');
56 navigation_node::override_active_url(new moodle_url('/group/index.php', array('id' => $courseid)));
58 // Print the page and form
59 $preview = '';
60 $error = '';
62 /// Get applicable roles - used in menus etc later on
63 $rolenames = role_fix_names(get_profile_roles($context), $context, ROLENAME_ALIAS, true);
65 /// Create the form
66 $editform = new autogroup_form(null, array('roles' => $rolenames));
67 $editform->set_data(array('courseid' => $courseid, 'seed' => time()));
69 /// Handle form submission
70 if ($editform->is_cancelled()) {
71 redirect($returnurl);
73 } elseif ($data = $editform->get_data()) {
75 /// Allocate members from the selected role to groups
76 switch ($data->allocateby) {
77 case 'no':
78 case 'random':
79 case 'lastname':
80 $orderby = 'lastname, firstname'; break;
81 case 'firstname':
82 $orderby = 'firstname, lastname'; break;
83 case 'idnumber':
84 $orderby = 'idnumber'; break;
85 default:
86 print_error('unknoworder');
88 $source = array();
89 if ($data->cohortid) {
90 $source['cohortid'] = $data->cohortid;
92 if ($data->groupingid) {
93 $source['groupingid'] = $data->groupingid;
95 if ($data->groupid) {
96 $source['groupid'] = $data->groupid;
98 $users = groups_get_potential_members($data->courseid, $data->roleid, $source, $orderby, !empty($data->notingroup));
99 $usercnt = count($users);
101 if ($data->allocateby == 'random') {
102 srand($data->seed);
103 shuffle($users);
106 $groups = array();
108 // Plan the allocation
109 if ($data->groupby == 'groups') {
110 $numgrps = $data->number;
111 $userpergrp = floor($usercnt/$numgrps);
113 } else { // members
114 $numgrps = ceil($usercnt/$data->number);
115 $userpergrp = $data->number;
117 if (!empty($data->nosmallgroups) and $usercnt % $data->number != 0) {
118 // If there would be one group with a small number of member reduce the number of groups
119 $missing = $userpergrp * $numgrps - $usercnt;
120 if ($missing > $userpergrp * (1-AUTOGROUP_MIN_RATIO)) {
121 // spread the users from the last small group
122 $numgrps--;
123 $userpergrp = floor($usercnt/$numgrps);
128 // allocate the users - all groups equal count first
129 for ($i=0; $i<$numgrps; $i++) {
130 $groups[$i] = array();
131 $groups[$i]['name'] = groups_parse_name(trim($data->namingscheme), $i);
132 $groups[$i]['members'] = array();
133 if ($data->allocateby == 'no') {
134 continue; // do not allocate users
136 for ($j=0; $j<$userpergrp; $j++) {
137 if (empty($users)) {
138 break 2;
140 $user = array_shift($users);
141 $groups[$i]['members'][$user->id] = $user;
144 // now distribute the rest
145 if ($data->allocateby != 'no') {
146 for ($i=0; $i<$numgrps; $i++) {
147 if (empty($users)) {
148 break 1;
150 $user = array_shift($users);
151 $groups[$i]['members'][$user->id] = $user;
155 if (isset($data->preview)) {
156 $table = new html_table();
157 if ($data->allocateby == 'no') {
158 $table->head = array(get_string('groupscount', 'group', $numgrps));
159 $table->size = array('100%');
160 $table->align = array('left');
161 $table->width = '40%';
162 } else {
163 $table->head = array(get_string('groupscount', 'group', $numgrps), get_string('groupmembers', 'group'), get_string('usercounttotal', 'group', $usercnt));
164 $table->size = array('20%', '70%', '10%');
165 $table->align = array('left', 'left', 'center');
166 $table->width = '90%';
168 $table->data = array();
170 foreach ($groups as $group) {
171 $line = array();
172 if (groups_get_group_by_name($courseid, $group['name'])) {
173 $line[] = '<span class="notifyproblem">'.get_string('groupnameexists', 'group', $group['name']).'</span>';
174 $error = get_string('groupnameexists', 'group', $group['name']);
175 } else {
176 $line[] = $group['name'];
178 if ($data->allocateby != 'no') {
179 $unames = array();
180 foreach ($group['members'] as $user) {
181 $unames[] = fullname($user, true);
183 $line[] = implode(', ', $unames);
184 $line[] = count($group['members']);
186 $table->data[] = $line;
189 $preview .= html_writer::table($table);
191 } else {
192 $grouping = null;
193 $createdgrouping = null;
194 $createdgroups = array();
195 $failed = false;
197 // prepare grouping
198 if (!empty($data->grouping)) {
199 if ($data->grouping < 0) {
200 $grouping = new stdClass();
201 $grouping->courseid = $COURSE->id;
202 $grouping->name = trim($data->groupingname);
203 $grouping->id = groups_create_grouping($grouping);
204 $createdgrouping = $grouping->id;
205 } else {
206 $grouping = groups_get_grouping($data->grouping);
210 // Save the groups data
211 foreach ($groups as $key=>$group) {
212 if (groups_get_group_by_name($courseid, $group['name'])) {
213 $error = get_string('groupnameexists', 'group', $group['name']);
214 $failed = true;
215 break;
217 $newgroup = new stdClass();
218 $newgroup->courseid = $data->courseid;
219 $newgroup->name = $group['name'];
220 $groupid = groups_create_group($newgroup);
221 $createdgroups[] = $groupid;
222 foreach($group['members'] as $user) {
223 groups_add_member($groupid, $user->id);
225 if ($grouping) {
226 // Ask this function not to invalidate the cache, we'll do that manually once at the end.
227 groups_assign_grouping($grouping->id, $groupid, null, false);
231 // Invalidate the course groups cache seeing as we've changed it.
232 cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($courseid));
234 if ($failed) {
235 foreach ($createdgroups as $groupid) {
236 groups_delete_group($groupid);
238 if ($createdgrouping) {
239 groups_delete_grouping($createdgrouping);
241 } else {
242 redirect($returnurl);
247 $PAGE->navbar->add($strparticipants, new moodle_url('/user/index.php', array('id'=>$courseid)));
248 $PAGE->navbar->add($strgroups, new moodle_url('/group/index.php', array('id'=>$courseid)));
249 $PAGE->navbar->add($strautocreategroups);
251 echo $OUTPUT->header();
252 echo $OUTPUT->heading($strautocreategroups);
254 if ($error != '') {
255 echo $OUTPUT->notification($error);
258 /// Display the form
259 $editform->display();
261 if($preview !== '') {
262 echo $OUTPUT->heading(get_string('groupspreview', 'group'));
264 echo $preview;
267 echo $OUTPUT->footer();