xref: /webtrees/app/Module/PedigreeReportModule.php (revision fcfa147e10aaa6c7ff580c29bd6e5b88666befc1)
18c2e8227SGreg Roach<?php
23976b470SGreg 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 */
17*fcfa147eSGreg Roach
18e7f56f2aSGreg Roachdeclare(strict_types=1);
19e7f56f2aSGreg Roach
2076692c8bSGreg Roachnamespace Fisharebest\Webtrees\Module;
2176692c8bSGreg Roach
220e62c4b8SGreg Roachuse Fisharebest\Webtrees\I18N;
238c2e8227SGreg Roach
248c2e8227SGreg Roach/**
258c2e8227SGreg Roach * Class PedigreeReportModule
268c2e8227SGreg Roach */
2737eb8894SGreg Roachclass PedigreeReportModule extends AbstractModule implements ModuleReportInterface
28c1010edaSGreg Roach{
2949a243cbSGreg Roach    use ModuleReportTrait;
3049a243cbSGreg Roach
31961ec755SGreg Roach    /**
320cfd6963SGreg Roach     * How should this module be identified in the control panel, etc.?
33961ec755SGreg Roach     *
34961ec755SGreg Roach     * @return string
35961ec755SGreg Roach     */
3649a243cbSGreg Roach    public function title(): string
37c1010edaSGreg Roach    {
388c2e8227SGreg Roach        // This text also appears in the .XML file - update both together
39bbb76c12SGreg Roach        /* I18N: Name of a report */
40bbb76c12SGreg Roach        return I18N::translate('Pedigree');
418c2e8227SGreg Roach    }
428c2e8227SGreg Roach
43961ec755SGreg Roach    /**
44961ec755SGreg Roach     * A sentence describing what this module does.
45961ec755SGreg Roach     *
46961ec755SGreg Roach     * @return string
47961ec755SGreg Roach     */
4849a243cbSGreg Roach    public function description(): string
49c1010edaSGreg Roach    {
508c2e8227SGreg Roach        // This text also appears in the .XML file - update both together
51bbb76c12SGreg Roach        /* I18N: Description of the “Pedigree” module */
52bbb76c12SGreg Roach        return I18N::translate('A report of an individual’s ancestors, formatted as a tree.');
538c2e8227SGreg Roach    }
548c2e8227SGreg Roach}
55