125 lines
3.9 KiB
PHP
125 lines
3.9 KiB
PHP
<?php
|
|
/**
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
*
|
|
* @author Bart Visscher <bartv@thisnet.nl>
|
|
* @author Björn Schießle <bjoern@schiessle.org>
|
|
* @author Frank Karlitschek <frank@karlitschek.de>
|
|
* @author Georg Ehrke <oc.list@georgehrke.com>
|
|
* @author Joas Schilling <coding@schilljs.com>
|
|
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
|
|
* @author Lukas Reschke <lukas@statuscode.ch>
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
* @author Robin McCorkell <robin@mccorkell.me.uk>
|
|
* @author Sebastian Wessalowski <sebastian@wessalowski.org>
|
|
* @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/>
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* Public interface of ownCloud for apps to use.
|
|
* User Class
|
|
*
|
|
*/
|
|
|
|
// use OCP namespace for all classes that are considered public.
|
|
// This means that they should be used by apps instead of the internal ownCloud classes
|
|
namespace OCP;
|
|
|
|
/**
|
|
* 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
|
|
* @deprecated 13.0.0
|
|
*/
|
|
class User {
|
|
/**
|
|
* Get the user id of the user currently logged in.
|
|
* @return string uid or false
|
|
* @deprecated 8.0.0 Use \OC::$server->getUserSession()->getUser()->getUID()
|
|
* @since 5.0.0
|
|
*/
|
|
public static function getUser() {
|
|
return \OC_User::getUser();
|
|
}
|
|
|
|
/**
|
|
* Get a list of all users
|
|
* @param string $search search pattern
|
|
* @param int|null $limit
|
|
* @param int|null $offset
|
|
* @return array an array of all uids
|
|
* @deprecated 8.1.0 use method search() of \OCP\IUserManager - \OC::$server->getUserManager()
|
|
* @since 5.0.0
|
|
*/
|
|
public static function getUsers( $search = '', $limit = null, $offset = null ) {
|
|
return \OC_User::getUsers( $search, $limit, $offset );
|
|
}
|
|
|
|
/**
|
|
* Get the user display name of the user currently logged in.
|
|
* @param string|null $user user id or null for current user
|
|
* @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
|
|
*/
|
|
public static function getDisplayName( $user = null ) {
|
|
return \OC_User::getDisplayName( $user );
|
|
}
|
|
|
|
/**
|
|
* Check if the user is logged in
|
|
* @return boolean
|
|
* @since 5.0.0
|
|
* @deprecated 13.0.0 Use annotation based ACLs from the AppFramework instead
|
|
*/
|
|
public static function isLoggedIn() {
|
|
return \OC::$server->getUserSession()->isLoggedIn();
|
|
}
|
|
|
|
/**
|
|
* Check if a user exists
|
|
* @param string $uid the username
|
|
* @param string $excludingBackend (default none)
|
|
* @return boolean
|
|
* @deprecated 8.1.0 use method userExists() of \OCP\IUserManager - \OC::$server->getUserManager()
|
|
* @since 5.0.0
|
|
*/
|
|
public static function userExists($uid, $excludingBackend = null) {
|
|
return \OC::$server->getUserManager()->userExists($uid);
|
|
}
|
|
|
|
/**
|
|
* Check if the user is a admin, redirects to home if not
|
|
* @since 5.0.0
|
|
* @deprecated 13.0.0 Use annotation based ACLs from the AppFramework instead
|
|
*/
|
|
public static function checkAdminUser() {
|
|
\OC_Util::checkAdminUser();
|
|
}
|
|
|
|
/**
|
|
* Check if the user is logged in, redirects to home if not. With
|
|
* redirect URL parameter to the request URI.
|
|
* @since 5.0.0
|
|
* @deprecated 13.0.0 Use annotation based ACLs from the AppFramework instead
|
|
*/
|
|
public static function checkLoggedIn() {
|
|
\OC_Util::checkLoggedIn();
|
|
}
|
|
}
|