xref: /webtrees/app/Module/DescendancyReportModule.php (revision 3976b4703df669696105ed6b024b96d433c8fbdb)
18c2e8227SGreg Roach<?php
2*3976b470SGreg Roach
38c2e8227SGreg Roach/**
48c2e8227SGreg Roach * webtrees: online genealogy
58fcd0d32SGreg Roach * Copyright (C) 2019 webtrees development team
68c2e8227SGreg Roach * This program is free software: you can redistribute it and/or modify
78c2e8227SGreg Roach * it under the terms of the GNU General Public License as published by
88c2e8227SGreg Roach * the Free Software Foundation, either version 3 of the License, or
98c2e8227SGreg Roach * (at your option) any later version.
108c2e8227SGreg Roach * This program is distributed in the hope that it will be useful,
118c2e8227SGreg Roach * but WITHOUT ANY WARRANTY; without even the implied warranty of
128c2e8227SGreg Roach * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
138c2e8227SGreg Roach * GNU General Public License for more details.
148c2e8227SGreg Roach * You should have received a copy of the GNU General Public License
158c2e8227SGreg Roach * along with this program. If not, see <http://www.gnu.org/licenses/>.
168c2e8227SGreg Roach */
17e7f56f2aSGreg Roachdeclare(strict_types=1);
18e7f56f2aSGreg Roach
1976692c8bSGreg Roachnamespace Fisharebest\Webtrees\Module;
2076692c8bSGreg Roach
210e62c4b8SGreg Roachuse Fisharebest\Webtrees\I18N;
228c2e8227SGreg Roach
238c2e8227SGreg Roach/**
248c2e8227SGreg Roach * Class DescendancyReportModule
258c2e8227SGreg Roach */
2637eb8894SGreg Roachclass DescendancyReportModule extends AbstractModule implements ModuleReportInterface
27c1010edaSGreg Roach{
2849a243cbSGreg Roach    use ModuleReportTrait;
2949a243cbSGreg Roach
30961ec755SGreg Roach    /**
310cfd6963SGreg Roach     * How should this module be identified in the control panel, etc.?
32961ec755SGreg Roach     *
33961ec755SGreg Roach     * @return string
34961ec755SGreg Roach     */
3549a243cbSGreg Roach    public function title(): string
36c1010edaSGreg Roach    {
378c2e8227SGreg Roach        // This text also appears in the .XML file - update both together
38bbb76c12SGreg Roach        /* I18N: Name of a module/report */
39bbb76c12SGreg Roach        return I18N::translate('Descendants');
408c2e8227SGreg Roach    }
418c2e8227SGreg Roach
42961ec755SGreg Roach    /**
43961ec755SGreg Roach     * A sentence describing what this module does.
44961ec755SGreg Roach     *
45961ec755SGreg Roach     * @return string
46961ec755SGreg Roach     */
4749a243cbSGreg Roach    public function description(): string
48c1010edaSGreg Roach    {
498c2e8227SGreg Roach        // This text also appears in the .XML file - update both together
50bbb76c12SGreg Roach        /* I18N: Description of the “Descendants” module */
51bbb76c12SGreg Roach        return I18N::translate('A report of an individual’s descendants, in a narrative style.');
528c2e8227SGreg Roach    }
538c2e8227SGreg Roach}
54