. */ namespace Fisharebest\Webtrees\Module; use Fisharebest\Webtrees\Auth; use Fisharebest\Webtrees\I18N; 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() { return /* I18N: Name of a module */ I18N::translate('Album'); } /** * A sentence describing what this module does. * * @return string */ public function getDescription() { return /* I18N: Description of the “Album” module */ 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() { return 60; } /** * Is this tab empty? If so, we don't always need to display it. * * @return bool */ public function hasTabContent() { global $WT_TREE; return Auth::isEditor($WT_TREE) || $this->getMedia(); } /** * A greyed out tab has no actual content, but may perhaps have * options to create content. * * @return bool */ public function isGrayedOut() { return !$this->getMedia(); } /** * Generate the HTML content of this tab. * * @return string */ public function getTabContent() { global $WT_TREE, $controller; $html = '
'; $html .= '
'; $html .= ''; $html .= '
'; $html .= '
'; return $html; } /** * Get all facts containing media links for this person and their spouse-family records * * @return Media[] */ private function getMedia() { global $controller; if ($this->media_list === null) { // Use facts from this individual and all their spouses $facts = $controller->record->getFacts(); foreach ($controller->record->getSpouseFamilies() as $family) { foreach ($family->getFacts() 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->getGedcom(), $matches); foreach ($matches[1] as $match) { $media = Media::getInstance($match, $controller->record->getTree()); 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 ($controller->record->getFacts('_WT_OBJE_SORT') as $fact) { $wt_obje_sort[] = trim($fact->getValue(), '@'); } usort($this->media_list, function (Media $x, Media $y) use ($wt_obje_sort) { return array_search($x->getXref(), $wt_obje_sort) - array_search($y->getXref(), $wt_obje_sort); }); } return $this->media_list; } /** * Can this tab load asynchronously? * * @return bool */ public function canLoadAjax() { return false; } /** * Any content (e.g. Javascript) that needs to be rendered before the tabs. * * This function is probably not needed, as there are better ways to achieve this. * * @return string */ public function getPreLoadContent() { return ''; } }