xref: /webtrees/app/Module/ModuleHistoricEventsInterface.php (revision 3c04ac885329c9488ff9db0a765e872bf41b9781)
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\Individual;
21use Illuminate\Support\Collection;
22
23/**
24 * Interface ModuleHistoricEventsInterface - Show historic facts on an individual‘s page
25 */
26interface ModuleHistoricEventsInterface extends ModuleInterface
27{
28    /**
29     * All events provided by this module.
30     *
31     * @param Individual $individual
32     *
33     * @return string[]
34     */
35    public function historicEventsAll(): array;
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