Improve container return type annotations

Signed-off-by: Julius Härtl <jus@bitgrid.net>
nextcloud · Jul 28, 2022 · a48f05f · a48f05f
1 parent 97e88f3
commit a48f05f
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 3 deletions.
diff --git a/lib/private/AppFramework/Utility/SimpleContainer.php b/lib/private/AppFramework/Utility/SimpleContainer.php
@@ -34,6 +34,7 @@
 use OCP\AppFramework\QueryException;
 use OCP\IContainer;
 use Pimple\Container;
+use Psr\Container\ContainerExceptionInterface;
 use Psr\Container\ContainerInterface;
 use ReflectionClass;
 use ReflectionException;
@@ -53,6 +54,16 @@ public function __construct() {
 		$this->container = new Container();
 	}
 
+	/**
+	 * @template T
+	 * @param class-string<T>|string $id
+	 * @return T|mixed
+	 * @psalm-template S as class-string<T>|string
+	 * @psalm-param S $id
+	 * @psalm-return (S is class-string<T> ? T : mixed)
+	 * @throws QueryException
+	 * @throws ContainerExceptionInterface
+	 */
 	public function get(string $id) {
 		return $this->query($id);
 	}

diff --git a/lib/private/ServerContainer.php b/lib/private/ServerContainer.php
@@ -30,6 +30,7 @@
 use OC\AppFramework\DependencyInjection\DIContainer;
 use OC\AppFramework\Utility\SimpleContainer;
 use OCP\AppFramework\QueryException;
+use Psr\Container\ContainerExceptionInterface;
 use function explode;
 use function strtolower;
 
@@ -127,6 +128,14 @@ public function has($id, bool $noRecursion = false): bool {
 	}
 
 	/**
+	 * @template T
+	 * @param class-string<T>|string $name
+	 * @return T|mixed
+	 * @psalm-template S as class-string<T>|string
+	 * @psalm-param S $name
+	 * @psalm-return (S is class-string<T> ? T : mixed)
+	 * @throws QueryException
+	 * @throws ContainerExceptionInterface
 	 * @deprecated 20.0.0 use \Psr\Container\ContainerInterface::get
 	 */
 	public function query(string $name, bool $autoload = true) {

diff --git a/lib/public/Server.php b/lib/public/Server.php
@@ -41,9 +41,11 @@
 final class Server {
 	/**
 	 * @template T
-	 * @template S as class-string<T>|string
-	 * @param S $serviceName
-	 * @return (S is class-string<T> ? T : mixed)
+	 * @param class-string<T>|string $serviceName
+	 * @return T|mixed
+	 * @psalm-template S as class-string<T>|string
+	 * @psalm-param S $serviceName
+	 * @psalm-return (S is class-string<T> ? T : mixed)
 	 * @throws ContainerExceptionInterface
 	 * @throws NotFoundExceptionInterface
 	 * @since 25.0.0