1<?php 2 3/** 4 * webtrees: online genealogy 5 * Copyright (C) 2021 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\Census; 21 22use Fisharebest\Webtrees\Date; 23use Fisharebest\Webtrees\Individual; 24 25/** 26 * Definitions for a census column 27 */ 28interface CensusColumnInterface 29{ 30 /** 31 * A short version of the column's name. 32 * 33 * @return string 34 */ 35 public function abbreviation(): string; 36 37 /** 38 * When did this census occur 39 * 40 * @return Date 41 */ 42 public function date(): Date; 43 44 /** 45 * Generate the likely value of this census column, based on available information. 46 * 47 * @param Individual $individual 48 * @param Individual $head 49 * 50 * @return string 51 */ 52 public function generate(Individual $individual, Individual $head): string; 53 54 /** 55 * Where did this census occur 56 * 57 * @return string 58 */ 59 public function place(): string; 60 61 /** 62 * The full version of the column's name. 63 * 64 * @return string 65 */ 66 public function title(): string; 67} 68