summaryrefslogtreecommitdiffstats
path: root/lib/public/appframework/iappcontainer.php
blob: 1cc0daf68adf583cec29f4655dcaf1fb6594127e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
<?php
/**
 * @author Bernhard Posselt <dev@bernhard-posselt.com>
 * @author Jörn Friedrich Dreyer <jfd@butonic.de>
 * @author Morris Jobke <hey@morrisjobke.de>
 * @author Roeland Jago Douma <rullzer@owncloud.com>
 * @author Thomas Müller <thomas.mueller@tmit.eu>
 *
 * @copyright Copyright (c) 2015, ownCloud, Inc.
 * @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/>
 *
 */

namespace OCP\AppFramework;

use OCP\AppFramework\IApi;
use OCP\IContainer;

/**
 * Class IAppContainer
 * @package OCP\AppFramework
 *
 * This container interface provides short cuts for app developers to access predefined app service.
 * @since 6.0.0
 */
interface IAppContainer extends IContainer {

	/**
	 * used to return the appname of the set application
	 * @return string the name of your application
	 * @since 6.0.0
	 */
	function getAppName();

	/**
	 * @deprecated 8.0.0 implements only deprecated methods
	 * @return IApi
	 * @since 6.0.0
	 */
	function getCoreApi();

	/**
	 * @return \OCP\IServerContainer
	 * @since 6.0.0
	 */
	function getServer();

	/**
	 * @param string $middleWare
	 * @return boolean
	 * @since 6.0.0
	 */
	function registerMiddleWare($middleWare);

	/**
	 * @deprecated 8.0.0 use IUserSession->isLoggedIn()
	 * @return boolean
	 * @since 6.0.0
	 */
	function isLoggedIn();

	/**
	 * @deprecated 8.0.0 use IGroupManager->isAdmin($userId)
	 * @return boolean
	 * @since 6.0.0
	 */
	function isAdminUser();

	/**
	 * @deprecated 8.0.0 use the ILogger instead
	 * @param string $message
	 * @param string $level
	 * @return mixed
	 * @since 6.0.0
	 */
	function log($message, $level);

	/**
	 * Register a capability
	 *
	 * @param string $serviceName e.g. 'OCA\Files\Capabilities'
	 * @since 8.2.0
	 */
	 public function registerCapability($serviceName);
}