xref: /webtrees/app/Factories/AbstractGedcomRecordFactory.php (revision 43e7e97ace939b5136597bb51e4493fec0c1f88a) 
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\Factories;
21
22use Fisharebest\Webtrees\Cache;
23use Fisharebest\Webtrees\Gedcom;
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    /** @var Cache */
35    protected $cache;
36
37    /**
38     * GedcomRecordFactory constructor.
39     *
40     * @param Cache $cache
41     */
42    public function __construct(Cache $cache)
43    {
44        $this->cache = $cache;
45    }
46
47    /**
48     * @param Tree $tree
49     *
50     * @return Collection<stdClass>
51     */
52    protected function pendingChanges(Tree $tree): Collection
53    {
54        // Caution - this cache can be overwritten by GedcomExportService
55        return $this->cache->remember(__CLASS__ . $tree->id(), static function () use ($tree): Collection {
56            return DB::table('change')
57                ->where('gedcom_id', '=', $tree->id())
58                ->where('status', '=', 'pending')
59                ->orderBy('change_id')
60                ->pluck('new_gedcom', 'xref');
61        });
62    }
63
64    /**
65     * We may have searched for X123, but found the record for x123.
66     *
67     * @param string $gedcom
68     * @param string $xref
69     *
70     * @return mixed|string
71     */
72    protected function extractXref(string $gedcom, string $xref)
73    {
74        if (preg_match('/^0 @(' . Gedcom::REGEX_XREF . ')@/', $gedcom, $match)) {
75            return $match[1];
76        }
77
78        return $xref;
79    }
80}
81