xref: /webtrees/app/Http/RequestHandlers/TomSelectFamily.php (revision 36779af1bd0601de7819554b13a393f6edb92507) 
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\Family;
23use Fisharebest\Webtrees\Registry;
24use Fisharebest\Webtrees\Services\SearchService;
25use Fisharebest\Webtrees\Tree;
26use Illuminate\Support\Collection;
27
28use function explode;
29use function view;
30
31/**
32 * Autocomplete for families.
33 */
34class TomSelectFamily extends AbstractTomSelectHandler
35{
36    protected SearchService $search_service;
37
38    /**
39     * TomSelectFamily constructor.
40     *
41     * @param SearchService $search_service
42     */
43    public function __construct(
44        SearchService $search_service
45    ) {
46        $this->search_service = $search_service;
47    }
48
49    /**
50     * Perform the search
51     *
52     * @param Tree   $tree
53     * @param string $query
54     * @param int    $offset
55     * @param int    $limit
56     * @param string $at
57     *
58     * @return Collection<int,array<string,string>>
59     */
60    protected function search(Tree $tree, string $query, int $offset, int $limit, string $at): Collection
61    {
62        // Search by XREF
63        $family = Registry::familyFactory()->make($query, $tree);
64
65        if ($family instanceof Family) {
66            $results = new Collection([$family]);
67        } else {
68            $results = $this->search_service->searchFamilyNames([$tree], explode(' ', $query), $offset, $limit);
69        }
70
71        return $results->map(static function (Family $family) use ($at): array {
72            return [
73                'text'  => view('selects/family', ['family' => $family]),
74                'value' => $at . $family->xref() . $at,
75            ];
76        });
77    }
78}
79