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