xref: /webtrees/app/Http/RequestHandlers/AutoCompletePlace.php (revision a5068f91b4349f8a5e47576f9dd749d221f61a10) 
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\Module\ModuleMapAutocompleteInterface;
23use Fisharebest\Webtrees\Place;
24use Fisharebest\Webtrees\Services\ModuleService;
25use Fisharebest\Webtrees\Services\SearchService;
26use Fisharebest\Webtrees\Tree;
27use Illuminate\Support\Collection;
28use Psr\Http\Message\ServerRequestInterface;
29
30use function assert;
31
32/**
33 * Autocomplete handler for places
34 */
35class AutoCompletePlace extends AbstractAutocompleteHandler
36{
37    private ModuleService $module_service;
38
39    /**
40     * @param SearchService $search_service
41     */
42    public function __construct(SearchService $search_service, ModuleService $module_service)
43    {
44        parent::__construct($search_service);
45
46        $this->module_service = $module_service;
47    }
48
49    /**
50     * @param ServerRequestInterface $request
51     *
52     * @return Collection<string>
53     */
54    protected function search(ServerRequestInterface $request): Collection
55    {
56        $tree = $request->getAttribute('tree');
57        assert($tree instanceof Tree);
58
59        $query = $request->getQueryParams()['query'] ?? '';
60
61        $data = $this->search_service
62            ->searchPlaces($tree, $query, 0, static::LIMIT)
63            ->map(static function (Place $place): string {
64                return $place->gedcomName();
65            });
66
67        // No place found? Use external gazetteers.
68        foreach ($this->module_service->findByInterface(ModuleMapAutocompleteInterface::class) as $module) {
69            if ($data->isEmpty()) {
70                $data = $data->concat($module->searchPlaceNames($query))->sort();
71            }
72        }
73
74        return $data;
75    }
76}
77