2012-07-20 15:15:12 +04:00
|
|
|
<?php
|
|
|
|
|
|
|
|
/**
|
|
|
|
* ownCloud - group interface
|
|
|
|
*
|
|
|
|
* @author Arthur Schiwon
|
|
|
|
* @copyright 2012 Arthur Schiwon blizzz@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/>.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
interface OC_Group_Interface {
|
|
|
|
/**
|
|
|
|
* @brief Check if backend implements actions
|
2012-09-23 04:39:11 +04:00
|
|
|
* @param int $actions bitwise-or'ed actions
|
|
|
|
* @return boolean
|
2012-07-20 15:15:12 +04:00
|
|
|
*
|
|
|
|
* Returns the supported actions as int to be
|
|
|
|
* compared with OC_GROUP_BACKEND_CREATE_GROUP etc.
|
|
|
|
*/
|
|
|
|
public function implementsActions($actions);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief is user in group?
|
2012-09-23 04:39:11 +04:00
|
|
|
* @param string $uid uid of the user
|
|
|
|
* @param string $gid gid of the group
|
|
|
|
* @return bool
|
2012-07-20 15:15:12 +04:00
|
|
|
*
|
|
|
|
* Checks whether the user is member of a group or not.
|
|
|
|
*/
|
|
|
|
public function inGroup($uid, $gid);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Get all groups a user belongs to
|
2012-09-23 04:39:11 +04:00
|
|
|
* @param string $uid Name of the user
|
2014-05-11 21:13:51 +04:00
|
|
|
* @return array an array of group names
|
2012-07-20 15:15:12 +04:00
|
|
|
*
|
|
|
|
* This function fetches all groups a user belongs to. It does not check
|
|
|
|
* if the user exists at all.
|
|
|
|
*/
|
|
|
|
public function getUserGroups($uid);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief get a list of all groups
|
2012-09-23 04:39:11 +04:00
|
|
|
* @param string $search
|
|
|
|
* @param int $limit
|
|
|
|
* @param int $offset
|
2014-05-11 21:13:51 +04:00
|
|
|
* @return array an array of group names
|
2012-07-20 15:15:12 +04:00
|
|
|
*
|
|
|
|
* Returns a list with all groups
|
|
|
|
*/
|
2012-08-12 00:06:31 +04:00
|
|
|
public function getGroups($search = '', $limit = -1, $offset = 0);
|
2012-07-20 15:15:12 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* check if a group exists
|
|
|
|
* @param string $gid
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function groupExists($gid);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief get a list of all users in a group
|
2012-09-23 04:39:11 +04:00
|
|
|
* @param string $gid
|
|
|
|
* @param string $search
|
|
|
|
* @param int $limit
|
|
|
|
* @param int $offset
|
2014-05-11 21:13:51 +04:00
|
|
|
* @return array an array of user ids
|
2012-07-20 15:15:12 +04:00
|
|
|
*/
|
2012-08-12 00:21:09 +04:00
|
|
|
public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0);
|
2012-07-20 15:15:12 +04:00
|
|
|
|
2012-09-23 04:39:11 +04:00
|
|
|
}
|