IBootContext.php 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright 2020 Christoph Wurst <christoph@winzerhof-wurst.at>
  5. *
  6. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  7. * @author Morris Jobke <hey@morrisjobke.de>
  8. *
  9. * @license GNU AGPL version 3 or any later version
  10. *
  11. * This program is free software: you can redistribute it and/or modify
  12. * it under the terms of the GNU Affero General Public License as
  13. * published by the Free Software Foundation, either version 3 of the
  14. * License, or (at your option) any later version.
  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
  22. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23. *
  24. */
  25. namespace OCP\AppFramework\Bootstrap;
  26. use OCP\AppFramework\IAppContainer;
  27. use OCP\IServerContainer;
  28. use Psr\Container\ContainerExceptionInterface;
  29. use Throwable;
  30. /**
  31. * @since 20.0.0
  32. */
  33. interface IBootContext {
  34. /**
  35. * Get hold of the app's container
  36. *
  37. * Useful to register and query app-specific services
  38. *
  39. * @return IAppContainer
  40. * @since 20.0.0
  41. */
  42. public function getAppContainer(): IAppContainer;
  43. /**
  44. * Get hold of the server DI container
  45. *
  46. * Useful to register and query system-wide services
  47. *
  48. * @return IServerContainer
  49. * @since 20.0.0
  50. */
  51. public function getServerContainer(): IServerContainer;
  52. /**
  53. * Invoke the given callable and inject all parameters based on their types
  54. * and names
  55. *
  56. * Note: when used with methods, make sure they are public or use \Closure::fromCallable
  57. * to wrap the private method call, e.g.
  58. * * `$context->injectFn([$obj, 'publicMethod'])`
  59. * * `$context->injectFn([$this, 'publicMethod'])`
  60. * * `$context->injectFn(\Closure::fromCallable([$this, 'privateMethod']))`
  61. *
  62. * Note: the app container will be queried
  63. *
  64. * @param callable $fn
  65. * @throws ContainerExceptionInterface if at least one of the parameter can't be resolved
  66. * @throws Throwable any error the function invocation might cause
  67. * @return mixed|null the return value of the invoked function, if any
  68. * @since 20.0.0
  69. */
  70. public function injectFn(callable $fn);
  71. }