xref: /webtrees/app/Census/CensusColumnRelationToHead.php (revision ad51e0bb9a7bb401eb57cbcefc4f840924a5bbaa)
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2015 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 */
16namespace Fisharebest\Webtrees\Census;
17
18use Fisharebest\Webtrees\Functions\Functions;
19use Fisharebest\Webtrees\Individual;
20
21/**
22 * Relationshiop to head of household.
23 */
24class CensusColumnRelationToHead extends AbstractCensusColumn implements CensusColumnInterface {
25	/**
26	 * Generate the likely value of this census column, based on available information.
27	 *
28	 * @param Individual      $individual
29	 * @param Individual|null $head
30	 *
31	 * @return string
32	 */
33	public function generate(Individual $individual, Individual $head = null) {
34		if ($head === null) {
35			return '';
36		} elseif ($individual == $head) {
37			return 'head';
38		} else {
39			return Functions::getCloseRelationshipName($head, $individual);
40		}
41	}
42}
43