Completed
Push — develop ( 0d6c46...c341e4 )
by Greg
15:25 queued 09:07
created

AbstractXrefElement::valueXrefLink()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 11
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 3
eloc 5
nc 3
nop 3
dl 0
loc 11
rs 10
c 1
b 0
f 0
1
<?php
2
3
/**
4
 * webtrees: online genealogy
5
 * Copyright (C) 2020 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 <http://www.gnu.org/licenses/>.
16
 */
17
18
declare(strict_types=1);
19
20
namespace Fisharebest\Webtrees\GedcomElements;
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\GedcomElements\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\GedcomRecord;
24
use Fisharebest\Webtrees\Tree;
25
26
use function e;
27
use function preg_match;
28
29
/**
30
 * Common behaviour for all XREF links
31
 */
32
class AbstractXrefElement extends AbstractElement
33
{
34
    /**
35
     * Escape @ signs in a GEDCOM export.
36
     *
37
     * @param string $value
38
     *
39
     * @return string
40
     */
41
    public function escape(string $value): string
42
    {
43
        return $value;
44
    }
45
46
    /**
47
     * Display the value of this type of element - convert XREFs to links.
48
     *
49
     * @param string $value
50
     * @param Tree   $tree
51
     * @param mixed  $factory We can type-hint this from PHP 7.4
52
     *
53
     * @return string
54
     */
55
    protected function valueXrefLink(string $value, Tree $tree, $factory): string
56
    {
57
        if (preg_match('/@(' . Gedcom::REGEX_XREF . ')@/', $value, $match)) {
58
            $record = $factory->make($match[1], $tree);
59
60
            if ($record instanceof GedcomRecord) {
61
                return '<a href="' . e($record->url()) . '">' . $record->fullName() . '</a>';
62
            }
63
        }
64
65
        return '<span class="error">' . e($value) . '</span>';
66
    }
67
}
68