2013-08-20 23:02:15 +00:00
|
|
|
<?php
|
2013-08-30 23:41:24 +00:00
|
|
|
/**
|
2015-03-26 10:44:34 +00:00
|
|
|
* @author Bernhard Posselt <dev@bernhard-posselt.com>
|
|
|
|
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
|
|
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
2015-10-26 12:54:55 +00:00
|
|
|
* @author Roeland Jago Douma <rullzer@owncloud.com>
|
2015-03-26 10:44:34 +00:00
|
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
2013-08-30 23:41:24 +00:00
|
|
|
*
|
2016-01-12 14:02:16 +00:00
|
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
2015-03-26 10:44:34 +00:00
|
|
|
* @license AGPL-3.0
|
2013-08-30 23:41:24 +00:00
|
|
|
*
|
2015-03-26 10:44:34 +00: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.
|
2013-08-30 23:41:24 +00:00
|
|
|
*
|
2015-03-26 10:44:34 +00:00
|
|
|
* This program is distributed in the hope that it will be useful,
|
2013-08-30 23:41:24 +00:00
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
2015-03-26 10:44:34 +00:00
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU Affero General Public License for more details.
|
2013-08-30 23:41:24 +00:00
|
|
|
*
|
2015-03-26 10:44:34 +00: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/>
|
2013-08-30 23:41:24 +00:00
|
|
|
*
|
|
|
|
*/
|
2015-02-26 10:37:37 +00:00
|
|
|
|
2013-08-20 23:02:15 +00:00
|
|
|
namespace OCP\AppFramework;
|
|
|
|
|
|
|
|
use OCP\AppFramework\IApi;
|
2013-08-31 19:34:29 +00:00
|
|
|
use OCP\IContainer;
|
2013-08-20 23:02:15 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Class IAppContainer
|
|
|
|
* @package OCP\AppFramework
|
|
|
|
*
|
|
|
|
* This container interface provides short cuts for app developers to access predefined app service.
|
2015-04-16 15:00:08 +00:00
|
|
|
* @since 6.0.0
|
2013-08-20 23:02:15 +00:00
|
|
|
*/
|
2014-12-16 18:07:14 +00:00
|
|
|
interface IAppContainer extends IContainer {
|
2013-08-20 23:02:15 +00:00
|
|
|
|
2013-09-25 08:30:48 +00:00
|
|
|
/**
|
|
|
|
* used to return the appname of the set application
|
|
|
|
* @return string the name of your application
|
2015-04-16 15:00:08 +00:00
|
|
|
* @since 6.0.0
|
2013-09-25 08:30:48 +00:00
|
|
|
*/
|
|
|
|
function getAppName();
|
|
|
|
|
2013-08-20 23:02:15 +00:00
|
|
|
/**
|
2015-04-18 23:04:59 +00:00
|
|
|
* @deprecated 8.0.0 implements only deprecated methods
|
2013-08-20 23:02:15 +00:00
|
|
|
* @return IApi
|
2015-04-16 15:00:08 +00:00
|
|
|
* @since 6.0.0
|
2013-08-20 23:02:15 +00:00
|
|
|
*/
|
|
|
|
function getCoreApi();
|
|
|
|
|
|
|
|
/**
|
2013-08-31 19:34:29 +00:00
|
|
|
* @return \OCP\IServerContainer
|
2015-04-16 15:00:08 +00:00
|
|
|
* @since 6.0.0
|
2013-08-20 23:02:15 +00:00
|
|
|
*/
|
|
|
|
function getServer();
|
2013-09-25 08:30:48 +00:00
|
|
|
|
|
|
|
/**
|
2014-04-09 21:59:57 +00:00
|
|
|
* @param string $middleWare
|
2013-09-25 08:30:48 +00:00
|
|
|
* @return boolean
|
2015-04-16 15:00:08 +00:00
|
|
|
* @since 6.0.0
|
2013-09-25 08:30:48 +00:00
|
|
|
*/
|
2014-04-09 21:59:57 +00:00
|
|
|
function registerMiddleWare($middleWare);
|
2013-10-06 22:33:54 +00:00
|
|
|
|
|
|
|
/**
|
2015-04-18 23:04:59 +00:00
|
|
|
* @deprecated 8.0.0 use IUserSession->isLoggedIn()
|
2013-10-06 22:33:54 +00:00
|
|
|
* @return boolean
|
2015-04-16 15:00:08 +00:00
|
|
|
* @since 6.0.0
|
2013-10-06 22:33:54 +00:00
|
|
|
*/
|
|
|
|
function isLoggedIn();
|
|
|
|
|
|
|
|
/**
|
2015-04-18 23:04:59 +00:00
|
|
|
* @deprecated 8.0.0 use IGroupManager->isAdmin($userId)
|
2013-10-06 22:33:54 +00:00
|
|
|
* @return boolean
|
2015-04-16 15:00:08 +00:00
|
|
|
* @since 6.0.0
|
2013-10-06 22:33:54 +00:00
|
|
|
*/
|
|
|
|
function isAdminUser();
|
|
|
|
|
|
|
|
/**
|
2015-04-18 23:04:59 +00:00
|
|
|
* @deprecated 8.0.0 use the ILogger instead
|
2014-02-06 15:30:58 +00:00
|
|
|
* @param string $message
|
|
|
|
* @param string $level
|
2013-10-06 22:33:54 +00:00
|
|
|
* @return mixed
|
2015-04-16 15:00:08 +00:00
|
|
|
* @since 6.0.0
|
2013-10-06 22:33:54 +00:00
|
|
|
*/
|
|
|
|
function log($message, $level);
|
|
|
|
|
2015-07-22 11:04:56 +00:00
|
|
|
/**
|
|
|
|
* Register a capability
|
|
|
|
*
|
|
|
|
* @param string $serviceName e.g. 'OCA\Files\Capabilities'
|
|
|
|
* @since 8.2.0
|
|
|
|
*/
|
|
|
|
public function registerCapability($serviceName);
|
2013-08-20 23:02:15 +00:00
|
|
|
}
|