Completed
Push — master ( bee36e...8d4065 )
by Greg
14:04
created

AbstractAutocompleteHandler   A

Complexity

Total Complexity 2

Size/Duplication

Total Lines 41
Duplicated Lines 0 %

Importance

Changes 1
Bugs 0 Features 1
Metric Value
eloc 9
c 1
b 0
f 1
dl 0
loc 41
rs 10
wmc 2

2 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 3 1
A handle() 0 9 1
1
<?php
2
3
/**
4
 * webtrees: online genealogy
5
 * Copyright (C) 2020 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 <http://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 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