nextcloud/lib/public/User.php

159 lines
4.9 KiB
PHP
Raw Normal View History

2012-05-01 11:39:12 +04:00
<?php
/**
2016-07-21 18:07:57 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
2015-03-26 13:44:34 +03:00
* @author Bart Visscher <bartv@thisnet.nl>
2016-05-26 20:56:05 +03:00
* @author Björn Schießle <bjoern@schiessle.org>
* @author Frank Karlitschek <frank@karlitschek.de>
2015-03-26 13:44:34 +03:00
* @author Georg Ehrke <georg@owncloud.com>
2016-07-21 18:07:57 +03:00
* @author Joas Schilling <coding@schilljs.com>
2015-03-26 13:44:34 +03:00
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
* @author Lorenzo M. Catucci <lorenzo@sancho.ccd.uniroma2.it>
2016-05-26 20:56:05 +03:00
* @author Lukas Reschke <lukas@statuscode.ch>
2015-03-26 13:44:34 +03:00
* @author Morris Jobke <hey@morrisjobke.de>
2016-01-12 17:02:16 +03:00
* @author Robin McCorkell <robin@mccorkell.me.uk>
2015-03-26 13:44:34 +03:00
* @author Thomas Müller <thomas.mueller@tmit.eu>
*
2015-03-26 13:44:34 +03:00
* @license AGPL-3.0
*
2015-03-26 13:44:34 +03:00
* 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.
*
2015-03-26 13:44:34 +03:00
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
2015-03-26 13:44:34 +03:00
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
2015-03-26 13:44:34 +03:00
* 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/>
*
*/
/**
* Public interface of ownCloud for apps to use.
* User Class
*
*/
2012-08-29 10:38:33 +04:00
// use OCP namespace for all classes that are considered public.
2012-05-01 11:39:12 +04:00
// This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP;
2012-05-19 12:36:57 +04:00
/**
2013-02-11 20:44:02 +04:00
* This class provides access to the user management. You can get information
* about the currently logged in user and the permissions for example
* @since 5.0.0
2012-05-19 12:36:57 +04:00
*/
2012-05-01 11:39:12 +04:00
class User {
/**
* Get the user id of the user currently logged in.
2012-05-01 11:39:12 +04:00
* @return string uid or false
2015-04-19 02:04:59 +03:00
* @deprecated 8.0.0 Use \OC::$server->getUserSession()->getUser()->getUID()
* @since 5.0.0
2012-05-01 11:39:12 +04:00
*/
2012-09-07 17:22:01 +04:00
public static function getUser() {
return \OC_User::getUser();
2012-05-01 11:39:12 +04:00
}
2012-05-04 13:13:07 +04:00
/**
* Get a list of all users
* @param string $search search pattern
* @param int|null $limit
* @param int|null $offset
2014-05-11 21:13:51 +04:00
* @return array an array of all uids
* @deprecated 8.1.0 use method search() of \OCP\IUserManager - \OC::$server->getUserManager()
* @since 5.0.0
2012-05-04 13:13:07 +04:00
*/
public static function getUsers( $search = '', $limit = null, $offset = null ) {
return \OC_User::getUsers( $search, $limit, $offset );
2012-05-04 13:13:07 +04:00
}
2013-02-22 20:21:57 +04:00
/**
* Get the user display name of the user currently logged in.
* @param string|null $user user id or null for current user
2013-02-22 20:21:57 +04:00
* @return string display name
* @deprecated 8.1.0 fetch \OCP\IUser (has getDisplayName()) by using method
* get() of \OCP\IUserManager - \OC::$server->getUserManager()
* @since 5.0.0
2013-02-22 20:21:57 +04:00
*/
public static function getDisplayName( $user = null ) {
return \OC_User::getDisplayName( $user );
}
2013-02-22 20:21:57 +04:00
/**
* Get a list of all display names and user ids.
* @param string $search search pattern
* @param int|null $limit
* @param int|null $offset
2014-05-11 21:13:51 +04:00
* @return array an array of all display names (value) and the correspondig uids (key)
* @deprecated 8.1.0 use method searchDisplayName() of \OCP\IUserManager - \OC::$server->getUserManager()
* @since 5.0.0
* @suppressed PhanDeprecatedFunction
2013-02-22 20:21:57 +04:00
*/
public static function getDisplayNames( $search = '', $limit = null, $offset = null ) {
return \OC_User::getDisplayNames( $search, $limit, $offset );
2013-01-25 14:05:00 +04:00
}
2013-02-22 20:21:57 +04:00
2012-05-01 11:39:12 +04:00
/**
* Check if the user is logged in
* @return boolean
* @since 5.0.0
2012-05-01 11:39:12 +04:00
*/
2012-09-07 17:22:01 +04:00
public static function isLoggedIn() {
return \OC::$server->getUserSession()->isLoggedIn();
2012-05-01 11:39:12 +04:00
}
2012-05-01 23:07:08 +04:00
/**
* Check if a user exists
2012-05-01 23:07:08 +04:00
* @param string $uid the username
2013-01-14 23:30:39 +04:00
* @param string $excludingBackend (default none)
2012-05-01 23:07:08 +04:00
* @return boolean
* @deprecated 8.1.0 use method userExists() of \OCP\IUserManager - \OC::$server->getUserManager()
* @since 5.0.0
2012-05-01 23:07:08 +04:00
*/
public static function userExists($uid, $excludingBackend = null) {
return \OC_User::userExists($uid);
2012-05-01 23:07:08 +04:00
}
/**
* Logs the user out including all the session data
2012-05-01 23:07:08 +04:00
* Logout, destroys session
2015-04-19 02:04:59 +03:00
* @deprecated 8.0.0 Use \OC::$server->getUserSession()->logout();
* @since 5.0.0
2012-05-01 23:07:08 +04:00
*/
2012-09-07 17:22:01 +04:00
public static function logout() {
\OC::$server->getUserSession()->logout();
2012-05-01 23:07:08 +04:00
}
/**
* Check if the password is correct
* @param string $uid The username
* @param string $password The password
* @return string|false username on success, false otherwise
2012-05-01 23:07:08 +04:00
*
* Check if the password is correct without logging in the user
2015-04-19 02:04:59 +03:00
* @deprecated 8.0.0 Use \OC::$server->getUserManager()->checkPassword();
* @since 5.0.0
2012-05-01 23:07:08 +04:00
*/
2012-09-07 17:22:01 +04:00
public static function checkPassword( $uid, $password ) {
return \OC_User::checkPassword( $uid, $password );
2012-05-01 23:07:08 +04:00
}
2012-05-01 11:39:12 +04:00
2012-09-08 18:17:01 +04:00
/**
* Check if the user is a admin, redirects to home if not
* @since 5.0.0
*/
2012-09-08 18:17:01 +04:00
public static function checkAdminUser() {
\OC_Util::checkAdminUser();
}
2012-09-08 18:17:01 +04:00
/**
* Check if the user is logged in, redirects to home if not. With
* redirect URL parameter to the request URI.
* @since 5.0.0
*/
2012-09-08 18:17:01 +04:00
public static function checkLoggedIn() {
\OC_Util::checkLoggedIn();
}
2012-05-01 23:07:08 +04:00
}