. */ declare(strict_types=1); namespace Fisharebest\Webtrees\Module; use Fisharebest\Webtrees\Fact; use Fisharebest\Webtrees\GedcomRecord; use Fisharebest\Webtrees\I18N; use Fisharebest\Webtrees\Individual; use Fisharebest\Webtrees\Tree; use Illuminate\Support\Collection; use function e; use function str_contains; use function strtoupper; /** * Class FixPrimaryTag */ class FixPrimaryTag extends AbstractModule implements ModuleDataFixInterface { use ModuleDataFixTrait; /** * 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('Convert _PRIM tags to GEDCOM 5.5.1'); } /** * A sentence describing what this module does. * * @return string */ public function description(): string { /* I18N: Description of a “Data fix” module */ return I18N::translate('“Highlighted image” (_PRIM) tags are used by some genealogy applications to indicate the preferred image for an individual. An alternative is to re-order the images so that the preferred one is listed first.'); } /** * XREFs of media records that might need fixing. * * @param Tree $tree * @param array $params * * @return Collection */ public function mediaToFix(Tree $tree, array $params): Collection { return $this->mediaToFixQuery($tree, $params) ->where('m_file', '=', $tree->id()) ->where('m_gedcom', 'LIKE', "%\n1 _PRIM %") ->pluck('m_id'); } /** * Does a record need updating? * * @param GedcomRecord $record * @param array $params * * @return bool */ public function doesRecordNeedUpdate(GedcomRecord $record, array $params): bool { return str_contains($record->gedcom(), "\n1 _PRIM "); } /** * Show the changes we would make * * @param GedcomRecord $record * @param array $params * * @return string */ public function previewUpdate(GedcomRecord $record, array $params): string { $html = ''; foreach ($record->facts(['_PRIM']) as $prim) { $html = '

' . I18N::translate('Delete') . ' – ' . e($prim->gedcom()) . '

'; } $html .= '
    '; foreach ($record->linkedIndividuals('OBJE') as $individual) { $html .= '
  • ' . I18N::translate('Re-order media') . ' – ' . $individual->fullName() . '
    • '; } $html .= '
'; return $html; } /** * Fix a record * * @param GedcomRecord $record * @param array $params * * @return void */ public function updateRecord(GedcomRecord $record, array $params): void { $facts = $record->facts(['_PRIM'])->filter(static function (Fact $fact): bool { return !$fact->isPendingDeletion(); }); foreach ($facts as $fact) { $primary = strtoupper($fact->value()) !== 'N'; foreach ($record->linkedIndividuals('OBJE') as $individual) { $this->updateMediaLinks($individual, $record->xref(), $primary); } $record->deleteFact($fact->id(), false); } } /** * @param Individual $individual * @param string $xref * @param bool $primary */ private function updateMediaLinks(Individual $individual, string $xref, bool $primary): void { $facts = $individual->facts([], false, null, true); $facts1 = new Collection(); $facts2 = new Collection(); $facts3 = new Collection(); $facts4 = new Collection(); foreach ($facts as $fact) { if ($fact->getTag() !== 'OBJE') { $facts1->push($fact); } elseif ($fact->value() !== '@' . $xref . '@') { $facts3->push($fact); } elseif ($primary) { $facts2->push($fact); } else { $facts4->push($fact); } } $sorted_facts = $facts1->concat($facts2)->concat($facts3)->concat($facts4); $gedcom = $sorted_facts->map(static function (Fact $fact): string { return "\n" . $fact->gedcom(); })->implode(''); $gedcom = '0 @' . $individual->xref() . '@ INDI' . $gedcom; $individual->updateRecord($gedcom, false); } }