xref: /webtrees/app/Elements/AbstractEventElement.php (revision 2c685d76b4ab2ea8f166ab8a2e4112fa1ba8de5d) 
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\I18N;
23use Fisharebest\Webtrees\Tree;
24
25use function e;
26use function nl2br;
27
28/**
29 * Events which can take "Y" to indicate that they occurred, but date/place are unknown.
30 */
31class AbstractEventElement extends AbstractElement
32{
33    /**
34     * Create a default value for this element.
35     *
36     * @param Tree $tree
37     *
38     * @return string
39     */
40    public function default(Tree $tree): string
41    {
42        return 'Y';
43    }
44
45    /**
46     * An edit control for this data.
47     *
48     * @param string $id
49     * @param string $name
50     * @param string $value
51     * @param Tree   $tree
52     *
53     * @return string
54     */
55    public function edit(string $id, string $name, string $value, Tree $tree): string
56    {
57        return
58            '<div class="form-check">' .
59            $this->editHidden($id, $name, $value ? 'Y' : '') .
60            '<input class="form-check-input" type="checkbox" value="Y" id="' . e($id) . '-check" ' . ($value ? 'checked="checked"' : '') . ' />' .
61            '<label class="form-check-label" for="' . e($id) . '-check">' .
62            I18N::translate('This event occurred, but the details are unknown.') .
63            '</label>' .
64            '</div>' .
65            '<script>' .
66            'document.getElementById("' . e($id) . '-check").addEventListener("change", function () {' .
67            'document.getElementById("' . e($id) . '").value = this.checked ? "Y" : "";' .
68            '})' .
69            '</script>';
70    }
71
72    /**
73     * Display the value of this type of element.
74     *
75     * @param string $value
76     * @param Tree   $tree
77     *
78     * @return string
79     */
80    public function value(string $value, Tree $tree): string
81    {
82        if ($value === 'Y') {
83            return I18N::translate('yes');
84        }
85
86        return parent::value($value, $tree);
87    }
88}
89