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\Auth; 21use Fisharebest\Webtrees\I18N; 22use Fisharebest\Webtrees\Menu; 23use Fisharebest\Webtrees\Tree; 24 25/** 26 * Class SearchMenuModule - provide a menu option for the search options 27 */ 28class SearchMenuModule extends AbstractModule implements ModuleMenuInterface 29{ 30 use ModuleMenuTrait; 31 32 /** 33 * How should this module be identified in the control panel, etc.? 34 * 35 * @return string 36 */ 37 public function title(): string 38 { 39 /* I18N: Name of a module */ 40 return I18N::translate('Search'); 41 } 42 43 /** 44 * A sentence describing what this module does. 45 * 46 * @return string 47 */ 48 public function description(): string 49 { 50 /* I18N: Description of the “Reports” module */ 51 return I18N::translate('The search menu.'); 52 } 53 54 /** 55 * The default position for this menu. It can be changed in the control panel. 56 * 57 * @return int 58 */ 59 public function defaultMenuOrder(): int 60 { 61 return 6; 62 } 63 64 /** 65 * A menu, to be added to the main application menu. 66 * 67 * @param Tree $tree 68 * 69 * @return Menu|null 70 */ 71 public function getMenu(Tree $tree): ?Menu 72 { 73 $submenu = [ 74 $this->menuSearchGeneral($tree), 75 $this->menuSearchPhonetic($tree), 76 $this->menuSearchAdvanced($tree), 77 $this->menuSearchAndReplace($tree), 78 ]; 79 80 $submenu = array_filter($submenu); 81 82 return new Menu(I18N::translate('Search'), '#', 'menu-search', ['rel' => 'nofollow'], $submenu); 83 } 84 85 /** 86 * @param Tree $tree 87 * 88 * @return Menu 89 */ 90 protected function menuSearchGeneral(Tree $tree): Menu 91 { 92 return new Menu(I18N::translate('General search'), route('search-general', ['ged' => $tree->name()]), 'menu-search-general', ['rel' => 'nofollow']); 93 } 94 95 /** 96 * @param Tree $tree 97 * 98 * @return Menu 99 */ 100 protected function menuSearchPhonetic(Tree $tree): Menu 101 { 102 /* I18N: search using “sounds like”, rather than exact spelling */ 103 return new Menu(I18N::translate('Phonetic search'), route('search-phonetic', ['ged' => $tree->name(), 'action' => 'soundex']), 'menu-search-soundex', ['rel' => 'nofollow']); 104 } 105 106 /** 107 * @param Tree $tree 108 * 109 * @return Menu 110 */ 111 protected function menuSearchAdvanced(Tree $tree): Menu 112 { 113 return new Menu(I18N::translate('Advanced search'), route('search-advanced', ['ged' => $tree->name()]), 'menu-search-advanced', ['rel' => 'nofollow']); 114 } 115 116 /** 117 * @param Tree $tree 118 * 119 * @return Menu|null 120 */ 121 protected function menuSearchAndReplace(Tree $tree): ?Menu 122 { 123 if (Auth::isEditor($tree)) { 124 return new Menu(I18N::translate('Search and replace'), route('search-replace', [ 125 'ged' => $tree->name(), 126 'action' => 'replace', 127 ]), 'menu-search-replace'); 128 } 129 130 return null; 131 } 132} 133