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