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