. */ declare(strict_types=1); namespace Fisharebest\Webtrees\Services; use Fisharebest\Webtrees\Fact; use Fisharebest\Webtrees\GedcomRecord; use Fisharebest\Webtrees\Session; use Illuminate\Support\Collection; /** * Copy and past facts between records. */ class ClipboardService { // Maximum number of entries in the clipboard. private const CLIPBOARD_SIZE = 10; /** * Copy a fact to the clipboard. * * @param Fact $fact */ public function copyFact(Fact $fact): void { $clipboard = Session::get('clipboard', []); $record_type = $fact->record()::RECORD_TYPE; $fact_id = $fact->id(); // If we are copying the same fact twice, make sure the new one is at the end. unset($clipboard[$record_type][$fact_id]); $clipboard[$record_type][$fact_id] = [ 'factrec' => $fact->gedcom(), 'fact' => $fact->tag(), ]; // The clipboard only holds a limited number of facts. $clipboard[$record_type] = array_slice($clipboard[$record_type], -self::CLIPBOARD_SIZE); Session::put('clipboard', $clipboard); } /** * Copy a fact from the clipboard to a record. * * @param string $fact_id * @param GedcomRecord $record * * @return bool */ public function pasteFact(string $fact_id, GedcomRecord $record): bool { $clipboard = Session::get('clipboard'); $record_type = $record::RECORD_TYPE; if (isset($clipboard[$record_type][$fact_id])) { $record->createFact($clipboard[$record_type][$fact_id]['factrec'], true); return true; } return false; } /** * Create a list of facts that can be pasted into a given record * * @param GedcomRecord $record * @param Collection $exclude_types * * @return Collection */ public function pastableFacts(GedcomRecord $record, Collection $exclude_types): Collection { // The facts are stored in the session. return (new Collection(Session::get('clipboard', [])[$record::RECORD_TYPE] ?? [])) // Put the most recently copied fact at the top of the list. ->reverse() // Create facts for the record. ->map(static function (array $clipping) use ($record): Fact { return new Fact($clipping['factrec'], $record, md5($clipping['factrec'])); })->filter(static function (Fact $fact) use ($exclude_types): bool { return $exclude_types->isEmpty() || !$exclude_types->contains($fact->tag()); }); } /** * Find facts of a given type, from all records. * * @param GedcomRecord $record * @param Collection $types * * @return Collection */ public function pastableFactsOfType(GedcomRecord $record, Collection $types): Collection { // The facts are stored in the session. return (new Collection(Session::get('clipboard', []))) ->flatten(1) ->reverse() ->map(static function (array $clipping) use ($record): Fact { return new Fact($clipping['factrec'], $record, md5($clipping['factrec'])); }) ->filter(static function (Fact $fact) use ($types): bool { return $types->contains($fact->tag()); }); } }