summaryrefslogtreecommitdiffstats
path: root/lib/group/database.php
diff options
context:
space:
mode:
authorRobin Appelman <icewind@owncloud.com>2012-09-23 02:39:11 +0200
committerRobin Appelman <icewind@owncloud.com>2012-09-23 02:40:03 +0200
commit4131b205d42336157ca938b2835dd78766dc7d19 (patch)
treebaa5e0bee3f79921ee67af57245d38081301c5c1 /lib/group/database.php
parentf71f731f1cfc3a0e0efa5e13759478c5fdb7f4fc (diff)
downloadnextcloud-server-4131b205d42336157ca938b2835dd78766dc7d19.tar.gz
nextcloud-server-4131b205d42336157ca938b2835dd78766dc7d19.zip
fix some more phpdoc
Diffstat (limited to 'lib/group/database.php')
-rw-r--r--lib/group/database.php47
1 files changed, 27 insertions, 20 deletions
diff --git a/lib/group/database.php b/lib/group/database.php
index f3012563acf..6eca98ba019 100644
--- a/lib/group/database.php
+++ b/lib/group/database.php
@@ -44,10 +44,10 @@ class OC_Group_Database extends OC_Group_Backend {
/**
* @brief Try to create a new group
- * @param $gid The name of the group to create
- * @returns true/false
+ * @param string $gid The name of the group to create
+ * @return bool
*
- * Trys to create a new group. If the group name already exists, false will
+ * Tries to create a new group. If the group name already exists, false will
* be returned.
*/
public function createGroup( $gid ) {
@@ -70,28 +70,28 @@ class OC_Group_Database extends OC_Group_Backend {
/**
* @brief delete a group
- * @param $gid gid of the group to delete
- * @returns true/false
+ * @param string $gid gid of the group to delete
+ * @return bool
*
* Deletes a group and removes it from the group_user-table
*/
public function deleteGroup( $gid ) {
// Delete the group
$stmt = OC_DB::prepare( "DELETE FROM `*PREFIX*groups` WHERE `gid` = ?" );
- $result = $stmt->execute( array( $gid ));
+ $stmt->execute( array( $gid ));
// Delete the group-user relation
$stmt = OC_DB::prepare( "DELETE FROM `*PREFIX*group_user` WHERE `gid` = ?" );
- $result = $stmt->execute( array( $gid ));
+ $stmt->execute( array( $gid ));
return true;
}
/**
* @brief is user in group?
- * @param $uid uid of the user
- * @param $gid gid of the group
- * @returns true/false
+ * @param string $uid uid of the user
+ * @param string $gid gid of the group
+ * @return bool
*
* Checks whether the user is member of a group or not.
*/
@@ -105,9 +105,9 @@ class OC_Group_Database extends OC_Group_Backend {
/**
* @brief Add a user to a group
- * @param $uid Name of the user to add to group
- * @param $gid Name of the group in which add the user
- * @returns true/false
+ * @param string $uid Name of the user to add to group
+ * @param string $gid Name of the group in which add the user
+ * @return bool
*
* Adds a user to a group.
*/
@@ -124,9 +124,9 @@ class OC_Group_Database extends OC_Group_Backend {
/**
* @brief Removes a user from a group
- * @param $uid Name of the user to remove from group
- * @param $gid Name of the group from which remove the user
- * @returns true/false
+ * @param string $uid Name of the user to remove from group
+ * @param string $gid Name of the group from which remove the user
+ * @return bool
*
* removes the user from a group.
*/
@@ -139,8 +139,8 @@ class OC_Group_Database extends OC_Group_Backend {
/**
* @brief Get all groups a user belongs to
- * @param $uid Name of the user
- * @returns array with group names
+ * @param string $uid Name of the user
+ * @return array with group names
*
* This function fetches all groups a user belongs to. It does not check
* if the user exists at all.
@@ -160,7 +160,10 @@ class OC_Group_Database extends OC_Group_Backend {
/**
* @brief get a list of all groups
- * @returns array with group names
+ * @param string $search
+ * @param int $limit
+ * @param int $offset
+ * @return array with group names
*
* Returns a list with all groups
*/
@@ -190,7 +193,11 @@ class OC_Group_Database extends OC_Group_Backend {
/**
* @brief get a list of all users in a group
- * @returns array with user ids
+ * @param string $gid
+ * @param string $search
+ * @param int $limit
+ * @param int $offset
+ * @return array with user ids
*/
public function usersInGroup($gid, $search = '', $limit = null, $offset = null) {
$stmt = OC_DB::prepare('SELECT `uid` FROM `*PREFIX*group_user` WHERE `gid` = ? AND `uid` LIKE ?', $limit, $offset);