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