1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2025 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Census;
use Fisharebest\Webtrees\Date;
use Fisharebest\Webtrees\Family;
use Fisharebest\Webtrees\Individual;
use function array_slice;
use function explode;
use function implode;
/**
* Definitions for a census column
*/
class AbstractCensusColumn
{
private CensusInterface $census;
private string $abbr;
private string $title;
/**
* Create a column for a census
*
* @param CensusInterface $census The census to which this column forms part.
* @param string $abbr The abbreviated on-screen name "BiC"
* @param string $title The full column heading "Born in the county"
*/
public function __construct(CensusInterface $census, string $abbr, string $title)
{
$this->census = $census;
$this->abbr = $abbr;
$this->title = $title;
}
/**
* A short version of the column's name.
*
* @return string
*/
public function abbreviation(): string
{
return $this->abbr;
}
/**
* Find the father of an individual
*/
public function father(Individual $individual): Individual|null
{
$family = $individual->childFamilies()->first();
if ($family instanceof Family) {
return $family->husband();
}
return null;
}
/**
* Find the mother of an individual
*/
public function mother(Individual $individual): Individual|null
{
$family = $individual->childFamilies()->first();
if ($family instanceof Family) {
return $family->wife();
}
return null;
}
/**
* Find the current spouse family of an individual
*/
public function spouseFamily(Individual $individual): Family|null
{
return $individual->spouseFamilies()
// Exclude families that were created after this census date
->filter(fn (Family $family): bool => Date::compare($family->getMarriageDate(), $this->date()) <= 0)
->sort(Family::marriageDateComparator())
->last();
}
/**
* What was an individual's likely name on a given date, allowing
* for marriages and married names.
*
* @return array<string>
*/
protected function nameAtCensusDate(Individual $individual): array
{
$names = $individual->getAllNames();
$name = $names[0];
$family = $this->spouseFamily($individual);
if ($family instanceof Family) {
$spouse = $family->spouse($individual);
if ($spouse instanceof Individual) {
foreach ($family->facts(['MARR']) as $marriage) {
if ($marriage->date()->isOK()) {
foreach ($names as $individual_name) {
foreach ($spouse->getAllNames() as $spouse_name) {
if ($individual_name['type'] === '_MARNM' && $individual_name['surn'] === $spouse_name['surn']) {
return $individual_name;
}
}
}
}
}
}
}
return $name;
}
/**
* When did this census occur
*/
public function date(): Date
{
return new Date($this->census->censusDate());
}
/**
* The full version of the column's name.
*
* @return string
*/
public function title(): string
{
return $this->title;
}
/**
* Extract the country (last part) of a place name.
*
* @param string $place e.g. "London, England"
*
* @return string e.g. "England"
*/
protected function lastPartOfPlace(string $place): string
{
$parts = explode(', ', $place);
return end($parts);
}
/**
* Remove the country of a place name, where it is the same as the census place
*
* @param string $place e.g. "London, England"
*
* @return string e.g. "London" (for census of England) and "London, England" elsewhere
*/
protected function notCountry(string $place): string
{
$parts = explode(', ', $place);
if (end($parts) === $this->place()) {
return implode(', ', array_slice($parts, 0, -1));
}
return $place;
}
/**
* Where did this census occur
*
* @return string
*/
public function place(): string
{
return $this->census->censusPlace();
}
}
|
