@@ -47,146 +47,146 @@ |
||
47 | 47 | * @since 8.0.0 |
48 | 48 | */ |
49 | 49 | interface IUserManager { |
50 | - /** |
|
51 | - * register a user backend |
|
52 | - * |
|
53 | - * @param \OCP\UserInterface $backend |
|
54 | - * @since 8.0.0 |
|
55 | - */ |
|
56 | - public function registerBackend($backend); |
|
57 | - |
|
58 | - /** |
|
59 | - * Get the active backends |
|
60 | - * @return \OCP\UserInterface[] |
|
61 | - * @since 8.0.0 |
|
62 | - */ |
|
63 | - public function getBackends(); |
|
64 | - |
|
65 | - /** |
|
66 | - * remove a user backend |
|
67 | - * |
|
68 | - * @param \OCP\UserInterface $backend |
|
69 | - * @since 8.0.0 |
|
70 | - */ |
|
71 | - public function removeBackend($backend); |
|
72 | - |
|
73 | - /** |
|
74 | - * remove all user backends |
|
75 | - * @since 8.0.0 |
|
76 | - */ |
|
77 | - public function clearBackends() ; |
|
78 | - |
|
79 | - /** |
|
80 | - * get a user by user id |
|
81 | - * |
|
82 | - * @param string $uid |
|
83 | - * @return \OCP\IUser|null Either the user or null if the specified user does not exist |
|
84 | - * @since 8.0.0 |
|
85 | - */ |
|
86 | - public function get($uid); |
|
87 | - |
|
88 | - /** |
|
89 | - * check if a user exists |
|
90 | - * |
|
91 | - * @param string $uid |
|
92 | - * @return bool |
|
93 | - * @since 8.0.0 |
|
94 | - */ |
|
95 | - public function userExists($uid); |
|
96 | - |
|
97 | - /** |
|
98 | - * Check if the password is valid for the user |
|
99 | - * |
|
100 | - * @param string $loginName |
|
101 | - * @param string $password |
|
102 | - * @return mixed the User object on success, false otherwise |
|
103 | - * @since 8.0.0 |
|
104 | - */ |
|
105 | - public function checkPassword($loginName, $password); |
|
106 | - |
|
107 | - /** |
|
108 | - * search by user id |
|
109 | - * |
|
110 | - * @param string $pattern |
|
111 | - * @param int $limit |
|
112 | - * @param int $offset |
|
113 | - * @return \OCP\IUser[] |
|
114 | - * @since 8.0.0 |
|
115 | - */ |
|
116 | - public function search($pattern, $limit = null, $offset = null); |
|
117 | - |
|
118 | - /** |
|
119 | - * search by displayName |
|
120 | - * |
|
121 | - * @param string $pattern |
|
122 | - * @param int $limit |
|
123 | - * @param int $offset |
|
124 | - * @return \OCP\IUser[] |
|
125 | - * @since 8.0.0 |
|
126 | - */ |
|
127 | - public function searchDisplayName($pattern, $limit = null, $offset = null); |
|
128 | - |
|
129 | - /** |
|
130 | - * @param string $uid |
|
131 | - * @param string $password |
|
132 | - * @throws \InvalidArgumentException |
|
133 | - * @return bool|\OCP\IUser the created user or false |
|
134 | - * @since 8.0.0 |
|
135 | - */ |
|
136 | - public function createUser($uid, $password); |
|
137 | - |
|
138 | - /** |
|
139 | - * @param string $uid |
|
140 | - * @param string $password |
|
141 | - * @param UserInterface $backend |
|
142 | - * @return IUser|null |
|
143 | - * @throws \InvalidArgumentException |
|
144 | - * @since 12.0.0 |
|
145 | - */ |
|
146 | - public function createUserFromBackend($uid, $password, UserInterface $backend); |
|
147 | - |
|
148 | - /** |
|
149 | - * returns how many users per backend exist (if supported by backend) |
|
150 | - * |
|
151 | - * @return array an array of backend class as key and count number as value |
|
152 | - * @since 8.0.0 |
|
153 | - */ |
|
154 | - public function countUsers(); |
|
155 | - |
|
156 | - /** |
|
157 | - * @param \Closure $callback |
|
158 | - * @psalm-param \Closure(\OCP\IUser):void $callback |
|
159 | - * @param string $search |
|
160 | - * @since 9.0.0 |
|
161 | - */ |
|
162 | - public function callForAllUsers(\Closure $callback, $search = ''); |
|
163 | - |
|
164 | - /** |
|
165 | - * returns how many users have logged in once |
|
166 | - * |
|
167 | - * @return int |
|
168 | - * @since 11.0.0 |
|
169 | - */ |
|
170 | - public function countDisabledUsers(); |
|
171 | - |
|
172 | - /** |
|
173 | - * returns how many users have logged in once |
|
174 | - * |
|
175 | - * @return int |
|
176 | - * @since 11.0.0 |
|
177 | - */ |
|
178 | - public function countSeenUsers(); |
|
179 | - |
|
180 | - /** |
|
181 | - * @param \Closure $callback |
|
182 | - * @since 11.0.0 |
|
183 | - */ |
|
184 | - public function callForSeenUsers(\Closure $callback); |
|
185 | - |
|
186 | - /** |
|
187 | - * @param string $email |
|
188 | - * @return IUser[] |
|
189 | - * @since 9.1.0 |
|
190 | - */ |
|
191 | - public function getByEmail($email); |
|
50 | + /** |
|
51 | + * register a user backend |
|
52 | + * |
|
53 | + * @param \OCP\UserInterface $backend |
|
54 | + * @since 8.0.0 |
|
55 | + */ |
|
56 | + public function registerBackend($backend); |
|
57 | + |
|
58 | + /** |
|
59 | + * Get the active backends |
|
60 | + * @return \OCP\UserInterface[] |
|
61 | + * @since 8.0.0 |
|
62 | + */ |
|
63 | + public function getBackends(); |
|
64 | + |
|
65 | + /** |
|
66 | + * remove a user backend |
|
67 | + * |
|
68 | + * @param \OCP\UserInterface $backend |
|
69 | + * @since 8.0.0 |
|
70 | + */ |
|
71 | + public function removeBackend($backend); |
|
72 | + |
|
73 | + /** |
|
74 | + * remove all user backends |
|
75 | + * @since 8.0.0 |
|
76 | + */ |
|
77 | + public function clearBackends() ; |
|
78 | + |
|
79 | + /** |
|
80 | + * get a user by user id |
|
81 | + * |
|
82 | + * @param string $uid |
|
83 | + * @return \OCP\IUser|null Either the user or null if the specified user does not exist |
|
84 | + * @since 8.0.0 |
|
85 | + */ |
|
86 | + public function get($uid); |
|
87 | + |
|
88 | + /** |
|
89 | + * check if a user exists |
|
90 | + * |
|
91 | + * @param string $uid |
|
92 | + * @return bool |
|
93 | + * @since 8.0.0 |
|
94 | + */ |
|
95 | + public function userExists($uid); |
|
96 | + |
|
97 | + /** |
|
98 | + * Check if the password is valid for the user |
|
99 | + * |
|
100 | + * @param string $loginName |
|
101 | + * @param string $password |
|
102 | + * @return mixed the User object on success, false otherwise |
|
103 | + * @since 8.0.0 |
|
104 | + */ |
|
105 | + public function checkPassword($loginName, $password); |
|
106 | + |
|
107 | + /** |
|
108 | + * search by user id |
|
109 | + * |
|
110 | + * @param string $pattern |
|
111 | + * @param int $limit |
|
112 | + * @param int $offset |
|
113 | + * @return \OCP\IUser[] |
|
114 | + * @since 8.0.0 |
|
115 | + */ |
|
116 | + public function search($pattern, $limit = null, $offset = null); |
|
117 | + |
|
118 | + /** |
|
119 | + * search by displayName |
|
120 | + * |
|
121 | + * @param string $pattern |
|
122 | + * @param int $limit |
|
123 | + * @param int $offset |
|
124 | + * @return \OCP\IUser[] |
|
125 | + * @since 8.0.0 |
|
126 | + */ |
|
127 | + public function searchDisplayName($pattern, $limit = null, $offset = null); |
|
128 | + |
|
129 | + /** |
|
130 | + * @param string $uid |
|
131 | + * @param string $password |
|
132 | + * @throws \InvalidArgumentException |
|
133 | + * @return bool|\OCP\IUser the created user or false |
|
134 | + * @since 8.0.0 |
|
135 | + */ |
|
136 | + public function createUser($uid, $password); |
|
137 | + |
|
138 | + /** |
|
139 | + * @param string $uid |
|
140 | + * @param string $password |
|
141 | + * @param UserInterface $backend |
|
142 | + * @return IUser|null |
|
143 | + * @throws \InvalidArgumentException |
|
144 | + * @since 12.0.0 |
|
145 | + */ |
|
146 | + public function createUserFromBackend($uid, $password, UserInterface $backend); |
|
147 | + |
|
148 | + /** |
|
149 | + * returns how many users per backend exist (if supported by backend) |
|
150 | + * |
|
151 | + * @return array an array of backend class as key and count number as value |
|
152 | + * @since 8.0.0 |
|
153 | + */ |
|
154 | + public function countUsers(); |
|
155 | + |
|
156 | + /** |
|
157 | + * @param \Closure $callback |
|
158 | + * @psalm-param \Closure(\OCP\IUser):void $callback |
|
159 | + * @param string $search |
|
160 | + * @since 9.0.0 |
|
161 | + */ |
|
162 | + public function callForAllUsers(\Closure $callback, $search = ''); |
|
163 | + |
|
164 | + /** |
|
165 | + * returns how many users have logged in once |
|
166 | + * |
|
167 | + * @return int |
|
168 | + * @since 11.0.0 |
|
169 | + */ |
|
170 | + public function countDisabledUsers(); |
|
171 | + |
|
172 | + /** |
|
173 | + * returns how many users have logged in once |
|
174 | + * |
|
175 | + * @return int |
|
176 | + * @since 11.0.0 |
|
177 | + */ |
|
178 | + public function countSeenUsers(); |
|
179 | + |
|
180 | + /** |
|
181 | + * @param \Closure $callback |
|
182 | + * @since 11.0.0 |
|
183 | + */ |
|
184 | + public function callForSeenUsers(\Closure $callback); |
|
185 | + |
|
186 | + /** |
|
187 | + * @param string $email |
|
188 | + * @return IUser[] |
|
189 | + * @since 9.1.0 |
|
190 | + */ |
|
191 | + public function getByEmail($email); |
|
192 | 192 | } |