xref: /webtrees/app/Module/MediaListModule.php (revision 3eae54c8a20b98985facfcff8d58c982338bbf85) 
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\Contracts\UserInterface;
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 MediaListModule
33 */
34class MediaListModule 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('Media objects');
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 “MediaListModule” module */
57        return I18N::translate('A list of media objects.');
58    }
59
60    /**
61     * CSS class for the URL.
62     *
63     * @return string
64     */
65    public function listMenuClass(): string
66    {
67        return 'menu-list-obje';
68    }
69
70    /**
71     * @param ServerRequestInterface $request
72     * @param Tree                   $tree
73     * @param UserInterface          $user
74     *
75     * @return ResponseInterface
76     */
77    public function getListAction(ServerRequestInterface $request, Tree $tree, UserInterface $user): ResponseInterface
78    {
79        Auth::checkComponentAccess($this, ModuleListInterface::class, $tree, $user);
80
81        $listController = new ListController(app(IndividualListService::class), app(LocalizationService::class));
82        return $listController->mediaList($request, $tree);
83    }
84
85    /**
86     * @return string[]
87     */
88    public function listUrlAttributes(): array
89    {
90        return [];
91    }
92
93    /**
94     * @param Tree $tree
95     *
96     * @return bool
97     */
98    public function listIsEmpty(Tree $tree): bool
99    {
100        return !DB::table('media')
101            ->where('m_file', '=', $tree->id())
102            ->exists();
103    }
104}
105