xref: /webtrees/app/Module/FamilyBookChartModule.php (revision 54452b04856df5056fa76d9764beb95110c35d02) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2019 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\I18N;
21use Fisharebest\Webtrees\Individual;
22use Fisharebest\Webtrees\Menu;
23
24/**
25 * Class FamilyBookChartModule
26 */
27class FamilyBookChartModule extends AbstractModule implements ModuleInterface, ModuleChartInterface
28{
29    use ModuleChartTrait;
30
31    /**
32     * How should this module be labelled on tabs, menus, etc.?
33     *
34     * @return string
35     */
36    public function title(): string
37    {
38        /* I18N: Name of a module/chart */
39        return I18N::translate('Family book');
40    }
41
42    /**
43     * A sentence describing what this module does.
44     *
45     * @return string
46     */
47    public function description(): string
48    {
49        /* I18N: Description of the “FamilyBookChart” module */
50        return I18N::translate('A chart of an individual’s ancestors and descendants, as a family book.');
51    }
52
53    /**
54     * CSS class for the URL.
55     *
56     * @return string
57     */
58    public function chartMenuClass(): string
59    {
60        return 'menu-chart-familybook';
61    }
62
63    /**
64     * Return a menu item for this chart - for use in individual boxes.
65     *
66     * @param Individual $individual
67     *
68     * @return Menu|null
69     */
70    public function chartBoxMenu(Individual $individual): ?Menu
71    {
72        return $this->chartMenu($individual);
73    }
74
75    /**
76     * The title for a specific instance of this chart.
77     *
78     * @param Individual $individual
79     *
80     * @return string
81     */
82    public function chartTitle(Individual $individual): string
83    {
84        /* I18N: %s is an individual’s name */
85        return I18N::translate('Family book of %s', $individual->getFullName());
86    }
87
88    /**
89     * The URL for this chart.
90     *
91     * @param Individual $individual
92     * @param string[]   $parameters
93     *
94     * @return string
95     */
96    public function chartUrl(Individual $individual, array $parameters = []): string
97    {
98        return route('family-book', [
99            'ged'  => $individual->tree()->name(),
100            'xref' => $individual->xref(),
101        ] + $parameters);
102    }
103}
104