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