Blame view
sources/lib/private/group/example.php
3.08 KB
03e52840d
Init
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
<?php
/**
* ownCloud
*
* @author Frank Karlitschek
* @copyright 2012 Frank Karlitschek frank@owncloud.org
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
*
* You should have received a copy of the GNU Affero General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
/**
* abstract reference class for group management
* this class should only be used as a reference for method signatures and their descriptions
*/
abstract class OC_Group_Example {
/**
|
6d9380f96
Update sources OC...
|
30 31 32 |
* Try to create a new group * @param string $gid The name of the group to create * @return bool |
|
03e52840d
Init
|
33 |
* |
|
6d9380f96
Update sources OC...
|
34 |
* Tries to create a new group. If the group name already exists, false will |
|
03e52840d
Init
|
35 36 37 38 39 |
* be returned. */ abstract public static function createGroup($gid); /** |
|
6d9380f96
Update sources OC...
|
40 41 42 |
* delete a group * @param string $gid gid of the group to delete * @return bool |
|
03e52840d
Init
|
43 44 45 46 47 48 |
* * Deletes a group and removes it from the group_user-table */ abstract public static function deleteGroup($gid); /** |
|
6d9380f96
Update sources OC...
|
49 50 51 52 |
* is user in group? * @param string $uid uid of the user * @param string $gid gid of the group * @return bool |
|
03e52840d
Init
|
53 54 55 56 57 58 |
* * Checks whether the user is member of a group or not. */ abstract public static function inGroup($uid, $gid); /** |
|
6d9380f96
Update sources OC...
|
59 60 61 62 |
* 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 |
|
03e52840d
Init
|
63 64 65 66 67 68 |
* * Adds a user to a group. */ abstract public static function addToGroup($uid, $gid); /** |
|
6d9380f96
Update sources OC...
|
69 70 71 72 |
* 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 |
|
03e52840d
Init
|
73 74 75 76 77 78 |
* * removes the user from a group. */ abstract public static function removeFromGroup($uid, $gid); /** |
|
6d9380f96
Update sources OC...
|
79 80 81 |
* Get all groups a user belongs to * @param string $uid Name of the user * @return array an array of group names |
|
03e52840d
Init
|
82 83 84 85 86 87 88 |
* * This function fetches all groups a user belongs to. It does not check * if the user exists at all. */ abstract public static function getUserGroups($uid); /** |
|
6d9380f96
Update sources OC...
|
89 90 91 92 93 |
* get a list of all groups * @param string $search * @param int $limit * @param int $offset * @return array an array of group names |
|
03e52840d
Init
|
94 95 96 97 |
*/ abstract public static function getGroups($search = '', $limit = -1, $offset = 0); /** |
|
6d9380f96
Update sources OC...
|
98 |
* Check if a group exists |
|
03e52840d
Init
|
99 100 101 102 103 104 |
* @param string $gid * @return bool */ abstract public function groupExists($gid); /** |
|
6d9380f96
Update sources OC...
|
105 106 107 108 109 110 |
* 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 |
|
03e52840d
Init
|
111 112 |
*/ abstract public static function usersInGroup($gid, $search = '', $limit = -1, $offset = 0); |
|
03e52840d
Init
|
113 |
} |