123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110 |
- <?php
- /**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Robin Appelman <robin@icewind.nl>
- *
- * @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/>
- *
- */
- namespace OCP;
- /**
- * Interface IGroup
- *
- * @package OCP
- * @since 8.0.0
- */
- interface IGroup {
- /**
- * @return string
- * @since 8.0.0
- */
- public function getGID();
- /**
- * get all users in the group
- *
- * @return \OCP\IUser[]
- * @since 8.0.0
- */
- public function getUsers();
- /**
- * check if a user is in the group
- *
- * @param \OCP\IUser $user
- * @return bool
- * @since 8.0.0
- */
- public function inGroup($user);
- /**
- * add a user to the group
- *
- * @param \OCP\IUser $user
- * @since 8.0.0
- */
- public function addUser($user);
- /**
- * remove a user from the group
- *
- * @param \OCP\IUser $user
- * @since 8.0.0
- */
- 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
- */
- 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
- */
- public function count($search = '');
- /**
- * search for users in the group by displayname
- *
- * @param string $search
- * @param int $limit
- * @param int $offset
- * @return \OCP\IUser[]
- * @since 8.0.0
- */
- public function searchDisplayName($search, $limit = null, $offset = null);
- /**
- * delete the group
- *
- * @return bool
- * @since 8.0.0
- */
- public function delete();
- }
|