summaryrefslogtreecommitdiffstats
path: root/lib/public/appframework/iappcontainer.php
blob: a0b0c06881a856fdd88d7f8b055670de1dc16946 (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
<?php
/**
 * ownCloud
 *
 * @author Thomas Müller
 * @copyright 2013 Thomas Müller deepdiver@owncloud.com
 *
 * 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/>.
 *
 */

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.
 */
interface IAppContainer extends IContainer{

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

	/**
	 * @return IApi
	 */
	function getCoreApi();

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

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

	/**
	 * @return boolean
	 */
	function isLoggedIn();

	/**
	 * @return boolean
	 */
	function isAdminUser();

	/**
	 * @param string $message
	 * @param string $level
	 * @return mixed
	 */
	function log($message, $level);

}