xref: /webtrees/app/Module/NotesTabModule.php (revision 07660c6784de912dff03f94c7d3f0f2b3d77a4d9)
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2016 webtrees development team
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16namespace Fisharebest\Webtrees\Module;
17
18use Fisharebest\Webtrees\Auth;
19use Fisharebest\Webtrees\Fact;
20use Fisharebest\Webtrees\Functions\Functions;
21use Fisharebest\Webtrees\Functions\FunctionsPrintFacts;
22use Fisharebest\Webtrees\GedcomTag;
23use Fisharebest\Webtrees\I18N;
24
25/**
26 * Class NotesTabModule
27 */
28class NotesTabModule extends AbstractModule implements ModuleTabInterface {
29	/** @var Fact[] A list facts for this note. */
30	private $facts;
31
32	/** {@inheritdoc} */
33	public function getTitle() {
34		return /* I18N: Name of a module */ I18N::translate('Notes');
35	}
36
37	/** {@inheritdoc} */
38	public function getDescription() {
39		return /* I18N: Description of the “Notes” module */ I18N::translate('A tab showing the notes attached to an individual.');
40	}
41
42	/** {@inheritdoc} */
43	public function defaultTabOrder() {
44		return 40;
45	}
46
47	/** {@inheritdoc} */
48	public function hasTabContent() {
49		global $WT_TREE;
50
51		return Auth::isEditor($WT_TREE) || $this->getFactsWithNotes();
52	}
53
54	/** {@inheritdoc} */
55	public function isGrayedOut() {
56		return !$this->getFactsWithNotes();
57	}
58
59	/** {@inheritdoc} */
60	public function getTabContent() {
61		global $WT_TREE, $controller;
62
63		ob_start();
64		?>
65		<script>
66			persistant_toggle("checkbox_note2", "row_note2");
67		</script>
68		<table class="facts_table">
69			<colgroup>
70				<col class="width20">
71				<col class="width80">
72			</colgroup>
73			<tr class="noprint">
74				<td colspan="2" class="descriptionbox rela">
75					<label>
76						<input id="checkbox_note2" type="checkbox" checked>
77						<?php echo I18N::translate('Show all notes'); ?>
78					</label>
79				</td>
80			</tr>
81
82		<?php
83		foreach ($this->getFactsWithNotes() as $fact) {
84			if ($fact->getTag() == 'NOTE') {
85				FunctionsPrintFacts::printMainNotes($fact, 1);
86			} else {
87				for ($i = 2; $i < 4; ++$i) {
88					FunctionsPrintFacts::printMainNotes($fact, $i);
89				}
90			}
91		}
92		if (!$this->getFactsWithNotes()) {
93			echo '<tr><td id="no_tab4" colspan="2" class="facts_value">', I18N::translate('There are no notes for this individual.'), '</td></tr>';
94		}
95
96		// New note link
97		if ($controller->record->canEdit()) {
98			?>
99			<tr class="noprint">
100				<td class="facts_label">
101					<?php echo GedcomTag::getLabel('NOTE'); ?>
102				</td>
103				<td class="facts_value">
104					<a href="#" onclick="add_new_record('<?php echo $controller->record->getXref(); ?>','NOTE'); return false;">
105						<?php echo I18N::translate('Add a note'); ?>
106					</a>
107				</td>
108			</tr>
109			<tr class="noprint">
110				<td class="facts_label">
111					<?php echo GedcomTag::getLabel('SHARED_NOTE'); ?>
112				</td>
113				<td class="facts_value">
114					<a href="#" onclick="add_new_record('<?php echo $controller->record->getXref(); ?>','SHARED_NOTE'); return false;">
115						<?php echo I18N::translate('Add a shared note'); ?>
116					</a>
117				</td>
118			</tr>
119		<?php
120		}
121		?>
122		</table>
123		<?php
124
125		return '<div id="' . $this->getName() . '_content">' . ob_get_clean() . '</div>';
126	}
127
128	/**
129	 * Get all the facts for an individual which contain notes.
130	 *
131	 * @return Fact[]
132	 */
133	private function getFactsWithNotes() {
134		global $controller;
135
136		if ($this->facts === null) {
137			$facts = $controller->record->getFacts();
138			foreach ($controller->record->getSpouseFamilies() as $family) {
139				if ($family->canShow()) {
140					foreach ($family->getFacts() as $fact) {
141						$facts[] = $fact;
142					}
143				}
144			}
145			$this->facts = array();
146			foreach ($facts as $fact) {
147				if (preg_match('/(?:^1|\n\d) NOTE/', $fact->getGedcom())) {
148					$this->facts[] = $fact;
149				}
150			}
151			Functions::sortFacts($this->facts);
152		}
153
154		return $this->facts;
155	}
156
157	/** {@inheritdoc} */
158	public function canLoadAjax() {
159		return !Auth::isSearchEngine(); // Search engines cannot use AJAX
160	}
161
162	/** {@inheritdoc} */
163	public function getPreLoadContent() {
164		return '';
165	}
166}
167