<?php
|
|
/**
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
*
|
|
* @author Lukas Reschke <lukas@statuscode.ch>
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
|
* @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.
|
|
* Authentication/IApacheBackend 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
|
|
|
|
namespace OCP\Authentication;
|
|
|
|
/**
|
|
* Interface IApacheBackend
|
|
*
|
|
* @since 6.0.0
|
|
*/
|
|
interface IApacheBackend {
|
|
|
|
/**
|
|
* In case the user has been authenticated by a module true is returned.
|
|
*
|
|
* @return boolean whether the module reports a user as currently logged in.
|
|
* @since 6.0.0
|
|
*/
|
|
public function isSessionActive();
|
|
|
|
/**
|
|
* Gets the current logout URL
|
|
*
|
|
* @return string
|
|
* @since 12.0.3
|
|
*/
|
|
public function getLogoutUrl();
|
|
|
|
/**
|
|
* Return the id of the current user
|
|
* @return string
|
|
* @since 6.0.0
|
|
*/
|
|
public function getCurrentUserId();
|
|
}
|