IGroupDetailsBackend.php 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2018 Roeland Jago Douma <roeland@famdouma.nl>
  5. *
  6. * @author Roeland Jago Douma <roeland@famdouma.nl>
  7. * @author Carl Schwan <carl@carlschwan.eu>
  8. *
  9. * @license GNU AGPL version 3 or any later version
  10. *
  11. * This program is free software: you can redistribute it and/or modify
  12. * it under the terms of the GNU Affero General Public License as
  13. * published by the Free Software Foundation, either version 3 of the
  14. * License, or (at your option) any later version.
  15. *
  16. * This program is distributed in the hope that it will be useful,
  17. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. * GNU Affero General Public License for more details.
  20. *
  21. * You should have received a copy of the GNU Affero General Public License
  22. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23. *
  24. */
  25. namespace OCP\Group\Backend;
  26. /**
  27. * @brief Optional interface for group backends
  28. * @since 14.0.0
  29. */
  30. interface IGroupDetailsBackend {
  31. /**
  32. * @brief Get additional details for a group, for example the display name.
  33. *
  34. * The array returned can be empty when no additional information is available
  35. * for the group.
  36. *
  37. * @return array{displayName?: string}
  38. * @since 14.0.0
  39. */
  40. public function getGroupDetails(string $gid): array;
  41. }