xref: /webtrees/app/Factories/AbstractGedcomRecordFactory.php (revision 36de22acf6348b1059dac63e3cd19589574906ac)
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;
27use stdClass;
28
29/**
30 * Make a GedcomRecord object.
31 */
32abstract class AbstractGedcomRecordFactory
33{
34    /**
35     * @param Tree $tree
36     *
37     * @return Collection<stdClass>
38     */
39    protected function pendingChanges(Tree $tree): Collection
40    {
41        // Caution - this cache can be overwritten by GedcomExportService
42        return Registry::cache()->array()->remember(__CLASS__ . $tree->id(), static function () use ($tree): Collection {
43            return DB::table('change')
44                ->where('gedcom_id', '=', $tree->id())
45                ->where('status', '=', 'pending')
46                ->orderBy('change_id')
47                ->pluck('new_gedcom', 'xref');
48        });
49    }
50
51    /**
52     * We may have searched for X123, but found the record for x123.
53     *
54     * @param string $gedcom
55     * @param string $xref
56     *
57     * @return string
58     */
59    protected function extractXref(string $gedcom, string $xref): string
60    {
61        if (preg_match('/^0 @(' . Gedcom::REGEX_XREF . ')@/', $gedcom, $match)) {
62            return $match[1];
63        }
64
65        return $xref;
66    }
67}
68