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