Improve typing for fopen/toTmpFile

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>
nextcloud · Mar 13, 2023 · 73a0066 · 73a0066
1 parent 09f371b
commit 73a0066
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 5 deletions.
diff --git a/lib/private/Files/Filesystem.php b/lib/private/Files/Filesystem.php
@@ -390,7 +390,7 @@ public static function tearDown() {
 	/**
 	 * get the relative path of the root data directory for the current user
 	 *
-	 * @return string
+	 * @return ?string
 	 *
 	 * Returns path like /admin/files
 	 */
@@ -584,9 +584,10 @@ public static function fopen($path, $mode) {
 	}
 
 	/**
-	 * @return string
+	 * @param string $path
+	 * @throws \OCP\Files\InvalidPathException
 	 */
-	public static function toTmpFile($path) {
+	public static function toTmpFile($path): string|false {
 		return self::$defaultInstance->toTmpFile($path);
 	}
 

diff --git a/lib/private/Files/Node/File.php b/lib/private/Files/Node/File.php
@@ -80,7 +80,7 @@ public function putContent($data) {
 
 	/**
 	 * @param string $mode
-	 * @return resource
+	 * @return resource|false
 	 * @throws NotPermittedException
 	 * @throws LockedException
 	 */

diff --git a/lib/public/Files/File.php b/lib/public/Files/File.php
@@ -68,7 +68,7 @@ public function getMimeType();
 	 * Open the file as stream, resulting resource can be operated as stream like the result from php's own fopen
 	 *
 	 * @param string $mode
-	 * @return resource
+	 * @return resource|false
 	 * @throws NotPermittedException
 	 * @throws LockedException
 	 * @since 6.0.0