xref: /webtrees/app/Module/AlbumModule.php (revision bd10b336a51f5826e8e665f7e2f4e057230251db) 
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		global $WT_TREE, $controller;
85
86		$html = '<div id="' . $this->getName() . '_content">';
87		$html .= '<div class="facts_value">';
88		$html .= '<ul class="album-list">';
89		foreach ($this->getMedia() as $media) {
90			$html .= '<li class="album-list-item">';
91			$html .= '<div class="album-image">' . $media->displayImage(100, 100, 'contain', []) . '</div>';
92			$html .= '<div class="album-title"><a href="' . $media->getXref() . '">' . $media->getFullName() . '</a></div>';
93			$html .= '</li>';
94		}
95		$html .= '</ul>';
96		$html .= '</div>';
97		$html .= '</div>';
98
99		return $html;
100	}
101
102	/**
103	 * Get all facts containing media links for this person and their spouse-family records
104	 *
105	 * @return Media[]
106	 */
107	private function getMedia() {
108		global $controller;
109
110		if ($this->media_list === null) {
111			// Use facts from this individual and all their spouses
112			$facts = $controller->record->getFacts();
113			foreach ($controller->record->getSpouseFamilies() as $family) {
114				foreach ($family->getFacts() as $fact) {
115					$facts[] = $fact;
116				}
117			}
118			// Use all media from each fact
119			$this->media_list = [];
120			foreach ($facts as $fact) {
121				// Don't show pending edits, as the user just sees duplicates
122				if (!$fact->isPendingDeletion()) {
123					preg_match_all('/(?:^1|\n\d) OBJE @(' . WT_REGEX_XREF . ')@/', $fact->getGedcom(), $matches);
124					foreach ($matches[1] as $match) {
125						$media = Media::getInstance($match, $controller->record->getTree());
126						if ($media && $media->canShow()) {
127							$this->media_list[] = $media;
128						}
129					}
130				}
131			}
132			// If a media object is linked twice, only show it once
133			$this->media_list = array_unique($this->media_list);
134			// Sort these using _WT_OBJE_SORT
135			$wt_obje_sort = [];
136			foreach ($controller->record->getFacts('_WT_OBJE_SORT') as $fact) {
137				$wt_obje_sort[] = trim($fact->getValue(), '@');
138			}
139			usort($this->media_list, function (Media $x, Media $y) use ($wt_obje_sort) {
140				return array_search($x->getXref(), $wt_obje_sort) - array_search($y->getXref(), $wt_obje_sort);
141			});
142		}
143
144		return $this->media_list;
145	}
146
147	/**
148	 * Can this tab load asynchronously?
149	 *
150	 * @return bool
151	 */
152	public function canLoadAjax() {
153		return false;
154	}
155
156	/**
157	 * Any content (e.g. Javascript) that needs to be rendered before the tabs.
158	 *
159	 * This function is probably not needed, as there are better ways to achieve this.
160	 *
161	 * @return string
162	 */
163	public function getPreLoadContent() {
164		return '';
165	}
166}
167