diff options
author | Roeland Jago Douma <rullzer@owncloud.com> | 2016-05-19 09:00:09 +0300 |
---|---|---|
committer | Roeland Jago Douma <rullzer@owncloud.com> | 2016-05-19 10:43:33 +0300 |
commit | d666725fa783c21235eec79fa6dbe8ba1881fec3 (patch) | |
tree | 98914481ca4218c9af2c04db17c6d8f281b0094d /lib/public/IUserManager.php | |
parent | 4a94203492e3b475ee26b65d5992796152c645bd (diff) |
Move \OCP to PSR-4
Diffstat (limited to 'lib/public/IUserManager.php')
-rw-r--r-- | lib/public/IUserManager.php | 152 |
1 files changed, 152 insertions, 0 deletions
diff --git a/lib/public/IUserManager.php b/lib/public/IUserManager.php new file mode 100644 index 00000000000..00c0bbc8721 --- /dev/null +++ b/lib/public/IUserManager.php @@ -0,0 +1,152 @@ +<?php +/** + * @author Lukas Reschke <lukas@owncloud.com> + * @author Morris Jobke <hey@morrisjobke.de> + * @author Robin Appelman <icewind@owncloud.com> + * @author Thomas Müller <thomas.mueller@tmit.eu> + * + * @copyright Copyright (c) 2016, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License, version 3, + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License, version 3, + * along with this program. If not, see <http://www.gnu.org/licenses/> + * + */ + +namespace OCP; + + +/** + * Class Manager + * + * Hooks available in scope \OC\User: + * - preSetPassword(\OC\User\User $user, string $password, string $recoverPassword) + * - postSetPassword(\OC\User\User $user, string $password, string $recoverPassword) + * - preDelete(\OC\User\User $user) + * - postDelete(\OC\User\User $user) + * - preCreateUser(string $uid, string $password) + * - postCreateUser(\OC\User\User $user, string $password) + * + * @package OC\User + * @since 8.0.0 + */ +interface IUserManager { + /** + * register a user backend + * + * @param \OCP\UserInterface $backend + * @since 8.0.0 + */ + public function registerBackend($backend); + + /** + * Get the active backends + * @return \OCP\UserInterface[] + * @since 8.0.0 + */ + public function getBackends(); + + /** + * remove a user backend + * + * @param \OCP\UserInterface $backend + * @since 8.0.0 + */ + public function removeBackend($backend); + + /** + * remove all user backends + * @since 8.0.0 + */ + public function clearBackends() ; + + /** + * get a user by user id + * + * @param string $uid + * @return \OCP\IUser|null Either the user or null if the specified user does not exist + * @since 8.0.0 + */ + public function get($uid); + + /** + * check if a user exists + * + * @param string $uid + * @return bool + * @since 8.0.0 + */ + public function userExists($uid); + + /** + * Check if the password is valid for the user + * + * @param string $loginName + * @param string $password + * @return mixed the User object on success, false otherwise + * @since 8.0.0 + */ + public function checkPassword($loginName, $password); + + /** + * search by user id + * + * @param string $pattern + * @param int $limit + * @param int $offset + * @return \OCP\IUser[] + * @since 8.0.0 + */ + public function search($pattern, $limit = null, $offset = null); + + /** + * search by displayName + * + * @param string $pattern + * @param int $limit + * @param int $offset + * @return \OCP\IUser[] + * @since 8.0.0 + */ + public function searchDisplayName($pattern, $limit = null, $offset = null); + + /** + * @param string $uid + * @param string $password + * @throws \Exception + * @return bool|\OCP\IUser the created user of false + * @since 8.0.0 + */ + public function createUser($uid, $password); + + /** + * returns how many users per backend exist (if supported by backend) + * + * @return array an array of backend class as key and count number as value + * @since 8.0.0 + */ + public function countUsers(); + + /** + * @param \Closure $callback + * @param string $search + * @since 9.0.0 + */ + public function callForAllUsers (\Closure $callback, $search = ''); + + /** + * @param string $email + * @return IUser[] + * @since 9.1.0 + */ + public function getByEmail($email); +} |