Commit b8eb0b7c authored by Thomas Müller's avatar Thomas Müller
Browse files

Merge pull request #14880 from owncloud/drop-example-backend

Drop example user backend
parents 0d9f149d e77d2ff2
......@@ -52,8 +52,6 @@ define('OC_USER_BACKEND_COUNT_USERS', 1 << 28);
/**
* Abstract base class for user management. Provides methods for querying backend
* capabilities.
*
* Subclass this for your own backends, and see OC_User_Example for descriptions
*/
abstract class OC_User_Backend implements OC_User_Interface {
/**
......
<?php
/**
* ownCloud
*
* @author Frank Karlitschek
* @copyright 2012 Frank Karlitschek frank@owncloud.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 {
/**
* Create a new user
* @param string $uid The username of the user to create
* @param string $password The password of the new user
* @return bool
*
* Creates a new user. Basic checking of username is done in OC_User
* itself, not in its subclasses.
*/
abstract public function createUser($uid, $password);
/**
* Set password
* @param string $uid The username
* @param string $password The new password
* @return bool
*
* Change the password of a user
*/
abstract public function setPassword($uid, $password);
/**
* Check if the password is correct
* @param string $uid The username
* @param string $password The password
* @return string
*
* Check if the password is correct without logging in the user
* returns the user id or false
*/
abstract public function checkPassword($uid, $password);
/**
* get the user's home directory
* @param string $uid The username
* @return string
*
* get the user's home directory
* returns the path or false
*/
abstract public function getHome($uid);
}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment