xref: /webtrees/app/Module/NoteListModule.php (revision 2dbf429a4992f2ce7ec14038012eed6a58ae47c6) 
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\Http\Controllers\ListController;
22use Fisharebest\Webtrees\I18N;
23use Fisharebest\Webtrees\Services\IndividualListService;
24use Fisharebest\Webtrees\Services\LocalizationService;
25use Fisharebest\Webtrees\Tree;
26use Fisharebest\Webtrees\Auth;
27use Illuminate\Database\Capsule\Manager as DB;
28use Psr\Http\Message\ResponseInterface;
29use Psr\Http\Message\ServerRequestInterface;
30
31/**
32 * Class IndividualListModule
33 */
34class NoteListModule extends AbstractModule implements ModuleListInterface
35{
36    use ModuleListTrait;
37
38    /**
39     * How should this module be identified in the control panel, etc.?
40     *
41     * @return string
42     */
43    public function title(): string
44    {
45        /* I18N: Name of a module/list */
46        return I18N::translate('Shared notes');
47    }
48
49    /**
50     * A sentence describing what this module does.
51     *
52     * @return string
53     */
54    public function description(): string
55    {
56        /* I18N: Description of the “NoteListModule” module */
57        return I18N::translate('A list of shared notes.');
58    }
59
60    /**
61     * CSS class for the URL.
62     *
63     * @return string
64     */
65    public function listMenuClass(): string
66    {
67        return 'menu-list-note';
68    }
69
70    /**
71     * @param ServerRequestInterface $request
72     *
73     * @return ResponseInterface
74     */
75    public function getListAction(ServerRequestInterface $request): ResponseInterface
76    {
77        $tree = $request->getAttribute('tree');
78        $user = $request->getAttribute('user');
79
80        Auth::checkComponentAccess($this, ModuleListInterface::class, $tree, $user);
81
82        $listController = new ListController(app(IndividualListService::class), app(LocalizationService::class));
83        return $listController->noteList($request);
84    }
85
86    /**
87     * @return string[]
88     */
89    public function listUrlAttributes(): array
90    {
91        return [];
92    }
93
94    /**
95     * @param Tree $tree
96     *
97     * @return bool
98     */
99    public function listIsEmpty(Tree $tree): bool
100    {
101        return !DB::table('other')
102            ->where('o_file', '=', $tree->id())
103            ->where('o_type', '=', 'NOTE')
104            ->exists();
105    }
106}
107