2014-07-09 15:32:33 +02:00
|
|
|
<?php
|
|
|
|
/**
|
2016-07-21 17:07:57 +02:00
|
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
|
|
*
|
2016-05-26 19:56:05 +02:00
|
|
|
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
|
|
|
|
* @author Lukas Reschke <lukas@statuscode.ch>
|
2015-03-26 11:44:34 +01:00
|
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
2016-07-21 18:13:36 +02:00
|
|
|
* @author Robin Appelman <robin@icewind.nl>
|
2015-03-26 11:44:34 +01:00
|
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
|
|
|
*
|
|
|
|
* @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/>
|
|
|
|
*
|
2014-07-09 15:32:33 +02:00
|
|
|
*/
|
2015-02-26 11:37:37 +01:00
|
|
|
|
2014-07-09 15:32:33 +02:00
|
|
|
namespace OCP;
|
|
|
|
|
2015-04-16 17:00:08 +02:00
|
|
|
/**
|
|
|
|
* Interface IUser
|
|
|
|
*
|
|
|
|
* @package OCP
|
|
|
|
* @since 8.0.0
|
|
|
|
*/
|
2014-07-09 15:32:33 +02:00
|
|
|
interface IUser {
|
2016-04-07 15:39:34 +02:00
|
|
|
|
2014-07-09 15:32:33 +02:00
|
|
|
/**
|
|
|
|
* get the user id
|
|
|
|
*
|
|
|
|
* @return string
|
2015-04-16 17:00:08 +02:00
|
|
|
* @since 8.0.0
|
2014-07-09 15:32:33 +02:00
|
|
|
*/
|
|
|
|
public function getUID();
|
|
|
|
|
|
|
|
/**
|
2014-07-24 12:50:39 +02:00
|
|
|
* get the display name for the user, if no specific display name is set it will fallback to the user id
|
2014-07-09 15:32:33 +02:00
|
|
|
*
|
|
|
|
* @return string
|
2015-04-16 17:00:08 +02:00
|
|
|
* @since 8.0.0
|
2014-07-09 15:32:33 +02:00
|
|
|
*/
|
|
|
|
public function getDisplayName();
|
|
|
|
|
|
|
|
/**
|
2014-07-24 12:50:39 +02:00
|
|
|
* set the display name for the user
|
2014-07-09 15:32:33 +02:00
|
|
|
*
|
|
|
|
* @param string $displayName
|
|
|
|
* @return bool
|
2015-04-16 17:00:08 +02:00
|
|
|
* @since 8.0.0
|
2014-07-09 15:32:33 +02:00
|
|
|
*/
|
|
|
|
public function setDisplayName($displayName);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* returns the timestamp of the user's last login or 0 if the user did never
|
|
|
|
* login
|
|
|
|
*
|
|
|
|
* @return int
|
2015-04-16 17:00:08 +02:00
|
|
|
* @since 8.0.0
|
2014-07-09 15:32:33 +02:00
|
|
|
*/
|
|
|
|
public function getLastLogin();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* updates the timestamp of the most recent login of this user
|
2015-04-16 17:00:08 +02:00
|
|
|
* @since 8.0.0
|
2014-07-09 15:32:33 +02:00
|
|
|
*/
|
|
|
|
public function updateLastLoginTimestamp();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Delete the user
|
|
|
|
*
|
|
|
|
* @return bool
|
2015-04-16 17:00:08 +02:00
|
|
|
* @since 8.0.0
|
2014-07-09 15:32:33 +02:00
|
|
|
*/
|
|
|
|
public function delete();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the password of the user
|
|
|
|
*
|
|
|
|
* @param string $password
|
|
|
|
* @param string $recoveryPassword for the encryption app to reset encryption keys
|
|
|
|
* @return bool
|
2015-04-16 17:00:08 +02:00
|
|
|
* @since 8.0.0
|
2014-07-09 15:32:33 +02:00
|
|
|
*/
|
2014-07-24 12:50:39 +02:00
|
|
|
public function setPassword($password, $recoveryPassword = null);
|
2014-07-09 15:32:33 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* get the users home folder to mount
|
|
|
|
*
|
|
|
|
* @return string
|
2015-06-19 10:51:36 +02:00
|
|
|
* @since 8.0.0
|
2014-07-09 15:32:33 +02:00
|
|
|
*/
|
|
|
|
public function getHome();
|
|
|
|
|
Expose backend type via REST API
This change will expose the user backend via the REST API which is a pre-requisite for https://github.com/owncloud/core/issues/12620.
For example:
````json
[{"name":"9707A09E-CA9A-4ABE-A66A-3F632F16C409","displayname":"Document Conversion User Account","groups":[],"subadmin":[],"quota":"default","storageLocation":"\/Users\/lreschke\/Programming\/core\/data\/9707A09E-CA9A-4ABE-A66A-3F632F16C409","lastLogin":0,"backend":"OCA\\user_ldap\\USER_LDAP"},{"name":"ED86733E-745C-4E4D-90CB-278A9737DB3C","displayname":"Hacker","groups":[],"subadmin":[],"quota":"default","storageLocation":"\/Users\/lreschke\/Programming\/core\/data\/ED86733E-745C-4E4D-90CB-278A9737DB3C","lastLogin":0,"backend":"OCA\\user_ldap\\USER_LDAP"},{"name":"71CDF45B-E125-450D-983C-D9192F36EC88","displayname":"admin","groups":[],"subadmin":[],"quota":"default","storageLocation":"\/Users\/lreschke\/Programming\/core\/data\/71CDF45B-E125-450D-983C-D9192F36EC88","lastLogin":0,"backend":"OCA\\user_ldap\\USER_LDAP"},{"name":"admin","displayname":"admin","groups":["admin"],"subadmin":[],"quota":"default","storageLocation":"\/Users\/lreschke\/Programming\/core\/data\/admin","lastLogin":"1418057287","backend":"OC_User_Database"},{"name":"test","displayname":"test","groups":[],"subadmin":[],"quota":"default","storageLocation":"\/Users\/lreschke\/Programming\/core\/data\/test","lastLogin":0,"backend":"OC_User_Database"}]
```
2014-12-08 22:38:54 +01:00
|
|
|
/**
|
|
|
|
* Get the name of the backend class the user is connected with
|
|
|
|
*
|
|
|
|
* @return string
|
2015-04-16 17:00:08 +02:00
|
|
|
* @since 8.0.0
|
Expose backend type via REST API
This change will expose the user backend via the REST API which is a pre-requisite for https://github.com/owncloud/core/issues/12620.
For example:
````json
[{"name":"9707A09E-CA9A-4ABE-A66A-3F632F16C409","displayname":"Document Conversion User Account","groups":[],"subadmin":[],"quota":"default","storageLocation":"\/Users\/lreschke\/Programming\/core\/data\/9707A09E-CA9A-4ABE-A66A-3F632F16C409","lastLogin":0,"backend":"OCA\\user_ldap\\USER_LDAP"},{"name":"ED86733E-745C-4E4D-90CB-278A9737DB3C","displayname":"Hacker","groups":[],"subadmin":[],"quota":"default","storageLocation":"\/Users\/lreschke\/Programming\/core\/data\/ED86733E-745C-4E4D-90CB-278A9737DB3C","lastLogin":0,"backend":"OCA\\user_ldap\\USER_LDAP"},{"name":"71CDF45B-E125-450D-983C-D9192F36EC88","displayname":"admin","groups":[],"subadmin":[],"quota":"default","storageLocation":"\/Users\/lreschke\/Programming\/core\/data\/71CDF45B-E125-450D-983C-D9192F36EC88","lastLogin":0,"backend":"OCA\\user_ldap\\USER_LDAP"},{"name":"admin","displayname":"admin","groups":["admin"],"subadmin":[],"quota":"default","storageLocation":"\/Users\/lreschke\/Programming\/core\/data\/admin","lastLogin":"1418057287","backend":"OC_User_Database"},{"name":"test","displayname":"test","groups":[],"subadmin":[],"quota":"default","storageLocation":"\/Users\/lreschke\/Programming\/core\/data\/test","lastLogin":0,"backend":"OC_User_Database"}]
```
2014-12-08 22:38:54 +01:00
|
|
|
*/
|
|
|
|
public function getBackendClassName();
|
|
|
|
|
2018-10-11 21:55:42 +02:00
|
|
|
/**
|
|
|
|
* Get the backend for the current user object
|
|
|
|
*
|
|
|
|
* @since 15.0.0
|
|
|
|
*/
|
|
|
|
public function getBackend();
|
|
|
|
|
2014-07-09 15:32:33 +02:00
|
|
|
/**
|
|
|
|
* check if the backend allows the user to change his avatar on Personal page
|
|
|
|
*
|
|
|
|
* @return bool
|
2015-04-16 17:00:08 +02:00
|
|
|
* @since 8.0.0
|
2014-07-09 15:32:33 +02:00
|
|
|
*/
|
|
|
|
public function canChangeAvatar();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* check if the backend supports changing passwords
|
|
|
|
*
|
|
|
|
* @return bool
|
2015-06-19 10:51:36 +02:00
|
|
|
* @since 8.0.0
|
2014-07-09 15:32:33 +02:00
|
|
|
*/
|
|
|
|
public function canChangePassword();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* check if the backend supports changing display names
|
|
|
|
*
|
|
|
|
* @return bool
|
2015-04-16 17:00:08 +02:00
|
|
|
* @since 8.0.0
|
2014-07-09 15:32:33 +02:00
|
|
|
*/
|
|
|
|
public function canChangeDisplayName();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* check if the user is enabled
|
|
|
|
*
|
|
|
|
* @return bool
|
2015-04-16 17:00:08 +02:00
|
|
|
* @since 8.0.0
|
2014-07-09 15:32:33 +02:00
|
|
|
*/
|
|
|
|
public function isEnabled();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* set the enabled status for the user
|
|
|
|
*
|
|
|
|
* @param bool $enabled
|
2015-04-16 17:00:08 +02:00
|
|
|
* @since 8.0.0
|
2014-07-09 15:32:33 +02:00
|
|
|
*/
|
2018-04-06 20:19:52 +02:00
|
|
|
public function setEnabled(bool $enabled = true);
|
2015-11-24 23:28:24 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* get the users email address
|
|
|
|
*
|
|
|
|
* @return string|null
|
|
|
|
* @since 9.0.0
|
|
|
|
*/
|
|
|
|
public function getEMailAddress();
|
2015-11-25 21:44:36 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* get the avatar image if it exists
|
|
|
|
*
|
|
|
|
* @param int $size
|
|
|
|
* @return IImage|null
|
|
|
|
* @since 9.0.0
|
|
|
|
*/
|
|
|
|
public function getAvatarImage($size);
|
2015-11-30 13:57:54 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* get the federation cloud id
|
|
|
|
*
|
|
|
|
* @return string
|
|
|
|
* @since 9.0.0
|
|
|
|
*/
|
|
|
|
public function getCloudId();
|
2016-01-18 20:27:43 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* set the email address of the user
|
|
|
|
*
|
|
|
|
* @param string|null $mailAddress
|
|
|
|
* @return void
|
|
|
|
* @since 9.0.0
|
|
|
|
*/
|
|
|
|
public function setEMailAddress($mailAddress);
|
2016-02-09 17:16:43 +01:00
|
|
|
|
|
|
|
/**
|
2016-02-09 17:41:04 +01:00
|
|
|
* get the users' quota in human readable form. If a specific quota is not
|
|
|
|
* set for the user, the default value is returned. If a default setting
|
|
|
|
* was not set otherwise, it is return as 'none', i.e. quota is not limited.
|
2016-02-09 17:16:43 +01:00
|
|
|
*
|
|
|
|
* @return string
|
|
|
|
* @since 9.0.0
|
|
|
|
*/
|
|
|
|
public function getQuota();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* set the users' quota
|
|
|
|
*
|
|
|
|
* @param string $quota
|
|
|
|
* @return void
|
|
|
|
* @since 9.0.0
|
|
|
|
*/
|
|
|
|
public function setQuota($quota);
|
2014-07-09 15:32:33 +02:00
|
|
|
}
|