xref: /webtrees/app/Module/LoggedInUsersModule.php (revision 7413816e6dd2d50e569034fb804f3dce7471bb94) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2023 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 <https://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Module;
21
22use Fisharebest\Webtrees\I18N;
23use Fisharebest\Webtrees\Registry;
24use Fisharebest\Webtrees\Statistics;
25use Fisharebest\Webtrees\Tree;
26use Illuminate\Support\Str;
27
28/**
29 * Class LoggedInUsersModule
30 */
31class LoggedInUsersModule extends AbstractModule implements ModuleBlockInterface
32{
33    use ModuleBlockTrait;
34
35    /**
36     * How should this module be identified in the control panel, etc.?
37     *
38     * @return string
39     */
40    public function title(): string
41    {
42        /* I18N: Name of a module. (A list of users who are online now) */
43        return I18N::translate('Who is online');
44    }
45
46    public function description(): string
47    {
48        /* I18N: Description of the “Who is online” module */
49        return I18N::translate('A list of users and visitors who are currently online.');
50    }
51
52    /**
53     * Generate the HTML content of this block.
54     *
55     * @param Tree                 $tree
56     * @param int                  $block_id
57     * @param string               $context
58     * @param array<string,string> $config
59     *
60     * @return string
61     */
62    public function getBlock(Tree $tree, int $block_id, string $context, array $config = []): string
63    {
64        $statistics = Registry::container()->get(Statistics::class);
65        $content    = $statistics->usersLoggedInList();
66
67        if ($context !== self::CONTEXT_EMBED) {
68            return view('modules/block-template', [
69                'block'      => Str::kebab($this->name()),
70                'id'         => $block_id,
71                'config_url' => '',
72                'title'      => $this->title(),
73                'content'    => $content,
74            ]);
75        }
76
77        return $content;
78    }
79
80    /**
81     * Should this block load asynchronously using AJAX?
82     *
83     * Simple blocks are faster in-line, more complex ones can be loaded later.
84     *
85     * @return bool
86     */
87    public function loadAjax(): bool
88    {
89        return false;
90    }
91
92    /**
93     * Can this block be shown on the user’s home page?
94     *
95     * @return bool
96     */
97    public function isUserBlock(): bool
98    {
99        return true;
100    }
101
102    /**
103     * Can this block be shown on the tree’s home page?
104     *
105     * @return bool
106     */
107    public function isTreeBlock(): bool
108    {
109        return true;
110    }
111}
112