xref: /webtrees/app/Module/AlbumModule.php (revision e0486a06db0c3b0e065a465cc3d95c8b317be9a7) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2017 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\I18N;
20use Fisharebest\Webtrees\Media;
21
22/**
23 * Class AlbumModule
24 */
25class AlbumModule extends AbstractModule implements ModuleTabInterface {
26	/** @var Media[] List of media objects. */
27	private $media_list;
28
29	/**
30	 * How should this module be labelled on tabs, menus, etc.?
31	 *
32	 * @return string
33	 */
34	public function getTitle() {
35		return /* I18N: Name of a module */ I18N::translate('Album');
36	}
37
38	/**
39	 * A sentence describing what this module does.
40	 *
41	 * @return string
42	 */
43	public function getDescription() {
44		return /* I18N: Description of the “Album” module */ I18N::translate('An alternative to the “media” tab, and an enhanced image viewer.');
45	}
46
47	/**
48	 * The user can re-arrange the tab order, but until they do, this
49	 * is the order in which tabs are shown.
50	 *
51	 * @return int
52	 */
53	public function defaultTabOrder() {
54		return 60;
55	}
56
57	/**
58	 * Is this tab empty? If so, we don't always need to display it.
59	 *
60	 * @return bool
61	 */
62	public function hasTabContent() {
63		global $WT_TREE;
64
65		return Auth::isEditor($WT_TREE) || $this->getMedia();
66	}
67
68	/**
69	 * A greyed out tab has no actual content, but may perhaps have
70	 * options to create content.
71	 *
72	 * @return bool
73	 */
74	public function isGrayedOut() {
75		return !$this->getMedia();
76	}
77
78	/**
79	 * Generate the HTML content of this tab.
80	 *
81	 * @return string
82	 */
83	public function getTabContent() {
84		$html = '<div id="' . $this->getName() . '_content">';
85		$html .= '<div>';
86		$html .= '<ul class="album-list">';
87		foreach ($this->getMedia() as $media) {
88			$html .= '<li class="album-list-item">';
89			$html .= '<div class="album-image">' . $media->displayImage(100, 100, 'contain', []) . '</div>';
90			$html .= '<div class="album-title"><a href="' . $media->getXref() . '">' . $media->getFullName() . '</a></div>';
91			$html .= '</li>';
92		}
93		$html .= '</ul>';
94		$html .= '</div>';
95		$html .= '</div>';
96
97		return $html;
98	}
99
100	/**
101	 * Get all facts containing media links for this person and their spouse-family records
102	 *
103	 * @return Media[]
104	 */
105	private function getMedia() {
106		global $controller;
107
108		if ($this->media_list === null) {
109			// Use facts from this individual and all their spouses
110			$facts = $controller->record->getFacts();
111			foreach ($controller->record->getSpouseFamilies() as $family) {
112				foreach ($family->getFacts() as $fact) {
113					$facts[] = $fact;
114				}
115			}
116			// Use all media from each fact
117			$this->media_list = [];
118			foreach ($facts as $fact) {
119				// Don't show pending edits, as the user just sees duplicates
120				if (!$fact->isPendingDeletion()) {
121					preg_match_all('/(?:^1|\n\d) OBJE @(' . WT_REGEX_XREF . ')@/', $fact->getGedcom(), $matches);
122					foreach ($matches[1] as $match) {
123						$media = Media::getInstance($match, $controller->record->getTree());
124						if ($media && $media->canShow()) {
125							$this->media_list[] = $media;
126						}
127					}
128				}
129			}
130			// If a media object is linked twice, only show it once
131			$this->media_list = array_unique($this->media_list);
132			// Sort these using _WT_OBJE_SORT
133			$wt_obje_sort = [];
134			foreach ($controller->record->getFacts('_WT_OBJE_SORT') as $fact) {
135				$wt_obje_sort[] = trim($fact->getValue(), '@');
136			}
137			usort($this->media_list, function (Media $x, Media $y) use ($wt_obje_sort) {
138				return array_search($x->getXref(), $wt_obje_sort) - array_search($y->getXref(), $wt_obje_sort);
139			});
140		}
141
142		return $this->media_list;
143	}
144
145	/**
146	 * Can this tab load asynchronously?
147	 *
148	 * @return bool
149	 */
150	public function canLoadAjax() {
151		return false;
152	}
153
154	/**
155	 * Any content (e.g. Javascript) that needs to be rendered before the tabs.
156	 *
157	 * This function is probably not needed, as there are better ways to achieve this.
158	 *
159	 * @return string
160	 */
161	public function getPreLoadContent() {
162		return '';
163	}
164}
165