xref: /webtrees/app/Module/FamilyGroupReportModule.php (revision 455a30fe529581f1d53045f9c38a0674472d498f) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2021 webtrees development team
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <https://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Module;
21
22use Fisharebest\Webtrees\Family;
23use Fisharebest\Webtrees\Http\RequestHandlers\ReportSetupPage;
24use Fisharebest\Webtrees\I18N;
25use Fisharebest\Webtrees\Individual;
26use Fisharebest\Webtrees\Menu;
27
28/**
29 * Class FamilyGroupReportModule
30 */
31class FamilyGroupReportModule extends AbstractModule implements ModuleReportInterface
32{
33    use ModuleReportTrait;
34
35    /**
36     * How should this module be identified in the control panel, etc.?
37     *
38     * @return string
39     */
40    public function title(): string
41    {
42        // This text also appears in the .XML file - update both together
43        /* I18N: Name of a module/report */
44        return I18N::translate('Family');
45    }
46
47    /**
48     * A sentence describing what this module does.
49     *
50     * @return string
51     */
52    public function description(): string
53    {
54        // This text also appears in the .XML file - update both together
55        /* I18N: Description of the “Family” module */
56        return I18N::translate('A report of family members and their details.');
57    }
58
59    /**
60     * Return a menu item for this report.
61     *
62     * @param Individual $individual
63     *
64     * @return Menu
65     */
66    public function getReportMenu(Individual $individual): Menu
67    {
68        $family = $individual->spouseFamilies()->first() ?? $individual->childFamilies();
69        $xref   = $family instanceof Family ? $family->xref() : '';
70
71        return new Menu(
72            $this->title(),
73            route(ReportSetupPage::class, [
74                'tree'   => $individual->tree()->name(),
75                'xref'   => $xref,
76                'report' => $this->name(),
77            ]),
78            'menu-report-' . $this->name(),
79            ['rel' => 'nofollow']
80        );
81    }
82}
83