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