diff options
Diffstat (limited to 'lib/public/GroupInterface.php')
| -rw-r--r-- | lib/public/GroupInterface.php | 75 |
1 files changed, 44 insertions, 31 deletions
diff --git a/lib/public/GroupInterface.php b/lib/public/GroupInterface.php index b7c07136126..cbfd74a068a 100644 --- a/lib/public/GroupInterface.php +++ b/lib/public/GroupInterface.php @@ -1,32 +1,12 @@ <?php + /** - * @copyright Copyright (c) 2016, ownCloud, Inc. - * - * @author Arthur Schiwon <blizzz@arthur-schiwon.de> - * @author Christoph Wurst <christoph@winzerhof-wurst.at> - * @author Jörn Friedrich Dreyer <jfd@butonic.de> - * @author Knut Ahlers <knut@ahlers.me> - * @author Morris Jobke <hey@morrisjobke.de> - * @author Roeland Jago Douma <roeland@famdouma.nl> - * @author Vincent Petry <vincent@nextcloud.com> - * - * @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/> - * + * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors + * SPDX-FileCopyrightText: 2016 ownCloud, Inc. + * SPDX-License-Identifier: AGPL-3.0-only */ // use OCP namespace for all classes that are considered public. -// This means that they should be used by apps instead of the internal ownCloud classes +// This means that they should be used by apps instead of the internal Nextcloud classes namespace OCP; @@ -38,15 +18,44 @@ namespace OCP; interface GroupInterface { /** * actions that user backends can define + * + * @since 12.0.0 */ public const CREATE_GROUP = 0x00000001; + + /** + * @since 12.0.0 + */ public const DELETE_GROUP = 0x00000010; + + /** + * @since 12.0.0 + */ public const ADD_TO_GROUP = 0x00000100; + + /** + * @since 12.0.0 + * @deprecated 29.0.0 + */ public const REMOVE_FROM_GOUP = 0x00001000; // oops + + /** + * @since 12.0.0 + */ public const REMOVE_FROM_GROUP = 0x00001000; + //OBSOLETE const GET_DISPLAYNAME = 0x00010000; + + /** + * @since 12.0.0 + */ public const COUNT_USERS = 0x00100000; + + /** + * @since 12.0.0 + */ public const GROUP_DETAILS = 0x01000000; + /** * @since 13.0.0 */ @@ -77,7 +86,7 @@ interface GroupInterface { /** * Get all groups a user belongs to * @param string $uid Name of the user - * @return array an array of group names + * @return list<string> an array of group names * @since 4.5.0 * * This function fetches all groups a user belongs to. It does not check @@ -86,7 +95,8 @@ interface GroupInterface { public function getUserGroups($uid); /** - * get a list of all groups + * @brief Get a list of all groups + * * @param string $search * @param int $limit * @param int $offset @@ -95,10 +105,11 @@ interface GroupInterface { * * Returns a list with all groups */ - public function getGroups($search = '', $limit = -1, $offset = 0); + public function getGroups(string $search = '', int $limit = -1, int $offset = 0); /** - * check if a group exists + * @brief Check if a group exists + * * @param string $gid * @return bool * @since 4.5.0 @@ -106,13 +117,15 @@ interface GroupInterface { public function groupExists($gid); /** - * get a list of all users in a group + * @brief Get a list of user ids in a group matching the given search parameters. + * * @param string $gid * @param string $search * @param int $limit * @param int $offset - * @return array an array of user ids + * @return array<int,string> an array of user ids * @since 4.5.0 + * @deprecated 27.0.0 Use searchInGroup instead, for performance reasons */ public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0); } |