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