xref: /webtrees/app/Statistics/Repository/Interfaces/HitCountRepositoryInterface.php (revision 44600102a007388f5288cc626f7b2a63c01d31bf) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2023 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
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Statistics\Repository\Interfaces;
21
22/**
23 * A repository providing methods for hit count related statistics.
24 */
25interface HitCountRepositoryInterface
26{
27    /**
28     * How many times has a page been viewed.
29     *
30     * @param string $page_parameter
31     *
32     * @return string
33     */
34    public function hitCount(string $page_parameter = ''): string;
35
36    /**
37     * How many times has a page been viewed.
38     *
39     * @param string $page_parameter
40     *
41     * @return string
42     */
43    public function hitCountUser(string $page_parameter = ''): string;
44
45    /**
46     * How many times has a page been viewed.
47     *
48     * @param string $page_parameter
49     *
50     * @return string
51     */
52    public function hitCountIndi(string $page_parameter = ''): string;
53
54    /**
55     * How many times has a page been viewed.
56     *
57     * @param string $page_parameter
58     *
59     * @return string
60     */
61    public function hitCountFam(string $page_parameter = ''): string;
62
63    /**
64     * How many times has a page been viewed.
65     *
66     * @param string $page_parameter
67     *
68     * @return string
69     */
70    public function hitCountSour(string $page_parameter = ''): string;
71
72    /**
73     * How many times has a page been viewed.
74     *
75     * @param string $page_parameter
76     *
77     * @return string
78     */
79    public function hitCountRepo(string $page_parameter = ''): string;
80
81    /**
82     * How many times has a page been viewed.
83     *
84     * @param string $page_parameter
85     *
86     * @return string
87     */
88    public function hitCountNote(string $page_parameter = ''): string;
89
90    /**
91     * How many times has a page been viewed.
92     *
93     * @param string $page_parameter
94     *
95     * @return string
96     */
97    public function hitCountObje(string $page_parameter = ''): string;
98}
99