xref: /webtrees/app/Statistics/Repository/Interfaces/LatestUserRepositoryInterface.php (revision ad7270802ba57a28d195fc58fcc55f26458a779a) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2018 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\Statistics\Repository\Interfaces;
19
20/**
21 * A repository providing methods for latest user related statistics.
22 */
23interface LatestUserRepositoryInterface
24{
25    /**
26     * Get the newest registered user's ID.
27     *
28     * @return string
29     */
30    public function latestUserId(): string;
31
32    /**
33     * Get the newest registered user's username.
34     *
35     * @return string
36     */
37    public function latestUserName(): string;
38
39    /**
40     * Get the newest registered user's real name.
41     *
42     * @return string
43     */
44    public function latestUserFullName(): string;
45
46    /**
47     * Get the date of the newest user registration.
48     *
49     * @param string|null $format
50     *
51     * @return string
52     */
53    public function latestUserRegDate(string $format = null): string;
54
55    /**
56     * Find the timestamp of the latest user to register.
57     *
58     * @param string|null $format
59     *
60     * @return string
61     */
62    public function latestUserRegTime(string $format = null): string;
63
64    /**
65     * Is the most recently registered user logged in right now?
66     *
67     * @param string|null $yes
68     * @param string|null $no
69     *
70     * @return string
71     */
72    public function latestUserLoggedin(string $yes = null, string $no = null): string;
73}
74