xref: /webtrees/app/Elements/XrefSource.php (revision c2ed51d13a57743094c11c8fe84befd9d4f158cd) 
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\Http\RequestHandlers\CreateSourceModal;
23use Fisharebest\Webtrees\I18N;
24use Fisharebest\Webtrees\Registry;
25use Fisharebest\Webtrees\Tree;
26
27use function e;
28use function route;
29use function trim;
30use function view;
31
32/**
33 * XREF:SOUR := {Size=1:22}
34 * A pointer to, or a cross-reference identifier of, a SOURce record.
35 */
36class XrefSource extends AbstractXrefElement
37{
38    protected const SUBTAGS = [
39        'PAGE' => '0:1',
40        'EVEN' => '0:1',
41        'DATA' => '0:1',
42        'OBJE' => '0:M',
43        'NOTE' => '0:M',
44        'QUAY' => '0:1',
45    ];
46
47    protected const ABRIDGED_SUBTAGS = [
48        'PAGE' => '0:1',
49        'DATA' => '0:1',
50        'OBJE' => '0:M',
51    ];
52
53    /**
54     * An edit control for this data.
55     *
56     * @param string $id
57     * @param string $name
58     * @param string $value
59     * @param Tree   $tree
60     *
61     * @return string
62     */
63    public function edit(string $id, string $name, string $value, Tree $tree): string
64    {
65        $select = view('components/select-source', [
66            'id'     => $id,
67            'name'   => $name,
68            'source' => Registry::sourceFactory()->make(trim($value, '@'), $tree),
69            'tree'   => $tree,
70            'at'     => '@',
71        ]);
72
73        return
74            '<div class="input-group">' .
75            '<div class="input-group-prepend">' .
76            '<button class="btn btn-secondary" type="button" data-toggle="modal" data-backdrop="static" data-target="#wt-ajax-modal" data-href="' . e(route(CreateSourceModal::class, ['tree' => $tree->name()])) . '" data-select-id="' . $id . '" title="' . I18N::translate('Create a source') . '">' .
77            view('icons/add') .
78            '</button>' .
79            '</div>' .
80            $select .
81            '</div>';
82    }
83
84    /**
85     * @param Tree $tree
86     *
87     * @return array<string,string>
88     */
89    public function subtags(Tree $tree): array
90    {
91        if ($tree->getPreference('FULL_SOURCES') === '1') {
92            return static::SUBTAGS;
93        }
94
95        return static::ABRIDGED_SUBTAGS;
96    }
97
98    /**
99     * Display the value of this type of element.
100     *
101     * @param string $value
102     * @param Tree   $tree
103     *
104     * @return string
105     */
106    public function value(string $value, Tree $tree): string
107    {
108        return $this->valueXrefLink($value, $tree, Registry::sourceFactory());
109    }
110}
111