xref: /webtrees/app/Module/ModuleHistoricEventsTrait.php (revision 3cfcc809af53e831fa6cafac7b274a2cb407db6e) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2019 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 <http://www.gnu.org/licenses/>.
16 */
17declare(strict_types=1);
18
19namespace Fisharebest\Webtrees\Module;
20
21use Fisharebest\Webtrees\Date;
22use Fisharebest\Webtrees\Fact;
23use Fisharebest\Webtrees\I18N;
24use Fisharebest\Webtrees\Individual;
25use Illuminate\Support\Collection;
26
27/**
28 * Trait ModuleHistoricEventsTrait - Show historic events on an individual‘s page
29 */
30trait ModuleHistoricEventsTrait
31{
32    /**
33     * A sentence describing what this module does.
34     *
35     * @return string
36     */
37    public function description(): string
38    {
39        return I18N::translate('Add historic events to an individual‘s page.');
40    }
41
42    /**
43     * All events provided by this module.
44     *
45     * @return string[]
46     */
47    public function historicEventsAll(): array
48    {
49        return [
50            "1 EVEN foo\n2 TYPE bar\n2 DATE FROM 6 FEB 1952"
51        ];
52    }
53
54    /**
55     * Which events should we show for an individual?
56     *
57     * @param Individual $individual
58     *
59     * @return Collection
60     */
61    public function historicEventsForIndividual(Individual $individual): Collection
62    {
63        $min_date = $individual->getEstimatedBirthDate();
64        $max_date = $individual->getEstimatedDeathDate();
65
66        return (new Collection($this->historicEventsAll()))
67            ->map(static function (string $gedcom) use ($individual): Fact {
68                return new Fact($gedcom, $individual, 'histo');
69            })
70            ->filter(static function (Fact $fact) use ($min_date, $max_date): bool {
71                return Date::compare($fact->date(), $min_date) >= 0 && Date::compare($fact->date(), $max_date) <= 0;
72            });
73    }
74}
75