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