nextcloud/lib/public/IGroup.php

129 lines
2.6 KiB
PHP
Raw Normal View History

2014-07-16 16:25:31 +04:00
<?php
/**
2016-07-21 18:07:57 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Julius Härtl <jus@bitgrid.net>
* @author Lukas Reschke <lukas@statuscode.ch>
2015-03-26 13:44:34 +03:00
* @author Morris Jobke <hey@morrisjobke.de>
2016-07-21 19:13:36 +03:00
* @author Robin Appelman <robin@icewind.nl>
* @author Vincent Petry <pvince81@owncloud.com>
2015-03-26 13:44:34 +03:00
*
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program 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, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
2014-07-16 16:25:31 +04:00
*/
2014-07-16 16:25:31 +04:00
namespace OCP;
/**
* Interface IGroup
*
* @package OCP
* @since 8.0.0
*/
2014-07-16 16:25:31 +04:00
interface IGroup {
/**
* @return string
* @since 8.0.0
2014-07-16 16:25:31 +04:00
*/
public function getGID();
2016-11-30 22:21:44 +03:00
/**
* Returns the group display name
*
* @return string
* @since 12.0.0
2016-11-30 22:21:44 +03:00
*/
public function getDisplayName();
2014-07-16 16:25:31 +04:00
/**
* get all users in the group
*
* @return \OCP\IUser[]
* @since 8.0.0
2014-07-16 16:25:31 +04:00
*/
public function getUsers();
/**
* check if a user is in the group
*
* @param \OCP\IUser $user
* @return bool
* @since 8.0.0
2014-07-16 16:25:31 +04:00
*/
public function inGroup(IUser $user);
2014-07-16 16:25:31 +04:00
/**
* add a user to the group
*
* @param \OCP\IUser $user
* @since 8.0.0
2014-07-16 16:25:31 +04:00
*/
public function addUser(IUser $user);
2014-07-16 16:25:31 +04:00
/**
* remove a user from the group
*
* @param \OCP\IUser $user
* @since 8.0.0
2014-07-16 16:25:31 +04:00
*/
public function removeUser($user);
/**
* search for users in the group by userid
*
* @param string $search
* @param int $limit
* @param int $offset
* @return \OCP\IUser[]
* @since 8.0.0
2014-07-16 16:25:31 +04:00
*/
public function searchUsers($search, $limit = null, $offset = null);
/**
* returns the number of users matching the search string
*
* @param string $search
* @return int|bool
* @since 8.0.0
2014-07-16 16:25:31 +04:00
*/
public function count($search = '');
/**
* returns the number of disabled users
*
* @return int|bool
*/
public function countDisabled();
2014-07-16 16:25:31 +04:00
/**
* search for users in the group by displayname
*
* @param string $search
* @param int $limit
* @param int $offset
* @return \OCP\IUser[]
* @since 8.0.0
2014-07-16 16:25:31 +04:00
*/
public function searchDisplayName($search, $limit = null, $offset = null);
/**
* delete the group
*
* @return bool
* @since 8.0.0
2014-07-16 16:25:31 +04:00
*/
public function delete();
}