xref: /webtrees/app/Module/ListsMenuModule.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\I18N;
21use Fisharebest\Webtrees\Menu;
22use Fisharebest\Webtrees\Tree;
23use Illuminate\Database\Capsule\Manager as DB;
24
25/**
26 * Class ListsMenuModule - provide a menu option for the lists
27 */
28class ListsMenuModule 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('Lists');
37    }
38
39    /** {@inheritdoc} */
40    public function description(): string
41    {
42        /* I18N: Description of the “Reports” module */
43        return I18N::translate('The lists 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 30;
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        // Do not show empty lists
66        $sources_exist = DB::table('sources')
67            ->where('s_file', '=', $tree->id())
68            ->exists();
69
70        $repositories_exist = DB::table('other')
71            ->where('o_file', '=', $tree->id())
72            ->where('o_type', '=', 'REPO')
73            ->exists();
74
75        $notes_exist = DB::table('other')
76            ->where('o_file', '=', $tree->id())
77            ->where('o_type', '=', 'NOTE')
78            ->exists();
79
80        $media_exist = DB::table('media')
81            ->where('m_file', '=', $tree->id())
82            ->exists();
83
84        $submenus = [
85            new Menu(I18N::translate('Individuals'), route('individual-list', ['ged' => $tree->name()]), 'menu-list-indi'),
86            new Menu(I18N::translate('Families'), route('family-list', ['ged' => $tree->name()]), 'menu-list-fam'),
87            new Menu(I18N::translate('Branches'), route('branches', ['ged' => $tree->name()]), 'menu-branches', ['rel' => 'nofollow']),
88            new Menu(I18N::translate('Place hierarchy'), route('place-hierarchy', ['ged' => $tree->name()]), 'menu-list-plac', ['rel' => 'nofollow']),
89        ];
90
91        if ($media_exist) {
92            $submenus[] = new Menu(I18N::translate('Media objects'), route('media-list', ['ged' => $tree->name()]), 'menu-list-obje', ['rel' => 'nofollow']);
93        }
94        if ($repositories_exist) {
95            $submenus[] = new Menu(I18N::translate('Repositories'), route('repository-list', ['ged' => $tree->name()]), 'menu-list-repo', ['rel' => 'nofollow']);
96        }
97        if ($sources_exist) {
98            $submenus[] = new Menu(I18N::translate('Sources'), route('source-list', ['ged' => $tree->name()]), 'menu-list-sour', ['rel' => 'nofollow']);
99        }
100        if ($notes_exist) {
101            $submenus[] = new Menu(I18N::translate('Shared notes'), route('note-list', ['ged' => $tree->name()]), 'menu-list-note', ['rel' => 'nofollow']);
102        }
103
104        uasort($submenus, function (Menu $x, Menu $y) {
105            return I18N::strcasecmp($x->getLabel(), $y->getLabel());
106        });
107
108        return new Menu(I18N::translate('Lists'), '#', 'menu-list', [], $submenus);
109    }
110}
111