nextcloud/lib/public/user.php

129 lines
3.5 KiB
PHP
Raw Normal View History

2012-05-01 11:39:12 +04:00
<?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/>.
*
*/
2012-05-01 11:39:12 +04:00
/**
* Public interface of ownCloud for apps to use.
2013-11-03 16:38:25 +04:00
* User Class
2012-05-01 11:39:12 +04:00
*
*/
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
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
*/
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 pattern
* @param int limit
* @param int offset
* @return array with all uids
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 user id or null for current user
2013-02-22 20:21:57 +04:00
* @return string display name
*/
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 pattern
* @param int limit
* @param int offset
* @return array with all display names (value) and the correspondig uids (key)
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
2012-05-01 11:39:12 +04:00
*/
2012-09-07 17:22:01 +04:00
public static function isLoggedIn() {
return \OC_User::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
*/
public static function userExists( $uid, $excludingBackend = null ) {
return \OC_User::userExists( $uid, $excludingBackend );
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
*/
2012-09-07 17:22:01 +04:00
public static function logout() {
\OC_User::logout();
2012-05-01 23:07:08 +04:00
}
/**
* Check if the password is correct
* @param string The username
* @param string The password
* @return mixed username on success, false otherwise
2012-05-01 23:07:08 +04:00
*
* Check if the password is correct without logging in the user
*/
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
*/
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.
*/
public static function checkLoggedIn() {
\OC_Util::checkLoggedIn();
}
2012-05-01 23:07:08 +04:00
}