xref: /webtrees/app/Census/CensusColumnFullName.php (revision d72b284a0846ca045e548a1c77ad11813bcbab92)
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2019 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 <http://www.gnu.org/licenses/>.
16 */
17declare(strict_types=1);
18
19namespace Fisharebest\Webtrees\Census;
20
21use Fisharebest\Webtrees\Date;
22use Fisharebest\Webtrees\Individual;
23
24/**
25 * The individual's full name.
26 */
27class CensusColumnFullName extends AbstractCensusColumn implements CensusColumnInterface
28{
29    /**
30     * Generate the likely value of this census column, based on available information.
31     *
32     * @param Individual $individual
33     * @param Individual $head
34     *
35     * @return string
36     */
37    public function generate(Individual $individual, Individual $head): string
38    {
39        $name = $this->nameAtCensusDate($individual, $this->date());
40
41        return strip_tags($name['full']);
42    }
43
44    /**
45     * What was an individual's likely name on a given date, allowing
46     * for marriages and married names.
47     *
48     * @param Individual $individual
49     * @param Date       $census_date
50     *
51     * @return string[]
52     */
53    protected function nameAtCensusDate(Individual $individual, Date $census_date): array
54    {
55        $names = $individual->getAllNames();
56        $name  = $names[0];
57
58        foreach ($individual->spouseFamilies() as $family) {
59            foreach ($family->facts(['MARR']) as $marriage) {
60                if ($marriage->date()->isOK() && Date::compare($marriage->date(), $census_date) < 0) {
61                    $spouse = $family->spouse($individual);
62                    foreach ($names as $individual_name) {
63                        foreach ($spouse->getAllNames() as $spouse_name) {
64                            if ($individual_name['type'] === '_MARNM' && $individual_name['surn'] === $spouse_name['surn']) {
65                                return $individual_name;
66                            }
67                        }
68                    }
69                }
70            }
71        }
72
73        return $name;
74    }
75}
76