1<?php 2 3/** 4 * webtrees: online genealogy 5 * Copyright (C) 2022 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 place related statistics. 24 */ 25interface PlaceRepositoryInterface 26{ 27 /** 28 * A list of common birth places. 29 * 30 * @return string 31 */ 32 public function commonBirthPlacesList(): string; 33 34 /** 35 * A list of common death places. 36 * 37 * @return string 38 */ 39 public function commonDeathPlacesList(): string; 40 41 /** 42 * A list of common marriage places. 43 * 44 * @return string 45 */ 46 public function commonMarriagePlacesList(): string; 47 48 /** 49 * A list of common countries. 50 * 51 * @return string 52 */ 53 public function commonCountriesList(): string; 54 55 /** 56 * Count total places. 57 * 58 * @return string 59 */ 60 public function totalPlaces(): string; 61 62 /** 63 * Create a chart showing where events occurred. 64 * 65 * @param string $chart_shows 66 * @param string $chart_type 67 * @param string $surname 68 * 69 * @return string 70 */ 71 public function chartDistribution( 72 string $chart_shows = 'world', 73 string $chart_type = '', 74 string $surname = '' 75 ): string; 76} 77