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\Functions\Functions; 23use Fisharebest\Webtrees\Individual; 24 25/** 26 * Relationship to head of household. 27 */ 28class CensusColumnRelationToHead extends AbstractCensusColumn implements CensusColumnInterface 29{ 30 /** @var string */ 31 protected $head_of_household = '-'; 32 33 /** 34 * Generate the likely value of this census column, based on available information. 35 * 36 * @param Individual $individual 37 * @param Individual $head 38 * 39 * @return string 40 */ 41 public function generate(Individual $individual, Individual $head): string 42 { 43 if ($individual === $head) { 44 return $this->head_of_household; 45 } 46 47 return Functions::getCloseRelationshipName($head, $individual); 48 } 49} 50