xref: /webtrees/app/Module/ModuleHistoricEventsInterface.php (revision 9b152ff9230017d2c03aa1bf603a98b18250446d)
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 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Module;
21
22use Fisharebest\Webtrees\Individual;
23use Illuminate\Support\Collection;
24
25/**
26 * Interface ModuleHistoricEventsInterface - Show historic facts on an individual‘s page
27 */
28interface ModuleHistoricEventsInterface extends ModuleInterface
29{
30    /**
31     * All events provided by this module.
32     *
33     * @return Collection
34     */
35    public function historicEventsAll(): Collection;
36
37    /**
38     * Which events should we show for an individual?
39     *
40     * @param Individual $individual
41     *
42     * @return Collection
43     */
44    public function historicEventsForIndividual(Individual $individual): Collection;
45}
46