xref: /webtrees/app/Statistics/Repository/Interfaces/FavoritesRepositoryInterface.php (revision 3976b4703df669696105ed6b024b96d433c8fbdb) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2019 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 <http://www.gnu.org/licenses/>.
16 */
17declare(strict_types=1);
18
19namespace Fisharebest\Webtrees\Statistics\Repository\Interfaces;
20
21/**
22 * A repository providing methods for favorites related statistics.
23 */
24interface FavoritesRepositoryInterface
25{
26    /**
27     * Find the favorites for the tree.
28     *
29     * @return string
30     */
31    public function gedcomFavorites(): string;
32
33    /**
34     * Find the favorites for the user.
35     *
36     * @return string
37     */
38    public function userFavorites(): string;
39
40    /**
41     * Find the number of favorites for the tree.
42     *
43     * @return string
44     */
45    public function totalGedcomFavorites(): string;
46
47    /**
48     * Find the number of favorites for the user.
49     *
50     * @return string
51     */
52    public function totalUserFavorites(): string;
53}
54