xref: /webtrees/app/Factories/NoteFactory.php (revision 3213013ede3591752a6702ce4e8d35f6396dd0f9) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2020 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 Closure;
23use Fisharebest\Webtrees\Contracts\NoteFactoryInterface;
24use Fisharebest\Webtrees\Factory;
25use Fisharebest\Webtrees\Note;
26use Fisharebest\Webtrees\Tree;
27use Illuminate\Database\Capsule\Manager as DB;
28use stdClass;
29
30use function assert;
31use function preg_match;
32
33/**
34 * Make a Note object.
35 */
36class NoteFactory extends AbstractGedcomRecordFactory implements NoteFactoryInterface
37{
38    private const TYPE_CHECK_REGEX = '/^0 @[^@]+@ ' . Note::RECORD_TYPE . '/';
39
40    /**
41     * Create a note.
42     *
43     * @param string      $xref
44     * @param Tree        $tree
45     * @param string|null $gedcom
46     *
47     * @return Note|null
48     */
49    public function make(string $xref, Tree $tree, string $gedcom = null): ?Note
50    {
51        return Factory::cache()->array()->remember(__CLASS__ . $xref . '@' . $tree->id(), function () use ($xref, $tree, $gedcom) {
52            $gedcom  = $gedcom ?? $this->gedcom($xref, $tree);
53            $pending = $this->pendingChanges($tree)->get($xref);
54
55            if ($gedcom === null && ($pending === null || !preg_match(self::TYPE_CHECK_REGEX, $pending))) {
56                return null;
57            }
58
59            $xref = $this->extractXref($gedcom ?? $pending, $xref);
60
61            return new Note($xref, $gedcom ?? '', $pending, $tree);
62        });
63    }
64
65    /**
66     * Create a note from a row in the database.
67     *
68     * @param Tree $tree
69     *
70     * @return Closure
71     */
72    public function mapper(Tree $tree): Closure
73    {
74        return function (stdClass $row) use ($tree): Note {
75            $note = $this->make($row->o_id, $tree, $row->o_gedcom);
76            assert($note instanceof Note);
77
78            return $note;
79        };
80    }
81
82    /**
83     * Create a note from raw GEDCOM data.
84     *
85     * @param string      $xref
86     * @param string      $gedcom  an empty string for new/pending records
87     * @param string|null $pending null for a record with no pending edits,
88     *                             empty string for records with pending deletions
89     * @param Tree        $tree
90     *
91     * @return Note
92     */
93    public function new(string $xref, string $gedcom, ?string $pending, Tree $tree): Note
94    {
95        return new Note($xref, $gedcom, $pending, $tree);
96    }
97
98    /**
99     * Fetch GEDCOM data from the database.
100     *
101     * @param string $xref
102     * @param Tree   $tree
103     *
104     * @return string|null
105     */
106    protected function gedcom(string $xref, Tree $tree): ?string
107    {
108        return DB::table('other')
109            ->where('o_id', '=', $xref)
110            ->where('o_file', '=', $tree->id())
111            ->where('o_type', '=', Note::RECORD_TYPE)
112            ->value('o_gedcom');
113    }
114}
115