From: nfreear <nfreear>
Date: Tue, 7 Nov 2006 17:15:27 +0000 (+0000)
Subject: Interface fix in groups_add_member, remove_member - basicgrouplib.php, dbXX.php,... 
X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=9459e87ff1865f1660ce2c74edb92b3eba9e599b;p=moodle.git

Interface fix in groups_add_member, remove_member - basicgrouplib.php, dbXX.php, test_XX.php (Bug MDL-7380 "groups".)
---

diff --git a/group/db/dbbasicgrouplib.php b/group/db/dbbasicgrouplib.php
index 2d9be3eebf..cf1348f701 100644
--- a/group/db/dbbasicgrouplib.php
+++ b/group/db/dbbasicgrouplib.php
@@ -276,7 +276,7 @@ function groups_db_create_group($courseid, $groupsettings = false) {
  * @param int $userid   The user id
  * @return boolean True if user added successfully, false otherwise. 
  */
-function groups_db_add_member($userid, $groupid) {
+function groups_db_add_member($groupid, $userid) {
 	// Check that the user and group are valid
     if (!$userid or !$groupid or !groups_db_group_exists($groupid)) {
         $useradded = false;
@@ -328,11 +328,11 @@ function groups_db_set_group_settings($groupid, $groupsettings) {
 
 /**
  * Deletes the specified user from the specified group
- * @param int $userid The user to delete
  * @param int $groupid The group to delete the user from
+ * @param int $userid The user to delete
  * @return boolean True if deletion was successful, false otherwise
  */
-function groups_db_remove_member($userid, $groupid) {
+function groups_db_remove_member($groupid, $userid) {
     if (!$userid or !$groupid) {
         $success = false;
     } else {
diff --git a/group/lib/basicgrouplib.php b/group/lib/basicgrouplib.php
index af826528ec..02e005c25f 100644
--- a/group/lib/basicgrouplib.php
+++ b/group/lib/basicgrouplib.php
@@ -1,4 +1,4 @@
-<?PHP  
+<?php
 /**
  * Library of basic group functions.
  *
@@ -260,13 +260,13 @@ function groups_set_group_settings($groupid, $groupsettings) {
 
 /**
  * Adds a specified user to a group
- * @param int $groupid  The group id
  * @param int $userid   The user id
+ * @param int $groupid  The group id
  * @return boolean True if user added successfully or the user is already a 
  * member of the group, false otherwise. 
  * See comment above on web service autoupdating. 
  */
-function groups_add_member($userid, $groupid) {
+function groups_add_member($groupid, $userid) {
 	$useradded = false;
     
     $alreadymember = groups_is_member($groupid, $userid);
@@ -275,7 +275,7 @@ function groups_add_member($userid, $groupid) {
     } elseif ($alreadymember) {
     	$useradded = true;
     } else {
-		$useradded = groups_db_add_member($userid, $groupid);
+		$useradded = groups_db_add_member($groupid, $userid);
     }
 
 	return $useradded;
@@ -302,13 +302,13 @@ function groups_delete_group($groupid) {
 
 /**
  * Deletes the specified user from the specified group
- * @param int $userid The user to delete
  * @param int $groupid The group to delete the user from
+ * @param int $userid The user to delete
  * @return boolean True if deletion was successful, false otherwise
  * See comment above on web service autoupdating. 
  */
-function groups_remove_member($userid, $groupid) {
-	return  groups_db_remove_member($userid, $groupid);
+function groups_remove_member($groupid, $userid) {
+	return  groups_db_remove_member($groupid, $userid);
 }
 
 ?>
\ No newline at end of file
diff --git a/group/simpletest/test_basicgrouplib.php b/group/simpletest/test_basicgrouplib.php
index 1bda9d7935..08e5650b4b 100644
--- a/group/simpletest/test_basicgrouplib.php
+++ b/group/simpletest/test_basicgrouplib.php
@@ -56,7 +56,8 @@ class basicgrouplib_test extends UnitTestCase {
     }
 
     function test_add_member() {
-        $this->assertTrue(groups_add_member($this->userid, $this->groupid));
+        // NOTE, interface change on add_member, remove_member. 
+        $this->assertTrue(groups_add_member($this->groupid, $this->userid));
         $this->assertTrue(groups_is_member($this->groupid, $this->userid));
         $this->assertTrue($userids = groups_get_members($this->groupid));
         //...
@@ -66,7 +67,7 @@ class basicgrouplib_test extends UnitTestCase {
     }
 
     function test_remove_member() {
-        $this->assertTrue(groups_remove_member($this->userid, $this->groupid));
+        $this->assertTrue(groups_remove_member($this->groupid, $this->userid));
         $this->assertFalse(groups_is_member($this->groupid, $this->userid));
     }