From cc92d5a293e85a8d67ed30e48bcad09fc03325f5 Mon Sep 17 00:00:00 2001 From: Christoph Wurst Date: Tue, 1 Dec 2020 11:37:39 +0100 Subject: [PATCH 1/2] Allow unified search results to have attributes Signed-off-by: Christoph Wurst --- lib/public/Search/SearchResultEntry.php | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/lib/public/Search/SearchResultEntry.php b/lib/public/Search/SearchResultEntry.php index b661ced5014..347c3fcd289 100644 --- a/lib/public/Search/SearchResultEntry.php +++ b/lib/public/Search/SearchResultEntry.php @@ -82,6 +82,13 @@ class SearchResultEntry implements JsonSerializable { */ protected $rounded; + /** + * @var string[] + * @psalm-var array + * @since 20.0.0 + */ + protected $attributes = []; + /** * @param string $thumbnailUrl a relative or absolute URL to the thumbnail or icon of the entry * @param string $title a main title of the entry @@ -106,6 +113,19 @@ class SearchResultEntry implements JsonSerializable { $this->rounded = $rounded; } + /** + * Add optional attributes to the result entry, e.g. an ID or some other + * context information that can be read by the client application + * + * @param string $key + * @param string $value + * + * @since 20.0.0 + */ + public function addAttribute(string $key, string $value): void { + $this->attributes[$key] = $value; + } + /** * @return array * @@ -119,6 +139,7 @@ class SearchResultEntry implements JsonSerializable { 'resourceUrl' => $this->resourceUrl, 'icon' => $this->icon, 'rounded' => $this->rounded, + 'attributes' => $this->attributes, ]; } } From 885dabb761c283be61ea4dd96e04146c98c02d1c Mon Sep 17 00:00:00 2001 From: Christoph Wurst Date: Wed, 2 Dec 2020 14:26:48 +0100 Subject: [PATCH 2/2] Add attributes to file search results Signed-off-by: Christoph Wurst --- apps/files/lib/Search/FilesSearchProvider.php | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/apps/files/lib/Search/FilesSearchProvider.php b/apps/files/lib/Search/FilesSearchProvider.php index 5c97e771ab7..a3c6120ef13 100644 --- a/apps/files/lib/Search/FilesSearchProvider.php +++ b/apps/files/lib/Search/FilesSearchProvider.php @@ -110,13 +110,16 @@ class FilesSearchProvider implements IProvider { ? $this->urlGenerator->linkToRouteAbsolute('core.Preview.getPreviewByFileId', ['x' => 32, 'y' => 32, 'fileId' => $result->id]) : ''; - return new SearchResultEntry( + $searchResultEntry = new SearchResultEntry( $thumbnailUrl, $result->name, $this->formatSubline($result), $this->urlGenerator->getAbsoluteURL($result->link), $result->type === 'folder' ? 'icon-folder' : $this->mimeTypeDetector->mimeTypeIcon($result->mime_type) ); + $searchResultEntry->addAttribute('fileId', (string)$result->id); + $searchResultEntry->addAttribute('path', $result->path); + return $searchResultEntry; }, $this->fileSearch->search($query->getTerm())) ); }