LoggedInUsersModule::isTreeBlock()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 1
nc 1
nop 0
dl 0
loc 3
rs 10
c 0
b 0
f 0
1
<?php
2
3
/**
4
 * webtrees: online genealogy
5
 * Copyright (C) 2025 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
18
declare(strict_types=1);
19
20
namespace Fisharebest\Webtrees\Module;
21
22
use Fisharebest\Webtrees\I18N;
0 ignored issues
show
Bug introduced by
The type Fisharebest\Webtrees\I18N was not found. Maybe you did not declare it correctly or list all dependencies?

The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:

filter:
    dependency_paths: ["lib/*"]

For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths

Loading history...
23
use Fisharebest\Webtrees\Registry;
24
use Fisharebest\Webtrees\Statistics;
25
use Fisharebest\Webtrees\Tree;
26
use Illuminate\Support\Str;
27
28
class LoggedInUsersModule extends AbstractModule implements ModuleBlockInterface
0 ignored issues
show
Bug introduced by
The type Fisharebest\Webtrees\Module\ModuleBlockInterface was not found. Maybe you did not declare it correctly or list all dependencies?

The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:

filter:
    dependency_paths: ["lib/*"]

For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths

Loading history...
29
{
30
    use ModuleBlockTrait;
31
32
    public function title(): string
33
    {
34
        /* I18N: Name of a module. (A list of users who are online now) */
35
        return I18N::translate('Who is online');
36
    }
37
38
    public function description(): string
39
    {
40
        /* I18N: Description of the “Who is online” module */
41
        return I18N::translate('A list of users and visitors who are currently online.');
42
    }
43
44
    /**
45
     * Generate the HTML content of this block.
46
     *
47
     * @param Tree                 $tree
48
     * @param int                  $block_id
49
     * @param string               $context
50
     * @param array<string,string> $config
51
     *
52
     * @return string
53
     */
54
    public function getBlock(Tree $tree, int $block_id, string $context, array $config = []): string
55
    {
56
        $statistics = Registry::container()->get(Statistics::class);
57
        $content    = $statistics->usersLoggedInList();
58
59
        if ($context !== self::CONTEXT_EMBED) {
60
            return view('modules/block-template', [
61
                'block'      => Str::kebab($this->name()),
62
                'id'         => $block_id,
63
                'config_url' => '',
64
                'title'      => $this->title(),
65
                'content'    => $content,
66
            ]);
67
        }
68
69
        return $content;
70
    }
71
72
    /**
73
     * Should this block load asynchronously using AJAX?
74
     *
75
     * Simple blocks are faster in-line, more complex ones can be loaded later.
76
     *
77
     * @return bool
78
     */
79
    public function loadAjax(): bool
80
    {
81
        return false;
82
    }
83
84
    /**
85
     * Can this block be shown on the user’s home page?
86
     *
87
     * @return bool
88
     */
89
    public function isUserBlock(): bool
90
    {
91
        return true;
92
    }
93
94
    /**
95
     * Can this block be shown on the tree’s home page?
96
     *
97
     * @return bool
98
     */
99
    public function isTreeBlock(): bool
100
    {
101
        return true;
102
    }
103
}
104