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