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