1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2018 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
namespace Fisharebest\Webtrees;
/**
* A GEDCOM note (NOTE) object.
*/
class Note extends GedcomRecord
{
const RECORD_TYPE = 'NOTE';
const ROUTE_NAME = 'note';
/**
* Get an instance of a note object. For single records,
* we just receive the XREF. For bulk records (such as lists
* and search results) we can receive the GEDCOM data as well.
*
* @param string $xref
* @param Tree $tree
* @param string|null $gedcom
*
* @throws \Exception
*
* @return Note|null
*/
public static function getInstance(string $xref, Tree $tree, string $gedcom = null)
{
$record = parent::getInstance($xref, $tree, $gedcom);
if ($record instanceof Note) {
return $record;
}
return null;
}
/**
* Get the text contents of the note
*
* @return string|null
*/
public function getNote()
{
if (preg_match('/^0 @' . WT_REGEX_XREF . '@ NOTE ?(.*(?:\n1 CONT ?.*)*)/', $this->gedcom . $this->pending, $match)) {
return preg_replace("/\n1 CONT ?/", "\n", $match[1]);
}
return null;
}
/**
* Each object type may have its own special rules, and re-implement this function.
*
* @param int $access_level
*
* @return bool
*/
protected function canShowByType(int $access_level): bool
{
// Hide notes if they are attached to private records
$linked_ids = Database::prepare(
"SELECT l_from FROM `##link` WHERE l_to=? AND l_file=?"
)->execute([
$this->xref,
$this->tree->getTreeId(),
])->fetchOneColumn();
foreach ($linked_ids as $linked_id) {
$linked_record = GedcomRecord::getInstance($linked_id, $this->tree);
if ($linked_record && !$linked_record->canShow($access_level)) {
return false;
}
}
// Apply default behaviour
return parent::canShowByType($access_level);
}
/**
* Generate a private version of this record
*
* @param int $access_level
*
* @return string
*/
protected function createPrivateGedcomRecord(int $access_level): string
{
return '0 @' . $this->xref . '@ NOTE ' . I18N::translate('Private');
}
/**
* Fetch data from the database
*
* @param string $xref
* @param int $tree_id
*
* @return null|string
*/
protected static function fetchGedcomRecord(string $xref, int $tree_id)
{
return Database::prepare(
"SELECT o_gedcom FROM `##other` WHERE o_id = :xref AND o_file = :tree_id AND o_type = 'NOTE'"
)->execute([
'xref' => $xref,
'tree_id' => $tree_id,
])->fetchOne();
}
/**
* Create a name for this note - apply (and remove) markup, then take
* a maximum of 100 characters from the first line.
*
* @return void
*/
public function extractNames()
{
$text = $this->getNote();
if ($text) {
switch ($this->getTree()->getPreference('FORMAT_TEXT')) {
case 'markdown':
$text = Filter::markdown($text, $this->getTree());
$text = strip_tags($text);
$text = html_entity_decode($text, ENT_QUOTES, 'UTF-8');
break;
}
list($text) = explode("\n", $text);
$this->addName('NOTE', strlen($text) > 100 ? mb_substr($text, 0, 100) . I18N::translate('…') : $text, $this->getGedcom());
}
}
}
|
