xref: /webtrees/app/Place.php (revision cab242e7d7a773b0a6dab130048696e26fd6612c)
1a25f0a04SGreg Roach<?php
2a25f0a04SGreg Roach/**
3a25f0a04SGreg Roach * webtrees: online genealogy
48fcd0d32SGreg Roach * Copyright (C) 2019 webtrees development team
5a25f0a04SGreg Roach * This program is free software: you can redistribute it and/or modify
6a25f0a04SGreg Roach * it under the terms of the GNU General Public License as published by
7a25f0a04SGreg Roach * the Free Software Foundation, either version 3 of the License, or
8a25f0a04SGreg Roach * (at your option) any later version.
9a25f0a04SGreg Roach * This program is distributed in the hope that it will be useful,
10a25f0a04SGreg Roach * but WITHOUT ANY WARRANTY; without even the implied warranty of
11a25f0a04SGreg Roach * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12a25f0a04SGreg Roach * GNU General Public License for more details.
13a25f0a04SGreg Roach * You should have received a copy of the GNU General Public License
14a25f0a04SGreg Roach * along with this program. If not, see <http://www.gnu.org/licenses/>.
15a25f0a04SGreg Roach */
16e7f56f2aSGreg Roachdeclare(strict_types=1);
17e7f56f2aSGreg Roach
1876692c8bSGreg Roachnamespace Fisharebest\Webtrees;
19a25f0a04SGreg Roach
2067992b6aSRichard Cisseeuse Fisharebest\Webtrees\Module\ModuleInterface;
2187cca37cSGreg Roachuse Fisharebest\Webtrees\Module\ModuleListInterface;
2267992b6aSRichard Cisseeuse Fisharebest\Webtrees\Module\PlaceHierarchyListModule;
2367992b6aSRichard Cisseeuse Fisharebest\Webtrees\Services\ModuleService;
24b68caec6SGreg Roachuse Illuminate\Database\Capsule\Manager as DB;
25392561bbSGreg Roachuse Illuminate\Support\Collection;
26b68caec6SGreg Roach
27a25f0a04SGreg Roach/**
2876692c8bSGreg Roach * A GEDCOM place (PLAC) object.
29a25f0a04SGreg Roach */
30c1010edaSGreg Roachclass Place
31c1010edaSGreg Roach{
32392561bbSGreg Roach    /** @var string e.g. "Westminster, London, England" */
33392561bbSGreg Roach    private $place_name;
34392561bbSGreg Roach
35392561bbSGreg Roach    /** @var Collection|string[] The parts of a place name, e.g. ["Westminster", "London", "England"] */
36392561bbSGreg Roach    private $parts;
3784caa210SGreg Roach
3876692c8bSGreg Roach    /** @var Tree We may have the same place name in different trees. */
3984caa210SGreg Roach    private $tree;
40a25f0a04SGreg Roach
41a25f0a04SGreg Roach    /**
4276692c8bSGreg Roach     * Create a place.
4376692c8bSGreg Roach     *
44392561bbSGreg Roach     * @param string $place_name
4584caa210SGreg Roach     * @param Tree   $tree
46a25f0a04SGreg Roach     */
47392561bbSGreg Roach    public function __construct(string $place_name, Tree $tree)
48c1010edaSGreg Roach    {
49392561bbSGreg Roach        // Ignore any empty parts in place names such as "Village, , , Country".
50321a89daSGreg Roach        $this->parts = Collection::make(preg_split(Gedcom::PLACE_SEPARATOR_REGEX, $place_name))
51392561bbSGreg Roach            ->filter();
52392561bbSGreg Roach
53392561bbSGreg Roach        // Rebuild the placename in the correct format.
54392561bbSGreg Roach        $this->place_name = $this->parts->implode(Gedcom::PLACE_SEPARATOR);
55392561bbSGreg Roach
5664b16745SGreg Roach        $this->tree = $tree;
57a25f0a04SGreg Roach    }
58a25f0a04SGreg Roach
59a25f0a04SGreg Roach    /**
6076692c8bSGreg Roach     * Get the higher level place.
6176692c8bSGreg Roach     *
62a25f0a04SGreg Roach     * @return Place
63a25f0a04SGreg Roach     */
64392561bbSGreg Roach    public function parent(): Place
65c1010edaSGreg Roach    {
668af6bbf8SGreg Roach        return new self($this->parts->slice(1)->implode(Gedcom::PLACE_SEPARATOR), $this->tree);
67392561bbSGreg Roach    }
68392561bbSGreg Roach
69392561bbSGreg Roach    /**
70392561bbSGreg Roach     * The database row that contains this place.
71392561bbSGreg Roach     * Note that due to database collation, both "Quebec" and "Québec" will share the same row.
72392561bbSGreg Roach     *
73392561bbSGreg Roach     * @return int
74392561bbSGreg Roach     */
75392561bbSGreg Roach    public function id(): int
76392561bbSGreg Roach    {
77*cab242e7SGreg Roach        return app('cache.array')->rememberForever(__CLASS__ . __METHOD__ . $this->place_name, function () {
78392561bbSGreg Roach            // The "top-level" place won't exist in the database.
79392561bbSGreg Roach            if ($this->parts->isEmpty()) {
80392561bbSGreg Roach                return 0;
81392561bbSGreg Roach            }
82392561bbSGreg Roach
838af6bbf8SGreg Roach            $parent_place_id = $this->parent()->id();
84392561bbSGreg Roach
85392561bbSGreg Roach            $place_id = (int) DB::table('places')
86392561bbSGreg Roach                ->where('p_file', '=', $this->tree->id())
87392561bbSGreg Roach                ->where('p_place', '=', $this->parts->first())
888af6bbf8SGreg Roach                ->where('p_parent_id', '=', $parent_place_id)
89392561bbSGreg Roach                ->value('p_id');
90392561bbSGreg Roach
91392561bbSGreg Roach            if ($place_id === 0) {
92392561bbSGreg Roach                $place = $this->parts->first();
93392561bbSGreg Roach
94392561bbSGreg Roach                DB::table('places')->insert([
95392561bbSGreg Roach                    'p_file'        => $this->tree->id(),
96392561bbSGreg Roach                    'p_place'       => $place,
978af6bbf8SGreg Roach                    'p_parent_id'   => $parent_place_id,
98392561bbSGreg Roach                    'p_std_soundex' => Soundex::russell($place),
99392561bbSGreg Roach                    'p_dm_soundex'  => Soundex::daitchMokotoff($place),
100392561bbSGreg Roach                ]);
101392561bbSGreg Roach
102392561bbSGreg Roach                $place_id = (int) DB::connection()->getPdo()->lastInsertId();
103392561bbSGreg Roach            }
104392561bbSGreg Roach
105392561bbSGreg Roach            return $place_id;
106392561bbSGreg Roach        });
107392561bbSGreg Roach    }
108392561bbSGreg Roach
109392561bbSGreg Roach    /**
110392561bbSGreg Roach     * Extract the locality (first parts) of a place name.
111392561bbSGreg Roach     *
112392561bbSGreg Roach     * @param int $n
113392561bbSGreg Roach     *
114392561bbSGreg Roach     * @return Collection
115392561bbSGreg Roach     */
116392561bbSGreg Roach    public function firstParts(int $n): Collection
117392561bbSGreg Roach    {
118392561bbSGreg Roach        return $this->parts->slice(0, $n);
119392561bbSGreg Roach    }
120392561bbSGreg Roach
121392561bbSGreg Roach    /**
122392561bbSGreg Roach     * Extract the country (last parts) of a place name.
123392561bbSGreg Roach     *
124392561bbSGreg Roach     * @param int $n
125392561bbSGreg Roach     *
126392561bbSGreg Roach     * @return Collection
127392561bbSGreg Roach     */
128392561bbSGreg Roach    public function lastParts(int $n): Collection
129392561bbSGreg Roach    {
130392561bbSGreg Roach        return $this->parts->slice(-$n);
131a25f0a04SGreg Roach    }
132a25f0a04SGreg Roach
133a25f0a04SGreg Roach    /**
13476692c8bSGreg Roach     * Get the lower level places.
13576692c8bSGreg Roach     *
136a25f0a04SGreg Roach     * @return Place[]
137a25f0a04SGreg Roach     */
1388f53f488SRico Sonntag    public function getChildPlaces(): array
139c1010edaSGreg Roach    {
140392561bbSGreg Roach        if ($this->place_name !== '') {
141392561bbSGreg Roach            $parent_text = Gedcom::PLACE_SEPARATOR . $this->place_name;
142a25f0a04SGreg Roach        } else {
143a25f0a04SGreg Roach            $parent_text = '';
144a25f0a04SGreg Roach        }
145a25f0a04SGreg Roach
146b68caec6SGreg Roach        return DB::table('places')
147b68caec6SGreg Roach            ->where('p_file', '=', $this->tree->id())
148392561bbSGreg Roach            ->where('p_parent_id', '=', $this->id())
149b68caec6SGreg Roach            ->orderBy(DB::raw('p_place /*! COLLATE ' . I18N::collation() . ' */'))
150b68caec6SGreg Roach            ->pluck('p_place')
151b68caec6SGreg Roach            ->map(function (string $place) use ($parent_text): Place {
152b68caec6SGreg Roach                return new self($place . $parent_text, $this->tree);
153b68caec6SGreg Roach            })
154b68caec6SGreg Roach            ->all();
155a25f0a04SGreg Roach    }
156a25f0a04SGreg Roach
157a25f0a04SGreg Roach    /**
15876692c8bSGreg Roach     * Create a URL to the place-hierarchy page.
15976692c8bSGreg Roach     *
160a25f0a04SGreg Roach     * @return string
161a25f0a04SGreg Roach     */
162e8777cb5SGreg Roach    public function url(): string
163c1010edaSGreg Roach    {
16467992b6aSRichard Cissee        //find a module providing the place hierarchy
16587cca37cSGreg Roach        $module = app(ModuleService::class)->findByComponent(ModuleListInterface::class, $this->tree, Auth::user())->first(function (ModuleInterface $module) {
16667992b6aSRichard Cissee            return $module instanceof PlaceHierarchyListModule;
16767992b6aSRichard Cissee        });
16867992b6aSRichard Cissee
16967992b6aSRichard Cissee        if ($module instanceof PlaceHierarchyListModule) {
17067992b6aSRichard Cissee            return $module->listUrl($this->tree, [
171392561bbSGreg Roach                'parent' => $this->parts->reverse()->all(),
172aa6f03bbSGreg Roach                'ged'    => $this->tree->name(),
173e8777cb5SGreg Roach            ]);
17467992b6aSRichard Cissee        } else {
17567992b6aSRichard Cissee            //TODO: should we be allowed to return null here?
17667992b6aSRichard Cissee            return \Fisharebest\Webtrees\Html::url('index.php', []);
17767992b6aSRichard Cissee        }
178a25f0a04SGreg Roach    }
179a25f0a04SGreg Roach
180a25f0a04SGreg Roach    /**
181392561bbSGreg Roach     * Format this place for GEDCOM data.
18276692c8bSGreg Roach     *
183a25f0a04SGreg Roach     * @return string
184a25f0a04SGreg Roach     */
185392561bbSGreg Roach    public function gedcomName(): string
186c1010edaSGreg Roach    {
187392561bbSGreg Roach        return $this->place_name;
188a25f0a04SGreg Roach    }
189a25f0a04SGreg Roach
190a25f0a04SGreg Roach    /**
19176692c8bSGreg Roach     * Format this place for display on screen.
19276692c8bSGreg Roach     *
193a25f0a04SGreg Roach     * @return string
194a25f0a04SGreg Roach     */
195392561bbSGreg Roach    public function placeName(): string
196c1010edaSGreg Roach    {
197392561bbSGreg Roach        $place_name = $this->parts->first() ?? I18N::translate('unknown');
198a25f0a04SGreg Roach
199392561bbSGreg Roach        return '<span dir="auto">' . e($place_name) . '</span>';
200a25f0a04SGreg Roach    }
201a25f0a04SGreg Roach
202a25f0a04SGreg Roach    /**
20376692c8bSGreg Roach     * Generate the place name for display, including the full hierarchy.
20476692c8bSGreg Roach     *
205392561bbSGreg Roach     * @param bool $link
206392561bbSGreg Roach     *
207a25f0a04SGreg Roach     * @return string
208a25f0a04SGreg Roach     */
209392561bbSGreg Roach    public function fullName(bool $link = false)
210c1010edaSGreg Roach    {
211392561bbSGreg Roach        if ($this->parts->isEmpty()) {
212392561bbSGreg Roach            return '';
213b2ce94c6SRico Sonntag        }
214b2ce94c6SRico Sonntag
215392561bbSGreg Roach        $full_name = $this->parts->implode(I18N::$list_separator);
216392561bbSGreg Roach
217392561bbSGreg Roach        if ($link) {
218392561bbSGreg Roach            return '<a dir="auto" href="' . e($this->url()) . '">' . e($full_name) . '</a>';
219a25f0a04SGreg Roach        }
220a25f0a04SGreg Roach
221392561bbSGreg Roach        return '<span dir="auto">' . e($full_name) . '</span>';
222a25f0a04SGreg Roach    }
223a25f0a04SGreg Roach
224a25f0a04SGreg Roach    /**
225a25f0a04SGreg Roach     * For lists and charts, where the full name won’t fit.
226a25f0a04SGreg Roach     *
227392561bbSGreg Roach     * @param bool $link
228a25f0a04SGreg Roach     *
229a25f0a04SGreg Roach     * @return string
230a25f0a04SGreg Roach     */
231392561bbSGreg Roach    public function shortName(bool $link = false)
232c1010edaSGreg Roach    {
233392561bbSGreg Roach        $SHOW_PEDIGREE_PLACES = (int) $this->tree->getPreference('SHOW_PEDIGREE_PLACES');
234392561bbSGreg Roach
235392561bbSGreg Roach        // Abbreviate the place name, for lists
236392561bbSGreg Roach        if ($this->tree->getPreference('SHOW_PEDIGREE_PLACES_SUFFIX')) {
237392561bbSGreg Roach            $parts = $this->lastParts($SHOW_PEDIGREE_PLACES);
238392561bbSGreg Roach        } else {
239392561bbSGreg Roach            $parts = $this->firstParts($SHOW_PEDIGREE_PLACES);
240a25f0a04SGreg Roach        }
241a25f0a04SGreg Roach
242392561bbSGreg Roach        $short_name = $parts->implode(I18N::$list_separator);
243392561bbSGreg Roach
244392561bbSGreg Roach        // Add a tool-tip showing the full name
245392561bbSGreg Roach        $title = strip_tags($this->fullName());
246392561bbSGreg Roach
247392561bbSGreg Roach        if ($link) {
248392561bbSGreg Roach            return '<a dir="auto" href="' . e($this->url()) . '" title="' . $title . '"">' . e($short_name) . '</a>';
249392561bbSGreg Roach        }
250392561bbSGreg Roach
251392561bbSGreg Roach        return '<span dir="auto">' . e($short_name) . '</span>';
252a25f0a04SGreg Roach    }
253a25f0a04SGreg Roach}
254