xref: /webtrees/app/Elements/XrefFamily.php (revision 2ebcf907ed34213f816592af04e6c160335d6311)
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\Elements;
21
22use Fisharebest\Webtrees\Registry;
23use Fisharebest\Webtrees\Tree;
24
25use function trim;
26use function view;
27
28/**
29 * XREF:FAM := {Size=1:22}
30 * A pointer to, or a cross-reference identifier of, a family record.
31 */
32class XrefFamily extends AbstractXrefElement
33{
34    /**
35     * An edit control for this data.
36     *
37     * @param string $id
38     * @param string $name
39     * @param string $value
40     * @param Tree   $tree
41     *
42     * @return string
43     */
44    public function edit(string $id, string $name, string $value, Tree $tree): string
45    {
46        return view('components/select-family', [
47            'id'     => $id,
48            'name'   => $name,
49            'family' => Registry::familyFactory()->make(trim($value, '@'), $tree),
50            'tree'   => $tree,
51            'at'     => '@',
52        ]);
53    }
54
55    /**
56     * Display the value of this type of element.
57     *
58     * @param string $value
59     * @param Tree   $tree
60     *
61     * @return string
62     */
63    public function value(string $value, Tree $tree): string
64    {
65        return $this->valueXrefLink($value, $tree, Registry::familyFactory());
66    }
67}
68