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