xref: /webtrees/app/Http/RequestHandlers/AutoCompletePlace.php (revision 202c018b592d5a516e4a465dc6dc515f3be37399)
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2023 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\Validator;
27use Illuminate\Support\Collection;
28use Psr\Http\Message\ServerRequestInterface;
29
30/**
31 * Autocomplete handler for places
32 */
33class AutoCompletePlace extends AbstractAutocompleteHandler
34{
35    private ModuleService $module_service;
36
37    /**
38     * @param ModuleService $module_service
39     * @param SearchService $search_service
40     */
41    public function __construct(ModuleService $module_service, SearchService $search_service)
42    {
43        parent::__construct($search_service);
44
45        $this->module_service = $module_service;
46    }
47
48    /**
49     * @param ServerRequestInterface $request
50     *
51     * @return Collection<int,string>
52     */
53    protected function search(ServerRequestInterface $request): Collection
54    {
55        $tree  = Validator::attributes($request)->tree();
56        $query = Validator::queryParams($request)->string('query');
57
58        $data = $this->search_service
59            ->searchPlaces($tree, $query, 0, static::LIMIT)
60            ->map(static fn(Place $place): string => $place->gedcomName());
61
62        // No place found? Use external gazetteers.
63        foreach ($this->module_service->findByInterface(ModuleMapAutocompleteInterface::class) as $module) {
64            if ($data->isEmpty()) {
65                $data = $data->concat($module->searchPlaceNames($query))->sort();
66            }
67        }
68
69        return $data;
70    }
71}
72