xref: /webtrees/app/Module/ModuleHistoricEventsTrait.php (revision 3ee4c7ef16663dd8419c69876f7c40ed549d5490)
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2023 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
28trait ModuleHistoricEventsTrait
29{
30    public function description(): string
31    {
32        return I18N::translate('Add historic events to an individual’s page.');
33    }
34
35    /**
36     * @return Collection<int,string>
37     */
38    public function historicEventsAll(string $language_tag): Collection
39    {
40        return new Collection();
41    }
42
43    /**
44     * @return Collection<int,Fact>
45     */
46    public function historicEventsForIndividual(Individual $individual): Collection
47    {
48        $min_date = $individual->getEstimatedBirthDate();
49        $max_date = $individual->getEstimatedDeathDate();
50
51        return $this->historicEventsAll(I18N::languageTag())
52            ->map(static fn (string $gedcom): Fact => new Fact($gedcom, $individual, 'histo'))
53            ->filter(static fn (Fact $fact): bool => Date::compare($fact->date(), $min_date) >= 0)
54            ->filter(static fn (Fact $fact): bool => Date::compare($fact->date(), $max_date) <= 0);
55    }
56}
57