xref: /webtrees/app/Module/FamilyGroupReportModule.php (revision 59597b37d69e8147c3f4a27643e9c8edaa2a0592) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2019 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 <http://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Module;
21
22use Fisharebest\Webtrees\Family;
23use Fisharebest\Webtrees\I18N;
24use Fisharebest\Webtrees\Individual;
25use Fisharebest\Webtrees\Menu;
26
27/**
28 * Class FamilyGroupReportModule
29 */
30class FamilyGroupReportModule extends AbstractModule implements ModuleReportInterface
31{
32    use ModuleReportTrait;
33
34    /**
35     * How should this module be identified in the control panel, etc.?
36     *
37     * @return string
38     */
39    public function title(): string
40    {
41        // This text also appears in the .XML file - update both together
42        /* I18N: Name of a module/report */
43        return I18N::translate('Family');
44    }
45
46    /**
47     * A sentence describing what this module does.
48     *
49     * @return string
50     */
51    public function description(): string
52    {
53        // This text also appears in the .XML file - update both together
54        /* I18N: Description of the “Family” module */
55        return I18N::translate('A report of family members and their details.');
56    }
57
58    /**
59     * Return a menu item for this report.
60     *
61     * @param Individual $individual
62     *
63     * @return Menu
64     */
65    public function getReportMenu(Individual $individual): Menu
66    {
67        $family = $individual->spouseFamilies()->first() ?? $individual->childFamilies();
68        $xref   = $family instanceof Family ? $family->xref() : '';
69
70        return new Menu(
71            $this->title(),
72            route('report-setup', [
73                'tree'   => $individual->tree()->name(),
74                'xref'   => $xref,
75                'report' => $this->name(),
76            ]),
77            'menu-report-' . $this->name(),
78            ['rel' => 'nofollow']
79        );
80    }
81}
82