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