xref: /webtrees/app/Module/NotesTabModule.php (revision 3cf92ae205660ec36316541b9e23f2ecbf0af8bb)
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2015 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		echo '<table class="facts_table">';
65		?>
66		<tr>
67			<td colspan="2" class="descriptionbox rela">
68				<input id="checkbox_note2" type="checkbox" <?php echo $WT_TREE->getPreference('SHOW_LEVEL2_NOTES') ? 'checked' : ''; ?> onclick="jQuery('tr.row_note2').toggle();">
69				<label for="checkbox_note2"><?php echo I18N::translate('Show all notes'); ?></label>
70			</td>
71		</tr>
72		<?php
73		foreach ($this->getFactsWithNotes() as $fact) {
74			if ($fact->getTag() == 'NOTE') {
75				FunctionsPrintFacts::printMainNotes($fact, 1);
76			} else {
77				for ($i = 2; $i < 4; ++$i) {
78					FunctionsPrintFacts::printMainNotes($fact, $i);
79				}
80			}
81		}
82		if (!$this->getFactsWithNotes()) {
83			echo '<tr><td id="no_tab4" colspan="2" class="facts_value">', I18N::translate('There are no notes for this individual.'), '</td></tr>';
84		}
85
86		// New note link
87		if ($controller->record->canEdit()) {
88			?>
89			<tr>
90				<td class="facts_label">
91					<?php echo GedcomTag::getLabel('NOTE'); ?>
92				</td>
93				<td class="facts_value">
94					<a href="#" onclick="add_new_record('<?php echo $controller->record->getXref(); ?>','NOTE'); return false;">
95						<?php echo I18N::translate('Add a new note'); ?>
96					</a>
97				</td>
98			</tr>
99			<tr>
100				<td class="facts_label">
101					<?php echo GedcomTag::getLabel('SHARED_NOTE'); ?>
102				</td>
103				<td class="facts_value">
104					<a href="#" onclick="add_new_record('<?php echo $controller->record->getXref(); ?>','SHARED_NOTE'); return false;">
105						<?php echo I18N::translate('Add a new shared note'); ?>
106					</a>
107				</td>
108			</tr>
109		<?php
110		}
111		?>
112		</table>
113		<?php
114		if (!$WT_TREE->getPreference('SHOW_LEVEL2_NOTES')) {
115			echo '<script>jQuery("tr.row_note2").toggle();</script>';
116		}
117
118		return '<div id="' . $this->getName() . '_content">' . ob_get_clean() . '</div>';
119	}
120
121	/**
122	 * Get all the facts for an individual which contain notes.
123	 *
124	 * @return Fact[]
125	 */
126	private function getFactsWithNotes() {
127		global $controller;
128
129		if ($this->facts === null) {
130			$facts = $controller->record->getFacts();
131			foreach ($controller->record->getSpouseFamilies() as $family) {
132				if ($family->canShow()) {
133					foreach ($family->getFacts() as $fact) {
134						$facts[] = $fact;
135					}
136				}
137			}
138			$this->facts = array();
139			foreach ($facts as $fact) {
140				if (preg_match('/(?:^1|\n\d) NOTE/', $fact->getGedcom())) {
141					$this->facts[] = $fact;
142				}
143			}
144			Functions::sortFacts($this->facts);
145		}
146
147		return $this->facts;
148	}
149
150	/** {@inheritdoc} */
151	public function canLoadAjax() {
152		return !Auth::isSearchEngine(); // Search engines cannot use AJAX
153	}
154
155	/** {@inheritdoc} */
156	public function getPreLoadContent() {
157		return '';
158	}
159}
160