xref: /webtrees/app/Statistics/Repository/Interfaces/FavoritesRepositoryInterface.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 favorites related statistics.
22 */
23interface FavoritesRepositoryInterface
24{
25    /**
26     * Find the favorites for the tree.
27     *
28     * @return string
29     */
30    public function gedcomFavorites(): string;
31
32    /**
33     * Find the favorites for the user.
34     *
35     * @return string
36     */
37    public function userFavorites(): string;
38
39    /**
40     * Find the number of favorites for the tree.
41     *
42     * @return string
43     */
44    public function totalGedcomFavorites(): string;
45
46    /**
47     * Find the number of favorites for the user.
48     *
49     * @return string
50     */
51    public function totalUserFavorites(): string;
52}
53