xref: /webtrees/app/Statistics/Repository/Interfaces/UserRepositoryInterface.php (revision d11be7027e34e3121be11cc025421873364403f9)

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2023 webtrees development team
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace Fisharebest\Webtrees\Statistics\Repository\Interfaces;

/**
 * A repository providing methods for user related statistics.
 */
interface UserRepositoryInterface
{
    /**
     * Who is currently logged in?
     *
     * @return string
     */
    public function usersLoggedIn(): string;

    /**
     * Who is currently logged in?
     *
     * @return string
     */
    public function usersLoggedInList(): string;

    /**
     * Returns the total number of logged in users (visible or anonymous).
     *
     * @return int
     */
    public function usersLoggedInTotal(): int;

    /**
     * Returns the total number of anonymous logged in users.
     *
     * @return int
     */
    public function usersLoggedInTotalAnon(): int;

    /**
     * Returns the total number of visible logged in users.
     *
     * @return int
     */
    public function usersLoggedInTotalVisible(): int;

    /**
     * Get the current user's ID.
     *
     * @return string
     */
    public function userId(): string;

    /**
     * Get the current user's username.
     *
     * @param string $visitor_text
     *
     * @return string
     */
    public function userName(string $visitor_text = ''): string;

    /**
     * Get the current user's full name.
     *
     * @return string
     */
    public function userFullName(): string;

    /**
     * Count the number of users.
     *
     * @return string
     */
    public function totalUsers(): string;

    /**
     * Count the number of administrators.
     *
     * @return string
     */
    public function totalAdmins(): string;

    /**
     * Count the number of administrators.
     *
     * @return string
     */
    public function totalNonAdmins(): string;
}