1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2018 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Individual;
use Fisharebest\Webtrees\Media;
/**
* Class AlbumModule
*/
class AlbumModule extends AbstractModule implements ModuleTabInterface
{
/** @var Media[] List of media objects. */
private $media_list;
/**
* How should this module be labelled on tabs, menus, etc.?
*
* @return string
*/
public function getTitle(): string
{
/* I18N: Name of a module */
return I18N::translate('Album');
}
/**
* A sentence describing what this module does.
*
* @return string
*/
public function getDescription(): string
{
/* I18N: Description of the “Album” module */
return I18N::translate('An alternative to the “media” tab, and an enhanced image viewer.');
}
/**
* The user can re-arrange the tab order, but until they do, this
* is the order in which tabs are shown.
*
* @return int
*/
public function defaultTabOrder(): int
{
return 60;
}
/**
* Is this tab empty? If so, we don't always need to display it.
*
* @param Individual $individual
*
* @return bool
*/
public function hasTabContent(Individual $individual): bool
{
return $individual->canEdit() || $this->getMedia($individual);
}
/**
* A greyed out tab has no actual content, but may perhaps have
* options to create content.
*
* @param Individual $individual
*
* @return bool
*/
public function isGrayedOut(Individual $individual): bool
{
return !$this->getMedia($individual);
}
/**
* Generate the HTML content of this tab.
*
* @param Individual $individual
*
* @return string
*/
public function getTabContent(Individual $individual): string
{
return view('modules/lightbox/tab', [
'media_list' => $this->getMedia($individual),
]);
}
/**
* Get all facts containing media links for this person and their spouse-family records
*
* @param Individual $individual
*
* @return Media[]
*/
private function getMedia(Individual $individual): array
{
if ($this->media_list === null) {
// Use facts from this individual and all their spouses
$facts = $individual->facts();
foreach ($individual->getSpouseFamilies() as $family) {
foreach ($family->facts() as $fact) {
$facts[] = $fact;
}
}
// Use all media from each fact
$this->media_list = [];
foreach ($facts as $fact) {
// Don't show pending edits, as the user just sees duplicates
if (!$fact->isPendingDeletion()) {
preg_match_all('/(?:^1|\n\d) OBJE @(' . WT_REGEX_XREF . ')@/', $fact->gedcom(), $matches);
foreach ($matches[1] as $match) {
$media = Media::getInstance($match, $individual->tree());
if ($media && $media->canShow()) {
$this->media_list[] = $media;
}
}
}
}
// If a media object is linked twice, only show it once
$this->media_list = array_unique($this->media_list);
// Sort these using _WT_OBJE_SORT
$wt_obje_sort = [];
foreach ($individual->facts('_WT_OBJE_SORT') as $fact) {
$wt_obje_sort[] = trim($fact->value(), '@');
}
usort($this->media_list, function (Media $x, Media $y) use ($wt_obje_sort): int {
return array_search($x->xref(), $wt_obje_sort) - array_search($y->xref(), $wt_obje_sort);
});
}
return $this->media_list;
}
/**
* Can this tab load asynchronously?
*
* @return bool
*/
public function canLoadAjax(): bool
{
return false;
}
}
|
