1<?php 2 3/** 4 * webtrees: online genealogy 5 * Copyright (C) 2021 webtrees development team 6 * This program is free software: you can redistribute it and/or modify 7 * it under the terms of the GNU General Public License as published by 8 * the Free Software Foundation, either version 3 of the License, or 9 * (at your option) any later version. 10 * This program is distributed in the hope that it will be useful, 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * GNU General Public License for more details. 14 * You should have received a copy of the GNU General Public License 15 * along with this program. If not, see <https://www.gnu.org/licenses/>. 16 */ 17 18declare(strict_types=1); 19 20namespace Fisharebest\Webtrees\Module; 21 22use Fisharebest\Webtrees\Date; 23use Fisharebest\Webtrees\Fact; 24use Fisharebest\Webtrees\I18N; 25use Fisharebest\Webtrees\Individual; 26use Illuminate\Support\Collection; 27 28/** 29 * Trait ModuleHistoricEventsTrait - Show historic events on an individual‘s page 30 */ 31trait ModuleHistoricEventsTrait 32{ 33 /** 34 * A sentence describing what this module does. 35 * 36 * @return string 37 */ 38 public function description(): string 39 { 40 return I18N::translate('Add historic events to an individual’s page.'); 41 } 42 43 /** 44 * All events provided by this module. 45 * 46 * @return Collection<string> 47 */ 48 public function historicEventsAll(): Collection 49 { 50 return new Collection([ 51 "1 EVEN foo\n2 TYPE bar\n2 DATE FROM 6 FEB 1952" 52 ]); 53 } 54 55 /** 56 * Which events should we show for an individual? 57 * 58 * @param Individual $individual 59 * 60 * @return Collection<Fact> 61 */ 62 public function historicEventsForIndividual(Individual $individual): Collection 63 { 64 $min_date = $individual->getEstimatedBirthDate(); 65 $max_date = $individual->getEstimatedDeathDate(); 66 67 return (new Collection($this->historicEventsAll())) 68 ->map(static function (string $gedcom) use ($individual): Fact { 69 return new Fact($gedcom, $individual, 'histo'); 70 }) 71 ->filter(static function (Fact $fact) use ($min_date, $max_date): bool { 72 return Date::compare($fact->date(), $min_date) >= 0 && Date::compare($fact->date(), $max_date) <= 0; 73 }); 74 } 75} 76