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\Auth; 23use Fisharebest\Webtrees\I18N; 24use Fisharebest\Webtrees\Menu; 25use Fisharebest\Webtrees\Tree; 26 27/** 28 * Class SearchMenuModule - provide a menu option for the search options 29 */ 30class SearchMenuModule 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('Search'); 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 “Reports” module */ 53 return I18N::translate('The search 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 6; 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->menuSearchGeneral($tree), 77 $this->menuSearchPhonetic($tree), 78 $this->menuSearchAdvanced($tree), 79 $this->menuSearchAndReplace($tree), 80 ]; 81 82 $submenu = array_filter($submenu); 83 84 return new Menu(I18N::translate('Search'), '#', 'menu-search', ['rel' => 'nofollow'], $submenu); 85 } 86 87 /** 88 * @param Tree $tree 89 * 90 * @return Menu 91 */ 92 protected function menuSearchGeneral(Tree $tree): Menu 93 { 94 return new Menu(I18N::translate('General search'), route('search-general', ['tree' => $tree->name()]), 'menu-search-general', ['rel' => 'nofollow']); 95 } 96 97 /** 98 * @param Tree $tree 99 * 100 * @return Menu 101 */ 102 protected function menuSearchPhonetic(Tree $tree): Menu 103 { 104 /* I18N: search using “sounds like”, rather than exact spelling */ 105 return new Menu(I18N::translate('Phonetic search'), route('search-phonetic', ['tree' => $tree->name(), 'action' => 'soundex']), 'menu-search-soundex', ['rel' => 'nofollow']); 106 } 107 108 /** 109 * @param Tree $tree 110 * 111 * @return Menu 112 */ 113 protected function menuSearchAdvanced(Tree $tree): Menu 114 { 115 return new Menu(I18N::translate('Advanced search'), route('search-advanced', ['tree' => $tree->name()]), 'menu-search-advanced', ['rel' => 'nofollow']); 116 } 117 118 /** 119 * @param Tree $tree 120 * 121 * @return Menu|null 122 */ 123 protected function menuSearchAndReplace(Tree $tree): ?Menu 124 { 125 if (Auth::isEditor($tree)) { 126 return new Menu(I18N::translate('Search and replace'), route('search-replace', [ 127 'tree' => $tree->name(), 128 'action' => 'replace', 129 ]), 'menu-search-replace'); 130 } 131 132 return null; 133 } 134} 135