. */ declare(strict_types=1); namespace Fisharebest\Webtrees; use Closure; use Exception; use Fisharebest\Webtrees\Functions\FunctionsPrintFacts; use Fisharebest\Webtrees\Http\RequestHandlers\MediaPage; use Illuminate\Database\Capsule\Manager as DB; use Illuminate\Support\Collection; use stdClass; /** * A GEDCOM media (OBJE) object. */ class Media extends GedcomRecord { public const RECORD_TYPE = 'OBJE'; protected const ROUTE_NAME = MediaPage::class; /** * A closure which will create a record from a database row. * * @param Tree $tree * * @return Closure */ public static function rowMapper(Tree $tree): Closure { return static function (stdClass $row) use ($tree): Media { $media = Media::getInstance($row->m_id, $tree, $row->m_gedcom); assert($media instanceof Media); return $media; }; } /** * Get an instance of a media object. For single records, * we just receive the XREF. For bulk records (such as lists * and search results) we can receive the GEDCOM data as well. * * @param string $xref * @param Tree $tree * @param string|null $gedcom * * @throws Exception * * @return Media|null */ public static function getInstance(string $xref, Tree $tree, string $gedcom = null): ?Media { $record = parent::getInstance($xref, $tree, $gedcom); if ($record instanceof self) { return $record; } return null; } /** * Each object type may have its own special rules, and re-implement this function. * * @param int $access_level * * @return bool */ protected function canShowByType(int $access_level): bool { // Hide media objects if they are attached to private records $linked_ids = DB::table('link') ->where('l_file', '=', $this->tree->id()) ->where('l_to', '=', $this->xref) ->pluck('l_from'); foreach ($linked_ids as $linked_id) { $linked_record = GedcomRecord::getInstance($linked_id, $this->tree); if ($linked_record && !$linked_record->canShow($access_level)) { return false; } } // ... otherwise apply default behavior return parent::canShowByType($access_level); } /** * Fetch data from the database * * @param string $xref * @param int $tree_id * * @return string|null */ protected static function fetchGedcomRecord(string $xref, int $tree_id): ?string { return DB::table('media') ->where('m_id', '=', $xref) ->where('m_file', '=', $tree_id) ->value('m_gedcom'); } /** * Get the media files for this media object * * @return Collection */ public function mediaFiles(): Collection { return $this->facts(['FILE']) ->map(function (Fact $fact): MediaFile { return new MediaFile($fact->gedcom(), $this); }); } /** * Get the first media file that contains an image. * * @return MediaFile|null */ public function firstImageFile(): ?MediaFile { return $this->mediaFiles() ->first(static function (MediaFile $media_file): bool { return $media_file->isImage() && !$media_file->isExternal(); }); } /** * Get the first note attached to this media object * * @return string */ public function getNote(): string { $fact = $this->facts(['NOTE'])->first(); if ($fact instanceof Fact) { // Link to note object $note = $fact->target(); if ($note instanceof Note) { return $note->getNote(); } // Inline note return $fact->value(); } return ''; } /** * Extract names from the GEDCOM record. * * @return void */ public function extractNames(): void { $names = []; foreach ($this->mediaFiles() as $media_file) { $names[] = $media_file->title(); } foreach ($this->mediaFiles() as $media_file) { $names[] = $media_file->filename(); } $names = array_filter(array_unique($names)); if ($names === []) { $names[] = $this->getFallBackName(); } foreach ($names as $name) { $this->addName(static::RECORD_TYPE, $name, ''); } } /** * This function should be redefined in derived classes to show any major * identifying characteristics of this record. * * @return string */ public function formatListDetails(): string { ob_start(); FunctionsPrintFacts::printMediaLinks($this->tree(), '1 OBJE @' . $this->xref() . '@', 1); return ob_get_clean(); } /** * Display an image-thumbnail or a media-icon, and add markup for image viewers such as colorbox. * * @param int $width Pixels * @param int $height Pixels * @param string $fit "crop" or "contain" * @param string[] $attributes Additional HTML attributes * * @return string */ public function displayImage($width, $height, $fit, $attributes = []): string { // Display the first image foreach ($this->mediaFiles() as $media_file) { if ($media_file->isImage()) { return $media_file->displayImage($width, $height, $fit, $attributes); } } // Display the first file of any type $media_file = $this->mediaFiles()->first(); if ($media_file instanceof MediaFile) { return $media_file->displayImage($width, $height, $fit, $attributes); } // No image? return ''; } }