xref: /webtrees/app/Statistics/Repository/Interfaces/FavoritesRepositoryInterface.php (revision 8add1155cb77caede54752196ff44696d1346431)
1*8add1155SRico Sonntag<?php
2*8add1155SRico Sonntag/**
3*8add1155SRico Sonntag * webtrees: online genealogy
4*8add1155SRico Sonntag * Copyright (C) 2018 webtrees development team
5*8add1155SRico Sonntag * This program is free software: you can redistribute it and/or modify
6*8add1155SRico Sonntag * it under the terms of the GNU General Public License as published by
7*8add1155SRico Sonntag * the Free Software Foundation, either version 3 of the License, or
8*8add1155SRico Sonntag * (at your option) any later version.
9*8add1155SRico Sonntag * This program is distributed in the hope that it will be useful,
10*8add1155SRico Sonntag * but WITHOUT ANY WARRANTY; without even the implied warranty of
11*8add1155SRico Sonntag * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12*8add1155SRico Sonntag * GNU General Public License for more details.
13*8add1155SRico Sonntag * You should have received a copy of the GNU General Public License
14*8add1155SRico Sonntag * along with this program. If not, see <http://www.gnu.org/licenses/>.
15*8add1155SRico Sonntag */
16*8add1155SRico Sonntagdeclare(strict_types=1);
17*8add1155SRico Sonntag
18*8add1155SRico Sonntagnamespace Fisharebest\Webtrees\Statistics\Repository\Interfaces;
19*8add1155SRico Sonntag
20*8add1155SRico Sonntag/**
21*8add1155SRico Sonntag * A repository providing methods for favorites related statistics.
22*8add1155SRico Sonntag */
23*8add1155SRico Sonntaginterface FavoritesRepositoryInterface
24*8add1155SRico Sonntag{
25*8add1155SRico Sonntag    /**
26*8add1155SRico Sonntag     * Find the favorites for the tree.
27*8add1155SRico Sonntag     *
28*8add1155SRico Sonntag     * @return string
29*8add1155SRico Sonntag     */
30*8add1155SRico Sonntag    public function gedcomFavorites(): string;
31*8add1155SRico Sonntag
32*8add1155SRico Sonntag    /**
33*8add1155SRico Sonntag     * Find the favorites for the user.
34*8add1155SRico Sonntag     *
35*8add1155SRico Sonntag     * @return string
36*8add1155SRico Sonntag     */
37*8add1155SRico Sonntag    public function userFavorites(): string;
38*8add1155SRico Sonntag
39*8add1155SRico Sonntag    /**
40*8add1155SRico Sonntag     * Find the number of favorites for the tree.
41*8add1155SRico Sonntag     *
42*8add1155SRico Sonntag     * @return string
43*8add1155SRico Sonntag     */
44*8add1155SRico Sonntag    public function totalGedcomFavorites(): string;
45*8add1155SRico Sonntag
46*8add1155SRico Sonntag    /**
47*8add1155SRico Sonntag     * Find the number of favorites for the user.
48*8add1155SRico Sonntag     *
49*8add1155SRico Sonntag     * @return string
50*8add1155SRico Sonntag     */
51*8add1155SRico Sonntag    public function totalUserFavorites(): string;
52*8add1155SRico Sonntag}
53