xref: /webtrees/app/Module/NotesTabModule.php (revision 14c3d3fb510e1c4899ec81cb0d1d1e7e08af7079)
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		<div class="descriptionbox rela">
66				<input id="checkbox_note2" type="checkbox" <?php echo $WT_TREE->getPreference('SHOW_LEVEL2_NOTES') ? 'checked' : ''; ?> onclick="jQuery('tr.row_note2').toggle();">
67		<label for="checkbox_note2"><?php echo I18N::translate('Show all notes'); ?></label>
68		</div>
69		<table class="facts_table">
70
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