add page heading
[moodle.git] / group / autogroup.php
1 <?php
2 /**
3  * Create and allocate users go groups
4  *
5  * @author  Matt Clarkson mattc@catalyst.net.nz
6  * @version 0.0.1
7  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
8  * @package groups
9  */
11 require_once('../config.php');
12 require_once('lib.php');
13 require_once('autogroup_form.php');
15 if (!defined('AUTOGROUP_MIN_RATIO')) {
16     define('AUTOGROUP_MIN_RATIO', 0.7); // means minimum member count is 70% in the smallest group
17 }
19 $courseid = required_param('courseid', PARAM_INT);
20 $PAGE->set_url('/group/autogroup.php', array('courseid' => $courseid));
22 if (!$course = $DB->get_record('course', array('id'=>$courseid))) {
23     print_error('invalidcourseid');
24 }
26 // Make sure that the user has permissions to manage groups.
27 require_login($course);
29 $context       = get_context_instance(CONTEXT_COURSE, $courseid);
30 $systemcontext = get_context_instance(CONTEXT_SYSTEM);
31 require_capability('moodle/course:managegroups', $context);
33 $returnurl = $CFG->wwwroot.'/group/index.php?id='.$course->id;
35 $strgroups           = get_string('groups');
36 $strparticipants     = get_string('participants');
37 $strautocreategroups = get_string('autocreategroups', 'group');
39 // Print the page and form
40 $preview = '';
41 $error = '';
43 /// Get applicable roles
44 $rolenames = array();
45 if ($roles = get_profile_roles($context)) {
46     foreach ($roles as $role) {
47         $rolenames[$role->id] = strip_tags(role_get_name($role, $context));   // Used in menus etc later on
48     }
49 }
51 /// Create the form
52 $editform = new autogroup_form(null, array('roles' => $rolenames));
53 $editform->set_data(array('courseid' => $courseid, 'seed' => time()));
55 /// Handle form submission
56 if ($editform->is_cancelled()) {
57     redirect($returnurl);
59 } elseif ($data = $editform->get_data()) {
61     /// Allocate members from the selected role to groups
62     switch ($data->allocateby) {
63         case 'no':
64         case 'random':
65         case 'lastname':
66             $orderby = 'lastname, firstname'; break;
67         case 'firstname':
68             $orderby = 'firstname, lastname'; break;
69         case 'idnumber':
70             $orderby = 'idnumber'; break;
71         default:
72             print_error('unknoworder');
73     }
74     $users = groups_get_potential_members($data->courseid, $data->roleid, $data->cohortid, $orderby);
75     $usercnt = count($users);
77     if ($data->allocateby == 'random') {
78         srand($data->seed);
79         shuffle($users);
80     }
82     $groups = array();
84     // Plan the allocation
85     if ($data->groupby == 'groups') {
86         $numgrps    = $data->number;
87         $userpergrp = floor($usercnt/$numgrps);
89     } else { // members
90         $numgrps    = ceil($usercnt/$data->number);
91         $userpergrp = $data->number;
93         if (!empty($data->nosmallgroups) and $usercnt % $data->number != 0) {
94             // If there would be one group with a small number of member reduce the number of groups
95             $missing = $userpergrp * $numgrps - $usercnt;
96             if ($missing > $userpergrp * (1-AUTOGROUP_MIN_RATIO)) {
97                 // spread the users from the last small group
98                 $numgrps--;
99                 $userpergrp = floor($usercnt/$numgrps);
100             }
101         }
102     }
104     // allocate the users - all groups equal count first
105     for ($i=0; $i<$numgrps; $i++) {
106         $groups[$i] = array();
107         $groups[$i]['name']    = groups_parse_name(trim($data->namingscheme), $i);
108         $groups[$i]['members'] = array();
109         if ($data->allocateby == 'no') {
110             continue; // do not allocate users
111         }
112         for ($j=0; $j<$userpergrp; $j++) {
113             if (empty($users)) {
114                 break 2;
115             }
116             $user = array_shift($users);
117             $groups[$i]['members'][$user->id] = $user;
118         }
119     }
120     // now distribute the rest
121     if ($data->allocateby != 'no') {
122         for ($i=0; $i<$numgrps; $i++) {
123             if (empty($users)) {
124                 break 1;
125             }
126             $user = array_shift($users);
127             $groups[$i]['members'][$user->id] = $user;
128         }
129     }
131     if (isset($data->preview)) {
132         $table = new html_table();
133         if ($data->allocateby == 'no') {
134             $table->head  = array(get_string('groupscount', 'group', $numgrps));
135             $table->size  = array('100%');
136             $table->align = array('left');
137             $table->width = '40%';
138         } else {
139             $table->head  = array(get_string('groupscount', 'group', $numgrps), get_string('groupmembers', 'group'), get_string('usercounttotal', 'group', $usercnt));
140             $table->size  = array('20%', '70%', '10%');
141             $table->align = array('left', 'left', 'center');
142             $table->width = '90%';
143         }
144         $table->data  = array();
146         foreach ($groups as $group) {
147             $line = array();
148             if (groups_get_group_by_name($courseid, $group['name'])) {
149                 $line[] = '<span class="notifyproblem">'.get_string('groupnameexists', 'group', $group['name']).'</span>';
150                 $error = get_string('groupnameexists', 'group', $group['name']);
151             } else {
152                 $line[] = $group['name'];
153             }
154             if ($data->allocateby != 'no') {
155                 $unames = array();
156                 foreach ($group['members'] as $user) {
157                     $unames[] = fullname($user, true);
158                 }
159                 $line[] = implode(', ', $unames);
160                 $line[] = count($group['members']);
161             }
162             $table->data[] = $line;
163         }
165         $preview .= html_writer::table($table);
167     } else {
168         $grouping = null;
169         $createdgrouping = null;
170         $createdgroups = array();
171         $failed = false;
173         // prepare grouping
174         if (!empty($data->grouping)) {
175             $groupingname = trim($data->groupingname);
176             if ($data->grouping < 0) {
177                 $grouping = new object();
178                 $grouping->courseid = $COURSE->id;
179                 $grouping->name     = $groupingname;
180                 $grouping->id = groups_create_grouping($grouping);
181                 $createdgrouping = $grouping->id;
182             } else {
183                 $grouping = groups_get_grouping($data->grouping);
184             }
185         }
187         // Save the groups data
188         foreach ($groups as $key=>$group) {
189             if (groups_get_group_by_name($courseid, $group['name'])) {
190                 $error = get_string('groupnameexists', 'group', $group['name']);
191                 $failed = true;
192                 break;
193             }
194             $newgroup = new object();
195             $newgroup->courseid = $data->courseid;
196             $newgroup->name     = $group['name'];
197             $groupid = groups_create_group($newgroup);
198             $createdgroups[] = $groupid;
199             foreach($group['members'] as $user) {
200                 groups_add_member($groupid, $user->id);
201             }
202             if ($grouping) {
203                 groups_assign_grouping($grouping->id, $groupid);
204             }
205         }
207         if ($failed) {
208             foreach ($createdgroups as $groupid) {
209                 groups_delete_group($groupid);
210             }
211             if ($createdgrouping) {
212                 groups_delete_grouping($createdgrouping);
213             }
214         } else {
215             redirect($returnurl);
216         }
217     }
220 $PAGE->navbar->add($strparticipants, new moodle_url('/user/index.php', array('id'=>$courseid)));
221 $PAGE->navbar->add($strgroups, new moodle_url('/group/index.php', array('id'=>$courseid)));
222 $PAGE->navbar->add($strautocreategroups);
224 /// Print header
225 $PAGE->set_title($strgroups);
226 $PAGE->set_heading($course->fullname. ': '.$strgroups);
227 echo $OUTPUT->header();
228 echo $OUTPUT->heading($strautocreategroups);
230 if ($error != '') {
231     echo $OUTPUT->notification($error);
234 /// Display the form
235 $editform->display();
237 if($preview !== '') {
238     echo $OUTPUT->heading(get_string('groupspreview', 'group'));
240     echo $preview;
243 echo $OUTPUT->footer();