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