aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/AppFramework/Bootstrap/IBootContext.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/AppFramework/Bootstrap/IBootContext.php')
-rw-r--r--lib/public/AppFramework/Bootstrap/IBootContext.php59
1 files changed, 59 insertions, 0 deletions
diff --git a/lib/public/AppFramework/Bootstrap/IBootContext.php b/lib/public/AppFramework/Bootstrap/IBootContext.php
new file mode 100644
index 00000000000..cdf3a0af732
--- /dev/null
+++ b/lib/public/AppFramework/Bootstrap/IBootContext.php
@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2020 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\AppFramework\Bootstrap;
+
+use OCP\AppFramework\IAppContainer;
+use OCP\IServerContainer;
+use Psr\Container\ContainerExceptionInterface;
+use Throwable;
+
+/**
+ * @since 20.0.0
+ */
+interface IBootContext {
+ /**
+ * Get hold of the app's container
+ *
+ * Useful to register and query app-specific services
+ *
+ * @return IAppContainer
+ * @since 20.0.0
+ */
+ public function getAppContainer(): IAppContainer;
+
+ /**
+ * Get hold of the server DI container
+ *
+ * Useful to register and query system-wide services
+ *
+ * @return IServerContainer
+ * @since 20.0.0
+ */
+ public function getServerContainer(): IServerContainer;
+
+ /**
+ * Invoke the given callable and inject all parameters based on their types
+ * and names
+ *
+ * Note: when used with methods, make sure they are public or use \Closure::fromCallable
+ * to wrap the private method call, e.g.
+ * * `$context->injectFn([$obj, 'publicMethod'])`
+ * * `$context->injectFn([$this, 'publicMethod'])`
+ * * `$context->injectFn(\Closure::fromCallable([$this, 'privateMethod']))`
+ *
+ * Note: the app container will be queried
+ *
+ * @param callable $fn
+ * @throws ContainerExceptionInterface if at least one of the parameter can't be resolved
+ * @throws Throwable any error the function invocation might cause
+ * @return mixed|null the return value of the invoked function, if any
+ * @since 20.0.0
+ */
+ public function injectFn(callable $fn);
+}