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