1 | <?php |
||
2 | |||
3 | /** |
||
4 | * webtrees: online genealogy |
||
5 | * Copyright (C) 2025 webtrees development team |
||
6 | * This program is free software: you can redistribute it and/or modify |
||
7 | * it under the terms of the GNU General Public License as published by |
||
8 | * the Free Software Foundation, either version 3 of the License, or |
||
9 | * (at your option) any later version. |
||
10 | * This program is distributed in the hope that it will be useful, |
||
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
||
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||
13 | * GNU General Public License for more details. |
||
14 | * You should have received a copy of the GNU General Public License |
||
15 | * along with this program. If not, see <https://www.gnu.org/licenses/>. |
||
16 | */ |
||
17 | |||
18 | declare(strict_types=1); |
||
19 | |||
20 | namespace Fisharebest\Webtrees\Http\RequestHandlers; |
||
21 | |||
22 | use Fisharebest\Webtrees\Services\SearchService; |
||
23 | use Illuminate\Support\Collection; |
||
24 | use Psr\Http\Message\ResponseInterface; |
||
25 | use Psr\Http\Message\ServerRequestInterface; |
||
26 | use Psr\Http\Server\RequestHandlerInterface; |
||
27 | |||
28 | use function response; |
||
29 | |||
30 | /** |
||
31 | * Autocomplete handler |
||
32 | */ |
||
33 | abstract class AbstractAutocompleteHandler implements RequestHandlerInterface |
||
34 | { |
||
35 | // The client software only shows the first few results |
||
36 | protected const int LIMIT = 10; |
||
0 ignored issues
–
show
Bug
introduced
by
![]() |
|||
37 | |||
38 | // Tell the browser to cache the results |
||
39 | protected const int CACHE_LIFE = 1200; |
||
40 | |||
41 | protected SearchService $search_service; |
||
42 | |||
43 | /** |
||
44 | * @param SearchService $search_service |
||
45 | */ |
||
46 | public function __construct(SearchService $search_service) |
||
47 | { |
||
48 | $this->search_service = $search_service; |
||
49 | } |
||
50 | |||
51 | /** |
||
52 | * @param ServerRequestInterface $request |
||
53 | * |
||
54 | * @return ResponseInterface |
||
55 | */ |
||
56 | public function handle(ServerRequestInterface $request): ResponseInterface |
||
57 | { |
||
58 | $data = $this->search($request) |
||
59 | ->map(static fn (string $datum): array => ['value' => $datum]); |
||
60 | |||
61 | return response($data) |
||
62 | ->withHeader('cache-control', 'public,max-age=' . static::CACHE_LIFE); |
||
63 | } |
||
64 | |||
65 | /** |
||
66 | * @param ServerRequestInterface $request |
||
67 | * |
||
68 | * @return Collection<int,string> |
||
69 | */ |
||
70 | abstract protected function search(ServerRequestInterface $request): Collection; |
||
71 | } |
||
72 |