IAppContainer.php 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016, ownCloud, Inc.
  4. *
  5. * @author Bernhard Posselt <dev@bernhard-posselt.com>
  6. * @author Morris Jobke <hey@morrisjobke.de>
  7. * @author Roeland Jago Douma <roeland@famdouma.nl>
  8. * @author Thomas Müller <thomas.mueller@tmit.eu>
  9. *
  10. * @license AGPL-3.0
  11. *
  12. * This code is free software: you can redistribute it and/or modify
  13. * it under the terms of the GNU Affero General Public License, version 3,
  14. * as published by the Free Software Foundation.
  15. *
  16. * This program is distributed in the hope that it will be useful,
  17. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. * GNU Affero General Public License for more details.
  20. *
  21. * You should have received a copy of the GNU Affero General Public License, version 3,
  22. * along with this program. If not, see <http://www.gnu.org/licenses/>
  23. *
  24. */
  25. namespace OCP\AppFramework;
  26. use OCP\IContainer;
  27. /**
  28. * Class IAppContainer
  29. * @package OCP\AppFramework
  30. *
  31. * This container interface provides short cuts for app developers to access predefined app service.
  32. * @since 6.0.0
  33. */
  34. interface IAppContainer extends IContainer {
  35. /**
  36. * used to return the appname of the set application
  37. * @return string the name of your application
  38. * @since 6.0.0
  39. */
  40. public function getAppName();
  41. /**
  42. * @return \OCP\IServerContainer
  43. * @since 6.0.0
  44. */
  45. public function getServer();
  46. /**
  47. * @param string $middleWare
  48. * @return boolean
  49. * @since 6.0.0
  50. */
  51. public function registerMiddleWare($middleWare);
  52. /**
  53. * Register a capability
  54. *
  55. * @param string $serviceName e.g. 'OCA\Files\Capabilities'
  56. * @since 8.2.0
  57. */
  58. public function registerCapability($serviceName);
  59. }