.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Individual;
use Fisharebest\Webtrees\Tree;
use Fisharebest\Webtrees\User;
use Symfony\Component\HttpFoundation\Request;
/**
* Class LoggedInUsersModule
*/
class LoggedInUsersModule extends AbstractModule implements ModuleBlockInterface
{
use ModuleBlockTrait;
/**
* How should this module be labelled on tabs, menus, etc.?
*
* @return string
*/
public function title(): string
{
/* I18N: Name of a module. (A list of users who are online now) */
return I18N::translate('Who is online');
}
/**
* A sentence describing what this module does.
*
* @return string
*/
public function description(): string
{
/* I18N: Description of the “Who is online” module */
return I18N::translate('A list of users and visitors who are currently online.');
}
/**
* Generate the HTML content of this block.
*
* @param Tree $tree
* @param int $block_id
* @param string $ctype
* @param string[] $cfg
*
* @return string
*/
public function getBlock(Tree $tree, int $block_id, string $ctype = '', array $cfg = []): string
{
$anonymous = 0;
$logged_in = [];
$content = '';
foreach (User::allLoggedIn() as $user) {
if (Auth::isAdmin() || $user->getPreference('visibleonline')) {
$logged_in[] = $user;
} else {
$anonymous++;
}
}
$count_logged_in = count($logged_in);
$content .= '
';
if ($anonymous) {
$content .= I18N::plural('%s anonymous signed-in user', '%s anonymous signed-in users', $anonymous, I18N::number($anonymous));
if ($count_logged_in) {
$content .= ' | ';
}
}
if ($count_logged_in) {
$content .= I18N::plural('%s signed-in user', '%s signed-in users', $count_logged_in, I18N::number($count_logged_in));
}
$content .= '
';
$content .= '';
if (Auth::check()) {
foreach ($logged_in as $user) {
$individual = Individual::getInstance($tree->getUserPreference($user, 'gedcomid'), $tree);
$content .= '
';
if ($individual) {
$content .= '
' . e($user->getRealName()) . '';
} else {
$content .= e($user->getRealName());
}
$content .= ' - ' . e($user->getUserName());
if (Auth::id() !== $user->id() && $user->getPreference('contactmethod') !== 'none') {
$content .= '
' . view('icons/email') . '';
}
$content .= '
';
}
}
$content .= '
';
if ($anonymous === 0 && $count_logged_in === 0) {
return '';
}
if ($ctype !== '') {
return view('modules/block-template', [
'block' => str_replace('_', '-', $this->name()),
'id' => $block_id,
'config_url' => '',
'title' => $this->title(),
'content' => $content,
]);
}
return $content;
}
/** {@inheritdoc} */
public function loadAjax(): bool
{
return false;
}
/** {@inheritdoc} */
public function isUserBlock(): bool
{
return true;
}
/** {@inheritdoc} */
public function isTreeBlock(): bool
{
return true;
}
/**
* Update the configuration for a block.
*
* @param Request $request
* @param int $block_id
*
* @return void
*/
public function saveBlockConfiguration(Request $request, int $block_id)
{
}
/**
* An HTML form to edit block settings
*
* @param Tree $tree
* @param int $block_id
*
* @return void
*/
public function editBlockConfiguration(Tree $tree, int $block_id)
{
}
}