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