diff options
Diffstat (limited to 'lib/private/group/example.php')
| -rw-r--r-- | lib/private/group/example.php | 48 |
1 files changed, 26 insertions, 22 deletions
diff --git a/lib/private/group/example.php b/lib/private/group/example.php index 3519b9ed92f..76c9ce2433d 100644 --- a/lib/private/group/example.php +++ b/lib/private/group/example.php @@ -28,18 +28,18 @@ abstract class OC_Group_Example { /** * @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. */ abstract public static function createGroup($gid); /** * @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 */ @@ -47,9 +47,9 @@ abstract class OC_Group_Example { /** * @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. */ @@ -57,9 +57,9 @@ abstract class OC_Group_Example { /** * @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. */ @@ -67,9 +67,9 @@ abstract class OC_Group_Example { /** * @brief Removes a user from a group - * @param $uid NameUSER 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. */ @@ -77,8 +77,8 @@ abstract class OC_Group_Example { /** * @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 an array of group names * * This function fetches all groups a user belongs to. It does not check * if the user exists at all. @@ -87,14 +87,15 @@ abstract class OC_Group_Example { /** * @brief get a list of all groups - * @returns array with group names - * - * Returns a list with all groups + * @param string $search + * @param int $limit + * @param int $offset + * @return array an array of group names */ abstract public static function getGroups($search = '', $limit = -1, $offset = 0); /** - * check if a group exists + * @brief Check if a group exists * @param string $gid * @return bool */ @@ -102,8 +103,11 @@ abstract class OC_Group_Example { /** * @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 an array of user ids */ abstract public static function usersInGroup($gid, $search = '', $limit = -1, $offset = 0); - } |