xref: /webtrees/app/Module/CalendarMenuModule.php (revision e873f434551745f888937263ff89e80db3b0f785) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2023 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    public function description(): string
46    {
47        /* I18N: Description of the “Calendar” module */
48        return I18N::translate('The calendar menu.');
49    }
50
51    /**
52     * The default position for this menu.  It can be changed in the control panel.
53     *
54     * @return int
55     */
56    public function defaultMenuOrder(): int
57    {
58        return 4;
59    }
60
61    /**
62     * A menu, to be added to the main application menu.
63     */
64    public function getMenu(Tree $tree): Menu|null
65    {
66        $submenu = [
67            $this->calendarDayMenu($tree),
68            $this->calendarMonthMenu($tree),
69            $this->calendarYearMenu($tree),
70        ];
71
72        return new Menu(I18N::translate('Calendar'), '#', 'menu-calendar', ['rel' => 'nofollow'], $submenu);
73    }
74
75    /**
76     * @param Tree $tree
77     *
78     * @return Menu
79     */
80    protected function calendarDayMenu(Tree $tree): Menu
81    {
82        return new Menu(I18N::translate('Day'), route(CalendarPage::class, [
83            'view' => 'day',
84            'tree' => $tree->name(),
85        ]), 'menu-calendar-day', ['rel' => 'nofollow']);
86    }
87
88    /**
89     * @param Tree $tree
90     *
91     * @return Menu
92     */
93    protected function calendarMonthMenu(Tree $tree): Menu
94    {
95        return new Menu(I18N::translate('Month'), route(CalendarPage::class, [
96            'view' => 'month',
97            'tree' => $tree->name(),
98        ]), 'menu-calendar-month', ['rel' => 'nofollow']);
99    }
100
101    /**
102     * @param Tree $tree
103     *
104     * @return Menu
105     */
106    protected function calendarYearMenu(Tree $tree): Menu
107    {
108        return new Menu(I18N::translate('Year'), route(CalendarPage::class, [
109            'view' => 'year',
110            'tree' => $tree->name(),
111        ]), 'menu-calendar-year', ['rel' => 'nofollow']);
112    }
113}
114