xref: /webtrees/app/Module/DescendancyReportModule.php (revision 71239cb694d278d044f33328daaa60c8ed7431e9) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2018 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\Auth;
21use Fisharebest\Webtrees\I18N;
22use Fisharebest\Webtrees\Individual;
23use Fisharebest\Webtrees\Menu;
24
25/**
26 * Class DescendancyReportModule
27 */
28class DescendancyReportModule extends AbstractModule implements ModuleReportInterface
29{
30    /** {@inheritdoc} */
31    public function getTitle(): string
32    {
33        // This text also appears in the .XML file - update both together
34        /* I18N: Name of a module/report */
35        return I18N::translate('Descendants');
36    }
37
38    /** {@inheritdoc} */
39    public function getDescription(): string
40    {
41        // This text also appears in the .XML file - update both together
42        /* I18N: Description of the “Descendants” module */
43        return I18N::translate('A report of an individual’s descendants, in a narrative style.');
44    }
45
46    /**
47     * What is the default access level for this module?
48     * Some modules are aimed at admins or managers, and are not generally shown to users.
49     *
50     * @return int
51     */
52    public function defaultAccessLevel(): int
53    {
54        return Auth::PRIV_PRIVATE;
55    }
56
57    /**
58     * Return a menu item for this report.
59     *
60     * @param Individual $individual
61     *
62     * @return Menu
63     */
64    public function getReportMenu(Individual $individual): Menu
65    {
66        return new Menu(
67            $this->getTitle(),
68            route('report-setup', [
69                'xref'   => $individual->xref(),
70                'ged'    => $individual->tree()->name(),
71                'report' => $this->getName(),
72            ]),
73            'menu-report-' . $this->getName(),
74            ['rel' => 'nofollow']
75        );
76    }
77}
78