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