ISearchableGroupBackend.php 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2022 Carl Schwan <carl@carlschwan.eu>
  5. *
  6. * @license GNU AGPL version 3 or any later version
  7. *
  8. * This program is free software: you can redistribute it and/or modify
  9. * it under the terms of the GNU Affero General Public License as
  10. * published by the Free Software Foundation, either version 3 of the
  11. * License, or (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU Affero General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU Affero General Public License
  19. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  20. *
  21. */
  22. namespace OCP\Group\Backend;
  23. use OCP\IUser;
  24. /**
  25. * @since 27.0.0
  26. */
  27. interface ISearchableGroupBackend {
  28. /**
  29. * @brief Get a list of users matching the given search parameters.
  30. *
  31. * Implementations of this method should return lazy evaluated user objects and
  32. * preload if possible the display name.
  33. *
  34. * <code>
  35. * $users = $groupBackend->searchInGroup('admin', 'John', 10, 0);
  36. * </code>
  37. *
  38. * @param string $gid The group id of the user we want to search
  39. * @param string $search The part of the display name or user id of the users we
  40. * want to search. This can be empty to get all the users.
  41. * @param int $limit The limit of results
  42. * @param int $offset The offset of the results
  43. * @return array<string,IUser> Users indexed by uid
  44. * @since 27.0.0
  45. */
  46. public function searchInGroup(string $gid, string $search = '', int $limit = -1, int $offset = 0): array;
  47. }