owncloud/core

View on GitHub
lib/public/AppFramework/IAppContainer.php

Summary

Maintainability
A
0 mins
Test Coverage
<?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) 2018, ownCloud GmbH
 * @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\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
     */
    public function getAppName();

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

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

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

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

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

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

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