diff --git a/lib/public/Search/SearchResultEntry.php b/lib/public/Search/SearchResultEntry.php index b661ced5014d9666f2914eb78a7a114aa38dba99..347c3fcd28992da430d8860755f3c251ceda4754 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<string, string> + * @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, ]; } }