. */ declare(strict_types=1); namespace Fisharebest\Webtrees\Module; use Fisharebest\Webtrees\Fact; use Fisharebest\Webtrees\Factory; use Fisharebest\Webtrees\Gedcom; use Fisharebest\Webtrees\I18N; use Fisharebest\Webtrees\Individual; use Fisharebest\Webtrees\Services\ClipboardService; use Illuminate\Support\Collection; use function preg_match; /** * Class MediaTabModule */ class MediaTabModule extends AbstractModule implements ModuleTabInterface { use ModuleTabTrait; /** @var Collection A list of facts with media objects. */ private $facts; /** @var ClipboardService */ private $clipboard_service; /** * NotesTabModule constructor. * * @param ClipboardService $clipboard_service */ public function __construct(ClipboardService $clipboard_service) { $this->clipboard_service = $clipboard_service; } /** * How should this module be identified in the control panel, etc.? * * @return string */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('Media'); } /** * A sentence describing what this module does. * * @return string */ public function description(): string { /* I18N: Description of the “Media” module */ return I18N::translate('A tab showing the media objects linked to an individual.'); } /** * The default position for this tab. It can be changed in the control panel. * * @return int */ public function defaultTabOrder(): int { return 5; } /** * 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->getFactsWithMedia($individual)->isNotEmpty(); } /** * 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->getFactsWithMedia($individual)->isEmpty(); } /** * Generate the HTML content of this tab. * * @param Individual $individual * * @return string */ public function getTabContent(Individual $individual): string { return view('modules/media/tab', [ 'can_edit' => $individual->canEdit(), 'clipboard_facts' => $this->clipboard_service->pastableFactsOfType($individual, $this->supportedFacts()), 'individual' => $individual, 'facts' => $this->getFactsWithMedia($individual), ]); } /** * Get all the facts for an individual which contain media objects. * * @param Individual $individual * * @return Collection */ protected function getFactsWithMedia(Individual $individual): Collection { return Factory::cache()->array()->remember(__CLASS__ . ':' . __METHOD__, static function () use ($individual): Collection { $facts = $individual->facts(); foreach ($individual->spouseFamilies() as $family) { if ($family->canShow()) { $facts = $facts->concat($family->facts()); } } $facts = $facts->filter(static function (Fact $fact): bool { return preg_match('/(?:^1|\n\d) OBJE @' . Gedcom::REGEX_XREF . '@/', $fact->gedcom()) === 1; }); return Fact::sortFacts($facts); }); } /** * Can this tab load asynchronously? * * @return bool */ public function canLoadAjax(): bool { return false; } /** * This module handles the following facts - so don't show them on the "Facts and events" tab. * * @return Collection */ public function supportedFacts(): Collection { return new Collection(['OBJE']); } }