xref: /webtrees/app/Repository.php (revision 86c75e30decf65b2ee2190ca2847e42271e795ee) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2019 webtrees development team
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16declare(strict_types=1);
17
18namespace Fisharebest\Webtrees;
19
20use Illuminate\Database\Capsule\Manager as DB;
21
22/**
23 * A GEDCOM repository (REPO) object.
24 */
25class Repository extends GedcomRecord
26{
27    public const RECORD_TYPE = 'REPO';
28
29    protected const ROUTE_NAME = 'repository';
30
31    /**
32     * Get an instance of a repository object. For single records,
33     * we just receive the XREF. For bulk records (such as lists
34     * and search results) we can receive the GEDCOM data as well.
35     *
36     * @param string      $xref
37     * @param Tree        $tree
38     * @param string|null $gedcom
39     *
40     * @throws \Exception
41     *
42     * @return Repository|null
43     */
44    public static function getInstance(string $xref, Tree $tree, string $gedcom = null)
45    {
46        $record = parent::getInstance($xref, $tree, $gedcom);
47
48        if ($record instanceof Repository) {
49            return $record;
50        }
51
52        return null;
53    }
54
55    /**
56     * Fetch data from the database
57     *
58     * @param string $xref
59     * @param int    $tree_id
60     *
61     * @return null|string
62     */
63    protected static function fetchGedcomRecord(string $xref, int $tree_id)
64    {
65        return DB::table('other')
66            ->where('o_id', '=', $xref)
67            ->where('o_file', '=', $tree_id)
68            ->where('o_type', '=', self::RECORD_TYPE)
69            ->value('o_gedcom');
70    }
71
72    /**
73     * Generate a private version of this record
74     *
75     * @param int $access_level
76     *
77     * @return string
78     */
79    protected function createPrivateGedcomRecord(int $access_level): string
80    {
81        return '0 @' . $this->xref . "@ REPO\n1 NAME " . I18N::translate('Private');
82    }
83
84    /**
85     * Extract names from the GEDCOM record.
86     *
87     * @return void
88     */
89    public function extractNames()
90    {
91        parent::extractNamesFromFacts(1, 'NAME', $this->facts(['NAME']));
92    }
93}
94