MDL-11419 - groups: interface enhancements + new features:
[moodle.git] / group / index.php
1 <?php
2 /**
3  * The main group management user interface.
4  *
5  * @copyright &copy; 2006 The Open University
6  * @author N.D.Freear AT open.ac.uk
7  * @author J.White AT open.ac.uk
8  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
9  * @package groups
10  */
11 require_once('../config.php');
12 require_once('lib.php');
13 require_once($CFG->libdir.'/json/JSON.php');
15 require_js('yui_yahoo');
16 require_js('yui_dom');
17 require_js('yui_utilities');
18 require_js('yui_connection');
19 require_js($CFG->wwwroot.'/group/clientlib.js');
21 $courseid = required_param('id', PARAM_INT);
22 $groupid  = optional_param('group', false, PARAM_INT);
23 $userid   = optional_param('user', false, PARAM_INT);
24 $action   = groups_param_action();
26 $returnurl = $CFG->wwwroot.'/group/index.php?id='.$courseid;
28 // Get the course information so we can print the header and
29 // check the course id is valid
31 if (!$course = get_record('course', 'id',$courseid)) {
32     $success = false;
33     print_error('invalidcourse'); //'The course ID is invalid'
34 }
36 // Make sure that the user has permissions to manage groups.
37 require_login($course);
39 $context = get_context_instance(CONTEXT_COURSE, $courseid);
40 if (! has_capability('moodle/course:managegroups', $context)) {
41     redirect(); //"group.php?id=$course->id");   // Not allowed to see all groups
42 }
44 switch ($action) {
45     case false: //OK, display form.
46         break;
48     case 'ajax_getmembersingroup':
49         $members = array();
50         if ($members = groups_get_members($groupid)) {
51             $member_names = array();
52             foreach($members as $member) {
53                 $user = new object();
54                 $user->id   = $member->id;
55                 $user->name = fullname($member, true);
56                 $member_names[] = $user;
57             }
58             $json = new Services_JSON();
59             echo $json->encode($member_names);
60         }
61         die;  // Client side JavaScript takes it from here.
63     case 'deletegroup':
64         redirect('group.php?delete=1&amp;courseid='.$courseid.'&amp;id='.$groupid);
65         break;
67     case 'showcreateorphangroupform':
68         redirect('group.php?courseid='.$courseid);
69         break;
71     case 'showautocreategroupsform':
72         redirect('autogroup.php?courseid='.$courseid);
73         break;        
75     case 'showgroupsettingsform':
76         redirect('group.php?courseid='.$courseid.'&amp;id='.$groupid);
77         break;
79     case 'updategroups': //Currently reloading.
80         break;
82     case 'removemembers':
83         break;
85     case 'showaddmembersform':
86         redirect('members.php?group='.$groupid);
87         break;
89     case 'updatemembers': //Currently reloading.
90         break;
92     default: //ERROR.
93         if (debugging()) {
94             error('Error, unknown button/action. Probably a user-interface bug!', $returnurl);
95         break;
96     }
97 }
99 // Print the page and form
100 $strgroups = get_string('groups');
101 $strparticipants = get_string('participants');
103 $navlinks = array(array('name'=>$strparticipants, 'link'=>$CFG->wwwroot.'/user/index.php?id='.$courseid, 'type'=>'misc'),
104                   array('name'=>$strgroups, 'link'=>'', 'type'=>'misc'));
105 $navigation = build_navigation($navlinks);
107 /// Print header
108 print_header_simple($strgroups, ': '.$strgroups, $navigation, '', '', true, '', navmenu($course));
110 if (!empty($CFG->enablegroupings)) {
111     // Add tabs
112     $currenttab = 'groups';
113     require('tabs.php');
116 $disabled = 'disabled="disabled"';
118 $showeditgroupsettingsform_disabled = $disabled;
119 $deletegroup_disabled = $disabled;
120 $showcreategroupform_disabled = $disabled;
122 if (!empty($groupid)) {
123     $showaddmembersform_disabled = '';
124     $showeditgroupsettingsform_disabled = '';
125     $deletegroup_disabled = '';
126 } else {
127     $deletegroup_disabled = $disabled;
128     $showeditgroupsettingsform_disabled = $disabled;
129     $showaddmembersform_disabled = $disabled;
132 print_heading(format_string($course->shortname) .' '.$strgroups, 'center', 3);
133 echo '<form id="groupeditform" action="index.php" method="post">'."\n";
134 echo '<div>'."\n";
135 echo '<input type="hidden" name="id" value="' . $courseid . '" />'."\n";
137 echo '<table cellpadding="6" class="generaltable generalbox groupmanagementtable boxaligncenter" summary="">'."\n";
138 echo '<tr>'."\n";
141 echo "<td>\n";
142 // NO GROUPINGS YET!
143 echo '<p><label for="groups"><span id="groupslabel">'.get_string('groups').':</span><span id="thegrouping">&nbsp;</span></label></p>'."\n";
145 if (ajaxenabled()) {
146     $onchange = 'membersCombo.refreshMembers(this.options[this.selectedIndex].value);';
147 } else {
148     $onchange = ''; 
152 echo '<select name="group" id="groups" size="15" class="select" onchange="'.$onchange.'"'."\n";
153 echo ' onclick="window.status=this.options[this.selectedIndex].title;" onmouseout="window.status=\'\';">'."\n";
155 $groups = groups_get_all_groups($courseid);
157 $sel_groupid = 0;
159 if ($groups) {
160     // Print out the HTML
161     foreach ($groups as $group) {
162         $select = '';
163         if ($groupid == $group->id) {
164             $select = ' selected="selected"';
165             $sel_groupid = $group->id;
166         }
167         $usercount = (int)count_records('groups_members', 'groupid', $group->id);
168         $groupname = format_string($group->name).' ('.$usercount.')';
170         echo "<option value=\"{$group->id}\"$select title=\"$groupname\">$groupname</option>\n";
171     }
172 } else {
173     // Print an empty option to avoid the XHTML error of having an empty select element
174     echo '<option>&nbsp;</option>';
177 echo '</select>'."\n";
178 echo '<p><input type="submit" name="act_updatemembers" id="updatemembers" value="'
179         . get_string('showmembersforgroup', 'group') . '" /></p>'."\n";
180 echo '<p><input type="submit" '. $showeditgroupsettingsform_disabled . ' name="act_showgroupsettingsform" id="showeditgroupsettingsform" value="'
181         . get_string('editgroupsettings', 'group') . '" /></p>'."\n";
182 echo '<p><input type="submit" '. $deletegroup_disabled . ' name="act_deletegroup" onclick="onDeleteGroup()" id="deletegroup" value="'
183         . get_string('deleteselectedgroup', 'group') . '" /></p>'."\n";
185 echo '<p><input type="submit" name="act_showcreateorphangroupform" id="showcreateorphangroupform" value="'
186         . get_string('creategroup', 'group') . '" /></p>'."\n";
187         
188 echo '<p><input type="submit" name="act_showautocreategroupsform" id="showautocreategroupsform" value="'
189         . get_string('autocreategroups', 'group') . '" /></p>'."\n";
191 echo '</td>'."\n";
192 echo '<td>'."\n";
193 echo '<p><label for="members"><span id="memberslabel">'.get_string('membersofselectedgroup', 'group').' </span><span id="thegroup">&nbsp;</span></label></p>'."\n";
194 //NOTE: the SELECT was, multiple="multiple" name="user[]" - not used and breaks onclick.
195 echo '<select name="user" id="members" size="15" class="select"'."\n";
196 echo ' onclick="window.status=this.options[this.selectedIndex].title;" onmouseout="window.status=\'\';">'."\n";
198 $member_names = array();
200 if ($sel_groupid) {
201     if ($members = groups_get_members($groupid)) {
202         foreach($members as $member) {
203             $member_names[$member->id] = fullname($member, true);
204         }
205     }
208 if ($member_names) {
209     // Put the groupings into a hash and sort them
210     foreach ($member_names as $userid=>$username) {
211         echo "<option value=\"{$userid}\" title=\"{$username}\">{$username}</option>\n";
212     }
214 } else {
215     // Print an empty option to avoid the XHTML error of having an empty select element
216     echo '<option>&nbsp;</option>';
219 echo '</select>'."\n";
221 echo '<p><input type="submit" ' . $showaddmembersform_disabled . ' name="act_showaddmembersform" '
222         . 'id="showaddmembersform" value="' . get_string('adduserstogroup', 'group'). '" /></p>'."\n";
223 echo '</td>'."\n";
224 echo '</tr>'."\n";
225 echo '</table>'."\n";
227 //<input type="hidden" name="rand" value="om" />
228 echo '</div>'."\n";
229 echo '</form>'."\n";
231 if (ajaxenabled()) {
232     echo '<script type="text/javascript">'."\n";
233     echo '//<![CDATA['."\n";
234     echo 'var groupsCombo = new UpdatableGroupsCombo("'.$CFG->wwwroot.'", '.$course->id.');'."\n";
235     echo 'var membersCombo = new UpdatableMembersCombo("'.$CFG->wwwroot.'", '.$course->id.');'."\n";
236     echo '//]]>'."\n";
237     echo '</script>'."\n";
240 print_footer($course);
242 /**
243  * Returns the first button action with the given prefix, taken from
244  * POST or GET, otherwise returns false.
245  * See /lib/moodlelib.php function optional_param.
246  * @param $prefix 'act_' as in 'action'.
247  * @return string The action without the prefix, or false if no action found.
248  */
249 function groups_param_action($prefix = 'act_') {
250     $action = false;
251 //($_SERVER['QUERY_STRING'] && preg_match("/$prefix(.+?)=(.+)/", $_SERVER['QUERY_STRING'], $matches)) { //b_(.*?)[&;]{0,1}/
253     if ($_POST) {
254         $form_vars = $_POST;
255     }
256     elseif ($_GET) {
257         $form_vars = $_GET;
258     }
259     if ($form_vars) {
260         foreach ($form_vars as $key => $value) {
261             if (preg_match("/$prefix(.+)/", $key, $matches)) {
262                 $action = $matches[1];
263                 break;
264             }
265         }
266     }
267     if ($action && !preg_match('/^\w+$/', $action)) {
268         $action = false;
269         error('Action had wrong type.');
270     }
271     ///if (debugging()) echo 'Debug: '.$action;
272     return $action;
275 ?>