xref: /webtrees/app/Module/MediaListModule.php (revision 9b152ff9230017d2c03aa1bf603a98b18250446d) 
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\Services\IndividualListService;
25use Fisharebest\Webtrees\Services\LocalizationService;
26use Fisharebest\Webtrees\Tree;
27use Fisharebest\Webtrees\Auth;
28use Illuminate\Database\Capsule\Manager as DB;
29use Psr\Http\Message\ResponseInterface;
30use Psr\Http\Message\ServerRequestInterface;
31
32use function assert;
33use function redirect;
34use function route;
35
36/**
37 * Class MediaListModule
38 */
39class MediaListModule extends AbstractModule implements ModuleListInterface
40{
41    use ModuleListTrait;
42
43    /**
44     * How should this module be identified in the control panel, etc.?
45     *
46     * @return string
47     */
48    public function title(): string
49    {
50        /* I18N: Name of a module/list */
51        return I18N::translate('Media objects');
52    }
53
54    /**
55     * A sentence describing what this module does.
56     *
57     * @return string
58     */
59    public function description(): string
60    {
61        /* I18N: Description of the “Media objects” module */
62        return I18N::translate('A list of media objects.');
63    }
64
65    /**
66     * CSS class for the URL.
67     *
68     * @return string
69     */
70    public function listMenuClass(): string
71    {
72        return 'menu-list-obje';
73    }
74
75    /**
76     * @param ServerRequestInterface $request
77     *
78     * @return ResponseInterface
79     */
80    public function getListAction(ServerRequestInterface $request): ResponseInterface
81    {
82        $tree = $request->getAttribute('tree');
83        assert($tree instanceof Tree);
84
85        $user = $request->getAttribute('user');
86
87        Auth::checkComponentAccess($this, ModuleListInterface::class, $tree, $user);
88
89        $listController = new ListController(app(IndividualListService::class), app(LocalizationService::class));
90        return $listController->mediaList($request);
91    }
92
93    /**
94     * @param ServerRequestInterface $request
95     *
96     * @return ResponseInterface
97     */
98    public function postListAction(ServerRequestInterface $request): ResponseInterface
99    {
100        $tree = $request->getAttribute('tree');
101        assert($tree instanceof Tree);
102
103        return redirect(route('module', [
104            'tree'      => $tree->name(),
105            'module'    => $this->name(),
106            'action'    => 'List',
107        ] + $request->getParsedBody()));
108    }
109
110    /**
111     * @return string[]
112     */
113    public function listUrlAttributes(): array
114    {
115        return [];
116    }
117
118    /**
119     * @param Tree $tree
120     *
121     * @return bool
122     */
123    public function listIsEmpty(Tree $tree): bool
124    {
125        return !DB::table('media')
126            ->where('m_file', '=', $tree->id())
127            ->exists();
128    }
129}
130