xref: /webtrees/app/Module/LoggedInUsersModule.php (revision 1f1ffa65b3b51df2b95b5c68894525436855964a) 
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\I18N;
21use Fisharebest\Webtrees\Statistics;
22use Fisharebest\Webtrees\Tree;
23use Illuminate\Support\Str;
24use Psr\Http\Message\ServerRequestInterface;
25
26/**
27 * Class LoggedInUsersModule
28 */
29class LoggedInUsersModule extends AbstractModule implements ModuleBlockInterface
30{
31    use ModuleBlockTrait;
32
33    /**
34     * How should this module be identified in the control panel, etc.?
35     *
36     * @return string
37     */
38    public function title(): string
39    {
40        /* I18N: Name of a module. (A list of users who are online now) */
41        return I18N::translate('Who is online');
42    }
43
44    /**
45     * A sentence describing what this module does.
46     *
47     * @return string
48     */
49    public function description(): string
50    {
51        /* I18N: Description of the “Who is online” module */
52        return I18N::translate('A list of users and visitors who are currently online.');
53    }
54
55    /**
56     * Generate the HTML content of this block.
57     *
58     * @param Tree     $tree
59     * @param int      $block_id
60     * @param string   $ctype
61     * @param string[] $cfg
62     *
63     * @return string
64     */
65    public function getBlock(Tree $tree, int $block_id, string $ctype = '', array $cfg = []): string
66    {
67        /** @var Statistics $statistics */
68        $statistics = app(Statistics::class);
69
70        $content = '<div class="logged_in_count">' . $statistics->usersLoggedInList() . '</div>';
71
72        if ($ctype !== '') {
73            return view('modules/block-template', [
74                'block'      => Str::kebab($this->name()),
75                'id'         => $block_id,
76                'config_url' => '',
77                'title'      => $this->title(),
78                'content'    => $content,
79            ]);
80        }
81
82        return $content;
83    }
84
85    /** {@inheritdoc} */
86    public function loadAjax(): bool
87    {
88        return false;
89    }
90
91    /** {@inheritdoc} */
92    public function isUserBlock(): bool
93    {
94        return true;
95    }
96
97    /** {@inheritdoc} */
98    public function isTreeBlock(): bool
99    {
100        return true;
101    }
102
103    /**
104     * Update the configuration for a block.
105     *
106     * @param ServerRequestInterface $request
107     * @param int     $block_id
108     *
109     * @return void
110     */
111    public function saveBlockConfiguration(ServerRequestInterface $request, int $block_id): void
112    {
113    }
114
115    /**
116     * An HTML form to edit block settings
117     *
118     * @param Tree $tree
119     * @param int  $block_id
120     *
121     * @return void
122     */
123    public function editBlockConfiguration(Tree $tree, int $block_id): void
124    {
125    }
126}
127