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