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