Completed
Push — master ( ac6993...e8ded2 )
by Greg
05:38
created

NoteStructure::edit()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 44
Code Lines 32

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 3
eloc 32
c 0
b 0
f 0
nc 3
nop 4
dl 0
loc 44
rs 9.408
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
18
declare(strict_types=1);
19
20
namespace Fisharebest\Webtrees\Elements;
21
22
use Fisharebest\Webtrees\Gedcom;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, Fisharebest\Webtrees\Elements\Gedcom. Consider defining an alias.

Let?s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let?s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
23
use Fisharebest\Webtrees\I18N;
24
use Fisharebest\Webtrees\Tree;
25
26
use function e;
27
use function preg_match;
28
29
/**
30
 * NOTE can be text or an XREF.
31
 */
32
class NoteStructure extends AbstractElement
33
{
34
    /**
35
     * Convert a value to a canonical form.
36
     *
37
     * @param string $value
38
     *
39
     * @return string
40
     */
41
    public function canonical(string $value): string
42
    {
43
        // Browsers use MS-DOS line endings in multi-line data.
44
        return strtr($value, ["\t" => ' ', "\r\n" => "\n", "\r" => "\n"]);
45
    }
46
47
    /**
48
     * An edit control for this data.
49
     *
50
     * @param string $id
51
     * @param string $name
52
     * @param string $value
53
     * @param Tree   $tree
54
     *
55
     * @return string
56
     */
57
    public function edit(string $id, string $name, string $value, Tree $tree): string
58
    {
59
        $submitter_text = new SubmitterText('');
60
        $xref_note      = new XrefNote('');
61
62
        // Existing shared note.
63
        if (preg_match('/@' . Gedcom::REGEX_XREF . '@/', $value)) {
64
            return $xref_note->edit($id, $name, $value, $tree);
65
        }
66
67
        // Existing inline note.
68
        if ($value !== '') {
69
            return $submitter_text->edit($id, $name, $value, $tree);
70
        }
71
72
        $options = [
73
            'inline' => I18N::translate('Add a note'),
74
            'shared' => I18N::translate('Add a shared note'),
75
        ];
76
77
        // New note - either inline or shared
78
        return
79
            '<div id="' . e($id) . '-note-structure">' .
80
            '<div id="' . e($id) . '-options">' .
81
            view('components/radios-inline', ['name' => $id . '-options', 'options' => $options, 'selected' => 'inline']) .
82
            '</div>' .
83
            '<div id="' . e($id) . '-inline">' .
84
            $submitter_text->edit($id, $name, $value, $tree) .
85
            '</div>' .
86
            '<div id="' . e($id) . '-shared" class="d-none">' .
87
            $xref_note->edit($id, $name, $value, $tree) .
88
            '</div>' .
89
            '</div>' .
90
            '<script>' .
91
            'document.getElementById("' . e($id) . '-shared").querySelector("select").disabled=true;' .
92
            'document.getElementById("' . e($id) . '-options").addEventListener("change", function(){' .
93
            ' document.getElementById("' . e($id) . '-inline").classList.toggle("d-none");' .
94
            ' document.getElementById("' . e($id) . '-shared").classList.toggle("d-none");' .
95
            ' const inline = document.getElementById("' . e($id) . '-inline").querySelector("textarea");' .
96
            ' const shared = document.getElementById("' . e($id) . '-shared").querySelector("select");' .
97
            ' inline.disabled = !inline.disabled;' .
98
            ' shared.disabled = !shared.disabled;' .
99
            '})' .
100
            '</script>';
101
    }
102
}
103