xref: /webtrees/app/Census/CensusColumnFullName.php (revision 9b5dd26610226f1dfba1845a48c6980d11ca6bda)
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2017 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	 * Generate the likely value of this census column, based on available information.
28	 *
29	 * @param Individual $individual
30	 * @param Individual $head
31	 *
32	 * @return string
33	 */
34	public function generate(Individual $individual, Individual $head = null) {
35		$name = $this->nameAtCensusDate($individual, $this->date());
36
37		return strip_tags($name['full']);
38	}
39
40	/**
41	 * What was an individual's likely name on a given date, allowing
42	 * for marriages and married names.
43	 *
44	 * @param Individual $individual
45	 * @param Date       $census_date
46	 *
47	 * @return string[]
48	 */
49	protected function nameAtCensusDate(Individual $individual, Date $census_date) {
50		$names = $individual->getAllNames();
51		$name  = $names[0];
52
53		foreach ($individual->getSpouseFamilies() as $family) {
54			foreach ($family->getFacts('MARR') as $marriage) {
55				if ($marriage->getDate()->isOK() && Date::compare($marriage->getDate(), $census_date) < 0) {
56					$spouse = $family->getSpouse($individual);
57					foreach ($names as $individual_name) {
58						foreach ($spouse->getAllNames() as $spouse_name) {
59							if ($individual_name['type'] === '_MARNM' && $individual_name['surn'] === $spouse_name['surn']) {
60								return $individual_name;
61							}
62						}
63					}
64				}
65			}
66		}
67
68		return $name;
69	}
70}
71