diff options
Diffstat (limited to 'lib/public/AppFramework/IAppContainer.php')
-rw-r--r-- | lib/public/AppFramework/IAppContainer.php | 97 |
1 files changed, 97 insertions, 0 deletions
diff --git a/lib/public/AppFramework/IAppContainer.php b/lib/public/AppFramework/IAppContainer.php new file mode 100644 index 00000000000..905539e735e --- /dev/null +++ b/lib/public/AppFramework/IAppContainer.php @@ -0,0 +1,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) 2016, 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); +} |