GroupInterface.php 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016, ownCloud, Inc.
  4. *
  5. * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
  6. * @author Jörn Friedrich Dreyer <jfd@butonic.de>
  7. * @author Morris Jobke <hey@morrisjobke.de>
  8. *
  9. * @license AGPL-3.0
  10. *
  11. * This code is free software: you can redistribute it and/or modify
  12. * it under the terms of the GNU Affero General Public License, version 3,
  13. * as published by the Free Software Foundation.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU Affero General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU Affero General Public License, version 3,
  21. * along with this program. If not, see <http://www.gnu.org/licenses/>
  22. *
  23. */
  24. /**
  25. * Public interface of ownCloud for apps to use.
  26. * Group Class.
  27. *
  28. */
  29. // use OCP namespace for all classes that are considered public.
  30. // This means that they should be used by apps instead of the internal ownCloud classes
  31. namespace OCP;
  32. /**
  33. * TODO actually this is a IGroupBackend
  34. *
  35. * @package OCP
  36. * @since 4.5.0
  37. */
  38. interface GroupInterface {
  39. /**
  40. * actions that user backends can define
  41. */
  42. const CREATE_GROUP = 0x00000001;
  43. const DELETE_GROUP = 0x00000010;
  44. const ADD_TO_GROUP = 0x00000100;
  45. const REMOVE_FROM_GOUP = 0x00001000; // oops
  46. const REMOVE_FROM_GROUP = 0x00001000;
  47. //OBSOLETE const GET_DISPLAYNAME = 0x00010000;
  48. const COUNT_USERS = 0x00100000;
  49. const GROUP_DETAILS = 0x01000000;
  50. /**
  51. * Check if backend implements actions
  52. * @param int $actions bitwise-or'ed actions
  53. * @return boolean
  54. * @since 4.5.0
  55. *
  56. * Returns the supported actions as int to be
  57. * compared with \OC_Group_Backend::CREATE_GROUP etc.
  58. */
  59. public function implementsActions($actions);
  60. /**
  61. * is user in group?
  62. * @param string $uid uid of the user
  63. * @param string $gid gid of the group
  64. * @return bool
  65. * @since 4.5.0
  66. *
  67. * Checks whether the user is member of a group or not.
  68. */
  69. public function inGroup($uid, $gid);
  70. /**
  71. * Get all groups a user belongs to
  72. * @param string $uid Name of the user
  73. * @return array an array of group names
  74. * @since 4.5.0
  75. *
  76. * This function fetches all groups a user belongs to. It does not check
  77. * if the user exists at all.
  78. */
  79. public function getUserGroups($uid);
  80. /**
  81. * get a list of all groups
  82. * @param string $search
  83. * @param int $limit
  84. * @param int $offset
  85. * @return array an array of group names
  86. * @since 4.5.0
  87. *
  88. * Returns a list with all groups
  89. */
  90. public function getGroups($search = '', $limit = -1, $offset = 0);
  91. /**
  92. * check if a group exists
  93. * @param string $gid
  94. * @return bool
  95. * @since 4.5.0
  96. */
  97. public function groupExists($gid);
  98. /**
  99. * get a list of all users in a group
  100. * @param string $gid
  101. * @param string $search
  102. * @param int $limit
  103. * @param int $offset
  104. * @return array an array of user ids
  105. * @since 4.5.0
  106. */
  107. public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0);
  108. }