1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2019 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees;
use Fisharebest\Webtrees\Services\GedcomService;
use Illuminate\Database\Capsule\Manager as DB;
use Illuminate\Support\Collection;
use stdClass;
/**
* Class Location
*/
class Location
{
/** @var string e.g. "Westminster, London, England" */
private $location_name;
/** @var Collection|string[] The parts of a location name, e.g. ["Westminster", "London", "England"] */
private $parts;
/**
* Create a location.
*
* @param string $location_name
*/
public function __construct(string $location_name)
{
// Ignore any empty parts in location names such as "Village, , , Country".
$this->parts = (new Collection(preg_split(Gedcom::PLACE_SEPARATOR_REGEX, $location_name)))
->filter();
// Rebuild the location name in the correct format.
$this->location_name = $this->parts->implode(Gedcom::PLACE_SEPARATOR);
}
/**
* Get the higher level location.
*
* @return Location
*/
public function parent(): Location
{
return new self($this->parts->slice(1)->implode(Gedcom::PLACE_SEPARATOR));
}
/**
* The database row that contains this location.
* Note that due to database collation, both "Quebec" and "Québec" will share the same row.
*
* @return int
*/
public function id(): int
{
return app('cache.array')->rememberForever(__CLASS__ . __METHOD__ . $this->location_name, function () {
// The "top-level" location won't exist in the database.
if ($this->parts->isEmpty()) {
return 0;
}
$parent_location_id = $this->parent()->id();
$location_id = (int) DB::table('placelocation')
->where('pl_place', '=', $this->parts->first())
->where('pl_parent_id', '=', $parent_location_id)
->value('pl_id');
if ($location_id === 0) {
$location = $this->parts->first();
$location_id = 1 + (int) DB::table('placelocation')->max('pl_id');
DB::table('placelocation')->insert([
'pl_id' => $location_id,
'pl_place' => $location,
'pl_parent_id' => $parent_location_id,
'pl_level' => $this->parts->count() - 1,
'pl_lati' => '',
'pl_long' => '',
'pl_icon' => '',
'pl_zoom' => 2,
]);
}
return $location_id;
});
}
/**
* Does this location exist in the database? Note that calls to Location::id() will
* create the row, so this function is only meaningful when called before a call to Location::id().
*
* @return bool
*/
public function exists(): bool
{
$location_id = 0;
$this->parts->reverse()->each(function (string $place) use (&$location_id) {
if ($location_id !== null) {
$location_id = DB::table('placelocation')
->where('pl_parent_id', '=', $location_id)
->where('pl_place', '=', $place)
->value('pl_id');
}
});
return $location_id !== null;
}
/**
* @return stdClass
*/
private function details(): stdClass
{
return app('cache.array')->rememberForever(__CLASS__ . __METHOD__ . $this->id(), function () {
// The "top-level" location won't exist in the database.
if ($this->parts->isEmpty()) {
return (object) [
'pl_id' => '0',
'pl_parent_id' => '0',
'pl_level' => null,
'pl_place' => '',
'pl_lati' => null,
'pl_long' => null,
'pl_zoom' => null,
'pl_icon' => null,
'pl_media' => null,
];
}
return DB::table('placelocation')
->where('pl_id', '=', $this->id())
->first();
});
}
/**
* Latitude of the location.
*
* @return float
*/
public function latitude(): float
{
$gedcom_service = new GedcomService();
return $gedcom_service->readLatitude($this->details()->pl_lati ?? '');
}
/**
* Latitude of the longitude.
*
* @return float
*/
public function longitude(): float
{
$gedcom_service = new GedcomService();
return $gedcom_service->readLongitude($this->details()->pl_long ?? '');
}
/**
* The icon for the location.
*
* @return string
*/
public function icon(): string
{
return (string) $this->details()->pl_icon;
}
/**
* Zoom level for the location.
*
* @return int
*/
public function zoom(): int
{
return (int) $this->details()->pl_zoom;
}
/**
* @return string
*/
public function locationName(): string
{
return (string) $this->parts->first();
}
}
|
