Move \OCP to PSR-4

1 files changed, 102 insertions, 0 deletions

diff --git a/lib/public/IContainer.php b/lib/public/IContainer.php
new file mode 100644
index 00000000000..d23ee5ea3b5
--- /dev/null
+++ b/lib/public/IContainer.php
@@ -0,0 +1,102 @@
+<?php
+/**
+ * @author Bernhard Posselt <dev@bernhard-posselt.com>
+ * @author Joas Schilling <nickvergessen@owncloud.com>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @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/>
+ *
+ */
+
+/**
+ * Public interface of ownCloud for apps to use.
+ * Container interface
+ *
+ */
+
+// use OCP namespace for all classes that are considered public.
+// This means that they should be used by apps instead of the internal ownCloud classes
+namespace OCP;
+
+use Closure;
+use OCP\AppFramework\QueryException;
+
+
+/**
+ * Class IContainer
+ *
+ * IContainer is the basic interface to be used for any internal dependency injection mechanism
+ *
+ * @package OCP
+ * @since 6.0.0
+ */
+interface IContainer {
+
+	/**
+	 * If a parameter is not registered in the container try to instantiate it
+	 * by using reflection to find out how to build the class
+	 * @param string $name the class name to resolve
+	 * @return \stdClass
+	 * @since 8.2.0
+	 * @throws QueryException if the class could not be found or instantiated
+	 */
+	public function resolve($name);
+
+	/**
+	 * Look up a service for a given name in the container.
+	 *
+	 * @param string $name
+	 * @return mixed
+	 * @since 6.0.0
+	 */
+	public function query($name);
+
+	/**
+	 * A value is stored in the container with it's corresponding name
+	 *
+	 * @param string $name
+	 * @param mixed $value
+	 * @return void
+	 * @since 6.0.0
+	 */
+	public function registerParameter($name, $value);
+
+	/**
+	 * A service is registered in the container where a closure is passed in which will actually
+	 * create the service on demand.
+	 * In case the parameter $shared is set to true (the default usage) the once created service will remain in
+	 * memory and be reused on subsequent calls.
+	 * In case the parameter is false the service will be recreated on every call.
+	 *
+	 * @param string $name
+	 * @param \Closure $closure
+	 * @param bool $shared
+	 * @return void
+	 * @since 6.0.0
+	 */
+	public function registerService($name, Closure $closure, $shared = true);
+
+	/**
+	 * Shortcut for returning a service from a service under a different key,
+	 * e.g. to tell the container to return a class when queried for an
+	 * interface
+	 * @param string $alias the alias that should be registered
+	 * @param string $target the target that should be resolved instead
+	 * @since 8.2.0
+	 */
+	public function registerAlias($alias, $target);
+}