@@ -48,145 +48,145 @@ |
||
| 48 | 48 | * @since 8.0.0 |
| 49 | 49 | */ |
| 50 | 50 | interface IUserManager { |
| 51 | - /** |
|
| 52 | - * register a user backend |
|
| 53 | - * |
|
| 54 | - * @param \OCP\UserInterface $backend |
|
| 55 | - * @since 8.0.0 |
|
| 56 | - */ |
|
| 57 | - public function registerBackend($backend); |
|
| 58 | - |
|
| 59 | - /** |
|
| 60 | - * Get the active backends |
|
| 61 | - * @return \OCP\UserInterface[] |
|
| 62 | - * @since 8.0.0 |
|
| 63 | - */ |
|
| 64 | - public function getBackends(); |
|
| 65 | - |
|
| 66 | - /** |
|
| 67 | - * remove a user backend |
|
| 68 | - * |
|
| 69 | - * @param \OCP\UserInterface $backend |
|
| 70 | - * @since 8.0.0 |
|
| 71 | - */ |
|
| 72 | - public function removeBackend($backend); |
|
| 73 | - |
|
| 74 | - /** |
|
| 75 | - * remove all user backends |
|
| 76 | - * @since 8.0.0 |
|
| 77 | - */ |
|
| 78 | - public function clearBackends() ; |
|
| 79 | - |
|
| 80 | - /** |
|
| 81 | - * get a user by user id |
|
| 82 | - * |
|
| 83 | - * @param string $uid |
|
| 84 | - * @return \OCP\IUser|null Either the user or null if the specified user does not exist |
|
| 85 | - * @since 8.0.0 |
|
| 86 | - */ |
|
| 87 | - public function get($uid); |
|
| 88 | - |
|
| 89 | - /** |
|
| 90 | - * check if a user exists |
|
| 91 | - * |
|
| 92 | - * @param string $uid |
|
| 93 | - * @return bool |
|
| 94 | - * @since 8.0.0 |
|
| 95 | - */ |
|
| 96 | - public function userExists($uid); |
|
| 97 | - |
|
| 98 | - /** |
|
| 99 | - * Check if the password is valid for the user |
|
| 100 | - * |
|
| 101 | - * @param string $loginName |
|
| 102 | - * @param string $password |
|
| 103 | - * @return mixed the User object on success, false otherwise |
|
| 104 | - * @since 8.0.0 |
|
| 105 | - */ |
|
| 106 | - public function checkPassword($loginName, $password); |
|
| 107 | - |
|
| 108 | - /** |
|
| 109 | - * search by user id |
|
| 110 | - * |
|
| 111 | - * @param string $pattern |
|
| 112 | - * @param int $limit |
|
| 113 | - * @param int $offset |
|
| 114 | - * @return \OCP\IUser[] |
|
| 115 | - * @since 8.0.0 |
|
| 116 | - */ |
|
| 117 | - public function search($pattern, $limit = null, $offset = null); |
|
| 118 | - |
|
| 119 | - /** |
|
| 120 | - * search by displayName |
|
| 121 | - * |
|
| 122 | - * @param string $pattern |
|
| 123 | - * @param int $limit |
|
| 124 | - * @param int $offset |
|
| 125 | - * @return \OCP\IUser[] |
|
| 126 | - * @since 8.0.0 |
|
| 127 | - */ |
|
| 128 | - public function searchDisplayName($pattern, $limit = null, $offset = null); |
|
| 129 | - |
|
| 130 | - /** |
|
| 131 | - * @param string $uid |
|
| 132 | - * @param string $password |
|
| 133 | - * @throws \InvalidArgumentException |
|
| 134 | - * @return bool|\OCP\IUser the created user or false |
|
| 135 | - * @since 8.0.0 |
|
| 136 | - */ |
|
| 137 | - public function createUser($uid, $password); |
|
| 138 | - |
|
| 139 | - /** |
|
| 140 | - * @param string $uid |
|
| 141 | - * @param string $password |
|
| 142 | - * @param UserInterface $backend |
|
| 143 | - * @return IUser|null |
|
| 144 | - * @throws \InvalidArgumentException |
|
| 145 | - * @since 12.0.0 |
|
| 146 | - */ |
|
| 147 | - public function createUserFromBackend($uid, $password, UserInterface $backend); |
|
| 148 | - |
|
| 149 | - /** |
|
| 150 | - * returns how many users per backend exist (if supported by backend) |
|
| 151 | - * |
|
| 152 | - * @return array an array of backend class as key and count number as value |
|
| 153 | - * @since 8.0.0 |
|
| 154 | - */ |
|
| 155 | - public function countUsers(); |
|
| 156 | - |
|
| 157 | - /** |
|
| 158 | - * @param \Closure $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); |
|
| 51 | + /** |
|
| 52 | + * register a user backend |
|
| 53 | + * |
|
| 54 | + * @param \OCP\UserInterface $backend |
|
| 55 | + * @since 8.0.0 |
|
| 56 | + */ |
|
| 57 | + public function registerBackend($backend); |
|
| 58 | + |
|
| 59 | + /** |
|
| 60 | + * Get the active backends |
|
| 61 | + * @return \OCP\UserInterface[] |
|
| 62 | + * @since 8.0.0 |
|
| 63 | + */ |
|
| 64 | + public function getBackends(); |
|
| 65 | + |
|
| 66 | + /** |
|
| 67 | + * remove a user backend |
|
| 68 | + * |
|
| 69 | + * @param \OCP\UserInterface $backend |
|
| 70 | + * @since 8.0.0 |
|
| 71 | + */ |
|
| 72 | + public function removeBackend($backend); |
|
| 73 | + |
|
| 74 | + /** |
|
| 75 | + * remove all user backends |
|
| 76 | + * @since 8.0.0 |
|
| 77 | + */ |
|
| 78 | + public function clearBackends() ; |
|
| 79 | + |
|
| 80 | + /** |
|
| 81 | + * get a user by user id |
|
| 82 | + * |
|
| 83 | + * @param string $uid |
|
| 84 | + * @return \OCP\IUser|null Either the user or null if the specified user does not exist |
|
| 85 | + * @since 8.0.0 |
|
| 86 | + */ |
|
| 87 | + public function get($uid); |
|
| 88 | + |
|
| 89 | + /** |
|
| 90 | + * check if a user exists |
|
| 91 | + * |
|
| 92 | + * @param string $uid |
|
| 93 | + * @return bool |
|
| 94 | + * @since 8.0.0 |
|
| 95 | + */ |
|
| 96 | + public function userExists($uid); |
|
| 97 | + |
|
| 98 | + /** |
|
| 99 | + * Check if the password is valid for the user |
|
| 100 | + * |
|
| 101 | + * @param string $loginName |
|
| 102 | + * @param string $password |
|
| 103 | + * @return mixed the User object on success, false otherwise |
|
| 104 | + * @since 8.0.0 |
|
| 105 | + */ |
|
| 106 | + public function checkPassword($loginName, $password); |
|
| 107 | + |
|
| 108 | + /** |
|
| 109 | + * search by user id |
|
| 110 | + * |
|
| 111 | + * @param string $pattern |
|
| 112 | + * @param int $limit |
|
| 113 | + * @param int $offset |
|
| 114 | + * @return \OCP\IUser[] |
|
| 115 | + * @since 8.0.0 |
|
| 116 | + */ |
|
| 117 | + public function search($pattern, $limit = null, $offset = null); |
|
| 118 | + |
|
| 119 | + /** |
|
| 120 | + * search by displayName |
|
| 121 | + * |
|
| 122 | + * @param string $pattern |
|
| 123 | + * @param int $limit |
|
| 124 | + * @param int $offset |
|
| 125 | + * @return \OCP\IUser[] |
|
| 126 | + * @since 8.0.0 |
|
| 127 | + */ |
|
| 128 | + public function searchDisplayName($pattern, $limit = null, $offset = null); |
|
| 129 | + |
|
| 130 | + /** |
|
| 131 | + * @param string $uid |
|
| 132 | + * @param string $password |
|
| 133 | + * @throws \InvalidArgumentException |
|
| 134 | + * @return bool|\OCP\IUser the created user or false |
|
| 135 | + * @since 8.0.0 |
|
| 136 | + */ |
|
| 137 | + public function createUser($uid, $password); |
|
| 138 | + |
|
| 139 | + /** |
|
| 140 | + * @param string $uid |
|
| 141 | + * @param string $password |
|
| 142 | + * @param UserInterface $backend |
|
| 143 | + * @return IUser|null |
|
| 144 | + * @throws \InvalidArgumentException |
|
| 145 | + * @since 12.0.0 |
|
| 146 | + */ |
|
| 147 | + public function createUserFromBackend($uid, $password, UserInterface $backend); |
|
| 148 | + |
|
| 149 | + /** |
|
| 150 | + * returns how many users per backend exist (if supported by backend) |
|
| 151 | + * |
|
| 152 | + * @return array an array of backend class as key and count number as value |
|
| 153 | + * @since 8.0.0 |
|
| 154 | + */ |
|
| 155 | + public function countUsers(); |
|
| 156 | + |
|
| 157 | + /** |
|
| 158 | + * @param \Closure $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 | } |