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