$shareTypes Types of shares to search for * @param int $limit Maximum number of results to return * * @return DataResponse, array{}> * * 200: Autocomplete results returned */ #[NoAdminRequired] #[ApiRoute(verb: 'GET', url: '/autocomplete/get', root: '/core')] public function get(string $search, ?string $itemType, ?string $itemId, ?string $sorter = null, array $shareTypes = [IShare::TYPE_USER], int $limit = 10): DataResponse { // if enumeration/user listings are disabled, we'll receive an empty // result from search() – thus nothing else to do here. [$results,] = $this->collaboratorSearch->search($search, $shareTypes, false, $limit, 0); $event = new AutoCompleteEvent([ 'search' => $search, 'results' => $results, 'itemType' => $itemType, 'itemId' => $itemId, 'sorter' => $sorter, 'shareTypes' => $shareTypes, 'limit' => $limit, ]); $this->dispatcher->dispatch(IManager::class . '::filterResults', $event); $results = $event->getResults(); $event = new AutoCompleteFilterEvent( $results, $search, $itemType, $itemId, $sorter, $shareTypes, $limit, ); $this->dispatcher->dispatchTyped($event); $results = $event->getResults(); $exactMatches = $results['exact']; unset($results['exact']); $results = array_merge_recursive($exactMatches, $results); if ($sorter !== null) { $sorters = array_reverse(explode('|', $sorter)); $this->autoCompleteManager->runSorters($sorters, $results, [ 'itemType' => $itemType, 'itemId' => $itemId, ]); } // transform to expected format $results = $this->prepareResultArray($results); return new DataResponse($results); } /** * @return list */ protected function prepareResultArray(array $results): array { $output = []; /** @var string $type */ foreach ($results as $type => $subResult) { foreach ($subResult as $result) { /** @var ?string $icon */ $icon = array_key_exists('icon', $result) ? $result['icon'] : null; /** @var string $label */ $label = $result['label']; /** @var ?string $subline */ $subline = array_key_exists('subline', $result) ? $result['subline'] : null; /** @var ?array{status: string, message: ?string, icon: ?string, clearAt: ?int} $status */ $status = array_key_exists('status', $result) && is_array($result['status']) && !empty($result['status']) ? $result['status'] : null; /** @var ?string $shareWithDisplayNameUnique */ $shareWithDisplayNameUnique = array_key_exists('shareWithDisplayNameUnique', $result) ? $result['shareWithDisplayNameUnique'] : null; $output[] = [ 'id' => (string)$result['value']['shareWith'], 'label' => $label, 'icon' => $icon ?? '', 'source' => $type, 'status' => $status ?? '', 'subline' => $subline ?? '', 'shareWithDisplayNameUnique' => $shareWithDisplayNameUnique ?? '', ]; } } return $output; } }