1<?php 2 3/** 4 * webtrees: online genealogy 5 * Copyright (C) 2019 webtrees development team 6 * This program is free software: you can redistribute it and/or modify 7 * it under the terms of the GNU General Public License as published by 8 * the Free Software Foundation, either version 3 of the License, or 9 * (at your option) any later version. 10 * This program is distributed in the hope that it will be useful, 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * GNU General Public License for more details. 14 * You should have received a copy of the GNU General Public License 15 * along with this program. If not, see <http://www.gnu.org/licenses/>. 16 */ 17 18declare(strict_types=1); 19 20namespace Fisharebest\Webtrees\Module; 21 22use Fisharebest\Webtrees\I18N; 23use Fisharebest\Webtrees\Tree; 24use Illuminate\Support\Collection; 25use stdClass; 26 27/** 28 * Class FixPlaceNames 29 */ 30class FixPlaceNames extends AbstractModule implements ModuleDataFixInterface 31{ 32 use ModuleDataFixTrait; 33 34 /** 35 * How should this module be identified in the control panel, etc.? 36 * 37 * @return string 38 */ 39 public function title(): string 40 { 41 /* I18N: Name of a module */ 42 return I18N::translate('Update place names'); 43 } 44 45 /** 46 * A sentence describing what this module does. 47 * 48 * @return string 49 */ 50 public function description(): string 51 { 52 /* I18N: Description of a “Data fix” module */ 53 return I18N::translate('Update the higher-level parts of place names, while keeping the lower-level parts.'); 54 } 55 56 /** 57 * A list of all records that need examining. This may include records 58 * that do not need updating, if we can't detect this quickly using SQL. 59 * 60 * @param Tree $tree 61 * @param array<string,string> $params 62 * 63 * @return Collection<stdClass> 64 */ 65 public function recordsToExamine(Tree $tree, array $params): Collection 66 { 67 return new Collection(); 68 } 69} 70