1<?php 2/** 3 * webtrees: online genealogy 4 * Copyright (C) 2019 webtrees development team 5 * This program is free software: you can redistribute it and/or modify 6 * it under the terms of the GNU General Public License as published by 7 * the Free Software Foundation, either version 3 of the License, or 8 * (at your option) any later version. 9 * This program is distributed in the hope that it will be useful, 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 * GNU General Public License for more details. 13 * You should have received a copy of the GNU General Public License 14 * along with this program. If not, see <http://www.gnu.org/licenses/>. 15 */ 16declare(strict_types=1); 17 18namespace Fisharebest\Webtrees\Census; 19 20use Fisharebest\Webtrees\Date; 21use Fisharebest\Webtrees\Individual; 22 23/** 24 * Definitions for a census column 25 */ 26interface CensusColumnInterface 27{ 28 /** 29 * A short version of the column's name. 30 * 31 * @return string 32 */ 33 public function abbreviation(): string; 34 35 /** 36 * When did this census occur 37 * 38 * @return Date 39 */ 40 public function date(): Date; 41 42 /** 43 * Generate the likely value of this census column, based on available information. 44 * 45 * @param Individual $individual 46 * @param Individual $head 47 * 48 * @return string 49 */ 50 public function generate(Individual $individual, Individual $head): string; 51 52 /** 53 * Where did this census occur 54 * 55 * @return string 56 */ 57 public function place(): string; 58 59 /** 60 * The full version of the column's name. 61 * 62 * @return string 63 */ 64 public function title(): string; 65} 66