xref: /webtrees/app/Census/CensusColumnNationality.php (revision ade86bc351a97d0852775e49c96dd4ac061c739b) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2023 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\Date;
23use Fisharebest\Webtrees\Individual;
24
25/**
26 * The nationality of the individual.
27 */
28class CensusColumnNationality extends AbstractCensusColumn implements CensusColumnInterface
29{
30    // Convert a country name to a nationality
31    private const NATIONALITIES = [
32        'England'     => 'British',
33        'Scotland'    => 'British',
34        'Wales'       => 'British',
35        'Deutschland' => 'Deutsch',
36        'Canada'      => 'Canadian',
37    ];
38
39    /**
40     * Generate the likely value of this census column, based on available information.
41     *
42     * @param Individual $individual
43     * @param Individual $head
44     *
45     * @return string
46     */
47    public function generate(Individual $individual, Individual $head): string
48    {
49        $place = $individual->getBirthPlace()->gedcomName();
50
51        // No birthplace?  Assume born in the same country.
52        if ($place === '') {
53            $place = $this->place();
54        }
55
56        // Did we emigrate or naturalise?
57        foreach ($individual->facts(['IMMI', 'EMIG', 'NATU'], true) as $fact) {
58            if (Date::compare($fact->date(), $this->date()) <= 0) {
59                $place = $fact->place()->gedcomName();
60            }
61        }
62
63        $place = $this->lastPartOfPlace($place);
64
65        return self::NATIONALITIES[$place] ?? $place;
66    }
67}
68