MDL-10383 - groups/groupings refactoring and improvements - basic UI for groupings...
[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/lib/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 'showgroupsettingsform':
72             redirect('group.php?courseid='.$courseid.'&amp;id='.$groupid);
73             break;
75         case 'updategroups': //Currently reloading.
76             break;
78         case 'removemembers':
79             break;
81         case 'showaddmembersform':
82             redirect('members.php?group='.$groupid);
83             break;
85         case 'updatemembers': //Currently reloading.
86             break;
88         default: //ERROR.
89             if (debugging()) {
90                 error('Error, unknown button/action. Probably a user-interface bug!', $returnurl);
91             break;
92         }
93     }
95     // Print the page and form
96     $strgroups = get_string('groups');
97     $strparticipants = get_string('participants');
99     print_header("$course->shortname: $strgroups",
100                  $course->fullname,
101                  "<a href=\"$CFG->wwwroot/course/view.php?id=$courseid\">$course->shortname</a> ".
102                  "-> <a href=\"$CFG->wwwroot/user/index.php?id=$courseid\">$strparticipants</a> ".
103                  "-> $strgroups", '', '', true, '', user_login_string($course, $USER));
105     $disabled = 'disabled="disabled"';
107     $showeditgroupsettingsform_disabled = $disabled;
108     $deletegroup_disabled = $disabled;
109     $showcreategroupform_disabled = $disabled;
111     if (!empty($groupid)) {
112         $showaddmembersform_disabled = '';
113         $showeditgroupsettingsform_disabled = '';
114         $deletegroup_disabled = '';
115     } else {
116         $deletegroup_disabled = $disabled;
117         $showeditgroupsettingsform_disabled = $disabled;
118         $showaddmembersform_disabled = $disabled;
119     }
121     print_heading(format_string($course->shortname) .' '.$strgroups, 'center', 3);
122     echo '<form id="groupeditform" action="index.php" method="post">'."\n";
123     echo '<div>'."\n";
124     echo '<input type="hidden" name="id" value="' . $courseid . '" />'."\n";
126     echo '<table cellpadding="6" class="generaltable generalbox groupmanagementtable boxaligncenter" summary="">'."\n";
127     echo '<tr>'."\n";
130     echo "<td>\n";
131     // NO GROUPINGS YET!
132     echo '<p><label for="groups"><span id="groupslabel">'.get_string('groups').':</span><span id="thegrouping">&nbsp;</span></label></p>'."\n";
134     echo '<select name="group" id="groups" size="15" class="select" onchange="membersCombo.refreshMembers(this.options[this.selectedIndex].value);"'."\n";
135     echo ' onclick="window.status=this.options[this.selectedIndex].title;" onmouseout="window.status=\'\';">'."\n";
137     if ($groups = groups_get_all_groups($courseid)) {
138         $groupids = array_keys($groups);
139     } else {
140         $groupids = false;
141     }
143     $sel_groupid = 0;
145     if ($groupids) {
146         // Put the groups into a hash and sort them
147         $group_names = groups_groupids_to_group_names($groupids);
149         // Print out the HTML
150         $count = 1;
151         foreach ($group_names as $group) {
152             $select = '';
153             if ($groupid == $group->id) { //|| $count <= 1) ??
154                 $select = ' selected="selected"';
155                 $sel_groupid = $group->id;
156             }
157             echo "<option value=\"{$group->id}\"$select title=\"{$group->name}\">{$group->name}</option>\n";
158             $count++;
159         }
160     } else {
161         // Print an empty option to avoid the XHTML error of having an empty select element
162         echo '<option>&nbsp;</option>';
163     }
165     echo '</select>'."\n";
166     echo '<p><input type="submit" name="act_updatemembers" id="updatemembers" value="'
167             . get_string('showmembersforgroup', 'group') . '" /></p>'."\n";
168     echo '<p><input type="submit" '. $showeditgroupsettingsform_disabled . ' name="act_showgroupsettingsform" id="showeditgroupsettingsform" value="'
169             . get_string('editgroupsettings', 'group') . '" /></p>'."\n";
170     echo '<p><input type="submit" '. $deletegroup_disabled . ' name="act_deletegroup" onclick="onDeleteGroup()" id="deletegroup" value="'
171             . get_string('deleteselectedgroup', 'group') . '" /></p>'."\n";
173     echo '<p><input type="submit" name="act_showcreateorphangroupform" id="showcreateorphangroupform" value="'
174             . get_string('creategroup', 'group') . '" /></p>'."\n";
176     echo '</td>'."\n";
177     echo '<td>'."\n";
178     echo '<p><label for="members"><span id="memberslabel">'.get_string('membersofselectedgroup', 'group').' </span><span id="thegroup">&nbsp;</span></label></p>'."\n";
179     //NOTE: the SELECT was, multiple="multiple" name="user[]" - not used and breaks onclick.
180     echo '<select name="user" id="members" size="15" class="select"'."\n";
181     echo ' onclick="window.status=this.options[this.selectedIndex].title;" onmouseout="window.status=\'\';">'."\n";
183     $member_names = array();
185     if ($sel_groupid) {
186         if ($members = groups_get_members($groupid)) {
187             foreach($members as $member) {
188                 $member_names[$member->id] = fullname($member, true);
189             }
190         }
191     }
193     if ($member_names) {
194         // Put the groupings into a hash and sort them
195         foreach ($member_names as $userid=>$username) {
196             echo "<option value=\"{$userid}\" title=\"{$username}\">{$username}</option>\n";
197         }
199     } else {
200         // Print an empty option to avoid the XHTML error of having an empty select element
201         echo '<option>&nbsp;</option>';
202     }
204     echo '</select>'."\n";
206     echo '<p><input type="submit" ' . $showaddmembersform_disabled . ' name="act_showaddmembersform" '
207             . 'id="showaddmembersform" value="' . get_string('adduserstogroup', 'group'). '" /></p>'."\n";
208     echo '</td>'."\n";
209     echo '</tr>'."\n";
210     echo '</table>'."\n";
212     //<input type="hidden" name="rand" value="om" />
213     echo '</div>'."\n";
214     echo '</form>'."\n";
216     echo '<script type="text/javascript">'."\n";
217     echo '//<![CDATA['."\n";
218     echo 'var groupsCombo = new UpdatableGroupsCombo("'.$CFG->wwwroot.'", '.$course->id.');'."\n";
219     echo 'var membersCombo = new UpdatableMembersCombo("'.$CFG->wwwroot.'", '.$course->id.');'."\n";
220     echo '//]]>'."\n";
221     echo '</script>'."\n";
223     print_footer($course);
225 /**
226  * Returns the first button action with the given prefix, taken from
227  * POST or GET, otherwise returns false.
228  * See /lib/moodlelib.php function optional_param.
229  * @param $prefix 'act_' as in 'action'.
230  * @return string The action without the prefix, or false if no action found.
231  */
232 function groups_param_action($prefix = 'act_') {
233     $action = false;
234 //($_SERVER['QUERY_STRING'] && preg_match("/$prefix(.+?)=(.+)/", $_SERVER['QUERY_STRING'], $matches)) { //b_(.*?)[&;]{0,1}/
236     if ($_POST) {
237         $form_vars = $_POST;
238     }
239     elseif ($_GET) {
240         $form_vars = $_GET;
241     }
242     if ($form_vars) {
243         foreach ($form_vars as $key => $value) {
244             if (preg_match("/$prefix(.+)/", $key, $matches)) {
245                 $action = $matches[1];
246                 break;
247             }
248         }
249     }
250     if ($action && !preg_match('/^\w+$/', $action)) {
251         $action = false;
252         error('Action had wrong type.');
253     }
254     ///if (debugging()) echo 'Debug: '.$action;
255     return $action;
258 ?>