fix(autocomplete): Move known array keys to psalm docs

Signed-off-by: Joas Schilling <coding@schilljs.com>
nextcloud · Sep 18, 2024 · 0af0bf3 · 0af0bf3
1 parent 13fce9f
commit 0af0bf3
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/apps/files_sharing/tests/Collaboration/ShareRecipientSorterTest.php b/apps/files_sharing/tests/Collaboration/ShareRecipientSorterTest.php
@@ -109,7 +109,7 @@ public function testSortNoNodes(): void {
 			]
 		];
 		$workArray = $originalArray;
-		$this->sorter->sort($workArray, ['itemType' => 'files', 'itemId' => 404]);
+		$this->sorter->sort($workArray, ['itemType' => 'files', 'itemId' => '404']);
 
 		$this->assertEquals($originalArray, $workArray);
 	}
@@ -118,7 +118,7 @@ public function sortDataProvider() {
 		return [[
 			[
 				#0 – sort properly and otherwise keep existing order
-				'context' => ['itemType' => 'files', 'itemId' => 42],
+				'context' => ['itemType' => 'files', 'itemId' => '42'],
 				'accessList' => ['users' => ['celia', 'darius', 'faruk', 'gail'], 'bots' => ['r2-d2']],
 				'input' => [
 					'users' =>
@@ -155,7 +155,7 @@ public function sortDataProvider() {
 			],
 			[
 				#1 – no recipients
-				'context' => ['itemType' => 'files', 'itemId' => 42],
+				'context' => ['itemType' => 'files', 'itemId' => '42'],
 				'accessList' => ['users' => false],
 				'input' => [
 					'users' =>
@@ -192,7 +192,7 @@ public function sortDataProvider() {
 			],
 			[
 				#2 – unsupported item  type
-				'context' => ['itemType' => 'announcements', 'itemId' => 42],
+				'context' => ['itemType' => 'announcements', 'itemId' => '42'],
 				'accessList' => null, // not needed
 				'input' => [
 					'users' =>
@@ -229,7 +229,7 @@ public function sortDataProvider() {
 			],
 			[
 				#3 – no nothing
-				'context' => ['itemType' => 'files', 'itemId' => 42],
+				'context' => ['itemType' => 'files', 'itemId' => '42'],
 				'accessList' => [],
 				'input' => [],
 				'expected' => [],

diff --git a/lib/public/Collaboration/AutoComplete/IManager.php b/lib/public/Collaboration/AutoComplete/IManager.php
@@ -20,7 +20,7 @@ public function registerSorter($className);
 	/**
 	 * @param array $sorters list of sorter IDs, separated by "|"
 	 * @param array $sortArray array representation of OCP\Collaboration\Collaborators\ISearchResult
-	 * @param array $context context info of the search, keys: itemType, itemId
+	 * @param array{itemType: string, itemId: string, search?: string} $context context info of the search
 	 * @since 13.0.0
 	 */
 	public function runSorters(array $sorters, array &$sortArray, array $context);

diff --git a/lib/public/Collaboration/AutoComplete/ISorter.php b/lib/public/Collaboration/AutoComplete/ISorter.php
@@ -23,7 +23,7 @@ public function getId();
 	 * executes the sort action
 	 *
 	 * @param array $sortArray the array to be sorted, provided as reference
-	 * @param array $context carries key 'itemType' and 'itemId' of the source object (e.g. a file)
+	 * @param array{itemType: string, itemId: string, search?: string} $context carries key 'itemType' and 'itemId' of the source object (e.g. a file)
 	 * @since 13.0.0
 	 */
 	public function sort(array &$sortArray, array $context);