1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2021 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Http\RequestHandlers\SearchAdvancedPage;
use Fisharebest\Webtrees\Http\RequestHandlers\SearchGeneralPage;
use Fisharebest\Webtrees\Http\RequestHandlers\SearchPhoneticPage;
use Fisharebest\Webtrees\Http\RequestHandlers\SearchReplacePage;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Menu;
use Fisharebest\Webtrees\Tree;
use function route;
/**
* Class SearchMenuModule - provide a menu option for the search options
*/
class SearchMenuModule extends AbstractModule implements ModuleMenuInterface
{
use ModuleMenuTrait;
/**
* How should this module be identified in the control panel, etc.?
*
* @return string
*/
public function title(): string
{
/* I18N: Name of a module */
return I18N::translate('Search');
}
/**
* A sentence describing what this module does.
*
* @return string
*/
public function description(): string
{
/* I18N: Description of the “Search” module */
return I18N::translate('The search menu.');
}
/**
* The default position for this menu. It can be changed in the control panel.
*
* @return int
*/
public function defaultMenuOrder(): int
{
return 6;
}
/**
* A menu, to be added to the main application menu.
*
* @param Tree $tree
*
* @return Menu|null
*/
public function getMenu(Tree $tree): ?Menu
{
$submenu = [
$this->menuSearchGeneral($tree),
$this->menuSearchPhonetic($tree),
$this->menuSearchAdvanced($tree),
$this->menuSearchAndReplace($tree),
];
$submenu = array_filter($submenu);
return new Menu(I18N::translate('Search'), '#', 'menu-search', ['rel' => 'nofollow'], $submenu);
}
/**
* @param Tree $tree
*
* @return Menu
*/
protected function menuSearchGeneral(Tree $tree): Menu
{
return new Menu(I18N::translate('General search'), route(SearchGeneralPage::class, ['tree' => $tree->name()]), 'menu-search-general', ['rel' => 'nofollow']);
}
/**
* @param Tree $tree
*
* @return Menu
*/
protected function menuSearchPhonetic(Tree $tree): Menu
{
$url = route(SearchPhoneticPage::class, ['tree' => $tree->name()]);
/* I18N: search using “sounds like”, rather than exact spelling */
return new Menu(I18N::translate('Phonetic search'), $url, 'menu-search-soundex', ['rel' => 'nofollow']);
}
/**
* @param Tree $tree
*
* @return Menu
*/
protected function menuSearchAdvanced(Tree $tree): Menu
{
$url = route(SearchAdvancedPage::class, ['tree' => $tree->name()]);
return new Menu(I18N::translate('Advanced search'), $url, 'menu-search-advanced', ['rel' => 'nofollow']);
}
/**
* @param Tree $tree
*
* @return Menu|null
*/
protected function menuSearchAndReplace(Tree $tree): ?Menu
{
if (Auth::isEditor($tree)) {
$url = route(SearchReplacePage::class, ['tree' => $tree->name()]);
return new Menu(I18N::translate('Search and replace'), $url, 'menu-search-replace');
}
return null;
}
}
|
