2013-09-20 14:45:56 +04:00
|
|
|
<?php
|
|
|
|
/**
|
2013-11-03 16:51:39 +04:00
|
|
|
* ownCloud
|
|
|
|
*
|
|
|
|
* @author Bart Visscher
|
2014-12-16 21:07:14 +03:00
|
|
|
* @author Bernhard Posselt
|
2013-11-03 16:51:39 +04:00
|
|
|
* @copyright 2013 Bart Visscher bartv@thisnet.nl
|
2014-12-16 21:07:14 +03:00
|
|
|
* @copyright 2014 Bernhard Posselt <dev@bernhard-posselt.com>
|
2013-11-03 16:51:39 +04:00
|
|
|
*
|
|
|
|
* 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/>.
|
2013-10-31 22:00:53 +04:00
|
|
|
*
|
2013-09-20 14:45:56 +04:00
|
|
|
*/
|
|
|
|
|
2013-11-03 16:38:25 +04:00
|
|
|
/**
|
|
|
|
* Public interface of ownCloud for apps to use.
|
|
|
|
* User session interface
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
// 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
|
2013-09-20 14:45:56 +04:00
|
|
|
namespace OCP;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* User session
|
|
|
|
*/
|
|
|
|
interface IUserSession {
|
|
|
|
/**
|
|
|
|
* Do a user login
|
|
|
|
* @param string $user the username
|
|
|
|
* @param string $password the password
|
|
|
|
* @return bool true if successful
|
|
|
|
*/
|
|
|
|
public function login($user, $password);
|
|
|
|
|
|
|
|
/**
|
2013-10-31 22:00:53 +04:00
|
|
|
* Logs the user out including all the session data
|
2013-09-20 14:45:56 +04:00
|
|
|
* Logout, destroys session
|
2014-02-06 19:30:58 +04:00
|
|
|
* @return void
|
2013-09-20 14:45:56 +04:00
|
|
|
*/
|
|
|
|
public function logout();
|
|
|
|
|
2014-07-09 17:32:33 +04:00
|
|
|
/**
|
|
|
|
* set the currently active user
|
|
|
|
*
|
2014-07-15 19:41:44 +04:00
|
|
|
* @param \OCP\IUser|null $user
|
2014-07-09 17:32:33 +04:00
|
|
|
*/
|
|
|
|
public function setUser($user);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* get the current active user
|
|
|
|
*
|
2014-12-19 16:14:38 +03:00
|
|
|
* @return \OCP\IUser|null Current user, otherwise null
|
2014-07-09 17:32:33 +04:00
|
|
|
*/
|
|
|
|
public function getUser();
|
2014-12-16 21:07:14 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Checks wether the user is logged in
|
|
|
|
*
|
|
|
|
* @return bool if logged in
|
|
|
|
*/
|
|
|
|
public function isLoggedIn();
|
2013-09-20 14:45:56 +04:00
|
|
|
}
|