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