diff options
author | Jakob Sack <kde@jakobsack.de> | 2011-07-27 19:07:28 +0200 |
---|---|---|
committer | Jakob Sack <kde@jakobsack.de> | 2011-07-27 19:07:28 +0200 |
commit | f5c0dbd947d45520550b68dae77a894f871a0758 (patch) | |
tree | 5e3c8fe6a12af97990fd529fb0d692ddc9400386 /lib/user/example.php | |
parent | 59e55b711b36a41c4e4c621b5a46f9d601e15c38 (diff) | |
download | nextcloud-server-f5c0dbd947d45520550b68dae77a894f871a0758.tar.gz nextcloud-server-f5c0dbd947d45520550b68dae77a894f871a0758.zip |
Use autoload
Diffstat (limited to 'lib/user/example.php')
-rw-r--r-- | lib/user/example.php | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/lib/user/example.php b/lib/user/example.php new file mode 100644 index 00000000000..069f14492a4 --- /dev/null +++ b/lib/user/example.php @@ -0,0 +1,95 @@ +<?php + +/** + * ownCloud + * + * @author Frank Karlitschek + * @copyright 2010 Frank Karlitschek karlitschek@kde.org + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE + * License as published by the Free Software Foundation; either + * version 3 of the License, or any later version. + * + * This library 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 along with this library. If not, see <http://www.gnu.org/licenses/>. + * + */ + +/** + * abstract reference class for user management + * this class should only be used as a reference for method signatures and their descriptions + */ +abstract class OC_USER_EXAMPLE extends OC_USER_BACKEND { + /** + * @brief Create a new user + * @param $uid The username of the user to create + * @param $password The password of the new user + * @returns true/false + * + * Creates a new user. Basic checking of username is done in OC_USER + * itself, not in its subclasses. + */ + public function createUser($uid, $password){ + return OC_USER_BACKEND_NOT_IMPLEMENTED; + } + + /** + * @brief delete a user + * @param $uid The username of the user to delete + * @returns true/false + * + * Deletes a user + */ + public function deleteUser( $uid ){ + return OC_USER_BACKEND_NOT_IMPLEMENTED; + } + + /** + * @brief Set password + * @param $uid The username + * @param $password The new password + * @returns true/false + * + * Change the password of a user + */ + public function setPassword($uid, $password){ + return OC_USER_BACKEND_NOT_IMPLEMENTED; + } + + /** + * @brief Check if the password is correct + * @param $uid The username + * @param $password The password + * @returns true/false + * + * Check if the password is correct without logging in the user + */ + public function checkPassword($uid, $password){ + return OC_USER_BACKEND_NOT_IMPLEMENTED; + } + + /** + * @brief Get a list of all users + * @returns array with all uids + * + * Get a list of all users. + */ + public function getUsers(){ + return OC_USER_BACKEND_NOT_IMPLEMENTED; + } + + /** + * @brief check if a user exists + * @param string $uid the username + * @return boolean + */ + public function userExists($uid){ + return OC_USER_BACKEND_NOT_IMPLEMENTED; + } +} |