xref: /webtrees/app/Module/CalendarMenuModule.php (revision 2ebcf907ed34213f816592af04e6c160335d6311) 
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\Http\RequestHandlers\CalendarPage;
23use Fisharebest\Webtrees\I18N;
24use Fisharebest\Webtrees\Menu;
25use Fisharebest\Webtrees\Tree;
26
27/**
28 * Class CalendarMenuModule - provide a menu option for the calendar
29 */
30class CalendarMenuModule extends AbstractModule implements ModuleMenuInterface
31{
32    use ModuleMenuTrait;
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        /* I18N: Name of a module */
42        return I18N::translate('Calendar');
43    }
44
45    /**
46     * A sentence describing what this module does.
47     *
48     * @return string
49     */
50    public function description(): string
51    {
52        /* I18N: Description of the “Calendar” module */
53        return I18N::translate('The calendar menu.');
54    }
55
56    /**
57     * The default position for this menu.  It can be changed in the control panel.
58     *
59     * @return int
60     */
61    public function defaultMenuOrder(): int
62    {
63        return 4;
64    }
65
66    /**
67     * A menu, to be added to the main application menu.
68     *
69     * @param Tree $tree
70     *
71     * @return Menu|null
72     */
73    public function getMenu(Tree $tree): ?Menu
74    {
75        $submenu = [
76            $this->calendarDayMenu($tree),
77            $this->calendarMonthMenu($tree),
78            $this->calendarYearMenu($tree),
79        ];
80
81        return new Menu(I18N::translate('Calendar'), '#', 'menu-calendar', ['rel' => 'nofollow'], $submenu);
82    }
83
84    /**
85     * @param Tree $tree
86     *
87     * @return Menu
88     */
89    protected function calendarDayMenu(Tree $tree): Menu
90    {
91        return new Menu(I18N::translate('Day'), route(CalendarPage::class, [
92            'view' => 'day',
93            'tree' => $tree->name(),
94        ]), 'menu-calendar-day', ['rel' => 'nofollow']);
95    }
96
97    /**
98     * @param Tree $tree
99     *
100     * @return Menu
101     */
102    protected function calendarMonthMenu(Tree $tree): Menu
103    {
104        return new Menu(I18N::translate('Month'), route(CalendarPage::class, [
105            'view' => 'month',
106            'tree' => $tree->name(),
107        ]), 'menu-calendar-month', ['rel' => 'nofollow']);
108    }
109
110    /**
111     * @param Tree $tree
112     *
113     * @return Menu
114     */
115    protected function calendarYearMenu(Tree $tree): Menu
116    {
117        return new Menu(I18N::translate('Year'), route(CalendarPage::class, [
118            'view' => 'year',
119            'tree' => $tree->name(),
120        ]), 'menu-calendar-year', ['rel' => 'nofollow']);
121    }
122}
123