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