Blame view

sources/lib/public/igroupmanager.php 1.78 KB
f7d878ff1   kload   [enh] Update to 7...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
  <?php
  
  /**
   * Copyright (c) 2014 Robin Appelman <icewind@owncloud.com>
   * This file is licensed under the Affero General Public License version 3 or
   * later.
   * See the COPYING-README file.
   */
  
  namespace OCP;
  
  /**
   * Class Manager
   *
   * Hooks available in scope \OC\Group:
   * - preAddUser(\OC\Group\Group $group, \OC\User\User $user)
   * - postAddUser(\OC\Group\Group $group, \OC\User\User $user)
   * - preRemoveUser(\OC\Group\Group $group, \OC\User\User $user)
   * - postRemoveUser(\OC\Group\Group $group, \OC\User\User $user)
   * - preDelete(\OC\Group\Group $group)
   * - postDelete(\OC\Group\Group $group)
   * - preCreate(string $groupId)
   * - postCreate(\OC\Group\Group $group)
   *
   * @package OC\Group
   */
  interface IGroupManager {
  	/**
  	 * @param \OCP\UserInterface $backend
  	 */
  	public function addBackend($backend);
  
  	public function clearBackends();
  
  	/**
  	 * @param string $gid
  	 * @return \OCP\IGroup
  	 */
  	public function get($gid);
  
  	/**
  	 * @param string $gid
  	 * @return bool
  	 */
  	public function groupExists($gid);
  
  	/**
  	 * @param string $gid
  	 * @return \OCP\IGroup
  	 */
  	public function createGroup($gid);
  
  	/**
  	 * @param string $search
  	 * @param int $limit
  	 * @param int $offset
  	 * @return \OCP\IGroup[]
  	 */
  	public function search($search, $limit = null, $offset = null);
  
  	/**
  	 * @param \OCP\IUser $user
  	 * @return \OCP\IGroup[]
  	 */
  	public function getUserGroups($user);
  
  	/**
  	 * @param \OCP\IUser $user
  	 * @return array with group names
  	 */
  	public function getUserGroupIds($user);
  
  	/**
  	 * get a list of all display names in a group
  	 *
  	 * @param string $gid
  	 * @param string $search
  	 * @param int $limit
  	 * @param int $offset
  	 * @return array an array of display names (value) and user ids (key)
  	 */
  	public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0);
  }