Merge pull request #55993 from nextcloud/fix/direct-editing-interface

fix(DirectEditing): expose already used methods on the public interface

Author: AndyScherzinger

build/psalm-baseline.xml

@@ -1449,12 +1449,8 @@
     </DeprecatedMethod>
   </file>
   <file src="apps/files/lib/Controller/DirectEditingController.php">
-    <InvalidArgument>
-      <code><![CDATA[$templateId]]></code>
-    </InvalidArgument>
     <UndefinedInterfaceMethod>
       <code><![CDATA[getTemplates]]></code>
-      <code><![CDATA[open]]></code>
     </UndefinedInterfaceMethod>
   </file>
   <file src="apps/files/lib/Controller/ViewController.php">

lib/private/DirectEditing/Manager.php

@@ -125,6 +125,7 @@ public function create(string $path, string $editorId, string $creatorId, $templ
 		throw new \RuntimeException('No creator found');
 	}
 
+	#[\Override]
 	public function open(string $filePath, ?string $editorId = null, ?int $fileId = null): string {
 		$userFolder = $this->rootFolder->getUserFolder($this->userId);
 		$file = $userFolder->get($filePath);

lib/private/DirectEditing/Token.php

@@ -35,6 +35,7 @@ public function getFile(): File {
 		return $this->manager->getFileForToken($this->data['user_id'], $this->data['file_id'], $this->data['file_path']);
 	}
 
+	#[\Override]
 	public function getToken(): string {
 		return $this->data['token'];
 	}

lib/public/DirectEditing/IManager.php

@@ -23,39 +23,38 @@ interface IManager {
 	 * Register a new editor
 	 *
 	 * @since 18.0.0
-	 * @param IEditor $directEditor
 	 */
 	public function registerDirectEditor(IEditor $directEditor): void;
 
 	/**
 	 * Open the editing page for a provided token
 	 *
 	 * @since 18.0.0
-	 * @param string $token
-	 * @return Response
 	 */
 	public function edit(string $token): Response;
 
 	/**
-	 * Create a new token based on the file path and editor details
+	 * Create a file and generate a token based on the file path and editor details
 	 *
 	 * @since 18.0.0
-	 * @param string $path
-	 * @param string $editorId
-	 * @param string $creatorId
-	 * @param null $templateId
-	 * @return string
 	 * @throws NotPermittedException
 	 * @throws RuntimeException
 	 */
 	public function create(string $path, string $editorId, string $creatorId, $templateId = null): string;
 
+	/**
+	 * Create a token based on an existing file path and editor details
+	 *
+	 * @since 35.0.0
+	 * @throws NotPermittedException
+	 * @throws RuntimeException
+	 */
+	public function open(string $filePath, ?string $editorId = null, ?int $fileId = null): string;
+
 	/**
 	 * Get the token details for a given token
 	 *
 	 * @since 18.0.0
-	 * @param string $token
-	 * @return IToken
 	 */
 	public function getToken(string $token): IToken;
 
@@ -71,7 +70,6 @@ public function cleanup(): int;
 	 * Check if direct editing is enabled
 	 *
 	 * @since 20.0.0
-	 * @return bool
 	 */
 	public function isEnabled(): bool;
 

lib/public/DirectEditing/IToken.php

@@ -32,7 +32,6 @@ public function invalidate(): void;
 	 * Check if the token has already been used
 	 *
 	 * @since 18.0.0
-	 * @return bool
 	 */
 	public function hasBeenAccessed(): bool;
 
@@ -47,20 +46,22 @@ public function useTokenScope(): void;
 	 * Get the file that is related to the token
 	 *
 	 * @since 18.0.0
-	 * @return File
 	 * @throws NotFoundException
 	 */
 	public function getFile(): File;
 
 	/**
 	 * @since 18.0.0
-	 * @return string
 	 */
 	public function getEditor(): string;
 
 	/**
 	 * @since 18.0.0
-	 * @return string
 	 */
 	public function getUser(): string;
+
+	/**
+	 * @since 35.0.0
+	 */
+	public function getToken(): string;
 }