Passed
Push — master ( 466fee...8256f4 )
by Greg
06:43 queued 01:19
created

Submitter::fetchGedcomRecord()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 7
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 5
nc 1
nop 2
dl 0
loc 7
rs 10
c 1
b 0
f 0
1
<?php
2
3
/**
4
 * webtrees: online genealogy
5
 * Copyright (C) 2019 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;
21
22
use Closure;
23
use Exception;
24
use Fisharebest\Webtrees\Http\RequestHandlers\SubmitterPage;
25
use Illuminate\Database\Capsule\Manager as DB;
26
use stdClass;
27
28
/**
29
 * A GEDCOM submitter (SUBM) object.
30
 */
31
class Submitter extends GedcomRecord
32
{
33
    public const RECORD_TYPE = 'SUBM';
34
35
    protected const ROUTE_NAME = SubmitterPage::class;
36
37
    /**
38
     * A closure which will create a record from a database row.
39
     *
40
     * @param Tree $tree
41
     *
42
     * @return Closure
43
     */
44
    public static function rowMapper(Tree $tree): Closure
45
    {
46
        return static function (stdClass $row) use ($tree): Submitter {
47
            $submitter = Submitter::getInstance($row->o_id, $tree, $row->o_gedcom);
48
            assert($submitter instanceof Submitter);
49
50
            return $submitter;
51
        };
52
    }
53
54
    /**
55
     * Get an instance of a repository object. For single records,
56
     * we just receive the XREF. For bulk records (such as lists
57
     * and search results) we can receive the GEDCOM data as well.
58
     *
59
     * @param string      $xref
60
     * @param Tree        $tree
61
     * @param string|null $gedcom
62
     *
63
     * @throws Exception
64
     *
65
     * @return Submitter|null
66
     */
67
    public static function getInstance(string $xref, Tree $tree, string $gedcom = null): ?Submitter
68
    {
69
        $record = parent::getInstance($xref, $tree, $gedcom);
70
71
        if ($record instanceof self) {
72
            return $record;
73
        }
74
75
        return null;
76
    }
77
78
    /**
79
     * Fetch data from the database
80
     *
81
     * @param string $xref
82
     * @param int    $tree_id
83
     *
84
     * @return string|null
85
     */
86
    protected static function fetchGedcomRecord(string $xref, int $tree_id): ?string
87
    {
88
        return DB::table('other')
89
            ->where('o_id', '=', $xref)
90
            ->where('o_file', '=', $tree_id)
91
            ->where('o_type', '=', self::RECORD_TYPE)
92
            ->value('o_gedcom');
93
    }
94
95
    /**
96
     * Generate a private version of this record
97
     *
98
     * @param int $access_level
99
     *
100
     * @return string
101
     */
102
    protected function createPrivateGedcomRecord(int $access_level): string
103
    {
104
        return '0 @' . $this->xref . "@ SUBM\n1 NAME " . I18N::translate('Private');
105
    }
106
107
    /**
108
     * Extract names from the GEDCOM record.
109
     *
110
     * @return void
111
     */
112
    public function extractNames(): void
113
    {
114
        $this->extractNamesFromFacts(1, 'NAME', $this->facts(['NAME']));
115
    }
116
}
117