xref: /webtrees/app/Factories/AbstractGedcomRecordFactory.php (revision 2ebcf907ed34213f816592af04e6c160335d6311)
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2021 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 <https://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Factories;
21
22use Fisharebest\Webtrees\Gedcom;
23use Fisharebest\Webtrees\Registry;
24use Fisharebest\Webtrees\Tree;
25use Illuminate\Database\Capsule\Manager as DB;
26use Illuminate\Support\Collection;
27
28/**
29 * Make a GedcomRecord object.
30 */
31abstract class AbstractGedcomRecordFactory
32{
33    /**
34     * @param Tree $tree
35     *
36     * @return Collection<object>
37     */
38    protected function pendingChanges(Tree $tree): Collection
39    {
40        // Caution - this cache can be overwritten by GedcomExportService
41        return Registry::cache()->array()->remember(__CLASS__ . $tree->id(), static function () use ($tree): Collection {
42            return DB::table('change')
43                ->where('gedcom_id', '=', $tree->id())
44                ->where('status', '=', 'pending')
45                ->orderBy('change_id')
46                ->pluck('new_gedcom', 'xref');
47        });
48    }
49
50    /**
51     * We may have searched for X123, but found the record for x123.
52     *
53     * @param string $gedcom
54     * @param string $xref
55     *
56     * @return string
57     */
58    protected function extractXref(string $gedcom, string $xref): string
59    {
60        if (preg_match('/^0 @(' . Gedcom::REGEX_XREF . ')@/', $gedcom, $match)) {
61            return $match[1];
62        }
63
64        return $xref;
65    }
66}
67