xref: /webtrees/app/Http/RequestHandlers/AbstractAutocompleteHandler.php (revision afa67798854828b1edc33dd077960ec2b18e6140) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2021 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
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Http\RequestHandlers;
21
22use Fisharebest\Webtrees\Services\SearchService;
23use Illuminate\Support\Collection;
24use Psr\Http\Message\ResponseInterface;
25use Psr\Http\Message\ServerRequestInterface;
26use Psr\Http\Server\RequestHandlerInterface;
27
28use function response;
29
30/**
31 * Autocomplete handler
32 */
33abstract class AbstractAutocompleteHandler implements RequestHandlerInterface
34{
35    // The client software only shows the first few results
36    protected const LIMIT = 10;
37
38    // Tell the browser to cache the results
39    protected const CACHE_LIFE = 1200;
40
41    /** @var SearchService */
42    protected $search_service;
43
44    /**
45     * @param SearchService $search_service
46     */
47    public function __construct(SearchService $search_service)
48    {
49        $this->search_service = $search_service;
50    }
51
52    /**
53     * @param ServerRequestInterface $request
54     *
55     * @return ResponseInterface
56     */
57    public function handle(ServerRequestInterface $request): ResponseInterface
58    {
59        $data = $this->search($request)
60            ->map(static function (string $datum): array {
61                return ['value' => $datum];
62            });
63
64        return response($data)
65            ->withHeader('Cache-Control', 'public,max-age=' . static::CACHE_LIFE);
66    }
67
68    /**
69     * @param ServerRequestInterface $request
70     *
71     * @return Collection<string>
72     */
73    abstract protected function search(ServerRequestInterface $request): Collection;
74}
75