MDL-9062 Created two new files so the unfinished conversion doesn't affect any current code. Also added a convenience groups_update_group($data) method. Patience, this is taking a while but I'm learning to use these mforms for the first time :-)

2025-01-18 05:58:34 +01:00 · 2007-03-28 08:40:32 +00:00 · 2007-03-28 08:40:32 +00:00 · 77e90955b5
commit 77e90955b5
parent f5fd4347dd
3 changed files with 419 additions and 1 deletions
--- a/group/edit.php
+++ b/group/edit.php
@ -0,0 +1,267 @@
+<?php
+/**
+ * Create group OR edit group settings.
+ *
+ * @copyright &copy; 2006 The Open University
+ * @author N.D.Freear AT open.ac.uk
+ * @author J.White AT open.ac.uk 
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package groups
+ */
+/// include libraries
+require_once('../config.php');
+require_once($CFG->libdir.'/moodlelib.php');
+require_once($CFG->libdir.'/uploadlib.php');
+require_once('lib.php');
+require_once('edit_form.php');
+
+/// get url variables
+$id         = required_param('id', PARAM_INT);         
+$groupingid = optional_param('grouping', false, PARAM_INT);
+$newgrouping= optional_param('newgrouping', false, PARAM_INT);
+$groupid    = optional_param('group', false, PARAM_INT);
+
+$delete = optional_param('delete', false, PARAM_BOOL);
+
+/// Course must be valid 
+if (!$course = get_record('course', 'id', $id)) {
+    error('Course ID was incorrect');
+}
+
+/// Delete action should not be called without a group id
+if ($delete && !$groupid) {
+    error(get_string('errorinvalidgroup'));
+}
+
+/// basic access control checks
+if ($groupid) {
+    if (!$group = get_record('groups', 'id', $groupid)) {
+        error('Group ID was incorrect');
+    } 
+    require_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE), $course->id);
+}
+
+/// First create the form
+$editform = new group_edit_form('group.php', compact('group'));
+
+/// Override defaults if group is set
+if (!empty($group)) {
+    $editform->set_data($group);
+}
+
+if ($editform->is_cancelled()) {
+    redirect(groups_home_url($courseid, $groupid, $groupingid, false));
+} elseif ($data = $editform->get_data()) {
+    $success = true;
+
+    // preprocess data
+    if ($delete) {
+        if ($success = groups_delete_group($groupid)) {
+            redirect(groups_home_url($course->id, null, $groupingid, false));
+        } else {
+            print_error('erroreditgroup', 'group', groups_home_url($course->id));
+        }
+    } elseif (empty($group)) { // New group
+        if (!$group = groups_create_group($course->id)) {
+            print_error('erroreditgroup');
+        } else {
+            $success = (bool)$groupid = groups_create_group($course->id);
+        }
+    } elseif ($groupingid != $newgrouping) { // Moving group to new grouping
+        if ($groupingid != GROUP_NOT_IN_GROUPING) {
+            $success = $success && groups_remove_group_from_grouping($groupid, $groupingid);
+        } 
+    } else { // Updating group
+        if (!groups_update_group($data, $course->id)) {
+            print_error('groupnotupdated');
+        }
+    }
+    
+    // Handle file upload
+    if ($success) {
+        $um = new upload_manager('imagefile',false,false,$course=null,false,$modbytes=0,$silent=false,$allownull=true);
+        if ($um->preprocess_files()) {
+            require_once("$CFG->libdir/gdlib.php");
+
+            if (save_profile_image($groupid, $um, 'groups')) {
+                $groupsettings->picture = 1;
+            }
+        } else {
+            $success = false;
+        }
+    }
+    $success = $success && groups_set_group_settings($groupid, $groupsettings);
+
+    if ($success) {
+        redirect(groups_home_url($course->id, $groupid, $groupingid, false));
+    } else {
+        print_error('erroreditgroup', 'group', groups_home_url($course->id));
+    }
+} else { // Prepare and output form
+    $strgroups = get_string('groups');
+    
+    if ($groupid) {
+        $strheading = get_string('editgroupsettings', 'group');
+    } else {
+        $strheading = get_string('creategroup', 'group');
+    }
+    
+    print_header("$course->shortname: ". $strheading,
+                 $course->fullname, 
+                 "<a href=\"$CFG->wwwroot/course/view.php?id=$courseid\">$course->shortname</a> ".
+                 "-> <a href=\"$CFG->wwwroot/user/index.php?id=$courseid\">$strparticipants</a> ".
+                 "-> $strgroups", '', '', true, '', user_login_string($course, $USER));
+    $editform->display();
+    print_footer($course);
+}
+
+/// OR, prepare the form.
+
+if ($groupid) {
+    // Form to edit existing group.
+    $group = groups_get_group_settings($groupid);
+    if (! $group) {
+        print_error('errorinvalidgroup', 'group', groups_home_url($courseid));
+    }
+    $strname = s($group->name);
+    $strdesc = s($group->description);
+
+    $strbutton  = get_string('save', 'group'); 
+    $strheading = get_string('editgroupsettings', 'group');
+} else {
+    // Form to create a new one.
+    $strname = get_string('defaultgroupname', 'group');
+    $strdesc = '';
+    $strbutton = $strheading = get_string('creategroup', 'group');
+}
+$strgroups = get_string('groups');
+$strparticipants = get_string('participants');
+if ($delete) {
+    $strheading = get_string('deleteselectedgroup', 'group');
+} //else { $strheader = get_string('groupinfoedit'); }
+
+$maxbytes = get_max_upload_file_size($CFG->maxbytes, $course->maxbytes);
+if (!empty($CFG->gdversion) and $maxbytes) {
+    $printuploadpicture = true;
+} else {
+    $printuploadpicture = false;
+}
+
+/// Print the page and form
+
+print_header("$course->shortname: ". $strheading,
+             $course->fullname, 
+             "<a href=\"$CFG->wwwroot/course/view.php?id=$courseid\">$course->shortname</a> ".
+             "-> <a href=\"$CFG->wwwroot/user/index.php?id=$courseid\">$strparticipants</a> ".
+             "-> $strgroups", '', '', true, '', user_login_string($course, $USER));
+
+$usehtmleditor = false;
+
+echo '<h3 class="main">' . $strheading . '</h3>'."\n";
+
+echo '<form action="group.php" method="post" enctype="multipart/form-data" class="mform notmform" id="groupform">'."\n";
+echo '<div>'."\n";
+echo '<input type="hidden" name="sesskey" value="' . s(sesskey()) . '" />'."\n";
+echo '<input type="hidden" name="courseid" value="' . s($courseid) . '" />'."\n";
+echo '<input type="hidden" name="grouping" value="' . s($groupingid) . '" />'."\n";
+
+if ($groupid) {
+    echo '<input type="hidden" name="group" value="'. $groupid .'" />'."\n";
+}
+
+if ($delete) {
+    /*echo 'Are you sure you want to delete group X ?';
+    choose_from_menu_yesno('confirmdelete', false, '', true);*/
+
+    echo '<p>' . get_string('deletegroupconfirm', 'group', $strname) . '</p>'."\n";
+    echo '<input type="hidden" name="delete" value="1" />'."\n";
+    echo '<input type="submit" name="confirmdelete" value="' . get_string('yes') . '" />'."\n";
+    echo '<input type="submit" name="cancel" value="' . get_string('no') . '" />'."\n";
+} else {
+    echo '<div class="fitem">'."\n";
+    echo '<p><label for="groupname">' . get_string('groupname', 'group');
+    
+    if (isset($err['name'])) {
+        echo ' ';
+        formerr($err['name']);
+    } 
+    
+    echo '&nbsp; </label></p>'."\n";
+    echo '<p class="felement"><input id="groupname" name="name" type="text" size="40" value="' . $strname . '" /></p>'."\n";
+    echo '</div>'."\n";
+
+    echo '<p><label for="edit-description">' . get_string('groupdescription', 'group') . '&nbsp;</label></p>'."\n";
+    echo '<p>' . print_textarea($usehtmleditor, 5, 45, 200, 400, 'description', $strdesc, 0, true) . '</p>'."\n";
+
+    echo '<p><label for="enrolmentkey">' . get_string('enrolmentkey', 'group') . '&nbsp;</label></p>'."\n";
+    echo '<p><input id="enrolmentkey" name="enrolmentkey" type="text" size="25" /></p>'."\n";
+
+    if ($printuploadpicture) {
+        echo '<p><label for="menuhidepicture">' . get_string('hidepicture', 'group') . '&nbsp;</label></p>'."\n";
+        echo '<p>';
+        $options = array();
+        $options[0] = get_string('no');
+        $options[1] = get_string('yes');
+        choose_from_menu($options, 'hidepicture', isset($group)? $group->hidepicture: 1, '');
+        echo '</p>'."\n";
+
+        echo '<p><label >' . get_string('newpicture', 'group');
+        helpbutton('picture', get_string('helppicture'));
+        echo get_string('maxsize', '', display_size($maxbytes), 'group');
+
+        if (isset($err['imagefile'])) {
+            formerr($err['imagefile']);
+        }
+
+        echo '&nbsp;</label></p>'."\n";
+        echo '<p>' . upload_print_form_fragment(1, array('imagefile'), null,false,null,0,0,true) . '</p>'."\n";
+    }
+
+    if ($groupid) { //OK, editing - option to move grouping.
+
+        echo '<p><label for="groupings">' . get_string('addgroupstogrouping', 'group'). '</label></p>'."\n";
+        echo '<select name="newgrouping" id="groupings" class="select">'."\n";
+
+        $groupingids = groups_get_groupings($courseid);
+        if (GROUP_NOT_IN_GROUPING == $groupingid) {
+            $groupingids[] = GROUP_NOT_IN_GROUPING;
+        }
+        if ($groupingids) {    
+            // Put the groupings into a hash and sort them
+            foreach($groupingids as $id) {
+                $listgroupings[$id] = groups_get_grouping_displayname($id, $courseid);
+            }
+            natcasesort($listgroupings);
+            
+            // Print out the HTML
+            $count = 1;
+            foreach($listgroupings as $id => $name) {
+                $select = '';
+                if ($groupingid == $id) {
+                    $select = ' selected="selected"';
+                }
+                echo "<option value=\"$id\"$select>$name</option>\n";
+                $count++;
+            }
+        }
+
+        echo '</select>'."\n";
+    } //IF($groupid)
+
+    echo '<p class="fitem">'."\n";
+    echo '<label for="id_submit">&nbsp;</label>'."\n";
+    echo '<span class="f--element fsubmit">'."\n";
+    echo '<input type="submit" name="update" id="id_submit" value="' . $strbutton . '" />'."\n";
+    echo '<input type="submit" name="cancel" value="' . get_string('cancel', 'group') . '" />'."\n";
+    echo '</span>'."\n";
+    echo '</p>'."\n";
+
+} //IF($delete)
+
+echo '<span class="clearer">&nbsp;</span>'."\n";
+echo '</div>';
+echo '</form>'."\n";
+
+print_footer($course);
+
+?>
--- a/group/edit_form.php
+++ b/group/edit_form.php
@ -0,0 +1,128 @@
+<?php //$Id$
+
+require_once($CFG->dirroot.'/lib/formslib.php');
+
+class group_edit_form extends moodleform {
+
+    // Define the form
+    function definition () {
+        global $USER, $CFG, $COURSE;
+
+        $strrequired = get_string('required');
+
+        $group       = $this->_customdata['group'];
+        $groupingid  = $this->_customdata['groupingid'];
+        $newgrouping = $this->_customdata['newgrouping'];
+
+        $mform =& $this->_form;
+
+        $mform->addElement('text','name', get_string('name'),'maxlength="254" size="50"');
+        $mform->setDefault('name', get_string('defaultgroupname'));
+        $mform->addRule('name', get_string('missingname'), 'required', null, 'client');
+        $mform->setType('name', PARAM_MULTILANG);
+
+        $mform->addElement('htmleditor', 'description', get_string('description'), array('rows'=> '5', 'cols'=>'45'));
+        $mform->setType('description', PARAM_RAW);
+        
+        $mform->addElement('text', 'enrolmentkey', get_string('enrolmentkey', 'group'), 'maxlength="254" size="40"', get_string('enrolmentkey'));
+        $mform->setHelpButton('enrolmentkey', array('groupenrolmentkey', get_string('enrolmentkey', 'group')), true);
+        $mform->setType('enrolmentkey', PARAM_RAW);
+        
+        $options = array(get_string('no'), get_string('yes'));
+        $mform->addElement('select', 'hidepicture', get_string('hidepicture'), $options);
+        
+        $maxbytes = get_max_upload_file_size($CFG->maxbytes, $COURSE->maxbytes);
+        if (!empty($CFG->gdversion) and $maxbytes and !empty($CFG->disableuserimages)) {
+            $mform->addElement('file', 'imagefile', get_string('newpicture', 'group')); 
+            $mform->setHelpButton('imagefile', array('picture', get_string('helppicture')), true);
+        }
+
+        /// Add some extra hidden fields
+        if ($group) {
+            $mform->addElement('hidden', 'group', $group->id);
+        }
+        
+        if ($groupingid) {
+            $mform->addElement('hidden', 'groupingid', s($groupingid)); 
+        } else {
+
+        }
+
+        $mform->addElement('hidden', 'group');
+        $mform->addElement('hidden', 'course', $COURSE->id);
+
+        $this->set_upload_manager(new upload_manager('imagefile', false, false, null, false, 0, true, true, false));
+
+        $this->add_action_buttons(false, get_string('updatemyprofile'));
+    }
+
+    function definition_after_data() {
+        global $USER, $CFG;
+
+        $mform =& $this->_form;
+        $userid = $mform->getElementValue('id');
+
+        if ($user = get_record('user', 'id', $userid)) {
+
+            // print picture
+            if (!empty($CFG->gdversion)) {
+                $image_el = $mform->getElement('currentpicture');
+                if ($user and $user->picture) {
+                    $image_el->setValue(print_user_picture($user->id, SITEID, $user->picture, 64,true,false,'',true));
+                } else {
+                    $image_el->setValue(get_string('none'));
+                }
+            }
+
+            /// disable fields that are locked by auth plugins
+            $fields = get_user_fieldnames();
+            $freezefields = array();
+            $authplugin = get_auth_plugin($user->auth);
+            foreach ($fields as $field) {
+                if (!$mform->elementExists($field)) {
+                    continue;
+                }
+                $configvariable = 'field_lock_' . $field;
+                if (isset($authplugin->config->{$configvariable})) {
+                    if ($authplugin->config->{$configvariable} === 'locked') {
+                        $freezefields[] = $field;
+                    } else if ($authplugin->config->{$configvariable} === 'unlockedifempty' and $user->$field != '') {
+                        $freezefields[] = $field;
+                    }
+                }
+            }
+            $mform->hardFreeze($freezefields);
+        }
+    }
+
+    function validation ($usernew) {
+        global $CFG;
+
+        $usernew = (object)$usernew;
+        $user    = get_record('user', 'id', $usernew->id);
+        $err     = array();
+
+        // validate email
+        if (!validate_email($usernew->email)) {
+            $err['email'] = get_string('invalidemail');
+        } else if (($usernew->email !== $user->email) and record_exists('user', 'email', $usernew->email, 'mnethostid', $CFG->mnet_localhost_id)) {
+            $err['email'] = get_string('emailexists');
+        }
+
+        if ($usernew->email === $user->email and over_bounce_threshold($user)) {
+            $err['email'] = get_string('toomanybounces');
+        }
+
+        if (count($err) == 0){
+            return true;
+        } else {
+            return $err;
+        }
+    }
+
+    function get_um() {
+        return $this->_upload_manager;
+    }
+}
+
+?>
--- a/group/lib/basicgrouplib.php
+++ b/group/lib/basicgrouplib.php
@ -417,4 +417,27 @@ function groups_remove_all_members($groupid) {
    return $success;
 }

-?>
+/* 
+ * Update a group and return true or false
+ *
+ * @param object $data  - all the data needed for an entry in the 'groups' table
+ */
+function groups_update_group($data, $courseid) {
+    global $USER, $CFG;
+
+    $oldgroup = get_record('groups', 'id', $data->id); // should not fail, already tested above
+
+    // Update with the new data
+    if (update_record('groups', $data)) {
+
+        $group = get_record('groups', 'id', $data->id);
+
+        add_to_log($group->id, "groups", "update", "edit.php?id=$courseid&amp;group=$group->id", "");
+
+        return true;
+
+    }
+
+    return false;
+}
+?>