/
Individual.php
1155 lines (1028 loc) · 39.6 KB
/
Individual.php
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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2021 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;
use Closure;
use Fisharebest\ExtCalendar\GregorianCalendar;
use Fisharebest\Webtrees\Contracts\UserInterface;
use Fisharebest\Webtrees\Http\RequestHandlers\IndividualPage;
use Illuminate\Database\Capsule\Manager as DB;
use Illuminate\Support\Collection;
use function preg_match;
/**
* A GEDCOM individual (INDI) object.
*/
class Individual extends GedcomRecord
{
public const RECORD_TYPE = 'INDI';
// Placeholders to indicate unknown names
public const NOMEN_NESCIO = '@N.N.';
public const PRAENOMEN_NESCIO = '@P.N.';
protected const ROUTE_NAME = IndividualPage::class;
/** @var int used in some lists to keep track of this individual’s generation in that list */
public $generation;
/** @var Date The estimated date of birth */
private $estimated_birth_date;
/** @var Date The estimated date of death */
private $estimated_death_date;
/**
* A closure which will compare individuals by birth date.
*
* @return Closure
*/
public static function birthDateComparator(): Closure
{
return static function (Individual $x, Individual $y): int {
return Date::compare($x->getEstimatedBirthDate(), $y->getEstimatedBirthDate());
};
}
/**
* A closure which will compare individuals by death date.
*
* @return Closure
*/
public static function deathDateComparator(): Closure
{
return static function (Individual $x, Individual $y): int {
return Date::compare($x->getEstimatedDeathDate(), $y->getEstimatedDeathDate());
};
}
/**
* Sometimes, we'll know in advance that we need to load a set of records.
* Typically when we load families and their members.
*
* @param Tree $tree
* @param string[] $xrefs
*
* @return void
*/
public static function load(Tree $tree, array $xrefs): void
{
$rows = DB::table('individuals')
->where('i_file', '=', $tree->id())
->whereIn('i_id', array_unique($xrefs))
->select(['i_id AS xref', 'i_gedcom AS gedcom'])
->get();
foreach ($rows as $row) {
Registry::individualFactory()->make($row->xref, $tree, $row->gedcom);
}
}
/**
* Can the name of this record be shown?
*
* @param int|null $access_level
*
* @return bool
*/
public function canShowName(int $access_level = null): bool
{
$access_level = $access_level ?? Auth::accessLevel($this->tree);
return $this->tree->getPreference('SHOW_LIVING_NAMES') >= $access_level || $this->canShow($access_level);
}
/**
* Can this individual be shown?
*
* @param int $access_level
*
* @return bool
*/
protected function canShowByType(int $access_level): bool
{
// Dead people...
if ($this->tree->getPreference('SHOW_DEAD_PEOPLE') >= $access_level && $this->isDead()) {
$keep_alive = false;
$KEEP_ALIVE_YEARS_BIRTH = (int) $this->tree->getPreference('KEEP_ALIVE_YEARS_BIRTH');
if ($KEEP_ALIVE_YEARS_BIRTH) {
preg_match_all('/\n1 (?:' . implode('|', Gedcom::BIRTH_EVENTS) . ').*(?:\n[2-9].*)*(?:\n2 DATE (.+))/', $this->gedcom, $matches, PREG_SET_ORDER);
foreach ($matches as $match) {
$date = new Date($match[1]);
if ($date->isOK() && $date->gregorianYear() + $KEEP_ALIVE_YEARS_BIRTH > date('Y')) {
$keep_alive = true;
break;
}
}
}
$KEEP_ALIVE_YEARS_DEATH = (int) $this->tree->getPreference('KEEP_ALIVE_YEARS_DEATH');
if ($KEEP_ALIVE_YEARS_DEATH) {
preg_match_all('/\n1 (?:' . implode('|', Gedcom::DEATH_EVENTS) . ').*(?:\n[2-9].*)*(?:\n2 DATE (.+))/', $this->gedcom, $matches, PREG_SET_ORDER);
foreach ($matches as $match) {
$date = new Date($match[1]);
if ($date->isOK() && $date->gregorianYear() + $KEEP_ALIVE_YEARS_DEATH > date('Y')) {
$keep_alive = true;
break;
}
}
}
if (!$keep_alive) {
return true;
}
}
// Consider relationship privacy (unless an admin is applying download restrictions)
$user_path_length = (int) $this->tree->getUserPreference(Auth::user(), UserInterface::PREF_TREE_PATH_LENGTH);
$gedcomid = $this->tree->getUserPreference(Auth::user(), UserInterface::PREF_TREE_ACCOUNT_XREF);
if ($gedcomid !== '' && $user_path_length > 0) {
return self::isRelated($this, $user_path_length);
}
// No restriction found - show living people to members only:
return Auth::PRIV_USER >= $access_level;
}
/**
* For relationship privacy calculations - is this individual a close relative?
*
* @param Individual $target
* @param int $distance
*
* @return bool
*/
private static function isRelated(Individual $target, int $distance): bool
{
static $cache = null;
$user_individual = Registry::individualFactory()->make($target->tree->getUserPreference(Auth::user(), UserInterface::PREF_TREE_ACCOUNT_XREF), $target->tree);
if ($user_individual) {
if (!$cache) {
$cache = [
0 => [$user_individual],
1 => [],
];
foreach ($user_individual->facts(['FAMC', 'FAMS'], false, Auth::PRIV_HIDE) as $fact) {
$family = $fact->target();
if ($family instanceof Family) {
$cache[1][] = $family;
}
}
}
} else {
// No individual linked to this account? Cannot use relationship privacy.
return true;
}
// Double the distance, as we count the INDI-FAM and FAM-INDI links separately
$distance *= 2;
// Consider each path length in turn
for ($n = 0; $n <= $distance; ++$n) {
if (array_key_exists($n, $cache)) {
// We have already calculated all records with this length
if ($n % 2 === 0 && in_array($target, $cache[$n], true)) {
return true;
}
} else {
// Need to calculate these paths
$cache[$n] = [];
if ($n % 2 === 0) {
// Add FAM->INDI links
foreach ($cache[$n - 1] as $family) {
foreach ($family->facts(['HUSB', 'WIFE', 'CHIL'], false, Auth::PRIV_HIDE) as $fact) {
$individual = $fact->target();
// Don’t backtrack
if ($individual instanceof self && !in_array($individual, $cache[$n - 2], true)) {
$cache[$n][] = $individual;
}
}
}
if (in_array($target, $cache[$n], true)) {
return true;
}
} else {
// Add INDI->FAM links
foreach ($cache[$n - 1] as $individual) {
foreach ($individual->facts(['FAMC', 'FAMS'], false, Auth::PRIV_HIDE) as $fact) {
$family = $fact->target();
// Don’t backtrack
if ($family instanceof Family && !in_array($family, $cache[$n - 2], true)) {
$cache[$n][] = $family;
}
}
}
}
}
}
return false;
}
/**
* Generate a private version of this record
*
* @param int $access_level
*
* @return string
*/
protected function createPrivateGedcomRecord(int $access_level): string
{
$SHOW_PRIVATE_RELATIONSHIPS = (bool) $this->tree->getPreference('SHOW_PRIVATE_RELATIONSHIPS');
$rec = '0 @' . $this->xref . '@ INDI';
if ($this->tree->getPreference('SHOW_LIVING_NAMES') >= $access_level) {
// Show all the NAME tags, including subtags
foreach ($this->facts(['NAME']) as $fact) {
$rec .= "\n" . $fact->gedcom();
}
}
// Just show the 1 FAMC/FAMS tag, not any subtags, which may contain private data
preg_match_all('/\n1 (?:FAMC|FAMS) @(' . Gedcom::REGEX_XREF . ')@/', $this->gedcom, $matches, PREG_SET_ORDER);
foreach ($matches as $match) {
$rela = Registry::familyFactory()->make($match[1], $this->tree);
if ($rela && ($SHOW_PRIVATE_RELATIONSHIPS || $rela->canShow($access_level))) {
$rec .= $match[0];
}
}
// Don’t privatize sex.
if (preg_match('/\n1 SEX [MFU]/', $this->gedcom, $match)) {
$rec .= $match[0];
}
return $rec;
}
/**
* Calculate whether this individual is living or dead.
* If not known to be dead, then assume living.
*
* @return bool
*/
public function isDead(): bool
{
$MAX_ALIVE_AGE = (int) $this->tree->getPreference('MAX_ALIVE_AGE');
$today_jd = Carbon::now()->julianDay();
// "1 DEAT Y" or "1 DEAT/2 DATE" or "1 DEAT/2 PLAC"
if (preg_match('/\n1 (?:' . implode('|', Gedcom::DEATH_EVENTS) . ')(?: Y|(?:\n[2-9].+)*\n2 (DATE|PLAC) )/', $this->gedcom)) {
return true;
}
// If any event occured more than $MAX_ALIVE_AGE years ago, then assume the individual is dead
if (preg_match_all('/\n2 DATE (.+)/', $this->gedcom, $date_matches)) {
foreach ($date_matches[1] as $date_match) {
$date = new Date($date_match);
if ($date->isOK() && $date->maximumJulianDay() <= $today_jd - 365 * $MAX_ALIVE_AGE) {
return true;
}
}
// The individual has one or more dated events. All are less than $MAX_ALIVE_AGE years ago.
// If one of these is a birth, the individual must be alive.
if (preg_match('/\n1 BIRT(?:\n[2-9].+)*\n2 DATE /', $this->gedcom)) {
return false;
}
}
// If we found no conclusive dates then check the dates of close relatives.
// Check parents (birth and adopted)
foreach ($this->childFamilies(Auth::PRIV_HIDE) as $family) {
foreach ($family->spouses(Auth::PRIV_HIDE) as $parent) {
// Assume parents are no more than 45 years older than their children
preg_match_all('/\n2 DATE (.+)/', $parent->gedcom, $date_matches);
foreach ($date_matches[1] as $date_match) {
$date = new Date($date_match);
if ($date->isOK() && $date->maximumJulianDay() <= $today_jd - 365 * ($MAX_ALIVE_AGE + 45)) {
return true;
}
}
}
}
// Check spouses
foreach ($this->spouseFamilies(Auth::PRIV_HIDE) as $family) {
preg_match_all('/\n2 DATE (.+)/', $family->gedcom, $date_matches);
foreach ($date_matches[1] as $date_match) {
$date = new Date($date_match);
// Assume marriage occurs after age of 10
if ($date->isOK() && $date->maximumJulianDay() <= $today_jd - 365 * ($MAX_ALIVE_AGE - 10)) {
return true;
}
}
// Check spouse dates
$spouse = $family->spouse($this, Auth::PRIV_HIDE);
if ($spouse) {
preg_match_all('/\n2 DATE (.+)/', $spouse->gedcom, $date_matches);
foreach ($date_matches[1] as $date_match) {
$date = new Date($date_match);
// Assume max age difference between spouses of 40 years
if ($date->isOK() && $date->maximumJulianDay() <= $today_jd - 365 * ($MAX_ALIVE_AGE + 40)) {
return true;
}
}
}
// Check child dates
foreach ($family->children(Auth::PRIV_HIDE) as $child) {
preg_match_all('/\n2 DATE (.+)/', $child->gedcom, $date_matches);
// Assume children born after age of 15
foreach ($date_matches[1] as $date_match) {
$date = new Date($date_match);
if ($date->isOK() && $date->maximumJulianDay() <= $today_jd - 365 * ($MAX_ALIVE_AGE - 15)) {
return true;
}
}
// Check grandchildren
foreach ($child->spouseFamilies(Auth::PRIV_HIDE) as $child_family) {
foreach ($child_family->children(Auth::PRIV_HIDE) as $grandchild) {
preg_match_all('/\n2 DATE (.+)/', $grandchild->gedcom, $date_matches);
// Assume grandchildren born after age of 30
foreach ($date_matches[1] as $date_match) {
$date = new Date($date_match);
if ($date->isOK() && $date->maximumJulianDay() <= $today_jd - 365 * ($MAX_ALIVE_AGE - 30)) {
return true;
}
}
}
}
}
}
return false;
}
/**
* Find the highlighted media object for an individual
*
* @return MediaFile|null
*/
public function findHighlightedMediaFile(): ?MediaFile
{
$fact = $this->facts(['OBJE'])
->first(static function (Fact $fact): bool {
$media = $fact->target();
return $media instanceof Media && $media->firstImageFile() instanceof MediaFile;
});
if ($fact instanceof Fact && $fact->target() instanceof Media) {
return $fact->target()->firstImageFile();
}
return null;
}
/**
* Display the prefered image for this individual.
* Use an icon if no image is available.
*
* @param int $width Pixels
* @param int $height Pixels
* @param string $fit "crop" or "contain"
* @param string[] $attributes Additional HTML attributes
*
* @return string
*/
public function displayImage(int $width, int $height, string $fit, array $attributes): string
{
$media_file = $this->findHighlightedMediaFile();
if ($media_file !== null) {
return $media_file->displayImage($width, $height, $fit, $attributes);
}
if ($this->tree->getPreference('USE_SILHOUETTE')) {
return '<i class="icon-silhouette-' . $this->sex() . '"></i>';
}
return '';
}
/**
* Get the date of birth
*
* @return Date
*/
public function getBirthDate(): Date
{
foreach ($this->getAllBirthDates() as $date) {
if ($date->isOK()) {
return $date;
}
}
return new Date('');
}
/**
* Get the place of birth
*
* @return Place
*/
public function getBirthPlace(): Place
{
foreach ($this->getAllBirthPlaces() as $place) {
return $place;
}
return new Place('', $this->tree);
}
/**
* Get the date of death
*
* @return Date
*/
public function getDeathDate(): Date
{
foreach ($this->getAllDeathDates() as $date) {
if ($date->isOK()) {
return $date;
}
}
return new Date('');
}
/**
* Get the place of death
*
* @return Place
*/
public function getDeathPlace(): Place
{
foreach ($this->getAllDeathPlaces() as $place) {
return $place;
}
return new Place('', $this->tree);
}
/**
* Get the range of years in which a individual lived. e.g. “1870–”, “1870–1920”, “–1920”.
* Provide the place and full date using a tooltip.
* For consistent layout in charts, etc., show just a “–” when no dates are known.
* Note that this is a (non-breaking) en-dash, and not a hyphen.
*
* @return string
*/
public function lifespan(): string
{
// Just the first part of the place name.
$birth_place = strip_tags($this->getBirthPlace()->shortName());
$death_place = strip_tags($this->getDeathPlace()->shortName());
// Remove markup from dates.
$birth_date = strip_tags($this->getBirthDate()->display());
$death_date = strip_tags($this->getDeathDate()->display());
// Use minimum and maximum dates - to agree with the age calculations.
$birth_year = $this->getBirthDate()->minimumDate()->format('%Y');
$death_year = $this->getDeathDate()->maximumDate()->format('%Y');
/* I18N: A range of years, e.g. “1870–”, “1870–1920”, “–1920” */
return I18N::translate(
'%1$s–%2$s',
'<span title="' . $birth_place . ' ' . $birth_date . '">' . $birth_year . '</span>',
'<span title="' . $death_place . ' ' . $death_date . '">' . $death_year . '</span>'
);
}
/**
* Get all the birth dates - for the individual lists.
*
* @return Date[]
*/
public function getAllBirthDates(): array
{
foreach (Gedcom::BIRTH_EVENTS as $event) {
$dates = $this->getAllEventDates([$event]);
if ($dates !== []) {
return $dates;
}
}
return [];
}
/**
* Gat all the birth places - for the individual lists.
*
* @return Place[]
*/
public function getAllBirthPlaces(): array
{
foreach (Gedcom::BIRTH_EVENTS as $event) {
$places = $this->getAllEventPlaces([$event]);
if ($places !== []) {
return $places;
}
}
return [];
}
/**
* Get all the death dates - for the individual lists.
*
* @return Date[]
*/
public function getAllDeathDates(): array
{
foreach (Gedcom::DEATH_EVENTS as $event) {
$dates = $this->getAllEventDates([$event]);
if ($dates !== []) {
return $dates;
}
}
return [];
}
/**
* Get all the death places - for the individual lists.
*
* @return Place[]
*/
public function getAllDeathPlaces(): array
{
foreach (Gedcom::DEATH_EVENTS as $event) {
$places = $this->getAllEventPlaces([$event]);
if ($places !== []) {
return $places;
}
}
return [];
}
/**
* Generate an estimate for the date of birth, based on dates of parents/children/spouses
*
* @return Date
*/
public function getEstimatedBirthDate(): Date
{
if ($this->estimated_birth_date === null) {
foreach ($this->getAllBirthDates() as $date) {
if ($date->isOK()) {
$this->estimated_birth_date = $date;
break;
}
}
if ($this->estimated_birth_date === null) {
$min = [];
$max = [];
$tmp = $this->getDeathDate();
if ($tmp->isOK()) {
$min[] = $tmp->minimumJulianDay() - $this->tree->getPreference('MAX_ALIVE_AGE') * 365;
$max[] = $tmp->maximumJulianDay();
}
foreach ($this->childFamilies() as $family) {
$tmp = $family->getMarriageDate();
if ($tmp->isOK()) {
$min[] = $tmp->maximumJulianDay() - 365 * 1;
$max[] = $tmp->minimumJulianDay() + 365 * 30;
}
$husband = $family->husband();
if ($husband instanceof self) {
$tmp = $husband->getBirthDate();
if ($tmp->isOK()) {
$min[] = $tmp->maximumJulianDay() + 365 * 15;
$max[] = $tmp->minimumJulianDay() + 365 * 65;
}
}
$wife = $family->wife();
if ($wife instanceof self) {
$tmp = $wife->getBirthDate();
if ($tmp->isOK()) {
$min[] = $tmp->maximumJulianDay() + 365 * 15;
$max[] = $tmp->minimumJulianDay() + 365 * 45;
}
}
foreach ($family->children() as $child) {
$tmp = $child->getBirthDate();
if ($tmp->isOK()) {
$min[] = $tmp->maximumJulianDay() - 365 * 30;
$max[] = $tmp->minimumJulianDay() + 365 * 30;
}
}
}
foreach ($this->spouseFamilies() as $family) {
$tmp = $family->getMarriageDate();
if ($tmp->isOK()) {
$min[] = $tmp->maximumJulianDay() - 365 * 45;
$max[] = $tmp->minimumJulianDay() - 365 * 15;
}
$spouse = $family->spouse($this);
if ($spouse) {
$tmp = $spouse->getBirthDate();
if ($tmp->isOK()) {
$min[] = $tmp->maximumJulianDay() - 365 * 25;
$max[] = $tmp->minimumJulianDay() + 365 * 25;
}
}
foreach ($family->children() as $child) {
$tmp = $child->getBirthDate();
if ($tmp->isOK()) {
$min[] = $tmp->maximumJulianDay() - 365 * ($this->sex() === 'F' ? 45 : 65);
$max[] = $tmp->minimumJulianDay() - 365 * 15;
}
}
}
if ($min && $max) {
$gregorian_calendar = new GregorianCalendar();
[$year] = $gregorian_calendar->jdToYmd(intdiv(max($min) + min($max), 2));
$this->estimated_birth_date = new Date('EST ' . $year);
} else {
$this->estimated_birth_date = new Date(''); // always return a date object
}
}
}
return $this->estimated_birth_date;
}
/**
* Generate an estimated date of death.
*
* @return Date
*/
public function getEstimatedDeathDate(): Date
{
if ($this->estimated_death_date === null) {
foreach ($this->getAllDeathDates() as $date) {
if ($date->isOK()) {
$this->estimated_death_date = $date;
break;
}
}
if ($this->estimated_death_date === null) {
if ($this->getEstimatedBirthDate()->minimumJulianDay()) {
$max_alive_age = (int) $this->tree->getPreference('MAX_ALIVE_AGE');
$this->estimated_death_date = $this->getEstimatedBirthDate()->addYears($max_alive_age, 'BEF');
} else {
$this->estimated_death_date = new Date(''); // always return a date object
}
}
}
return $this->estimated_death_date;
}
/**
* Get the sex - M F or U
* Use the un-privatised gedcom record. We call this function during
* the privatize-gedcom function, and we are allowed to know this.
*
* @return string
*/
public function sex(): string
{
if (preg_match('/\n1 SEX ([MF])/', $this->gedcom . $this->pending, $match)) {
return $match[1];
}
return 'U';
}
/**
* Get a list of this individual’s spouse families
*
* @param int|null $access_level
*
* @return Collection<Family>
*/
public function spouseFamilies($access_level = null): Collection
{
$access_level = $access_level ?? Auth::accessLevel($this->tree);
if ($this->tree->getPreference('SHOW_PRIVATE_RELATIONSHIPS') === '1') {
$access_level = Auth::PRIV_HIDE;
}
$families = new Collection();
foreach ($this->facts(['FAMS'], false, $access_level) as $fact) {
$family = $fact->target();
if ($family instanceof Family && $family->canShow($access_level)) {
$families->push($family);
}
}
return new Collection($families);
}
/**
* Get the current spouse of this individual.
*
* Where an individual has multiple spouses, assume they are stored
* in chronological order, and take the last one found.
*
* @return Individual|null
*/
public function getCurrentSpouse(): ?Individual
{
$family = $this->spouseFamilies()->last();
if ($family instanceof Family) {
return $family->spouse($this);
}
return null;
}
/**
* Count the children belonging to this individual.
*
* @return int
*/
public function numberOfChildren(): int
{
if (preg_match('/\n1 NCHI (\d+)(?:\n|$)/', $this->gedcom(), $match)) {
return (int) $match[1];
}
$children = [];
foreach ($this->spouseFamilies() as $fam) {
foreach ($fam->children() as $child) {
$children[$child->xref()] = true;
}
}
return count($children);
}
/**
* Get a list of this individual’s child families (i.e. their parents).
*
* @param int|null $access_level
*
* @return Collection<Family>
*/
public function childFamilies($access_level = null): Collection
{
$access_level = $access_level ?? Auth::accessLevel($this->tree);
if ($this->tree->getPreference('SHOW_PRIVATE_RELATIONSHIPS') === '1') {
$access_level = Auth::PRIV_HIDE;
}
$families = new Collection();
foreach ($this->facts(['FAMC'], false, $access_level) as $fact) {
$family = $fact->target();
if ($family instanceof Family && $family->canShow($access_level)) {
$families->push($family);
}
}
return $families;
}
/**
* Get a list of step-parent families.
*
* @return Collection<Family>
*/
public function childStepFamilies(): Collection
{
$step_families = new Collection();
$families = $this->childFamilies();
foreach ($families as $family) {
foreach ($family->spouses() as $parent) {
foreach ($parent->spouseFamilies() as $step_family) {
if (!$families->containsStrict($step_family)) {
$step_families->add($step_family);
}
}
}
}
return $step_families->uniqueStrict(static function (Family $family): string {
return $family->xref();
});
}
/**
* Get a list of step-parent families.
*
* @return Collection<Family>
*/
public function spouseStepFamilies(): Collection
{
$step_families = [];
$families = $this->spouseFamilies();
foreach ($families as $family) {
$spouse = $family->spouse($this);
if ($spouse instanceof self) {
foreach ($family->spouse($this)->spouseFamilies() as $step_family) {
if (!$families->containsStrict($step_family)) {
$step_families[] = $step_family;
}
}
}
}
return new Collection($step_families);
}
/**
* A label for a parental family group
*
* @param Family $family
*
* @return string
*/
public function getChildFamilyLabel(Family $family): string
{
preg_match('/\n1 FAMC @' . $family->xref() . '@(?:\n[2-9].*)*\n2 PEDI (.+)/', $this->gedcom(), $match);
$values = [
'birth' => I18N::translate('Family with parents'),
'adopted' => I18N::translate('Family with adoptive parents'),
'foster' => I18N::translate('Family with foster parents'),
'sealing' => /* I18N: “sealing” is a Mormon ceremony. */
I18N::translate('Family with sealing parents'),
'rada' => /* I18N: “rada” is an Arabic word, pronounced “ra DAH”. It is child-to-parent pedigree, established by wet-nursing. */
I18N::translate('Family with rada parents'),
];
return $values[$match[1] ?? 'birth'] ?? $values['birth'];
}
/**
* Create a label for a step family
*
* @param Family $step_family
*
* @return string
*/
public function getStepFamilyLabel(Family $step_family): string
{
foreach ($this->childFamilies() as $family) {
if ($family !== $step_family) {
// Must be a step-family
foreach ($family->spouses() as $parent) {
foreach ($step_family->spouses() as $step_parent) {
if ($parent === $step_parent) {
// One common parent - must be a step family
if ($parent->sex() === 'M') {
// Father’s family with someone else
if ($step_family->spouse($step_parent)) {
/* I18N: A step-family. %s is an individual’s name */
return I18N::translate('Father’s family with %s', $step_family->spouse($step_parent)->fullName());
}
/* I18N: A step-family. */
return I18N::translate('Father’s family with an unknown individual');
}
// Mother’s family with someone else
if ($step_family->spouse($step_parent)) {
/* I18N: A step-family. %s is an individual’s name */
return I18N::translate('Mother’s family with %s', $step_family->spouse($step_parent)->fullName());
}
/* I18N: A step-family. */
return I18N::translate('Mother’s family with an unknown individual');
}
}
}
}
}
// Perahps same parents - but a different family record?
return I18N::translate('Family with parents');
}
/**
* Get the description for the family.
*
* For example, "XXX's family with new wife".
*
* @param Family $family
*
* @return string
*/
public function getSpouseFamilyLabel(Family $family): string
{
$spouse = $family->spouse($this);
if ($spouse) {
/* I18N: %s is the spouse name */
return I18N::translate('Family with %s', $spouse->fullName());
}
return $family->fullName();
}
/**
* If this object has no name, what do we call it?
*
* @return string
*/
public function getFallBackName(): string
{
return '@P.N. /@N.N./';
}
/**
* Convert a name record into ‘full’ and ‘sort’ versions.
* Use the NAME field to generate the ‘full’ version, as the
* gedcom spec says that this is the individual’s name, as they would write it.
* Use the SURN field to generate the sortable names. Note that this field
* may also be used for the ‘true’ surname, perhaps spelt differently to that
* recorded in the NAME field. e.g.
*
* 1 NAME Robert /de Gliderow/
* 2 GIVN Robert
* 2 SPFX de
* 2 SURN CLITHEROW
* 2 NICK The Bald
*
* full=>'Robert de Gliderow 'The Bald''
* sort=>'CLITHEROW, ROBERT'
*
* Handle multiple surnames, either as;
*
* 1 NAME Carlos /Vasquez/ y /Sante/
* or
* 1 NAME Carlos /Vasquez y Sante/
* 2 GIVN Carlos
* 2 SURN Vasquez,Sante
*
* @param string $type
* @param string $value
* @param string $gedcom
*
* @return void
*/
protected function addName(string $type, string $value, string $gedcom): void
{
////////////////////////////////////////////////////////////////////////////
// Extract the structured name parts - use for "sortable" names and indexes
////////////////////////////////////////////////////////////////////////////
$sublevel = 1 + (int) substr($gedcom, 0, 1);
$GIVN = preg_match("/\n{$sublevel} GIVN (.+)/", $gedcom, $match) ? $match[1] : '';
$SURN = preg_match("/\n{$sublevel} SURN (.+)/", $gedcom, $match) ? $match[1] : '';
// SURN is an comma-separated list of surnames...
if ($SURN !== '') {
$SURNS = preg_split('/ *, */', $SURN);
} else {
$SURNS = [];
}
// ...so is GIVN - but nobody uses it like that