ecommun / owncloud_ynh

Blame view

sources/lib/private/user/example.php 2 KB
edit raw normal view history
03e52840d   Kload   Init 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
  <?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 {
  	/**
6d9380f96   Cédric Dupont   Update sources OC... 
30
31
32
33
 
  		* 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
03e52840d   Kload   Init 
34
35
36
37
38
39
40
 
  		*
  		* Creates a new user. Basic checking of username is done in OC_User
  		* itself, not in its subclasses.
  		*/
  	abstract public function createUser($uid, $password);
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC... 
41
42
43
44
 
  		* Set password
  		* @param string $uid The username
  		* @param string $password The new password
  		* @return bool
03e52840d   Kload   Init 
45
46
47
48
49
50
 
  		*
  		* Change the password of a user
  		*/
  	abstract public function setPassword($uid, $password);
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC... 
51
52
53
54
 
  		* Check if the password is correct
  		* @param string $uid The username
  		* @param string $password The password
  		* @return string
03e52840d   Kload   Init 
55
56
57
58
59
60
61
 
  		*
  		* Check if the password is correct without logging in the user
  		* returns the user id or false
  		*/
  	abstract public function checkPassword($uid, $password);
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC... 
62
63
64
 
  		* get the user's home directory
  		* @param string $uid The username
  		* @return string
03e52840d   Kload   Init 
65
66
67
68
69
70
 
  		*
  		* get the user's home directory
  		* returns the path or false
  		*/
  	abstract public function getHome($uid);
  }