diff options
Diffstat (limited to 'lib/private/group/example.php')
| -rw-r--r-- | lib/private/group/example.php | 64 |
1 files changed, 34 insertions, 30 deletions
diff --git a/lib/private/group/example.php b/lib/private/group/example.php index 3519b9ed92f..8c1e22866f2 100644 --- a/lib/private/group/example.php +++ b/lib/private/group/example.php @@ -27,58 +27,58 @@ */ abstract class OC_Group_Example { /** - * @brief Try to create a new group - * @param $gid The name of the group to create - * @returns true/false + * Try to create a new group + * @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 + * delete a group + * @param string $gid gid of the group to delete + * @return bool * * Deletes a group and removes it from the group_user-table */ abstract public static function deleteGroup($gid); /** - * @brief is user in group? - * @param $uid uid of the user - * @param $gid gid of the group - * @returns true/false + * is user in group? + * @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. */ abstract public static function inGroup($uid, $gid); /** - * @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 + * Add a user to a group + * @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. */ abstract public static function addToGroup($uid, $gid); /** - * @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 + * Removes a user from a group + * @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. */ abstract public static function removeFromGroup($uid, $gid); /** - * @brief Get all groups a user belongs to - * @param $uid Name of the user - * @returns array with group names + * Get all groups a user belongs to + * @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. @@ -86,24 +86,28 @@ abstract class OC_Group_Example { abstract public static function getUserGroups($uid); /** - * @brief get a list of all groups - * @returns array with group names - * - * Returns a list with all groups + * get a list of 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 + * Check if a group exists * @param string $gid * @return bool */ abstract public function groupExists($gid); /** - * @brief get a list of all users in a group - * @returns array with user ids + * get a list of all users in a group + * @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); - } |