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