xref: /webtrees/app/Module/ModuleHistoricEventsInterface.php (revision b5c8fd7e66957665381ee23f19cf39bda22bc768)
117c50b57SGreg Roach<?php
23976b470SGreg Roach
317c50b57SGreg Roach/**
417c50b57SGreg Roach * webtrees: online genealogy
517c50b57SGreg Roach * Copyright (C) 2019 webtrees development team
617c50b57SGreg Roach * This program is free software: you can redistribute it and/or modify
717c50b57SGreg Roach * it under the terms of the GNU General Public License as published by
817c50b57SGreg Roach * the Free Software Foundation, either version 3 of the License, or
917c50b57SGreg Roach * (at your option) any later version.
1017c50b57SGreg Roach * This program is distributed in the hope that it will be useful,
1117c50b57SGreg Roach * but WITHOUT ANY WARRANTY; without even the implied warranty of
1217c50b57SGreg Roach * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1317c50b57SGreg Roach * GNU General Public License for more details.
1417c50b57SGreg Roach * You should have received a copy of the GNU General Public License
1517c50b57SGreg Roach * along with this program. If not, see <http://www.gnu.org/licenses/>.
1617c50b57SGreg Roach */
17fcfa147eSGreg Roach
1817c50b57SGreg Roachdeclare(strict_types=1);
1917c50b57SGreg Roach
2017c50b57SGreg Roachnamespace Fisharebest\Webtrees\Module;
2117c50b57SGreg Roach
22*b5c8fd7eSGreg Roachuse Fisharebest\Webtrees\Fact;
2317c50b57SGreg Roachuse Fisharebest\Webtrees\Individual;
2417c50b57SGreg Roachuse Illuminate\Support\Collection;
2517c50b57SGreg Roach
2617c50b57SGreg Roach/**
2717c50b57SGreg Roach * Interface ModuleHistoricEventsInterface - Show historic facts on an individual‘s page
2817c50b57SGreg Roach */
2917c50b57SGreg Roachinterface ModuleHistoricEventsInterface extends ModuleInterface
3017c50b57SGreg Roach{
3117c50b57SGreg Roach    /**
3217c50b57SGreg Roach     * All events provided by this module.
3317c50b57SGreg Roach     *
34*b5c8fd7eSGreg Roach     * @return Collection<string>
3517c50b57SGreg Roach     */
365b3469b5SGreg Roach    public function historicEventsAll(): Collection;
3717c50b57SGreg Roach
3817c50b57SGreg Roach    /**
3917c50b57SGreg Roach     * Which events should we show for an individual?
4017c50b57SGreg Roach     *
4117c50b57SGreg Roach     * @param Individual $individual
4217c50b57SGreg Roach     *
43*b5c8fd7eSGreg Roach     * @return Collection<Fact>
4417c50b57SGreg Roach     */
4517c50b57SGreg Roach    public function historicEventsForIndividual(Individual $individual): Collection;
4617c50b57SGreg Roach}
47