@@ -29,126 +29,126 @@ |
||
29 | 29 | */ |
30 | 30 | class SourceStatusService |
31 | 31 | { |
32 | - /** |
|
33 | - * Maximum timespan between the date of a source and the date of the event to consider the source precise. |
|
34 | - * Arbitrally set to approximately a year around the event date. |
|
35 | - * |
|
36 | - * @var int DATE_PRECISION_MARGIN |
|
37 | - */ |
|
38 | - private const DATE_PRECISION_MARGIN = 180; |
|
39 | - |
|
40 | - /** |
|
41 | - * Return the status of source citations for a fact. |
|
42 | - * |
|
43 | - * @param Fact $fact |
|
44 | - * @return FactSourceStatus |
|
45 | - */ |
|
46 | - public function sourceStatusForFact(Fact $fact): FactSourceStatus |
|
47 | - { |
|
48 | - $source_status = new FactSourceStatus(); |
|
49 | - |
|
50 | - $date = $fact->date(); |
|
51 | - $source_status |
|
52 | - ->setFactHasDate($date->isOK()) |
|
53 | - ->setFactHasPreciseDate($date->qual1 === '' && $date->minimumJulianDay() === $date->maximumJulianDay()); |
|
54 | - |
|
55 | - foreach ($fact->getCitations() as $citation) { |
|
56 | - $source_status |
|
57 | - ->setHasSource(true) |
|
58 | - ->addHasSupportingDocument(preg_match('/\n3 _ACT (?:.*)/', $citation) === 1); |
|
59 | - |
|
60 | - preg_match_all("/\n3 DATA(?:\n[4-9] .*)*\n4 DATE (.*)/", $citation, $date_matches, PREG_SET_ORDER); |
|
61 | - foreach ($date_matches as $date_match) { |
|
62 | - $source_date = new Date($date_match[1]); |
|
63 | - $source_status |
|
64 | - ->addSourceHasDate($source_date->isOK()) |
|
65 | - ->addSourceMatchesFactDate($date->isOK() && $source_date->isOK() |
|
66 | - && abs($source_date->julianDay() - $date->julianDay()) < self::DATE_PRECISION_MARGIN); |
|
67 | - } |
|
68 | - |
|
69 | - if ($source_status->isFullySourced()) { |
|
70 | - return $source_status; |
|
71 | - } |
|
72 | - } |
|
73 | - |
|
74 | - return $source_status; |
|
75 | - } |
|
76 | - |
|
77 | - /** |
|
78 | - * Return the status of sources for a Gedcom record. |
|
79 | - * |
|
80 | - * @param GedcomRecord $record |
|
81 | - * @return SourceStatus |
|
82 | - */ |
|
83 | - public function sourceStatusForRecord(GedcomRecord $record): SourceStatus |
|
84 | - { |
|
85 | - $source_status = new SourceStatus(); |
|
86 | - |
|
87 | - foreach ($record->facts(['SOUR']) as $source) { |
|
88 | - $source_status |
|
89 | - ->setHasSource(true) |
|
90 | - ->addHasSupportingDocument($source->attribute('_ACT') !== ''); |
|
91 | - |
|
92 | - if ($source_status->isFullySourced()) { |
|
93 | - return $source_status; |
|
94 | - } |
|
95 | - } |
|
96 | - |
|
97 | - return $source_status; |
|
98 | - } |
|
99 | - |
|
100 | - /** |
|
101 | - * Return the status of source citations for a list of fact types associated with a record. |
|
102 | - * |
|
103 | - * @param GedcomRecord $record |
|
104 | - * @param string[] $tags |
|
105 | - * @return FactSourceStatus |
|
106 | - */ |
|
107 | - public function sourceStatusForFactsWithTags(GedcomRecord $record, array $tags): FactSourceStatus |
|
108 | - { |
|
109 | - $source_status = new NullFactSourceStatus(); |
|
110 | - |
|
111 | - foreach ($record->facts($tags) as $fact) { |
|
112 | - $source_status = $source_status->combineWith($this->sourceStatusForFact($fact)); |
|
113 | - if ($source_status->isFullySourced()) { |
|
114 | - return $source_status; |
|
115 | - } |
|
116 | - } |
|
117 | - |
|
118 | - return $source_status; |
|
119 | - } |
|
120 | - |
|
121 | - /** |
|
122 | - * Return the status of source citations for an individual's birth events. |
|
123 | - * |
|
124 | - * @param Individual $individual |
|
125 | - * @return FactSourceStatus |
|
126 | - */ |
|
127 | - public function sourceStatusForBirth(Individual $individual): FactSourceStatus |
|
128 | - { |
|
129 | - return $this->sourceStatusForFactsWithTags($individual, Gedcom::BIRTH_EVENTS); |
|
130 | - } |
|
131 | - |
|
132 | - /** |
|
133 | - * Return the status of source citations for an individual's death events. |
|
134 | - * |
|
135 | - * @param Individual $individual |
|
136 | - * @return FactSourceStatus |
|
137 | - */ |
|
138 | - public function sourceStatusForDeath(Individual $individual): FactSourceStatus |
|
139 | - { |
|
140 | - return $this->sourceStatusForFactsWithTags($individual, Gedcom::DEATH_EVENTS); |
|
141 | - } |
|
142 | - |
|
143 | - /** |
|
144 | - * Return the status of source citations for a family's marriage events. |
|
145 | - * |
|
146 | - * @param Family $family |
|
147 | - * @return FactSourceStatus |
|
148 | - */ |
|
149 | - public function sourceStatusForMarriage(Family $family): FactSourceStatus |
|
150 | - { |
|
151 | - $marr_events = [...Gedcom::MARRIAGE_EVENTS, 'MARC', 'MARL', 'MARS']; |
|
152 | - return $this->sourceStatusForFactsWithTags($family, $marr_events); |
|
153 | - } |
|
32 | + /** |
|
33 | + * Maximum timespan between the date of a source and the date of the event to consider the source precise. |
|
34 | + * Arbitrally set to approximately a year around the event date. |
|
35 | + * |
|
36 | + * @var int DATE_PRECISION_MARGIN |
|
37 | + */ |
|
38 | + private const DATE_PRECISION_MARGIN = 180; |
|
39 | + |
|
40 | + /** |
|
41 | + * Return the status of source citations for a fact. |
|
42 | + * |
|
43 | + * @param Fact $fact |
|
44 | + * @return FactSourceStatus |
|
45 | + */ |
|
46 | + public function sourceStatusForFact(Fact $fact): FactSourceStatus |
|
47 | + { |
|
48 | + $source_status = new FactSourceStatus(); |
|
49 | + |
|
50 | + $date = $fact->date(); |
|
51 | + $source_status |
|
52 | + ->setFactHasDate($date->isOK()) |
|
53 | + ->setFactHasPreciseDate($date->qual1 === '' && $date->minimumJulianDay() === $date->maximumJulianDay()); |
|
54 | + |
|
55 | + foreach ($fact->getCitations() as $citation) { |
|
56 | + $source_status |
|
57 | + ->setHasSource(true) |
|
58 | + ->addHasSupportingDocument(preg_match('/\n3 _ACT (?:.*)/', $citation) === 1); |
|
59 | + |
|
60 | + preg_match_all("/\n3 DATA(?:\n[4-9] .*)*\n4 DATE (.*)/", $citation, $date_matches, PREG_SET_ORDER); |
|
61 | + foreach ($date_matches as $date_match) { |
|
62 | + $source_date = new Date($date_match[1]); |
|
63 | + $source_status |
|
64 | + ->addSourceHasDate($source_date->isOK()) |
|
65 | + ->addSourceMatchesFactDate($date->isOK() && $source_date->isOK() |
|
66 | + && abs($source_date->julianDay() - $date->julianDay()) < self::DATE_PRECISION_MARGIN); |
|
67 | + } |
|
68 | + |
|
69 | + if ($source_status->isFullySourced()) { |
|
70 | + return $source_status; |
|
71 | + } |
|
72 | + } |
|
73 | + |
|
74 | + return $source_status; |
|
75 | + } |
|
76 | + |
|
77 | + /** |
|
78 | + * Return the status of sources for a Gedcom record. |
|
79 | + * |
|
80 | + * @param GedcomRecord $record |
|
81 | + * @return SourceStatus |
|
82 | + */ |
|
83 | + public function sourceStatusForRecord(GedcomRecord $record): SourceStatus |
|
84 | + { |
|
85 | + $source_status = new SourceStatus(); |
|
86 | + |
|
87 | + foreach ($record->facts(['SOUR']) as $source) { |
|
88 | + $source_status |
|
89 | + ->setHasSource(true) |
|
90 | + ->addHasSupportingDocument($source->attribute('_ACT') !== ''); |
|
91 | + |
|
92 | + if ($source_status->isFullySourced()) { |
|
93 | + return $source_status; |
|
94 | + } |
|
95 | + } |
|
96 | + |
|
97 | + return $source_status; |
|
98 | + } |
|
99 | + |
|
100 | + /** |
|
101 | + * Return the status of source citations for a list of fact types associated with a record. |
|
102 | + * |
|
103 | + * @param GedcomRecord $record |
|
104 | + * @param string[] $tags |
|
105 | + * @return FactSourceStatus |
|
106 | + */ |
|
107 | + public function sourceStatusForFactsWithTags(GedcomRecord $record, array $tags): FactSourceStatus |
|
108 | + { |
|
109 | + $source_status = new NullFactSourceStatus(); |
|
110 | + |
|
111 | + foreach ($record->facts($tags) as $fact) { |
|
112 | + $source_status = $source_status->combineWith($this->sourceStatusForFact($fact)); |
|
113 | + if ($source_status->isFullySourced()) { |
|
114 | + return $source_status; |
|
115 | + } |
|
116 | + } |
|
117 | + |
|
118 | + return $source_status; |
|
119 | + } |
|
120 | + |
|
121 | + /** |
|
122 | + * Return the status of source citations for an individual's birth events. |
|
123 | + * |
|
124 | + * @param Individual $individual |
|
125 | + * @return FactSourceStatus |
|
126 | + */ |
|
127 | + public function sourceStatusForBirth(Individual $individual): FactSourceStatus |
|
128 | + { |
|
129 | + return $this->sourceStatusForFactsWithTags($individual, Gedcom::BIRTH_EVENTS); |
|
130 | + } |
|
131 | + |
|
132 | + /** |
|
133 | + * Return the status of source citations for an individual's death events. |
|
134 | + * |
|
135 | + * @param Individual $individual |
|
136 | + * @return FactSourceStatus |
|
137 | + */ |
|
138 | + public function sourceStatusForDeath(Individual $individual): FactSourceStatus |
|
139 | + { |
|
140 | + return $this->sourceStatusForFactsWithTags($individual, Gedcom::DEATH_EVENTS); |
|
141 | + } |
|
142 | + |
|
143 | + /** |
|
144 | + * Return the status of source citations for a family's marriage events. |
|
145 | + * |
|
146 | + * @param Family $family |
|
147 | + * @return FactSourceStatus |
|
148 | + */ |
|
149 | + public function sourceStatusForMarriage(Family $family): FactSourceStatus |
|
150 | + { |
|
151 | + $marr_events = [...Gedcom::MARRIAGE_EVENTS, 'MARC', 'MARL', 'MARS']; |
|
152 | + return $this->sourceStatusForFactsWithTags($family, $marr_events); |
|
153 | + } |
|
154 | 154 | } |
@@ -27,80 +27,80 @@ |
||
27 | 27 | */ |
28 | 28 | abstract class AbstractHookCollector implements HookCollectorInterface, HookInterface |
29 | 29 | { |
30 | - /** @var Collection<THook> $hooks */ |
|
31 | - protected Collection $hooks; |
|
30 | + /** @var Collection<THook> $hooks */ |
|
31 | + protected Collection $hooks; |
|
32 | 32 | |
33 | - private ModuleInterface $module; |
|
33 | + private ModuleInterface $module; |
|
34 | 34 | |
35 | - /** |
|
36 | - * Constructor for AbstractHookCollector |
|
37 | - * |
|
38 | - * @param ModuleInterface $module |
|
39 | - */ |
|
40 | - public function __construct(ModuleInterface $module) |
|
41 | - { |
|
42 | - $this->hooks = new Collection(); |
|
43 | - $this->module = $module; |
|
44 | - } |
|
35 | + /** |
|
36 | + * Constructor for AbstractHookCollector |
|
37 | + * |
|
38 | + * @param ModuleInterface $module |
|
39 | + */ |
|
40 | + public function __construct(ModuleInterface $module) |
|
41 | + { |
|
42 | + $this->hooks = new Collection(); |
|
43 | + $this->module = $module; |
|
44 | + } |
|
45 | 45 | |
46 | - /** |
|
47 | - * {@inheritDoc} |
|
48 | - * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookInterface::module() |
|
49 | - */ |
|
50 | - public function module(): ModuleInterface |
|
51 | - { |
|
52 | - return $this->module; |
|
53 | - } |
|
46 | + /** |
|
47 | + * {@inheritDoc} |
|
48 | + * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookInterface::module() |
|
49 | + */ |
|
50 | + public function module(): ModuleInterface |
|
51 | + { |
|
52 | + return $this->module; |
|
53 | + } |
|
54 | 54 | |
55 | - /** |
|
56 | - * {@inheritDoc} |
|
57 | - * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::name() |
|
58 | - */ |
|
59 | - public function name(): string |
|
60 | - { |
|
61 | - return $this->module->name() . '-' . |
|
62 | - mb_substr(str_replace('collector', '', mb_strtolower((new ReflectionClass($this))->getShortName())), 0, 64); |
|
63 | - } |
|
55 | + /** |
|
56 | + * {@inheritDoc} |
|
57 | + * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::name() |
|
58 | + */ |
|
59 | + public function name(): string |
|
60 | + { |
|
61 | + return $this->module->name() . '-' . |
|
62 | + mb_substr(str_replace('collector', '', mb_strtolower((new ReflectionClass($this))->getShortName())), 0, 64); |
|
63 | + } |
|
64 | 64 | |
65 | - /** |
|
66 | - * {@inheritDoc} |
|
67 | - * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::title() |
|
68 | - */ |
|
69 | - abstract public function title(): string; |
|
65 | + /** |
|
66 | + * {@inheritDoc} |
|
67 | + * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::title() |
|
68 | + */ |
|
69 | + abstract public function title(): string; |
|
70 | 70 | |
71 | - /** |
|
72 | - * {@inheritDoc} |
|
73 | - * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::description() |
|
74 | - */ |
|
75 | - abstract public function description(): string; |
|
71 | + /** |
|
72 | + * {@inheritDoc} |
|
73 | + * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::description() |
|
74 | + */ |
|
75 | + abstract public function description(): string; |
|
76 | 76 | |
77 | - /** |
|
78 | - * {@inheritDoc} |
|
79 | - * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::hookInterface() |
|
80 | - */ |
|
81 | - abstract public function hookInterface(): string; |
|
77 | + /** |
|
78 | + * {@inheritDoc} |
|
79 | + * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::hookInterface() |
|
80 | + */ |
|
81 | + abstract public function hookInterface(): string; |
|
82 | 82 | |
83 | - /** |
|
84 | - * {@inheritDoc} |
|
85 | - * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::register() |
|
86 | - */ |
|
87 | - public function register(HookInterface $hook_instance, int $order): void |
|
88 | - { |
|
89 | - if ($this->hooks->has($order)) { |
|
90 | - $this->hooks->splice($order + 1, 0, [$hook_instance]); |
|
91 | - } else { |
|
92 | - $this->hooks->put($order, $hook_instance); |
|
93 | - } |
|
94 | - } |
|
83 | + /** |
|
84 | + * {@inheritDoc} |
|
85 | + * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::register() |
|
86 | + */ |
|
87 | + public function register(HookInterface $hook_instance, int $order): void |
|
88 | + { |
|
89 | + if ($this->hooks->has($order)) { |
|
90 | + $this->hooks->splice($order + 1, 0, [$hook_instance]); |
|
91 | + } else { |
|
92 | + $this->hooks->put($order, $hook_instance); |
|
93 | + } |
|
94 | + } |
|
95 | 95 | |
96 | - /** |
|
97 | - * {@inheritDoc} |
|
98 | - * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::hooks() |
|
99 | - * |
|
100 | - * @return Collection<THook> |
|
101 | - */ |
|
102 | - public function hooks(): Collection |
|
103 | - { |
|
104 | - return $this->hooks->sortKeys(); |
|
105 | - } |
|
96 | + /** |
|
97 | + * {@inheritDoc} |
|
98 | + * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::hooks() |
|
99 | + * |
|
100 | + * @return Collection<THook> |
|
101 | + */ |
|
102 | + public function hooks(): Collection |
|
103 | + { |
|
104 | + return $this->hooks->sortKeys(); |
|
105 | + } |
|
106 | 106 | } |
@@ -28,133 +28,133 @@ |
||
28 | 28 | */ |
29 | 29 | class GeoAnalysisPlace |
30 | 30 | { |
31 | - /** |
|
32 | - * The default place name for invalid places |
|
33 | - * @var string INVALID_PLACE |
|
34 | - */ |
|
35 | - private const INVALID_PLACE = '##INVALID##'; |
|
36 | - |
|
37 | - private Place $place; |
|
38 | - private bool $is_excluded; |
|
39 | - |
|
40 | - /** |
|
41 | - * Constructor for GeoAnalysisPlace |
|
42 | - * |
|
43 | - * @param Tree $tree Default tree |
|
44 | - * @param Place|null $place Place resulting from the analysis |
|
45 | - * @param int $depth Place hierarchy depth defined by the geographical analysis view |
|
46 | - * @param bool $strict_depth Checks whether places with a lower depth than defined should be flagged as invalid |
|
47 | - */ |
|
48 | - public function __construct(Tree $tree, ?Place $place, int $depth, bool $strict_depth = false) |
|
49 | - { |
|
50 | - $this->place = $this->extractPlace($place, $depth, $strict_depth) ?? new Place('', $tree); |
|
51 | - $this->is_excluded = false; |
|
52 | - } |
|
53 | - |
|
54 | - /** |
|
55 | - * Process the provided Place to determine its status for further usage |
|
56 | - * |
|
57 | - * @param Place|null $place |
|
58 | - * @param int $depth |
|
59 | - * @param bool $strict_depth |
|
60 | - * @return Place|NULL |
|
61 | - */ |
|
62 | - private function extractPlace(?Place $place, int $depth, bool $strict_depth): ?Place |
|
63 | - { |
|
64 | - if ($place === null) { |
|
65 | - return null; |
|
66 | - } |
|
67 | - if (mb_strlen($place->gedcomName()) === 0) { |
|
68 | - return null; |
|
69 | - } |
|
70 | - $parts = $place->lastParts($depth); |
|
71 | - if ($strict_depth && $parts->count() !== $depth) { |
|
72 | - return new Place(self::INVALID_PLACE, $place->tree()); |
|
73 | - } |
|
74 | - return new Place($parts->implode(', '), $place->tree()); |
|
75 | - } |
|
76 | - |
|
77 | - /** |
|
78 | - * Get the GeoAnalysis Place key |
|
79 | - * |
|
80 | - * @return string |
|
81 | - */ |
|
82 | - public function key(): string |
|
83 | - { |
|
84 | - return $this->place->gedcomName(); |
|
85 | - } |
|
86 | - |
|
87 | - /** |
|
88 | - * Get the underlying Place object |
|
89 | - * |
|
90 | - * @return Place |
|
91 | - */ |
|
92 | - public function place(): Place |
|
93 | - { |
|
94 | - return $this->place; |
|
95 | - } |
|
96 | - |
|
97 | - /** |
|
98 | - * Check if the GeoAnalysis Place is in the Known status |
|
99 | - * |
|
100 | - * @return bool |
|
101 | - */ |
|
102 | - public function isKnown(): bool |
|
103 | - { |
|
104 | - return !$this->isUnknown(); |
|
105 | - } |
|
106 | - |
|
107 | - /** |
|
108 | - * Check if the GeoAnalysis Place is in the Unknown status |
|
109 | - * |
|
110 | - * @return bool |
|
111 | - */ |
|
112 | - public function isUnknown(): bool |
|
113 | - { |
|
114 | - return mb_strlen($this->place->gedcomName()) === 0; |
|
115 | - } |
|
116 | - |
|
117 | - /** |
|
118 | - * Check if the GeoAnalysis Place is in the Invalid status |
|
119 | - * |
|
120 | - * @return bool |
|
121 | - */ |
|
122 | - public function isInvalid(): bool |
|
123 | - { |
|
124 | - return $this->place->gedcomName() === self::INVALID_PLACE; |
|
125 | - } |
|
126 | - |
|
127 | - /** |
|
128 | - * Check if the GeoAnalysis Place is in the Excluded status |
|
129 | - * |
|
130 | - * @return bool |
|
131 | - */ |
|
132 | - public function isExcluded(): bool |
|
133 | - { |
|
134 | - return $this->isUnknown() || $this->isInvalid() || $this->is_excluded; |
|
135 | - } |
|
136 | - |
|
137 | - /** |
|
138 | - * Set the GeoAnalysis Place status to Found, if the parameter is true |
|
139 | - * |
|
140 | - * @param bool $include |
|
141 | - * @return $this |
|
142 | - */ |
|
143 | - public function include(bool $include = true): self |
|
144 | - { |
|
145 | - $this->is_excluded = !$include; |
|
146 | - return $this; |
|
147 | - } |
|
148 | - |
|
149 | - /** |
|
150 | - * Set the GeoAnalysis Place status to Excluded, if the parameter is true |
|
151 | - * |
|
152 | - * @param bool $exclude |
|
153 | - * @return $this |
|
154 | - */ |
|
155 | - public function exclude(bool $exclude = true): self |
|
156 | - { |
|
157 | - $this->is_excluded = $exclude; |
|
158 | - return $this; |
|
159 | - } |
|
31 | + /** |
|
32 | + * The default place name for invalid places |
|
33 | + * @var string INVALID_PLACE |
|
34 | + */ |
|
35 | + private const INVALID_PLACE = '##INVALID##'; |
|
36 | + |
|
37 | + private Place $place; |
|
38 | + private bool $is_excluded; |
|
39 | + |
|
40 | + /** |
|
41 | + * Constructor for GeoAnalysisPlace |
|
42 | + * |
|
43 | + * @param Tree $tree Default tree |
|
44 | + * @param Place|null $place Place resulting from the analysis |
|
45 | + * @param int $depth Place hierarchy depth defined by the geographical analysis view |
|
46 | + * @param bool $strict_depth Checks whether places with a lower depth than defined should be flagged as invalid |
|
47 | + */ |
|
48 | + public function __construct(Tree $tree, ?Place $place, int $depth, bool $strict_depth = false) |
|
49 | + { |
|
50 | + $this->place = $this->extractPlace($place, $depth, $strict_depth) ?? new Place('', $tree); |
|
51 | + $this->is_excluded = false; |
|
52 | + } |
|
53 | + |
|
54 | + /** |
|
55 | + * Process the provided Place to determine its status for further usage |
|
56 | + * |
|
57 | + * @param Place|null $place |
|
58 | + * @param int $depth |
|
59 | + * @param bool $strict_depth |
|
60 | + * @return Place|NULL |
|
61 | + */ |
|
62 | + private function extractPlace(?Place $place, int $depth, bool $strict_depth): ?Place |
|
63 | + { |
|
64 | + if ($place === null) { |
|
65 | + return null; |
|
66 | + } |
|
67 | + if (mb_strlen($place->gedcomName()) === 0) { |
|
68 | + return null; |
|
69 | + } |
|
70 | + $parts = $place->lastParts($depth); |
|
71 | + if ($strict_depth && $parts->count() !== $depth) { |
|
72 | + return new Place(self::INVALID_PLACE, $place->tree()); |
|
73 | + } |
|
74 | + return new Place($parts->implode(', '), $place->tree()); |
|
75 | + } |
|
76 | + |
|
77 | + /** |
|
78 | + * Get the GeoAnalysis Place key |
|
79 | + * |
|
80 | + * @return string |
|
81 | + */ |
|
82 | + public function key(): string |
|
83 | + { |
|
84 | + return $this->place->gedcomName(); |
|
85 | + } |
|
86 | + |
|
87 | + /** |
|
88 | + * Get the underlying Place object |
|
89 | + * |
|
90 | + * @return Place |
|
91 | + */ |
|
92 | + public function place(): Place |
|
93 | + { |
|
94 | + return $this->place; |
|
95 | + } |
|
96 | + |
|
97 | + /** |
|
98 | + * Check if the GeoAnalysis Place is in the Known status |
|
99 | + * |
|
100 | + * @return bool |
|
101 | + */ |
|
102 | + public function isKnown(): bool |
|
103 | + { |
|
104 | + return !$this->isUnknown(); |
|
105 | + } |
|
106 | + |
|
107 | + /** |
|
108 | + * Check if the GeoAnalysis Place is in the Unknown status |
|
109 | + * |
|
110 | + * @return bool |
|
111 | + */ |
|
112 | + public function isUnknown(): bool |
|
113 | + { |
|
114 | + return mb_strlen($this->place->gedcomName()) === 0; |
|
115 | + } |
|
116 | + |
|
117 | + /** |
|
118 | + * Check if the GeoAnalysis Place is in the Invalid status |
|
119 | + * |
|
120 | + * @return bool |
|
121 | + */ |
|
122 | + public function isInvalid(): bool |
|
123 | + { |
|
124 | + return $this->place->gedcomName() === self::INVALID_PLACE; |
|
125 | + } |
|
126 | + |
|
127 | + /** |
|
128 | + * Check if the GeoAnalysis Place is in the Excluded status |
|
129 | + * |
|
130 | + * @return bool |
|
131 | + */ |
|
132 | + public function isExcluded(): bool |
|
133 | + { |
|
134 | + return $this->isUnknown() || $this->isInvalid() || $this->is_excluded; |
|
135 | + } |
|
136 | + |
|
137 | + /** |
|
138 | + * Set the GeoAnalysis Place status to Found, if the parameter is true |
|
139 | + * |
|
140 | + * @param bool $include |
|
141 | + * @return $this |
|
142 | + */ |
|
143 | + public function include(bool $include = true): self |
|
144 | + { |
|
145 | + $this->is_excluded = !$include; |
|
146 | + return $this; |
|
147 | + } |
|
148 | + |
|
149 | + /** |
|
150 | + * Set the GeoAnalysis Place status to Excluded, if the parameter is true |
|
151 | + * |
|
152 | + * @param bool $exclude |
|
153 | + * @return $this |
|
154 | + */ |
|
155 | + public function exclude(bool $exclude = true): self |
|
156 | + { |
|
157 | + $this->is_excluded = $exclude; |
|
158 | + return $this; |
|
159 | + } |
|
160 | 160 | } |
@@ -20,67 +20,67 @@ |
||
20 | 20 | */ |
21 | 21 | class GeoAnalysisResultItem |
22 | 22 | { |
23 | - private GeoAnalysisPlace $place; |
|
24 | - private int $count; |
|
23 | + private GeoAnalysisPlace $place; |
|
24 | + private int $count; |
|
25 | 25 | |
26 | - /** |
|
27 | - * Constructor for GeoAnalysisResultItem |
|
28 | - * |
|
29 | - * @param GeoAnalysisPlace $place |
|
30 | - * @param int $count |
|
31 | - */ |
|
32 | - public function __construct(GeoAnalysisPlace $place, int $count = 0) |
|
33 | - { |
|
34 | - $this->place = $place; |
|
35 | - $this->count = $count; |
|
36 | - } |
|
26 | + /** |
|
27 | + * Constructor for GeoAnalysisResultItem |
|
28 | + * |
|
29 | + * @param GeoAnalysisPlace $place |
|
30 | + * @param int $count |
|
31 | + */ |
|
32 | + public function __construct(GeoAnalysisPlace $place, int $count = 0) |
|
33 | + { |
|
34 | + $this->place = $place; |
|
35 | + $this->count = $count; |
|
36 | + } |
|
37 | 37 | |
38 | - /** |
|
39 | - * Get the item key. |
|
40 | - * |
|
41 | - * @return string |
|
42 | - */ |
|
43 | - public function key(): string |
|
44 | - { |
|
45 | - return $this->place->key(); |
|
46 | - } |
|
38 | + /** |
|
39 | + * Get the item key. |
|
40 | + * |
|
41 | + * @return string |
|
42 | + */ |
|
43 | + public function key(): string |
|
44 | + { |
|
45 | + return $this->place->key(); |
|
46 | + } |
|
47 | 47 | |
48 | - /** |
|
49 | - * Get the referenced GeoAnalysis Place |
|
50 | - * |
|
51 | - * @return GeoAnalysisPlace |
|
52 | - */ |
|
53 | - public function place(): GeoAnalysisPlace |
|
54 | - { |
|
55 | - return $this->place; |
|
56 | - } |
|
48 | + /** |
|
49 | + * Get the referenced GeoAnalysis Place |
|
50 | + * |
|
51 | + * @return GeoAnalysisPlace |
|
52 | + */ |
|
53 | + public function place(): GeoAnalysisPlace |
|
54 | + { |
|
55 | + return $this->place; |
|
56 | + } |
|
57 | 57 | |
58 | - /** |
|
59 | - * Get the count of occurrences of the GeoAnalysis Place in the analysis |
|
60 | - * |
|
61 | - * @return int |
|
62 | - */ |
|
63 | - public function count(): int |
|
64 | - { |
|
65 | - return $this->count; |
|
66 | - } |
|
58 | + /** |
|
59 | + * Get the count of occurrences of the GeoAnalysis Place in the analysis |
|
60 | + * |
|
61 | + * @return int |
|
62 | + */ |
|
63 | + public function count(): int |
|
64 | + { |
|
65 | + return $this->count; |
|
66 | + } |
|
67 | 67 | |
68 | - /** |
|
69 | - * Increment the count of occurrences of the GeoAnalysis Place in the analysis |
|
70 | - * |
|
71 | - * @return $this |
|
72 | - */ |
|
73 | - public function increment(): self |
|
74 | - { |
|
75 | - $this->count++; |
|
76 | - return $this; |
|
77 | - } |
|
68 | + /** |
|
69 | + * Increment the count of occurrences of the GeoAnalysis Place in the analysis |
|
70 | + * |
|
71 | + * @return $this |
|
72 | + */ |
|
73 | + public function increment(): self |
|
74 | + { |
|
75 | + $this->count++; |
|
76 | + return $this; |
|
77 | + } |
|
78 | 78 | |
79 | - /** |
|
80 | - * Clone the item object |
|
81 | - */ |
|
82 | - public function __clone() |
|
83 | - { |
|
84 | - $this->place = clone $this->place; |
|
85 | - } |
|
79 | + /** |
|
80 | + * Clone the item object |
|
81 | + */ |
|
82 | + public function __clone() |
|
83 | + { |
|
84 | + $this->place = clone $this->place; |
|
85 | + } |
|
86 | 86 | } |
@@ -23,252 +23,252 @@ |
||
23 | 23 | */ |
24 | 24 | class TaskSchedule |
25 | 25 | { |
26 | - private int $id; |
|
27 | - private bool $enabled; |
|
28 | - private string $task_id; |
|
29 | - private TimestampInterface $last_run; |
|
30 | - private bool $last_result; |
|
31 | - private int $frequency; |
|
32 | - private int $nb_occurrences; |
|
33 | - private bool $is_running; |
|
26 | + private int $id; |
|
27 | + private bool $enabled; |
|
28 | + private string $task_id; |
|
29 | + private TimestampInterface $last_run; |
|
30 | + private bool $last_result; |
|
31 | + private int $frequency; |
|
32 | + private int $nb_occurrences; |
|
33 | + private bool $is_running; |
|
34 | 34 | |
35 | - /** |
|
36 | - * Constructor for TaskSchedule |
|
37 | - * |
|
38 | - * @param int $id Schedule ID |
|
39 | - * @param string $task_id Task ID |
|
40 | - * @param bool $enabled Is the schedule enabled |
|
41 | - * @param TimestampInterface $last_run Last successful run date/time |
|
42 | - * @param bool $last_result Result of the last run |
|
43 | - * @param int $frequency Schedule frequency in minutes |
|
44 | - * @param int $nb_occurrences Number of remaining occurrences to be run |
|
45 | - * @param bool $is_running Is the task currently running |
|
46 | - */ |
|
47 | - public function __construct( |
|
48 | - int $id, |
|
49 | - string $task_id, |
|
50 | - bool $enabled, |
|
51 | - TimestampInterface $last_run, |
|
52 | - bool $last_result, |
|
53 | - int $frequency, |
|
54 | - int $nb_occurrences, |
|
55 | - bool $is_running |
|
56 | - ) { |
|
57 | - $this->id = $id; |
|
58 | - $this->task_id = $task_id; |
|
59 | - $this->enabled = $enabled; |
|
60 | - $this->last_run = $last_run; |
|
61 | - $this->last_result = $last_result; |
|
62 | - $this->frequency = $frequency; |
|
63 | - $this->nb_occurrences = $nb_occurrences; |
|
64 | - $this->is_running = $is_running; |
|
65 | - } |
|
35 | + /** |
|
36 | + * Constructor for TaskSchedule |
|
37 | + * |
|
38 | + * @param int $id Schedule ID |
|
39 | + * @param string $task_id Task ID |
|
40 | + * @param bool $enabled Is the schedule enabled |
|
41 | + * @param TimestampInterface $last_run Last successful run date/time |
|
42 | + * @param bool $last_result Result of the last run |
|
43 | + * @param int $frequency Schedule frequency in minutes |
|
44 | + * @param int $nb_occurrences Number of remaining occurrences to be run |
|
45 | + * @param bool $is_running Is the task currently running |
|
46 | + */ |
|
47 | + public function __construct( |
|
48 | + int $id, |
|
49 | + string $task_id, |
|
50 | + bool $enabled, |
|
51 | + TimestampInterface $last_run, |
|
52 | + bool $last_result, |
|
53 | + int $frequency, |
|
54 | + int $nb_occurrences, |
|
55 | + bool $is_running |
|
56 | + ) { |
|
57 | + $this->id = $id; |
|
58 | + $this->task_id = $task_id; |
|
59 | + $this->enabled = $enabled; |
|
60 | + $this->last_run = $last_run; |
|
61 | + $this->last_result = $last_result; |
|
62 | + $this->frequency = $frequency; |
|
63 | + $this->nb_occurrences = $nb_occurrences; |
|
64 | + $this->is_running = $is_running; |
|
65 | + } |
|
66 | 66 | |
67 | - /** |
|
68 | - * Get the schedule ID. |
|
69 | - * |
|
70 | - * @return int |
|
71 | - */ |
|
72 | - public function id(): int |
|
73 | - { |
|
74 | - return $this->id; |
|
75 | - } |
|
67 | + /** |
|
68 | + * Get the schedule ID. |
|
69 | + * |
|
70 | + * @return int |
|
71 | + */ |
|
72 | + public function id(): int |
|
73 | + { |
|
74 | + return $this->id; |
|
75 | + } |
|
76 | 76 | |
77 | - /** |
|
78 | - * Get the task ID. |
|
79 | - * |
|
80 | - * @return string |
|
81 | - */ |
|
82 | - public function taskId(): string |
|
83 | - { |
|
84 | - return $this->task_id; |
|
85 | - } |
|
77 | + /** |
|
78 | + * Get the task ID. |
|
79 | + * |
|
80 | + * @return string |
|
81 | + */ |
|
82 | + public function taskId(): string |
|
83 | + { |
|
84 | + return $this->task_id; |
|
85 | + } |
|
86 | 86 | |
87 | - /** |
|
88 | - * Returns whether the schedule is enabled |
|
89 | - * |
|
90 | - * @return bool |
|
91 | - */ |
|
92 | - public function isEnabled(): bool |
|
93 | - { |
|
94 | - return $this->enabled; |
|
95 | - } |
|
87 | + /** |
|
88 | + * Returns whether the schedule is enabled |
|
89 | + * |
|
90 | + * @return bool |
|
91 | + */ |
|
92 | + public function isEnabled(): bool |
|
93 | + { |
|
94 | + return $this->enabled; |
|
95 | + } |
|
96 | 96 | |
97 | - /** |
|
98 | - * Enable the schedule |
|
99 | - * |
|
100 | - * @return $this |
|
101 | - */ |
|
102 | - public function enable(): self |
|
103 | - { |
|
104 | - $this->enabled = true; |
|
105 | - return $this; |
|
106 | - } |
|
97 | + /** |
|
98 | + * Enable the schedule |
|
99 | + * |
|
100 | + * @return $this |
|
101 | + */ |
|
102 | + public function enable(): self |
|
103 | + { |
|
104 | + $this->enabled = true; |
|
105 | + return $this; |
|
106 | + } |
|
107 | 107 | |
108 | - /** |
|
109 | - * Disable the schedule |
|
110 | - * |
|
111 | - * @return $this |
|
112 | - */ |
|
113 | - public function disable(): self |
|
114 | - { |
|
115 | - $this->enabled = false; |
|
116 | - return $this; |
|
117 | - } |
|
108 | + /** |
|
109 | + * Disable the schedule |
|
110 | + * |
|
111 | + * @return $this |
|
112 | + */ |
|
113 | + public function disable(): self |
|
114 | + { |
|
115 | + $this->enabled = false; |
|
116 | + return $this; |
|
117 | + } |
|
118 | 118 | |
119 | - /** |
|
120 | - * Get the frequency of the schedule |
|
121 | - * |
|
122 | - * @return int |
|
123 | - */ |
|
124 | - public function frequency(): int |
|
125 | - { |
|
126 | - return $this->frequency; |
|
127 | - } |
|
119 | + /** |
|
120 | + * Get the frequency of the schedule |
|
121 | + * |
|
122 | + * @return int |
|
123 | + */ |
|
124 | + public function frequency(): int |
|
125 | + { |
|
126 | + return $this->frequency; |
|
127 | + } |
|
128 | 128 | |
129 | - /** |
|
130 | - * Set the frequency of the schedule |
|
131 | - * |
|
132 | - * @param int $frequency |
|
133 | - * @return $this |
|
134 | - */ |
|
135 | - public function setFrequency(int $frequency): self |
|
136 | - { |
|
137 | - $this->frequency = $frequency; |
|
138 | - return $this; |
|
139 | - } |
|
129 | + /** |
|
130 | + * Set the frequency of the schedule |
|
131 | + * |
|
132 | + * @param int $frequency |
|
133 | + * @return $this |
|
134 | + */ |
|
135 | + public function setFrequency(int $frequency): self |
|
136 | + { |
|
137 | + $this->frequency = $frequency; |
|
138 | + return $this; |
|
139 | + } |
|
140 | 140 | |
141 | - /** |
|
142 | - * Get the date/time of the last successful run. |
|
143 | - * |
|
144 | - * @return TimestampInterface |
|
145 | - */ |
|
146 | - public function lastRunTime(): TimestampInterface |
|
147 | - { |
|
148 | - return $this->last_run; |
|
149 | - } |
|
141 | + /** |
|
142 | + * Get the date/time of the last successful run. |
|
143 | + * |
|
144 | + * @return TimestampInterface |
|
145 | + */ |
|
146 | + public function lastRunTime(): TimestampInterface |
|
147 | + { |
|
148 | + return $this->last_run; |
|
149 | + } |
|
150 | 150 | |
151 | - /** |
|
152 | - * Set the last successful run date/time |
|
153 | - * |
|
154 | - * @param TimestampInterface $last_run |
|
155 | - * @return $this |
|
156 | - */ |
|
157 | - public function setLastRunTime(TimestampInterface $last_run): self |
|
158 | - { |
|
159 | - $this->last_run = $last_run; |
|
160 | - return $this; |
|
161 | - } |
|
151 | + /** |
|
152 | + * Set the last successful run date/time |
|
153 | + * |
|
154 | + * @param TimestampInterface $last_run |
|
155 | + * @return $this |
|
156 | + */ |
|
157 | + public function setLastRunTime(TimestampInterface $last_run): self |
|
158 | + { |
|
159 | + $this->last_run = $last_run; |
|
160 | + return $this; |
|
161 | + } |
|
162 | 162 | |
163 | - /** |
|
164 | - * Returns whether the last run was successful |
|
165 | - * |
|
166 | - * @return bool |
|
167 | - */ |
|
168 | - public function wasLastRunSuccess(): bool |
|
169 | - { |
|
170 | - return $this->last_result; |
|
171 | - } |
|
163 | + /** |
|
164 | + * Returns whether the last run was successful |
|
165 | + * |
|
166 | + * @return bool |
|
167 | + */ |
|
168 | + public function wasLastRunSuccess(): bool |
|
169 | + { |
|
170 | + return $this->last_result; |
|
171 | + } |
|
172 | 172 | |
173 | - /** |
|
174 | - * Set the last run result |
|
175 | - * |
|
176 | - * @param bool $last_result |
|
177 | - * @return $this |
|
178 | - */ |
|
179 | - public function setLastResult(bool $last_result): self |
|
180 | - { |
|
181 | - $this->last_result = $last_result; |
|
182 | - return $this; |
|
183 | - } |
|
173 | + /** |
|
174 | + * Set the last run result |
|
175 | + * |
|
176 | + * @param bool $last_result |
|
177 | + * @return $this |
|
178 | + */ |
|
179 | + public function setLastResult(bool $last_result): self |
|
180 | + { |
|
181 | + $this->last_result = $last_result; |
|
182 | + return $this; |
|
183 | + } |
|
184 | 184 | |
185 | - /** |
|
186 | - * Get the number of remaining of occurrences of task runs. |
|
187 | - * Returns 0 if the tasks must be run indefinitely. |
|
188 | - * |
|
189 | - * @return int |
|
190 | - */ |
|
191 | - public function remainingOccurrences(): int |
|
192 | - { |
|
193 | - return $this->nb_occurrences; |
|
194 | - } |
|
185 | + /** |
|
186 | + * Get the number of remaining of occurrences of task runs. |
|
187 | + * Returns 0 if the tasks must be run indefinitely. |
|
188 | + * |
|
189 | + * @return int |
|
190 | + */ |
|
191 | + public function remainingOccurrences(): int |
|
192 | + { |
|
193 | + return $this->nb_occurrences; |
|
194 | + } |
|
195 | 195 | |
196 | - /** |
|
197 | - * Decrements the number of remaining occurrences by 1. |
|
198 | - * The task will be disabled when the number reaches 0. |
|
199 | - * |
|
200 | - * @return $this |
|
201 | - */ |
|
202 | - public function decrementRemainingOccurrences(): self |
|
203 | - { |
|
204 | - if ($this->nb_occurrences > 0) { |
|
205 | - $this->nb_occurrences--; |
|
206 | - if ($this->nb_occurrences == 0) { |
|
207 | - $this->disable(); |
|
208 | - } |
|
209 | - } |
|
210 | - return $this; |
|
211 | - } |
|
196 | + /** |
|
197 | + * Decrements the number of remaining occurrences by 1. |
|
198 | + * The task will be disabled when the number reaches 0. |
|
199 | + * |
|
200 | + * @return $this |
|
201 | + */ |
|
202 | + public function decrementRemainingOccurrences(): self |
|
203 | + { |
|
204 | + if ($this->nb_occurrences > 0) { |
|
205 | + $this->nb_occurrences--; |
|
206 | + if ($this->nb_occurrences == 0) { |
|
207 | + $this->disable(); |
|
208 | + } |
|
209 | + } |
|
210 | + return $this; |
|
211 | + } |
|
212 | 212 | |
213 | - /** |
|
214 | - * Set the number of remaining occurrences of task runs. |
|
215 | - * |
|
216 | - * @param int $nb_occurrences |
|
217 | - * @return $this |
|
218 | - */ |
|
219 | - public function setRemainingOccurrences(int $nb_occurrences): self |
|
220 | - { |
|
221 | - $this->nb_occurrences = $nb_occurrences; |
|
222 | - return $this; |
|
223 | - } |
|
213 | + /** |
|
214 | + * Set the number of remaining occurrences of task runs. |
|
215 | + * |
|
216 | + * @param int $nb_occurrences |
|
217 | + * @return $this |
|
218 | + */ |
|
219 | + public function setRemainingOccurrences(int $nb_occurrences): self |
|
220 | + { |
|
221 | + $this->nb_occurrences = $nb_occurrences; |
|
222 | + return $this; |
|
223 | + } |
|
224 | 224 | |
225 | - /** |
|
226 | - * Returns whether the task is running |
|
227 | - * @return bool |
|
228 | - */ |
|
229 | - public function isRunning(): bool |
|
230 | - { |
|
231 | - return $this->is_running; |
|
232 | - } |
|
225 | + /** |
|
226 | + * Returns whether the task is running |
|
227 | + * @return bool |
|
228 | + */ |
|
229 | + public function isRunning(): bool |
|
230 | + { |
|
231 | + return $this->is_running; |
|
232 | + } |
|
233 | 233 | |
234 | - /** |
|
235 | - * Informs the schedule that the task is going to run |
|
236 | - * |
|
237 | - * @return $this |
|
238 | - */ |
|
239 | - public function startRunning(): self |
|
240 | - { |
|
241 | - $this->is_running = true; |
|
242 | - return $this; |
|
243 | - } |
|
234 | + /** |
|
235 | + * Informs the schedule that the task is going to run |
|
236 | + * |
|
237 | + * @return $this |
|
238 | + */ |
|
239 | + public function startRunning(): self |
|
240 | + { |
|
241 | + $this->is_running = true; |
|
242 | + return $this; |
|
243 | + } |
|
244 | 244 | |
245 | - /** |
|
246 | - * Informs the schedule that the task has stopped running. |
|
247 | - * @return $this |
|
248 | - */ |
|
249 | - public function stopRunning(): self |
|
250 | - { |
|
251 | - $this->is_running = false; |
|
252 | - return $this; |
|
253 | - } |
|
245 | + /** |
|
246 | + * Informs the schedule that the task has stopped running. |
|
247 | + * @return $this |
|
248 | + */ |
|
249 | + public function stopRunning(): self |
|
250 | + { |
|
251 | + $this->is_running = false; |
|
252 | + return $this; |
|
253 | + } |
|
254 | 254 | |
255 | - /** |
|
256 | - * Returns the schedule details as an associate array |
|
257 | - * |
|
258 | - * @phpcs:ignore Generic.Files.LineLength.TooLong |
|
259 | - * @return array{id: int, task_id: string, enabled: bool, last_run: TimestampInterface, last_result: bool, frequency: int, nb_occurrences: int, is_running: bool} |
|
260 | - */ |
|
261 | - public function toArray(): array |
|
262 | - { |
|
263 | - return [ |
|
264 | - 'id' => $this->id, |
|
265 | - 'task_id' => $this->task_id, |
|
266 | - 'enabled' => $this->enabled, |
|
267 | - 'last_run' => $this->last_run, |
|
268 | - 'last_result' => $this->last_result, |
|
269 | - 'frequency' => $this->frequency, |
|
270 | - 'nb_occurrences' => $this->nb_occurrences, |
|
271 | - 'is_running' => $this->is_running |
|
272 | - ]; |
|
273 | - } |
|
255 | + /** |
|
256 | + * Returns the schedule details as an associate array |
|
257 | + * |
|
258 | + * @phpcs:ignore Generic.Files.LineLength.TooLong |
|
259 | + * @return array{id: int, task_id: string, enabled: bool, last_run: TimestampInterface, last_result: bool, frequency: int, nb_occurrences: int, is_running: bool} |
|
260 | + */ |
|
261 | + public function toArray(): array |
|
262 | + { |
|
263 | + return [ |
|
264 | + 'id' => $this->id, |
|
265 | + 'task_id' => $this->task_id, |
|
266 | + 'enabled' => $this->enabled, |
|
267 | + 'last_run' => $this->last_run, |
|
268 | + 'last_result' => $this->last_result, |
|
269 | + 'frequency' => $this->frequency, |
|
270 | + 'nb_occurrences' => $this->nb_occurrences, |
|
271 | + 'is_running' => $this->is_running |
|
272 | + ]; |
|
273 | + } |
|
274 | 274 | } |
@@ -29,538 +29,538 @@ |
||
29 | 29 | */ |
30 | 30 | class SosaStatisticsService |
31 | 31 | { |
32 | - private UserInterface $user; |
|
33 | - private Tree $tree; |
|
34 | - |
|
35 | - /** |
|
36 | - * Constructor for Sosa Statistics Service |
|
37 | - * |
|
38 | - * @param Tree $tree |
|
39 | - * @param UserInterface $user |
|
40 | - */ |
|
41 | - public function __construct(Tree $tree, UserInterface $user) |
|
42 | - { |
|
43 | - $this->tree = $tree; |
|
44 | - $this->user = $user; |
|
45 | - } |
|
46 | - |
|
47 | - /** |
|
48 | - * Check if PDO support the queries used in Sosa statistics. |
|
49 | - * |
|
50 | - * SQLite does not support RIGHT and FULL JOIN, and POWER/SQRT require a specific compilation flag. |
|
51 | - * |
|
52 | - * @return bool |
|
53 | - */ |
|
54 | - public function isPdoSupported(): bool |
|
55 | - { |
|
56 | - return DB::connection()->getDriverName() !== 'sqlite'; |
|
57 | - } |
|
58 | - |
|
59 | - /** |
|
60 | - * Return the root individual for the reference tree and user. |
|
61 | - * |
|
62 | - * @return Individual|NULL |
|
63 | - */ |
|
64 | - public function rootIndividual(): ?Individual |
|
65 | - { |
|
66 | - $root_indi_id = $this->tree->getUserPreference($this->user, 'MAJ_SOSA_ROOT_ID'); |
|
67 | - return Registry::individualFactory()->make($root_indi_id, $this->tree); |
|
68 | - } |
|
69 | - |
|
70 | - /** |
|
71 | - * Get the highest generation for the reference tree and user. |
|
72 | - * |
|
73 | - * @return int |
|
74 | - */ |
|
75 | - public function maxGeneration(): int |
|
76 | - { |
|
77 | - return (int) DB::table('maj_sosa') |
|
78 | - ->where('majs_gedcom_id', '=', $this->tree->id()) |
|
79 | - ->where('majs_user_id', '=', $this->user->id()) |
|
80 | - ->max('majs_gen'); |
|
81 | - } |
|
82 | - |
|
83 | - /** |
|
84 | - * Get the total count of individuals in the tree. |
|
85 | - * |
|
86 | - * @return int |
|
87 | - */ |
|
88 | - public function totalIndividuals(): int |
|
89 | - { |
|
90 | - return DB::table('individuals') |
|
91 | - ->where('i_file', '=', $this->tree->id()) |
|
92 | - ->count(); |
|
93 | - } |
|
94 | - |
|
95 | - /** |
|
96 | - * Get the total count of Sosa ancestors for all generations |
|
97 | - * |
|
98 | - * @return int |
|
99 | - */ |
|
100 | - public function totalAncestors(): int |
|
101 | - { |
|
102 | - return DB::table('maj_sosa') |
|
103 | - ->where('majs_gedcom_id', '=', $this->tree->id()) |
|
104 | - ->where('majs_user_id', '=', $this->user->id()) |
|
105 | - ->count(); |
|
106 | - } |
|
107 | - |
|
108 | - /** |
|
109 | - * Get the total count of Sosa ancestors for a generation |
|
110 | - * |
|
111 | - * @return int |
|
112 | - */ |
|
113 | - public function totalAncestorsAtGeneration(int $gen): int |
|
114 | - { |
|
115 | - return DB::table('maj_sosa') |
|
116 | - ->where('majs_gedcom_id', '=', $this->tree->id()) |
|
117 | - ->where('majs_user_id', '=', $this->user->id()) |
|
118 | - ->where('majs_gen', '=', $gen) |
|
119 | - ->count(); |
|
120 | - } |
|
121 | - |
|
122 | - /** |
|
123 | - * Get the total count of distinct Sosa ancestors for all generations |
|
124 | - * |
|
125 | - * @return int |
|
126 | - */ |
|
127 | - public function totalDistinctAncestors(): int |
|
128 | - { |
|
129 | - return DB::table('maj_sosa') |
|
130 | - ->where('majs_gedcom_id', '=', $this->tree->id()) |
|
131 | - ->where('majs_user_id', '=', $this->user->id()) |
|
132 | - ->distinct() |
|
133 | - ->count('majs_i_id'); |
|
134 | - } |
|
135 | - |
|
136 | - /** |
|
137 | - * Get the mean generation time, as the slope of the linear regression of birth years vs generations |
|
138 | - * |
|
139 | - * @return float |
|
140 | - */ |
|
141 | - public function meanGenerationTime(): float |
|
142 | - { |
|
143 | - $row = DB::table('maj_sosa') |
|
144 | - ->where('majs_gedcom_id', '=', $this->tree->id()) |
|
145 | - ->where('majs_user_id', '=', $this->user->id()) |
|
146 | - ->whereNotNull('majs_birth_year') |
|
147 | - ->selectRaw('COUNT(majs_sosa) AS n') |
|
148 | - ->selectRaw('SUM(majs_gen * majs_birth_year) AS sum_xy') |
|
149 | - ->selectRaw('SUM(majs_gen) AS sum_x') |
|
150 | - ->selectRaw('SUM(majs_birth_year) AS sum_y') |
|
151 | - ->selectRaw('SUM(majs_gen * majs_gen) AS sum_x2') |
|
152 | - ->get()->first(); |
|
153 | - |
|
154 | - return $row->n == 0 ? 0 : |
|
155 | - -($row->n * $row->sum_xy - $row->sum_x * $row->sum_y) / ($row->n * $row->sum_x2 - pow($row->sum_x, 2)); |
|
156 | - } |
|
157 | - |
|
158 | - /** |
|
159 | - * Get the statistic array detailed by generation. |
|
160 | - * Statistics for each generation are: |
|
161 | - * - The number of Sosa in generation |
|
162 | - * - The number of Sosa up to generation |
|
163 | - * - The number of distinct Sosa up to generation |
|
164 | - * - The year of the first birth in generation |
|
165 | - * - The year of the first estimated birth in generation |
|
166 | - * - The year of the last birth in generation |
|
167 | - * - The year of the last estimated birth in generation |
|
168 | - * - The average year of birth in generation |
|
169 | - * |
|
170 | - * @return array<int, array<string, int|null>> Statistics array |
|
171 | - */ |
|
172 | - public function statisticsByGenerations(): array |
|
173 | - { |
|
174 | - $stats_by_gen = $this->statisticsByGenerationBasicData(); |
|
175 | - $cumul_stats_by_gen = $this->statisticsByGenerationCumulativeData(); |
|
176 | - |
|
177 | - $statistics_by_gen = []; |
|
178 | - foreach ($stats_by_gen as $gen => $stats_gen) { |
|
179 | - $statistics_by_gen[(int) $stats_gen->gen] = array( |
|
180 | - 'sosaCount' => (int) $stats_gen->total_sosa, |
|
181 | - 'sosaTotalCount' => (int) $cumul_stats_by_gen[$gen]->total_cumul, |
|
182 | - 'diffSosaTotalCount' => (int) $cumul_stats_by_gen[$gen]->total_distinct_cumul, |
|
183 | - 'firstBirth' => $stats_gen->first_year, |
|
184 | - 'firstEstimatedBirth' => $stats_gen->first_est_year, |
|
185 | - 'lastBirth' => $stats_gen->last_year, |
|
186 | - 'lastEstimatedBirth' => $stats_gen->last_est_year |
|
187 | - ); |
|
188 | - } |
|
189 | - |
|
190 | - return $statistics_by_gen; |
|
191 | - } |
|
192 | - |
|
193 | - /** |
|
194 | - * Returns the basic statistics data by generation. |
|
195 | - * |
|
196 | - * @return Collection<int, \stdClass> |
|
197 | - */ |
|
198 | - private function statisticsByGenerationBasicData(): Collection |
|
199 | - { |
|
200 | - return DB::table('maj_sosa') |
|
201 | - ->where('majs_gedcom_id', '=', $this->tree->id()) |
|
202 | - ->where('majs_user_id', '=', $this->user->id()) |
|
203 | - ->groupBy('majs_gen') |
|
204 | - ->orderBy('majs_gen', 'asc') |
|
205 | - ->select('majs_gen AS gen') |
|
206 | - ->selectRaw('COUNT(majs_sosa) AS total_sosa') |
|
207 | - ->selectRaw('MIN(majs_birth_year) AS first_year') |
|
208 | - ->selectRaw('MIN(majs_birth_year_est) AS first_est_year') |
|
209 | - ->selectRaw('MAX(majs_birth_year) AS last_year') |
|
210 | - ->selectRaw('MAX(majs_birth_year_est) AS last_est_year') |
|
211 | - ->get()->keyBy('gen'); |
|
212 | - } |
|
213 | - |
|
214 | - /** |
|
215 | - * Returns the cumulative statistics data by generation |
|
216 | - * |
|
217 | - * @return Collection<int, \stdClass> |
|
218 | - */ |
|
219 | - private function statisticsByGenerationCumulativeData(): Collection |
|
220 | - { |
|
221 | - $list_gen = DB::table('maj_sosa')->select('majs_gen')->distinct() |
|
222 | - ->where('majs_gedcom_id', '=', $this->tree->id()) |
|
223 | - ->where('majs_user_id', '=', $this->user->id()); |
|
224 | - |
|
225 | - return DB::table('maj_sosa') |
|
226 | - ->joinSub($list_gen, 'list_gen', function (JoinClause $join): void { |
|
227 | - $join->on('maj_sosa.majs_gen', '<=', 'list_gen.majs_gen') |
|
228 | - ->where('majs_gedcom_id', '=', $this->tree->id()) |
|
229 | - ->where('majs_user_id', '=', $this->user->id()); |
|
230 | - }) |
|
231 | - ->groupBy('list_gen.majs_gen') |
|
232 | - ->select('list_gen.majs_gen AS gen') |
|
233 | - ->selectRaw('COUNT(majs_i_id) AS total_cumul') |
|
234 | - ->selectRaw('COUNT(DISTINCT majs_i_id) AS total_distinct_cumul') |
|
235 | - ->selectRaw('1 - COUNT(DISTINCT majs_i_id) / COUNT(majs_i_id) AS pedi_collapse_simple') |
|
236 | - ->get()->keyBy('gen'); |
|
237 | - } |
|
238 | - |
|
239 | - /** |
|
240 | - * Returns the pedigree collapse improved calculation by generation. |
|
241 | - * |
|
242 | - * Format: |
|
243 | - * - key : generation |
|
244 | - * - values: |
|
245 | - * - pedi_collapse_roots : pedigree collapse of ancestor roots for the generation |
|
246 | - * - pedi_collapse_xgen : pedigree cross-generation shrinkage for the generation |
|
247 | - * |
|
248 | - * @return array<int, array<string, float>> |
|
249 | - */ |
|
250 | - public function pedigreeCollapseByGenerationData(): array |
|
251 | - { |
|
252 | - if (!$this->isPdoSupported()) { |
|
253 | - return []; |
|
254 | - } |
|
255 | - |
|
256 | - $table_prefix = DB::connection()->getTablePrefix(); |
|
257 | - |
|
258 | - $list_gen = DB::table('maj_sosa')->select('majs_gen')->distinct() |
|
259 | - ->where('majs_gedcom_id', '=', $this->tree->id()) |
|
260 | - ->where('majs_user_id', '=', $this->user->id()); |
|
261 | - |
|
262 | - /* Compute the contributions of nodes of previous generations to the current generation */ |
|
263 | - $root_ancestors_contributions = DB::table('maj_sosa AS sosa') |
|
264 | - ->select(['list_gen.majs_gen AS gen', 'sosa.majs_gedcom_id', 'sosa.majs_user_id']) |
|
265 | - ->addSelect(['sosa.majs_i_id', 'sosa.majs_gen']) |
|
266 | - ->selectRaw( |
|
267 | - '(CASE ' . |
|
268 | - ' WHEN ' . $table_prefix . 'sosa_fat.majs_i_id IS NULL' . |
|
269 | - ' THEN POWER(2, ' . $table_prefix . 'list_gen.majs_gen - ' . $table_prefix . 'sosa.majs_gen - 1)' . |
|
270 | - ' ELSE 0 ' . |
|
271 | - ' END)' . |
|
272 | - ' + (CASE ' . |
|
273 | - ' WHEN ' . $table_prefix . 'sosa_mot.majs_i_id IS NULL' . |
|
274 | - ' THEN POWER(2, ' . $table_prefix . 'list_gen.majs_gen - ' . $table_prefix . 'sosa.majs_gen - 1)' . |
|
275 | - ' ELSE 0 ' . |
|
276 | - ' END) contrib' |
|
277 | - ) |
|
278 | - ->joinSub($list_gen, 'list_gen', function (JoinClause $join): void { |
|
279 | - $join->on('sosa.majs_gen', '<', 'list_gen.majs_gen') |
|
280 | - ->where('majs_gedcom_id', '=', $this->tree->id()) |
|
281 | - ->where('majs_user_id', '=', $this->user->id()); |
|
282 | - }) |
|
283 | - ->leftJoin('maj_sosa AS sosa_fat', function (JoinClause $join) use ($table_prefix): void { |
|
284 | - // Link to sosa's father |
|
285 | - $join->whereRaw($table_prefix . 'sosa_fat.majs_sosa = 2 * ' . $table_prefix . 'sosa.majs_sosa') |
|
286 | - ->where('sosa_fat.majs_gedcom_id', '=', $this->tree->id()) |
|
287 | - ->where('sosa_fat.majs_user_id', '=', $this->user->id()); |
|
288 | - }) |
|
289 | - ->leftJoin('maj_sosa AS sosa_mot', function (JoinClause $join) use ($table_prefix): void { |
|
290 | - // Link to sosa's mother |
|
291 | - $join->whereRaw($table_prefix . 'sosa_mot.majs_sosa = 2 * ' . $table_prefix . 'sosa.majs_sosa + 1') |
|
292 | - ->where('sosa_mot.majs_gedcom_id', '=', $this->tree->id()) |
|
293 | - ->where('sosa_mot.majs_user_id', '=', $this->user->id()); |
|
294 | - }) |
|
295 | - ->where('sosa.majs_gedcom_id', '=', $this->tree->id()) |
|
296 | - ->where('sosa.majs_user_id', '=', $this->user->id()) |
|
297 | - ->where(function (Builder $query): void { |
|
298 | - $query->whereNull('sosa_fat.majs_i_id') |
|
299 | - ->orWhereNull('sosa_mot.majs_i_id'); |
|
300 | - }); |
|
301 | - |
|
302 | - /* Identify nodes in the generations with ancestors who are also in the same generation. |
|
32 | + private UserInterface $user; |
|
33 | + private Tree $tree; |
|
34 | + |
|
35 | + /** |
|
36 | + * Constructor for Sosa Statistics Service |
|
37 | + * |
|
38 | + * @param Tree $tree |
|
39 | + * @param UserInterface $user |
|
40 | + */ |
|
41 | + public function __construct(Tree $tree, UserInterface $user) |
|
42 | + { |
|
43 | + $this->tree = $tree; |
|
44 | + $this->user = $user; |
|
45 | + } |
|
46 | + |
|
47 | + /** |
|
48 | + * Check if PDO support the queries used in Sosa statistics. |
|
49 | + * |
|
50 | + * SQLite does not support RIGHT and FULL JOIN, and POWER/SQRT require a specific compilation flag. |
|
51 | + * |
|
52 | + * @return bool |
|
53 | + */ |
|
54 | + public function isPdoSupported(): bool |
|
55 | + { |
|
56 | + return DB::connection()->getDriverName() !== 'sqlite'; |
|
57 | + } |
|
58 | + |
|
59 | + /** |
|
60 | + * Return the root individual for the reference tree and user. |
|
61 | + * |
|
62 | + * @return Individual|NULL |
|
63 | + */ |
|
64 | + public function rootIndividual(): ?Individual |
|
65 | + { |
|
66 | + $root_indi_id = $this->tree->getUserPreference($this->user, 'MAJ_SOSA_ROOT_ID'); |
|
67 | + return Registry::individualFactory()->make($root_indi_id, $this->tree); |
|
68 | + } |
|
69 | + |
|
70 | + /** |
|
71 | + * Get the highest generation for the reference tree and user. |
|
72 | + * |
|
73 | + * @return int |
|
74 | + */ |
|
75 | + public function maxGeneration(): int |
|
76 | + { |
|
77 | + return (int) DB::table('maj_sosa') |
|
78 | + ->where('majs_gedcom_id', '=', $this->tree->id()) |
|
79 | + ->where('majs_user_id', '=', $this->user->id()) |
|
80 | + ->max('majs_gen'); |
|
81 | + } |
|
82 | + |
|
83 | + /** |
|
84 | + * Get the total count of individuals in the tree. |
|
85 | + * |
|
86 | + * @return int |
|
87 | + */ |
|
88 | + public function totalIndividuals(): int |
|
89 | + { |
|
90 | + return DB::table('individuals') |
|
91 | + ->where('i_file', '=', $this->tree->id()) |
|
92 | + ->count(); |
|
93 | + } |
|
94 | + |
|
95 | + /** |
|
96 | + * Get the total count of Sosa ancestors for all generations |
|
97 | + * |
|
98 | + * @return int |
|
99 | + */ |
|
100 | + public function totalAncestors(): int |
|
101 | + { |
|
102 | + return DB::table('maj_sosa') |
|
103 | + ->where('majs_gedcom_id', '=', $this->tree->id()) |
|
104 | + ->where('majs_user_id', '=', $this->user->id()) |
|
105 | + ->count(); |
|
106 | + } |
|
107 | + |
|
108 | + /** |
|
109 | + * Get the total count of Sosa ancestors for a generation |
|
110 | + * |
|
111 | + * @return int |
|
112 | + */ |
|
113 | + public function totalAncestorsAtGeneration(int $gen): int |
|
114 | + { |
|
115 | + return DB::table('maj_sosa') |
|
116 | + ->where('majs_gedcom_id', '=', $this->tree->id()) |
|
117 | + ->where('majs_user_id', '=', $this->user->id()) |
|
118 | + ->where('majs_gen', '=', $gen) |
|
119 | + ->count(); |
|
120 | + } |
|
121 | + |
|
122 | + /** |
|
123 | + * Get the total count of distinct Sosa ancestors for all generations |
|
124 | + * |
|
125 | + * @return int |
|
126 | + */ |
|
127 | + public function totalDistinctAncestors(): int |
|
128 | + { |
|
129 | + return DB::table('maj_sosa') |
|
130 | + ->where('majs_gedcom_id', '=', $this->tree->id()) |
|
131 | + ->where('majs_user_id', '=', $this->user->id()) |
|
132 | + ->distinct() |
|
133 | + ->count('majs_i_id'); |
|
134 | + } |
|
135 | + |
|
136 | + /** |
|
137 | + * Get the mean generation time, as the slope of the linear regression of birth years vs generations |
|
138 | + * |
|
139 | + * @return float |
|
140 | + */ |
|
141 | + public function meanGenerationTime(): float |
|
142 | + { |
|
143 | + $row = DB::table('maj_sosa') |
|
144 | + ->where('majs_gedcom_id', '=', $this->tree->id()) |
|
145 | + ->where('majs_user_id', '=', $this->user->id()) |
|
146 | + ->whereNotNull('majs_birth_year') |
|
147 | + ->selectRaw('COUNT(majs_sosa) AS n') |
|
148 | + ->selectRaw('SUM(majs_gen * majs_birth_year) AS sum_xy') |
|
149 | + ->selectRaw('SUM(majs_gen) AS sum_x') |
|
150 | + ->selectRaw('SUM(majs_birth_year) AS sum_y') |
|
151 | + ->selectRaw('SUM(majs_gen * majs_gen) AS sum_x2') |
|
152 | + ->get()->first(); |
|
153 | + |
|
154 | + return $row->n == 0 ? 0 : |
|
155 | + -($row->n * $row->sum_xy - $row->sum_x * $row->sum_y) / ($row->n * $row->sum_x2 - pow($row->sum_x, 2)); |
|
156 | + } |
|
157 | + |
|
158 | + /** |
|
159 | + * Get the statistic array detailed by generation. |
|
160 | + * Statistics for each generation are: |
|
161 | + * - The number of Sosa in generation |
|
162 | + * - The number of Sosa up to generation |
|
163 | + * - The number of distinct Sosa up to generation |
|
164 | + * - The year of the first birth in generation |
|
165 | + * - The year of the first estimated birth in generation |
|
166 | + * - The year of the last birth in generation |
|
167 | + * - The year of the last estimated birth in generation |
|
168 | + * - The average year of birth in generation |
|
169 | + * |
|
170 | + * @return array<int, array<string, int|null>> Statistics array |
|
171 | + */ |
|
172 | + public function statisticsByGenerations(): array |
|
173 | + { |
|
174 | + $stats_by_gen = $this->statisticsByGenerationBasicData(); |
|
175 | + $cumul_stats_by_gen = $this->statisticsByGenerationCumulativeData(); |
|
176 | + |
|
177 | + $statistics_by_gen = []; |
|
178 | + foreach ($stats_by_gen as $gen => $stats_gen) { |
|
179 | + $statistics_by_gen[(int) $stats_gen->gen] = array( |
|
180 | + 'sosaCount' => (int) $stats_gen->total_sosa, |
|
181 | + 'sosaTotalCount' => (int) $cumul_stats_by_gen[$gen]->total_cumul, |
|
182 | + 'diffSosaTotalCount' => (int) $cumul_stats_by_gen[$gen]->total_distinct_cumul, |
|
183 | + 'firstBirth' => $stats_gen->first_year, |
|
184 | + 'firstEstimatedBirth' => $stats_gen->first_est_year, |
|
185 | + 'lastBirth' => $stats_gen->last_year, |
|
186 | + 'lastEstimatedBirth' => $stats_gen->last_est_year |
|
187 | + ); |
|
188 | + } |
|
189 | + |
|
190 | + return $statistics_by_gen; |
|
191 | + } |
|
192 | + |
|
193 | + /** |
|
194 | + * Returns the basic statistics data by generation. |
|
195 | + * |
|
196 | + * @return Collection<int, \stdClass> |
|
197 | + */ |
|
198 | + private function statisticsByGenerationBasicData(): Collection |
|
199 | + { |
|
200 | + return DB::table('maj_sosa') |
|
201 | + ->where('majs_gedcom_id', '=', $this->tree->id()) |
|
202 | + ->where('majs_user_id', '=', $this->user->id()) |
|
203 | + ->groupBy('majs_gen') |
|
204 | + ->orderBy('majs_gen', 'asc') |
|
205 | + ->select('majs_gen AS gen') |
|
206 | + ->selectRaw('COUNT(majs_sosa) AS total_sosa') |
|
207 | + ->selectRaw('MIN(majs_birth_year) AS first_year') |
|
208 | + ->selectRaw('MIN(majs_birth_year_est) AS first_est_year') |
|
209 | + ->selectRaw('MAX(majs_birth_year) AS last_year') |
|
210 | + ->selectRaw('MAX(majs_birth_year_est) AS last_est_year') |
|
211 | + ->get()->keyBy('gen'); |
|
212 | + } |
|
213 | + |
|
214 | + /** |
|
215 | + * Returns the cumulative statistics data by generation |
|
216 | + * |
|
217 | + * @return Collection<int, \stdClass> |
|
218 | + */ |
|
219 | + private function statisticsByGenerationCumulativeData(): Collection |
|
220 | + { |
|
221 | + $list_gen = DB::table('maj_sosa')->select('majs_gen')->distinct() |
|
222 | + ->where('majs_gedcom_id', '=', $this->tree->id()) |
|
223 | + ->where('majs_user_id', '=', $this->user->id()); |
|
224 | + |
|
225 | + return DB::table('maj_sosa') |
|
226 | + ->joinSub($list_gen, 'list_gen', function (JoinClause $join): void { |
|
227 | + $join->on('maj_sosa.majs_gen', '<=', 'list_gen.majs_gen') |
|
228 | + ->where('majs_gedcom_id', '=', $this->tree->id()) |
|
229 | + ->where('majs_user_id', '=', $this->user->id()); |
|
230 | + }) |
|
231 | + ->groupBy('list_gen.majs_gen') |
|
232 | + ->select('list_gen.majs_gen AS gen') |
|
233 | + ->selectRaw('COUNT(majs_i_id) AS total_cumul') |
|
234 | + ->selectRaw('COUNT(DISTINCT majs_i_id) AS total_distinct_cumul') |
|
235 | + ->selectRaw('1 - COUNT(DISTINCT majs_i_id) / COUNT(majs_i_id) AS pedi_collapse_simple') |
|
236 | + ->get()->keyBy('gen'); |
|
237 | + } |
|
238 | + |
|
239 | + /** |
|
240 | + * Returns the pedigree collapse improved calculation by generation. |
|
241 | + * |
|
242 | + * Format: |
|
243 | + * - key : generation |
|
244 | + * - values: |
|
245 | + * - pedi_collapse_roots : pedigree collapse of ancestor roots for the generation |
|
246 | + * - pedi_collapse_xgen : pedigree cross-generation shrinkage for the generation |
|
247 | + * |
|
248 | + * @return array<int, array<string, float>> |
|
249 | + */ |
|
250 | + public function pedigreeCollapseByGenerationData(): array |
|
251 | + { |
|
252 | + if (!$this->isPdoSupported()) { |
|
253 | + return []; |
|
254 | + } |
|
255 | + |
|
256 | + $table_prefix = DB::connection()->getTablePrefix(); |
|
257 | + |
|
258 | + $list_gen = DB::table('maj_sosa')->select('majs_gen')->distinct() |
|
259 | + ->where('majs_gedcom_id', '=', $this->tree->id()) |
|
260 | + ->where('majs_user_id', '=', $this->user->id()); |
|
261 | + |
|
262 | + /* Compute the contributions of nodes of previous generations to the current generation */ |
|
263 | + $root_ancestors_contributions = DB::table('maj_sosa AS sosa') |
|
264 | + ->select(['list_gen.majs_gen AS gen', 'sosa.majs_gedcom_id', 'sosa.majs_user_id']) |
|
265 | + ->addSelect(['sosa.majs_i_id', 'sosa.majs_gen']) |
|
266 | + ->selectRaw( |
|
267 | + '(CASE ' . |
|
268 | + ' WHEN ' . $table_prefix . 'sosa_fat.majs_i_id IS NULL' . |
|
269 | + ' THEN POWER(2, ' . $table_prefix . 'list_gen.majs_gen - ' . $table_prefix . 'sosa.majs_gen - 1)' . |
|
270 | + ' ELSE 0 ' . |
|
271 | + ' END)' . |
|
272 | + ' + (CASE ' . |
|
273 | + ' WHEN ' . $table_prefix . 'sosa_mot.majs_i_id IS NULL' . |
|
274 | + ' THEN POWER(2, ' . $table_prefix . 'list_gen.majs_gen - ' . $table_prefix . 'sosa.majs_gen - 1)' . |
|
275 | + ' ELSE 0 ' . |
|
276 | + ' END) contrib' |
|
277 | + ) |
|
278 | + ->joinSub($list_gen, 'list_gen', function (JoinClause $join): void { |
|
279 | + $join->on('sosa.majs_gen', '<', 'list_gen.majs_gen') |
|
280 | + ->where('majs_gedcom_id', '=', $this->tree->id()) |
|
281 | + ->where('majs_user_id', '=', $this->user->id()); |
|
282 | + }) |
|
283 | + ->leftJoin('maj_sosa AS sosa_fat', function (JoinClause $join) use ($table_prefix): void { |
|
284 | + // Link to sosa's father |
|
285 | + $join->whereRaw($table_prefix . 'sosa_fat.majs_sosa = 2 * ' . $table_prefix . 'sosa.majs_sosa') |
|
286 | + ->where('sosa_fat.majs_gedcom_id', '=', $this->tree->id()) |
|
287 | + ->where('sosa_fat.majs_user_id', '=', $this->user->id()); |
|
288 | + }) |
|
289 | + ->leftJoin('maj_sosa AS sosa_mot', function (JoinClause $join) use ($table_prefix): void { |
|
290 | + // Link to sosa's mother |
|
291 | + $join->whereRaw($table_prefix . 'sosa_mot.majs_sosa = 2 * ' . $table_prefix . 'sosa.majs_sosa + 1') |
|
292 | + ->where('sosa_mot.majs_gedcom_id', '=', $this->tree->id()) |
|
293 | + ->where('sosa_mot.majs_user_id', '=', $this->user->id()); |
|
294 | + }) |
|
295 | + ->where('sosa.majs_gedcom_id', '=', $this->tree->id()) |
|
296 | + ->where('sosa.majs_user_id', '=', $this->user->id()) |
|
297 | + ->where(function (Builder $query): void { |
|
298 | + $query->whereNull('sosa_fat.majs_i_id') |
|
299 | + ->orWhereNull('sosa_mot.majs_i_id'); |
|
300 | + }); |
|
301 | + |
|
302 | + /* Identify nodes in the generations with ancestors who are also in the same generation. |
|
303 | 303 | * This is the vertical/generational collapse that will reduce the number or roots. |
304 | 304 | */ |
305 | - $non_roots_ancestors = DB::table('maj_sosa AS sosa') |
|
306 | - ->select(['sosa.majs_gen', 'sosa.majs_gedcom_id', 'sosa.majs_user_id', 'sosa.majs_sosa']) |
|
307 | - ->selectRaw('MAX(' . $table_prefix . 'sosa_anc.majs_sosa) - MIN(' . $table_prefix . 'sosa_anc.majs_sosa)' . |
|
308 | - ' AS full_ancestors') |
|
309 | - ->join('maj_sosa AS sosa_anc', function (JoinClause $join) use ($table_prefix): void { |
|
310 | - $join->on('sosa.majs_gen', '<', 'sosa_anc.majs_gen') |
|
311 | - ->whereRaw('FLOOR(' . $table_prefix . 'sosa_anc.majs_sosa / POWER(2, ' . |
|
312 | - $table_prefix . 'sosa_anc.majs_gen - ' . $table_prefix . 'sosa.majs_gen)) = ' . |
|
313 | - $table_prefix . 'sosa.majs_sosa') |
|
314 | - ->where('sosa_anc.majs_gedcom_id', '=', $this->tree->id()) |
|
315 | - ->where('sosa_anc.majs_user_id', '=', $this->user->id()); |
|
316 | - }) |
|
317 | - ->where('sosa.majs_gedcom_id', '=', $this->tree->id()) |
|
318 | - ->where('sosa.majs_user_id', '=', $this->user->id()) |
|
319 | - ->whereIn('sosa_anc.majs_i_id', function (Builder $query) use ($table_prefix): void { |
|
320 | - $query->from('maj_sosa AS sosa_gen') |
|
321 | - ->select('sosa_gen.majs_i_id')->distinct() |
|
322 | - ->where('sosa_gen.majs_gedcom_id', '=', $this->tree->id()) |
|
323 | - ->where('sosa_gen.majs_user_id', '=', $this->user->id()) |
|
324 | - ->whereRaw($table_prefix . 'sosa_gen.majs_gen = ' . $table_prefix . 'sosa.majs_gen'); |
|
325 | - }) |
|
326 | - ->groupBy(['sosa.majs_gen', 'sosa.majs_gedcom_id', 'sosa.majs_user_id', |
|
327 | - 'sosa.majs_sosa', 'sosa.majs_i_id']); |
|
328 | - |
|
329 | - /* Compute the contribution of the nodes in the generation, |
|
305 | + $non_roots_ancestors = DB::table('maj_sosa AS sosa') |
|
306 | + ->select(['sosa.majs_gen', 'sosa.majs_gedcom_id', 'sosa.majs_user_id', 'sosa.majs_sosa']) |
|
307 | + ->selectRaw('MAX(' . $table_prefix . 'sosa_anc.majs_sosa) - MIN(' . $table_prefix . 'sosa_anc.majs_sosa)' . |
|
308 | + ' AS full_ancestors') |
|
309 | + ->join('maj_sosa AS sosa_anc', function (JoinClause $join) use ($table_prefix): void { |
|
310 | + $join->on('sosa.majs_gen', '<', 'sosa_anc.majs_gen') |
|
311 | + ->whereRaw('FLOOR(' . $table_prefix . 'sosa_anc.majs_sosa / POWER(2, ' . |
|
312 | + $table_prefix . 'sosa_anc.majs_gen - ' . $table_prefix . 'sosa.majs_gen)) = ' . |
|
313 | + $table_prefix . 'sosa.majs_sosa') |
|
314 | + ->where('sosa_anc.majs_gedcom_id', '=', $this->tree->id()) |
|
315 | + ->where('sosa_anc.majs_user_id', '=', $this->user->id()); |
|
316 | + }) |
|
317 | + ->where('sosa.majs_gedcom_id', '=', $this->tree->id()) |
|
318 | + ->where('sosa.majs_user_id', '=', $this->user->id()) |
|
319 | + ->whereIn('sosa_anc.majs_i_id', function (Builder $query) use ($table_prefix): void { |
|
320 | + $query->from('maj_sosa AS sosa_gen') |
|
321 | + ->select('sosa_gen.majs_i_id')->distinct() |
|
322 | + ->where('sosa_gen.majs_gedcom_id', '=', $this->tree->id()) |
|
323 | + ->where('sosa_gen.majs_user_id', '=', $this->user->id()) |
|
324 | + ->whereRaw($table_prefix . 'sosa_gen.majs_gen = ' . $table_prefix . 'sosa.majs_gen'); |
|
325 | + }) |
|
326 | + ->groupBy(['sosa.majs_gen', 'sosa.majs_gedcom_id', 'sosa.majs_user_id', |
|
327 | + 'sosa.majs_sosa', 'sosa.majs_i_id']); |
|
328 | + |
|
329 | + /* Compute the contribution of the nodes in the generation, |
|
330 | 330 | * excluding the nodes with ancestors in the same generation. |
331 | 331 | * Nodes with a parent missing are not excluded to cater for the missing one. |
332 | 332 | */ |
333 | - $known_ancestors_contributions = DB::table('maj_sosa AS sosa') |
|
334 | - ->select(['sosa.majs_gen AS gen', 'sosa.majs_gedcom_id', 'sosa.majs_user_id']) |
|
335 | - ->addSelect(['sosa.majs_i_id', 'sosa.majs_gen']) |
|
336 | - ->selectRaw('1 AS contrib') |
|
337 | - ->leftJoinSub($non_roots_ancestors, 'nonroot', function (JoinClause $join): void { |
|
338 | - $join->on('sosa.majs_gen', '=', 'nonroot.majs_gen') |
|
339 | - ->on('sosa.majs_sosa', '=', 'nonroot.majs_sosa') |
|
340 | - ->where('nonroot.full_ancestors', '>', 0) |
|
341 | - ->where('nonroot.majs_gedcom_id', '=', $this->tree->id()) |
|
342 | - ->where('nonroot.majs_user_id', '=', $this->user->id()); |
|
343 | - }) |
|
344 | - ->where('sosa.majs_gedcom_id', '=', $this->tree->id()) |
|
345 | - ->where('sosa.majs_user_id', '=', $this->user->id()) |
|
346 | - ->whereNull('nonroot.majs_sosa'); |
|
347 | - |
|
348 | - /* Aggregate both queries, and calculate the sum of contributions by generation roots. |
|
333 | + $known_ancestors_contributions = DB::table('maj_sosa AS sosa') |
|
334 | + ->select(['sosa.majs_gen AS gen', 'sosa.majs_gedcom_id', 'sosa.majs_user_id']) |
|
335 | + ->addSelect(['sosa.majs_i_id', 'sosa.majs_gen']) |
|
336 | + ->selectRaw('1 AS contrib') |
|
337 | + ->leftJoinSub($non_roots_ancestors, 'nonroot', function (JoinClause $join): void { |
|
338 | + $join->on('sosa.majs_gen', '=', 'nonroot.majs_gen') |
|
339 | + ->on('sosa.majs_sosa', '=', 'nonroot.majs_sosa') |
|
340 | + ->where('nonroot.full_ancestors', '>', 0) |
|
341 | + ->where('nonroot.majs_gedcom_id', '=', $this->tree->id()) |
|
342 | + ->where('nonroot.majs_user_id', '=', $this->user->id()); |
|
343 | + }) |
|
344 | + ->where('sosa.majs_gedcom_id', '=', $this->tree->id()) |
|
345 | + ->where('sosa.majs_user_id', '=', $this->user->id()) |
|
346 | + ->whereNull('nonroot.majs_sosa'); |
|
347 | + |
|
348 | + /* Aggregate both queries, and calculate the sum of contributions by generation roots. |
|
349 | 349 | * Exclude as well nodes that already appear in lower generations, as their branche has already been reduced. |
350 | 350 | */ |
351 | - $ancestors_contributions_sum = DB::connection()->query() |
|
352 | - ->fromSub($root_ancestors_contributions->unionAll($known_ancestors_contributions), 'sosa_contribs') |
|
353 | - ->select(['sosa_contribs.gen', 'sosa_contribs.majs_gedcom_id', 'sosa_contribs.majs_user_id']) |
|
354 | - ->addSelect(['sosa_contribs.majs_i_id', 'sosa_contribs.contrib']) |
|
355 | - ->selectRaw('COUNT(' . $table_prefix . 'sosa_contribs.majs_i_id) * ' . |
|
356 | - $table_prefix . 'sosa_contribs.contrib AS totalContrib') |
|
357 | - ->leftJoin('maj_sosa AS sosa_low', function (JoinClause $join): void { |
|
358 | - $join->on('sosa_low.majs_gen', '<', 'sosa_contribs.majs_gen') |
|
359 | - ->on('sosa_low.majs_i_id', '=', 'sosa_contribs.majs_i_id') |
|
360 | - ->where('sosa_low.majs_gedcom_id', '=', $this->tree->id()) |
|
361 | - ->where('sosa_low.majs_user_id', '=', $this->user->id()); |
|
362 | - }) |
|
363 | - ->whereNull('sosa_low.majs_sosa') |
|
364 | - ->groupBy(['sosa_contribs.gen', 'sosa_contribs.majs_gedcom_id', 'sosa_contribs.majs_user_id', |
|
365 | - 'sosa_contribs.majs_i_id', 'sosa_contribs.contrib']); |
|
366 | - |
|
367 | - // Aggregate all generation roots to compute root and generation pedigree collapse |
|
368 | - $pedi_collapse_coll = DB::connection()->query()->fromSub($ancestors_contributions_sum, 'sosa_contribs_sum') |
|
369 | - ->select(['gen'])->selectRaw('SUM(contrib), SUM(totalContrib)') |
|
370 | - ->selectRaw('1 - SUM(contrib) / SUM(totalContrib) AS pedi_collapse_roots') // Roots/horizontal collapse |
|
371 | - ->selectRaw('1 - SUM(totalContrib) / POWER ( 2, gen - 1) AS pedi_collapse_xgen') // Crossgeneration collapse |
|
372 | - ->groupBy(['gen', 'majs_gedcom_id', 'majs_user_id']) |
|
373 | - ->orderBy('gen') |
|
374 | - ->get(); |
|
375 | - |
|
376 | - $pedi_collapse_by_gen = []; |
|
377 | - foreach ($pedi_collapse_coll as $collapse_gen) { |
|
378 | - $pedi_collapse_by_gen[(int) $collapse_gen->gen] = array( |
|
379 | - 'pedi_collapse_roots' => (float) $collapse_gen->pedi_collapse_roots, |
|
380 | - 'pedi_collapse_xgen' => (float) $collapse_gen->pedi_collapse_xgen |
|
381 | - ); |
|
382 | - } |
|
383 | - return $pedi_collapse_by_gen; |
|
384 | - } |
|
385 | - |
|
386 | - /** |
|
387 | - * Return a Collection of the mean generation depth and deviation for all Sosa ancestors at a given generation. |
|
388 | - * Sosa 1 is of generation 1. |
|
389 | - * |
|
390 | - * Mean generation depth and deviation are calculated based on the works of Marie-Héléne Cazes and Pierre Cazes, |
|
391 | - * published in Population (French Edition), Vol. 51, No. 1 (Jan. - Feb., 1996), pp. 117-140 |
|
392 | - * http://kintip.net/index.php?option=com_jdownloads&task=download.send&id=9&catid=4&m=0 |
|
393 | - * |
|
394 | - * Format: |
|
395 | - * - key : sosa number of the ancestor |
|
396 | - * - values: |
|
397 | - * - root_ancestor_id : ID of the ancestor |
|
398 | - * - mean_gen_depth : Mean generation depth |
|
399 | - * - stddev_gen_depth : Standard deviation of generation depth |
|
400 | - * |
|
401 | - * @param int $gen Sosa generation |
|
402 | - * @return Collection<int, \stdClass> |
|
403 | - */ |
|
404 | - public function generationDepthStatsAtGeneration(int $gen): Collection |
|
405 | - { |
|
406 | - if (!$this->isPdoSupported()) { |
|
407 | - return collect(); |
|
408 | - } |
|
409 | - |
|
410 | - $table_prefix = DB::connection()->getTablePrefix(); |
|
411 | - $missing_ancestors_by_gen = DB::table('maj_sosa AS sosa') |
|
412 | - ->selectRaw($table_prefix . 'sosa.majs_gen - ? AS majs_gen_norm', [$gen]) |
|
413 | - ->selectRaw('FLOOR(((' . $table_prefix . 'sosa.majs_sosa / POW(2, ' . $table_prefix . 'sosa.majs_gen -1 )) - 1) * POWER(2, ? - 1)) + POWER(2, ? - 1) AS root_ancestor', [$gen, $gen]) //@phpcs:ignore Generic.Files.LineLength.TooLong |
|
414 | - ->selectRaw('SUM(CASE WHEN ' . $table_prefix . 'sosa_fat.majs_i_id IS NULL AND ' . $table_prefix . 'sosa_mot.majs_i_id IS NULL THEN 1 ELSE 0 END) AS full_root_count') //@phpcs:ignore Generic.Files.LineLength.TooLong |
|
415 | - ->selectRaw('SUM(CASE WHEN ' . $table_prefix . 'sosa_fat.majs_i_id IS NULL AND ' . $table_prefix . 'sosa_mot.majs_i_id IS NULL THEN 0 ELSE 1 END) As semi_root_count') //@phpcs:ignore Generic.Files.LineLength.TooLong |
|
416 | - ->leftJoin('maj_sosa AS sosa_fat', function (JoinClause $join) use ($table_prefix): void { |
|
417 | - // Link to sosa's father |
|
418 | - $join->whereRaw($table_prefix . 'sosa_fat.majs_sosa = 2 * ' . $table_prefix . 'sosa.majs_sosa') |
|
419 | - ->where('sosa_fat.majs_gedcom_id', '=', $this->tree->id()) |
|
420 | - ->where('sosa_fat.majs_user_id', '=', $this->user->id()); |
|
421 | - }) |
|
422 | - ->leftJoin('maj_sosa AS sosa_mot', function (JoinClause $join) use ($table_prefix): void { |
|
423 | - // Link to sosa's mother |
|
424 | - $join->whereRaw($table_prefix . 'sosa_mot.majs_sosa = 2 * ' . $table_prefix . 'sosa.majs_sosa + 1') |
|
425 | - ->where('sosa_mot.majs_gedcom_id', '=', $this->tree->id()) |
|
426 | - ->where('sosa_mot.majs_user_id', '=', $this->user->id()); |
|
427 | - }) |
|
428 | - ->where('sosa.majs_gedcom_id', '=', $this->tree->id()) |
|
429 | - ->where('sosa.majs_user_id', '=', $this->user->id()) |
|
430 | - ->where('sosa.majs_gen', '>=', $gen) |
|
431 | - ->where(function (Builder $query): void { |
|
432 | - $query->whereNull('sosa_fat.majs_i_id') |
|
433 | - ->orWhereNull('sosa_mot.majs_i_id'); |
|
434 | - }) |
|
435 | - ->groupBy(['sosa.majs_gen', 'root_ancestor']); |
|
436 | - |
|
437 | - return DB::table('maj_sosa AS sosa_list') |
|
438 | - ->select(['stats_by_gen.root_ancestor AS root_ancestor_sosa', 'sosa_list.majs_i_id as root_ancestor_id']) |
|
439 | - ->selectRaw('1 + SUM( (majs_gen_norm) * ( 2 * full_root_count + semi_root_count) / (2 * POWER(2, majs_gen_norm))) AS mean_gen_depth') //@phpcs:ignore Generic.Files.LineLength.TooLong |
|
440 | - ->selectRaw(' SQRT(' . |
|
441 | - ' SUM(POWER(majs_gen_norm, 2) * ( 2 * full_root_count + semi_root_count) / (2 * POWER(2, majs_gen_norm)))' . //@phpcs:ignore Generic.Files.LineLength.TooLong |
|
442 | - ' - POWER( SUM( (majs_gen_norm) * ( 2 * full_root_count + semi_root_count) / (2 * POWER(2, majs_gen_norm))), 2)' . //@phpcs:ignore Generic.Files.LineLength.TooLong |
|
443 | - ' ) AS stddev_gen_depth') |
|
444 | - ->joinSub($missing_ancestors_by_gen, 'stats_by_gen', function (JoinClause $join): void { |
|
445 | - $join->on('sosa_list.majs_sosa', '=', 'stats_by_gen.root_ancestor') |
|
446 | - ->where('sosa_list.majs_gedcom_id', '=', $this->tree->id()) |
|
447 | - ->where('sosa_list.majs_user_id', '=', $this->user->id()); |
|
448 | - }) |
|
449 | - ->groupBy(['stats_by_gen.root_ancestor', 'sosa_list.majs_i_id']) |
|
450 | - ->orderBy('stats_by_gen.root_ancestor') |
|
451 | - ->get()->keyBy('root_ancestor_sosa'); |
|
452 | - } |
|
453 | - |
|
454 | - /** |
|
455 | - * Return a collection of the most duplicated root Sosa ancestors. |
|
456 | - * The number of ancestors to return is limited by the parameter $limit. |
|
457 | - * If several individuals are tied when reaching the limit, none of them are returned, |
|
458 | - * which means that there can be less individuals returned than requested. |
|
459 | - * |
|
460 | - * Format: |
|
461 | - * - value: |
|
462 | - * - sosa_i_id : sosa individual |
|
463 | - * - sosa_count: number of duplications of the ancestor (e.g. 3 if it appears 3 times) |
|
464 | - * |
|
465 | - * @param int $limit |
|
466 | - * @return Collection<\stdClass> |
|
467 | - */ |
|
468 | - public function topMultipleAncestorsWithNoTies(int $limit): Collection |
|
469 | - { |
|
470 | - $table_prefix = DB::connection()->getTablePrefix(); |
|
471 | - $multiple_ancestors = DB::table('maj_sosa AS sosa') |
|
472 | - ->select('sosa.majs_i_id AS sosa_i_id') |
|
473 | - ->selectRaw('COUNT(' . $table_prefix . 'sosa.majs_sosa) AS sosa_count') |
|
474 | - ->leftJoin('maj_sosa AS sosa_fat', function (JoinClause $join) use ($table_prefix): void { |
|
475 | - // Link to sosa's father |
|
476 | - $join->whereRaw($table_prefix . 'sosa_fat.majs_sosa = 2 * ' . $table_prefix . 'sosa.majs_sosa') |
|
477 | - ->where('sosa_fat.majs_gedcom_id', '=', $this->tree->id()) |
|
478 | - ->where('sosa_fat.majs_user_id', '=', $this->user->id()); |
|
479 | - }) |
|
480 | - ->leftJoin('maj_sosa AS sosa_mot', function (JoinClause $join) use ($table_prefix): void { |
|
481 | - // Link to sosa's mother |
|
482 | - $join->whereRaw($table_prefix . 'sosa_mot.majs_sosa = 2 * ' . $table_prefix . 'sosa.majs_sosa + 1') |
|
483 | - ->where('sosa_mot.majs_gedcom_id', '=', $this->tree->id()) |
|
484 | - ->where('sosa_mot.majs_user_id', '=', $this->user->id()); |
|
485 | - }) |
|
486 | - ->where('sosa.majs_gedcom_id', '=', $this->tree->id()) |
|
487 | - ->where('sosa.majs_user_id', '=', $this->user->id()) |
|
488 | - ->whereNull('sosa_fat.majs_sosa') // We keep only root individuals, i.e. those with no father or mother |
|
489 | - ->whereNull('sosa_mot.majs_sosa') |
|
490 | - ->groupBy('sosa.majs_i_id') |
|
491 | - ->havingRaw('COUNT(' . $table_prefix . 'sosa.majs_sosa) > 1') // Limit to the duplicate sosas. |
|
492 | - ->orderByRaw('COUNT(' . $table_prefix . 'sosa.majs_sosa) DESC, MIN(' . $table_prefix . 'sosa.majs_sosa) ASC') //@phpcs:ignore Generic.Files.LineLength.TooLong |
|
493 | - ->limit($limit + 1) // We want to select one more than required, for ties |
|
494 | - ->get(); |
|
495 | - |
|
496 | - if ($multiple_ancestors->count() > $limit) { |
|
497 | - $last_count = $multiple_ancestors->last()->sosa_count; |
|
498 | - $multiple_ancestors = $multiple_ancestors->reject( |
|
499 | - fn (stdClass $element): bool => $element->sosa_count === $last_count |
|
500 | - ); |
|
501 | - } |
|
502 | - return $multiple_ancestors; |
|
503 | - } |
|
504 | - |
|
505 | - /** |
|
506 | - * Return a computed array of statistics about the dispersion of ancestors across the ancestors |
|
507 | - * at a specified generation. |
|
508 | - * |
|
509 | - * Format: |
|
510 | - * - key : rank of the ancestor in generation G for which exclusive ancestors have been found |
|
511 | - * For instance 3 represent the maternal grand father |
|
512 | - * 0 is used for shared ancestors |
|
513 | - * - values: |
|
514 | - * - branches: same as key |
|
515 | - * - majs_i_id: xref of the ancestor at rank key in generation G, or null for shared ancestors |
|
516 | - * - count_indi: number of ancestors exclusively in the ancestors of the ancestor at rank key |
|
517 | - * |
|
518 | - * For instance a result at generation 3 could be : |
|
519 | - * [ |
|
520 | - * 0 => { branches: 0, majs_i_id: X1, count_indi: 12 } -> 12 ancestors are shared by the grand-parents |
|
521 | - * 1 => { branches: 1, majs_i_id: X2, count_indi: 32 } -> 32 ancestors are exclusive to the paternal grand-father |
|
522 | - * 2 => { branches: 2, majs_i_id: X3, count_indi: 25 } -> 25 ancestors are exclusive to the paternal grand-mother |
|
523 | - * 3 => { branches: 3, majs_i_id: X4, count_indi: 12 } -> 12 ancestors are exclusive to the maternal grand-father |
|
524 | - * 4 => { branches: 4, majs_i_id: X5, count_indi: 30 } -> 30 ancestors are exclusive to the maternal grand-mother |
|
525 | - * ] |
|
526 | - * |
|
527 | - * @param int $gen |
|
528 | - * @return Collection<int, \stdClass> |
|
529 | - */ |
|
530 | - public function ancestorsDispersionForGeneration(int $gen): Collection |
|
531 | - { |
|
532 | - if (!$this->isPdoSupported()) { |
|
533 | - return collect(); |
|
534 | - } |
|
535 | - |
|
536 | - $ancestors_branches = DB::table('maj_sosa') |
|
537 | - ->select('majs_i_id AS i_id') |
|
538 | - ->selectRaw('FLOOR(majs_sosa / POW(2, (majs_gen - ?))) - POW(2, ? -1) + 1 AS branch', [$gen, $gen]) |
|
539 | - ->where('majs_gedcom_id', '=', $this->tree->id()) |
|
540 | - ->where('majs_user_id', '=', $this->user->id()) |
|
541 | - ->where('majs_gen', '>=', $gen) |
|
542 | - ->groupBy('majs_i_id', 'branch'); |
|
543 | - |
|
544 | - $consolidated_ancestors_branches = DB::table('maj_sosa') |
|
545 | - ->fromSub($ancestors_branches, 'indi_branch') |
|
546 | - ->select('i_id') |
|
547 | - ->selectRaw('CASE WHEN COUNT(branch) > 1 THEN 0 ELSE MIN(branch) END AS branches') |
|
548 | - ->groupBy('i_id'); |
|
549 | - |
|
550 | - return DB::table('maj_sosa') |
|
551 | - ->rightJoinSub( |
|
552 | - $consolidated_ancestors_branches, |
|
553 | - 'indi_branch_consolidated', |
|
554 | - function (JoinClause $join) use ($gen): void { |
|
555 | - $join->where('maj_sosa.majs_gedcom_id', '=', $this->tree->id()) |
|
556 | - ->where('maj_sosa.majs_user_id', '=', $this->user->id()) |
|
557 | - ->where('branches', '>', 0) |
|
558 | - ->whereRaw('majs_sosa = POW(2, ? - 1) + branches - 1', [$gen]); |
|
559 | - } |
|
560 | - ) |
|
561 | - ->select(['branches', 'majs_i_id']) |
|
562 | - ->selectRaw('COUNT(i_id) AS count_indi') |
|
563 | - ->groupBy(['branches', 'majs_i_id']) |
|
564 | - ->get()->keyBy('branches'); |
|
565 | - } |
|
351 | + $ancestors_contributions_sum = DB::connection()->query() |
|
352 | + ->fromSub($root_ancestors_contributions->unionAll($known_ancestors_contributions), 'sosa_contribs') |
|
353 | + ->select(['sosa_contribs.gen', 'sosa_contribs.majs_gedcom_id', 'sosa_contribs.majs_user_id']) |
|
354 | + ->addSelect(['sosa_contribs.majs_i_id', 'sosa_contribs.contrib']) |
|
355 | + ->selectRaw('COUNT(' . $table_prefix . 'sosa_contribs.majs_i_id) * ' . |
|
356 | + $table_prefix . 'sosa_contribs.contrib AS totalContrib') |
|
357 | + ->leftJoin('maj_sosa AS sosa_low', function (JoinClause $join): void { |
|
358 | + $join->on('sosa_low.majs_gen', '<', 'sosa_contribs.majs_gen') |
|
359 | + ->on('sosa_low.majs_i_id', '=', 'sosa_contribs.majs_i_id') |
|
360 | + ->where('sosa_low.majs_gedcom_id', '=', $this->tree->id()) |
|
361 | + ->where('sosa_low.majs_user_id', '=', $this->user->id()); |
|
362 | + }) |
|
363 | + ->whereNull('sosa_low.majs_sosa') |
|
364 | + ->groupBy(['sosa_contribs.gen', 'sosa_contribs.majs_gedcom_id', 'sosa_contribs.majs_user_id', |
|
365 | + 'sosa_contribs.majs_i_id', 'sosa_contribs.contrib']); |
|
366 | + |
|
367 | + // Aggregate all generation roots to compute root and generation pedigree collapse |
|
368 | + $pedi_collapse_coll = DB::connection()->query()->fromSub($ancestors_contributions_sum, 'sosa_contribs_sum') |
|
369 | + ->select(['gen'])->selectRaw('SUM(contrib), SUM(totalContrib)') |
|
370 | + ->selectRaw('1 - SUM(contrib) / SUM(totalContrib) AS pedi_collapse_roots') // Roots/horizontal collapse |
|
371 | + ->selectRaw('1 - SUM(totalContrib) / POWER ( 2, gen - 1) AS pedi_collapse_xgen') // Crossgeneration collapse |
|
372 | + ->groupBy(['gen', 'majs_gedcom_id', 'majs_user_id']) |
|
373 | + ->orderBy('gen') |
|
374 | + ->get(); |
|
375 | + |
|
376 | + $pedi_collapse_by_gen = []; |
|
377 | + foreach ($pedi_collapse_coll as $collapse_gen) { |
|
378 | + $pedi_collapse_by_gen[(int) $collapse_gen->gen] = array( |
|
379 | + 'pedi_collapse_roots' => (float) $collapse_gen->pedi_collapse_roots, |
|
380 | + 'pedi_collapse_xgen' => (float) $collapse_gen->pedi_collapse_xgen |
|
381 | + ); |
|
382 | + } |
|
383 | + return $pedi_collapse_by_gen; |
|
384 | + } |
|
385 | + |
|
386 | + /** |
|
387 | + * Return a Collection of the mean generation depth and deviation for all Sosa ancestors at a given generation. |
|
388 | + * Sosa 1 is of generation 1. |
|
389 | + * |
|
390 | + * Mean generation depth and deviation are calculated based on the works of Marie-Héléne Cazes and Pierre Cazes, |
|
391 | + * published in Population (French Edition), Vol. 51, No. 1 (Jan. - Feb., 1996), pp. 117-140 |
|
392 | + * http://kintip.net/index.php?option=com_jdownloads&task=download.send&id=9&catid=4&m=0 |
|
393 | + * |
|
394 | + * Format: |
|
395 | + * - key : sosa number of the ancestor |
|
396 | + * - values: |
|
397 | + * - root_ancestor_id : ID of the ancestor |
|
398 | + * - mean_gen_depth : Mean generation depth |
|
399 | + * - stddev_gen_depth : Standard deviation of generation depth |
|
400 | + * |
|
401 | + * @param int $gen Sosa generation |
|
402 | + * @return Collection<int, \stdClass> |
|
403 | + */ |
|
404 | + public function generationDepthStatsAtGeneration(int $gen): Collection |
|
405 | + { |
|
406 | + if (!$this->isPdoSupported()) { |
|
407 | + return collect(); |
|
408 | + } |
|
409 | + |
|
410 | + $table_prefix = DB::connection()->getTablePrefix(); |
|
411 | + $missing_ancestors_by_gen = DB::table('maj_sosa AS sosa') |
|
412 | + ->selectRaw($table_prefix . 'sosa.majs_gen - ? AS majs_gen_norm', [$gen]) |
|
413 | + ->selectRaw('FLOOR(((' . $table_prefix . 'sosa.majs_sosa / POW(2, ' . $table_prefix . 'sosa.majs_gen -1 )) - 1) * POWER(2, ? - 1)) + POWER(2, ? - 1) AS root_ancestor', [$gen, $gen]) //@phpcs:ignore Generic.Files.LineLength.TooLong |
|
414 | + ->selectRaw('SUM(CASE WHEN ' . $table_prefix . 'sosa_fat.majs_i_id IS NULL AND ' . $table_prefix . 'sosa_mot.majs_i_id IS NULL THEN 1 ELSE 0 END) AS full_root_count') //@phpcs:ignore Generic.Files.LineLength.TooLong |
|
415 | + ->selectRaw('SUM(CASE WHEN ' . $table_prefix . 'sosa_fat.majs_i_id IS NULL AND ' . $table_prefix . 'sosa_mot.majs_i_id IS NULL THEN 0 ELSE 1 END) As semi_root_count') //@phpcs:ignore Generic.Files.LineLength.TooLong |
|
416 | + ->leftJoin('maj_sosa AS sosa_fat', function (JoinClause $join) use ($table_prefix): void { |
|
417 | + // Link to sosa's father |
|
418 | + $join->whereRaw($table_prefix . 'sosa_fat.majs_sosa = 2 * ' . $table_prefix . 'sosa.majs_sosa') |
|
419 | + ->where('sosa_fat.majs_gedcom_id', '=', $this->tree->id()) |
|
420 | + ->where('sosa_fat.majs_user_id', '=', $this->user->id()); |
|
421 | + }) |
|
422 | + ->leftJoin('maj_sosa AS sosa_mot', function (JoinClause $join) use ($table_prefix): void { |
|
423 | + // Link to sosa's mother |
|
424 | + $join->whereRaw($table_prefix . 'sosa_mot.majs_sosa = 2 * ' . $table_prefix . 'sosa.majs_sosa + 1') |
|
425 | + ->where('sosa_mot.majs_gedcom_id', '=', $this->tree->id()) |
|
426 | + ->where('sosa_mot.majs_user_id', '=', $this->user->id()); |
|
427 | + }) |
|
428 | + ->where('sosa.majs_gedcom_id', '=', $this->tree->id()) |
|
429 | + ->where('sosa.majs_user_id', '=', $this->user->id()) |
|
430 | + ->where('sosa.majs_gen', '>=', $gen) |
|
431 | + ->where(function (Builder $query): void { |
|
432 | + $query->whereNull('sosa_fat.majs_i_id') |
|
433 | + ->orWhereNull('sosa_mot.majs_i_id'); |
|
434 | + }) |
|
435 | + ->groupBy(['sosa.majs_gen', 'root_ancestor']); |
|
436 | + |
|
437 | + return DB::table('maj_sosa AS sosa_list') |
|
438 | + ->select(['stats_by_gen.root_ancestor AS root_ancestor_sosa', 'sosa_list.majs_i_id as root_ancestor_id']) |
|
439 | + ->selectRaw('1 + SUM( (majs_gen_norm) * ( 2 * full_root_count + semi_root_count) / (2 * POWER(2, majs_gen_norm))) AS mean_gen_depth') //@phpcs:ignore Generic.Files.LineLength.TooLong |
|
440 | + ->selectRaw(' SQRT(' . |
|
441 | + ' SUM(POWER(majs_gen_norm, 2) * ( 2 * full_root_count + semi_root_count) / (2 * POWER(2, majs_gen_norm)))' . //@phpcs:ignore Generic.Files.LineLength.TooLong |
|
442 | + ' - POWER( SUM( (majs_gen_norm) * ( 2 * full_root_count + semi_root_count) / (2 * POWER(2, majs_gen_norm))), 2)' . //@phpcs:ignore Generic.Files.LineLength.TooLong |
|
443 | + ' ) AS stddev_gen_depth') |
|
444 | + ->joinSub($missing_ancestors_by_gen, 'stats_by_gen', function (JoinClause $join): void { |
|
445 | + $join->on('sosa_list.majs_sosa', '=', 'stats_by_gen.root_ancestor') |
|
446 | + ->where('sosa_list.majs_gedcom_id', '=', $this->tree->id()) |
|
447 | + ->where('sosa_list.majs_user_id', '=', $this->user->id()); |
|
448 | + }) |
|
449 | + ->groupBy(['stats_by_gen.root_ancestor', 'sosa_list.majs_i_id']) |
|
450 | + ->orderBy('stats_by_gen.root_ancestor') |
|
451 | + ->get()->keyBy('root_ancestor_sosa'); |
|
452 | + } |
|
453 | + |
|
454 | + /** |
|
455 | + * Return a collection of the most duplicated root Sosa ancestors. |
|
456 | + * The number of ancestors to return is limited by the parameter $limit. |
|
457 | + * If several individuals are tied when reaching the limit, none of them are returned, |
|
458 | + * which means that there can be less individuals returned than requested. |
|
459 | + * |
|
460 | + * Format: |
|
461 | + * - value: |
|
462 | + * - sosa_i_id : sosa individual |
|
463 | + * - sosa_count: number of duplications of the ancestor (e.g. 3 if it appears 3 times) |
|
464 | + * |
|
465 | + * @param int $limit |
|
466 | + * @return Collection<\stdClass> |
|
467 | + */ |
|
468 | + public function topMultipleAncestorsWithNoTies(int $limit): Collection |
|
469 | + { |
|
470 | + $table_prefix = DB::connection()->getTablePrefix(); |
|
471 | + $multiple_ancestors = DB::table('maj_sosa AS sosa') |
|
472 | + ->select('sosa.majs_i_id AS sosa_i_id') |
|
473 | + ->selectRaw('COUNT(' . $table_prefix . 'sosa.majs_sosa) AS sosa_count') |
|
474 | + ->leftJoin('maj_sosa AS sosa_fat', function (JoinClause $join) use ($table_prefix): void { |
|
475 | + // Link to sosa's father |
|
476 | + $join->whereRaw($table_prefix . 'sosa_fat.majs_sosa = 2 * ' . $table_prefix . 'sosa.majs_sosa') |
|
477 | + ->where('sosa_fat.majs_gedcom_id', '=', $this->tree->id()) |
|
478 | + ->where('sosa_fat.majs_user_id', '=', $this->user->id()); |
|
479 | + }) |
|
480 | + ->leftJoin('maj_sosa AS sosa_mot', function (JoinClause $join) use ($table_prefix): void { |
|
481 | + // Link to sosa's mother |
|
482 | + $join->whereRaw($table_prefix . 'sosa_mot.majs_sosa = 2 * ' . $table_prefix . 'sosa.majs_sosa + 1') |
|
483 | + ->where('sosa_mot.majs_gedcom_id', '=', $this->tree->id()) |
|
484 | + ->where('sosa_mot.majs_user_id', '=', $this->user->id()); |
|
485 | + }) |
|
486 | + ->where('sosa.majs_gedcom_id', '=', $this->tree->id()) |
|
487 | + ->where('sosa.majs_user_id', '=', $this->user->id()) |
|
488 | + ->whereNull('sosa_fat.majs_sosa') // We keep only root individuals, i.e. those with no father or mother |
|
489 | + ->whereNull('sosa_mot.majs_sosa') |
|
490 | + ->groupBy('sosa.majs_i_id') |
|
491 | + ->havingRaw('COUNT(' . $table_prefix . 'sosa.majs_sosa) > 1') // Limit to the duplicate sosas. |
|
492 | + ->orderByRaw('COUNT(' . $table_prefix . 'sosa.majs_sosa) DESC, MIN(' . $table_prefix . 'sosa.majs_sosa) ASC') //@phpcs:ignore Generic.Files.LineLength.TooLong |
|
493 | + ->limit($limit + 1) // We want to select one more than required, for ties |
|
494 | + ->get(); |
|
495 | + |
|
496 | + if ($multiple_ancestors->count() > $limit) { |
|
497 | + $last_count = $multiple_ancestors->last()->sosa_count; |
|
498 | + $multiple_ancestors = $multiple_ancestors->reject( |
|
499 | + fn (stdClass $element): bool => $element->sosa_count === $last_count |
|
500 | + ); |
|
501 | + } |
|
502 | + return $multiple_ancestors; |
|
503 | + } |
|
504 | + |
|
505 | + /** |
|
506 | + * Return a computed array of statistics about the dispersion of ancestors across the ancestors |
|
507 | + * at a specified generation. |
|
508 | + * |
|
509 | + * Format: |
|
510 | + * - key : rank of the ancestor in generation G for which exclusive ancestors have been found |
|
511 | + * For instance 3 represent the maternal grand father |
|
512 | + * 0 is used for shared ancestors |
|
513 | + * - values: |
|
514 | + * - branches: same as key |
|
515 | + * - majs_i_id: xref of the ancestor at rank key in generation G, or null for shared ancestors |
|
516 | + * - count_indi: number of ancestors exclusively in the ancestors of the ancestor at rank key |
|
517 | + * |
|
518 | + * For instance a result at generation 3 could be : |
|
519 | + * [ |
|
520 | + * 0 => { branches: 0, majs_i_id: X1, count_indi: 12 } -> 12 ancestors are shared by the grand-parents |
|
521 | + * 1 => { branches: 1, majs_i_id: X2, count_indi: 32 } -> 32 ancestors are exclusive to the paternal grand-father |
|
522 | + * 2 => { branches: 2, majs_i_id: X3, count_indi: 25 } -> 25 ancestors are exclusive to the paternal grand-mother |
|
523 | + * 3 => { branches: 3, majs_i_id: X4, count_indi: 12 } -> 12 ancestors are exclusive to the maternal grand-father |
|
524 | + * 4 => { branches: 4, majs_i_id: X5, count_indi: 30 } -> 30 ancestors are exclusive to the maternal grand-mother |
|
525 | + * ] |
|
526 | + * |
|
527 | + * @param int $gen |
|
528 | + * @return Collection<int, \stdClass> |
|
529 | + */ |
|
530 | + public function ancestorsDispersionForGeneration(int $gen): Collection |
|
531 | + { |
|
532 | + if (!$this->isPdoSupported()) { |
|
533 | + return collect(); |
|
534 | + } |
|
535 | + |
|
536 | + $ancestors_branches = DB::table('maj_sosa') |
|
537 | + ->select('majs_i_id AS i_id') |
|
538 | + ->selectRaw('FLOOR(majs_sosa / POW(2, (majs_gen - ?))) - POW(2, ? -1) + 1 AS branch', [$gen, $gen]) |
|
539 | + ->where('majs_gedcom_id', '=', $this->tree->id()) |
|
540 | + ->where('majs_user_id', '=', $this->user->id()) |
|
541 | + ->where('majs_gen', '>=', $gen) |
|
542 | + ->groupBy('majs_i_id', 'branch'); |
|
543 | + |
|
544 | + $consolidated_ancestors_branches = DB::table('maj_sosa') |
|
545 | + ->fromSub($ancestors_branches, 'indi_branch') |
|
546 | + ->select('i_id') |
|
547 | + ->selectRaw('CASE WHEN COUNT(branch) > 1 THEN 0 ELSE MIN(branch) END AS branches') |
|
548 | + ->groupBy('i_id'); |
|
549 | + |
|
550 | + return DB::table('maj_sosa') |
|
551 | + ->rightJoinSub( |
|
552 | + $consolidated_ancestors_branches, |
|
553 | + 'indi_branch_consolidated', |
|
554 | + function (JoinClause $join) use ($gen): void { |
|
555 | + $join->where('maj_sosa.majs_gedcom_id', '=', $this->tree->id()) |
|
556 | + ->where('maj_sosa.majs_user_id', '=', $this->user->id()) |
|
557 | + ->where('branches', '>', 0) |
|
558 | + ->whereRaw('majs_sosa = POW(2, ? - 1) + branches - 1', [$gen]); |
|
559 | + } |
|
560 | + ) |
|
561 | + ->select(['branches', 'majs_i_id']) |
|
562 | + ->selectRaw('COUNT(i_id) AS count_indi') |
|
563 | + ->groupBy(['branches', 'majs_i_id']) |
|
564 | + ->get()->keyBy('branches'); |
|
565 | + } |
|
566 | 566 | } |