<?php
/**
 * webtrees: online genealogy
 * Copyright (C) 2017 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/>.
 */
namespace Fisharebest\Webtrees\GedcomCode;

use Fisharebest\Webtrees\I18N;

/**
 * Class GedcomCodeTemp - Functions and logic for GEDCOM "TEMP" codes
 */
class GedcomCodeTemp {
	/**
	 * A list of GEDCOM tags that require a TEMP subtag
	 *
	 * @param string $tag
	 *
	 * @return bool
	 */
	public static function isTagLDS($tag) {
		return $tag === 'BAPL' || $tag === 'CONL' || $tag === 'ENDL' || $tag === 'SLGC' || $tag === 'SLGS';
	}

	/**
	 * A list of all temple codes, from the GEDCOM 5.5.1 specification
	 *
	 * Note that this list is out-of-date. We could add recently built
	 * temples, but what codes would we use?
	 *
	 * @link http://en.wikipedia.org/wiki/List_of_temples_of_The_Church_of_Jesus_Christ_of_Latter-day_Saints
	 * @link http://www.ldschurchtemples.com/codes/
	 *
	 * @return string[]
	 */
	public static function templeCodes() {
		return [
			'ABA', 'ACCRA', 'ADELA', 'ALBER', 'ALBUQ', 'ANCHO', 'ARIZO', 'ASUNC',
			'ATLAN', 'BAIRE', 'BILLI', 'BIRMI', 'BISMA', 'BOGOT', 'BOISE', 'BOSTO',
			'BOUNT', 'BRIGH', 'BRISB', 'BROUG', 'CALGA', 'CAMPI', 'CARAC', 'CEBUP',
			'CHICA', 'CIUJU', 'COCHA', 'COLJU', 'COLSC', 'COLUM', 'COPEN', 'CORDO',
			'CRIVE', 'CURIT', 'DALLA', 'DENVE', 'DETRO', 'DRAPE', 'EDMON', 'EHOUS',
			'FORTL', 'FRANK', 'FREIB', 'FRESN', 'FUKUO', 'GILAV', 'GILBE', 'GUADA',
			'GUATE', 'GUAYA', 'HAGUE', 'HALIF', 'HARTF', 'HAWAI', 'HELSI', 'HERMO',
			'HKONG', 'HOUST', 'IFALL', 'INDIA', 'JOHAN', 'JRIVE', 'KANSA', 'KONA',
			'KYIV', 'LANGE', 'LIMA', 'LOGAN', 'LONDO', 'LOUIS', 'LUBBO', 'LVEGA',
			'MADRI', 'MANAU', 'MANHA', 'MANIL', 'MANTI', 'MEDFO', 'MELBO', 'MEMPH',
			'MERID', 'MEXIC', 'MNTVD', 'MONTE', 'MONTI', 'MONTR', 'MTIMP', 'NASHV',
			'NAUV2', 'NAUVO', 'NBEAC', 'NUKUA', 'NYORK', 'NZEAL', 'OAKLA', 'OAXAC',
			'OGDEN', 'OKLAH', 'OQUIR', 'ORLAN', 'PALEG', 'PALMY', 'PANAM', 'PAPEE',
			'PAYSO', 'PERTH', 'PHOEN', 'POFFI', 'PORTL', 'PREST', 'PROCC', 'PROVO',
			'QUETZ', 'RALEI', 'RECIF', 'REDLA', 'REGIN', 'RENO', 'REXBU', 'SACRA',
			'SAMOA', 'SANTI', 'SANSA', 'SANTO', 'SDIEG', 'SDOMI', 'SEATT', 'SEOUL',
			'SGEOR', 'SJOSE', 'SLAKE', 'SLOUI', 'SNOWF', 'SPAUL', 'SPMIN', 'SPOKA',
			'STOCK', 'SUVA', 'SWISS', 'SYDNE', 'TAIPE', 'TAMPI', 'TEGUC', 'TGUTI',
			'TIHUA', 'TOKYO', 'TORNO', 'TRUJI', 'TWINF', 'VANCO', 'VERAC', 'VERNA',
			'VILLA', 'WASHI', 'WINTE',
		];
	}

	/**
	 * Get the localized name for a temple code
	 *
	 * @param string $temple_code
	 *
	 * @return string
	 */
	public static function templeName($temple_code) {
		switch ($temple_code) {
		case 'ABA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Aba, Nigeria');
		case 'ACCRA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Accra, Ghana');
		case 'ADELA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Adelaide, Australia');
		case 'ALBER':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Cardston, Alberta, Canada');
		case 'ALBUQ':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Albuquerque, New Mexico, United States');
		case 'ANCHO':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Anchorage, Alaska, United States');
		case 'APIA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Apia, Samoa');
		case 'ARIZO':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Mesa, Arizona, United States');
		case 'ASUNC':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Asuncion, Paraguay');
		case 'ATLAN':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Atlanta, Georgia, United States');
		case 'BAIRE':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Buenos Aires, Argentina');
		case 'BILLI':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Billings, Montana, United States');
		case 'BIRMI':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Birmingham, Alabama, United States');
		case 'BISMA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Bismarck, North Dakota, United States');
		case 'BOGOT':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Bogota, Colombia');
		case 'BOISE':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Boise, Idaho, United States');
		case 'BOSTO':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Boston, Massachusetts, United States');
		case 'BOUNT':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Bountiful, Utah, United States');
		case 'BRIGH':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Brigham City, Utah, United States');
		case 'BRISB':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Brisbane, Australia');
		case 'BROUG':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Baton Rouge, Louisiana, United States');
		case 'CALGA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Calgary, Alberta, Canada');
		case 'CAMPI':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Campinas, Brazil');
		case 'CARAC':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Caracas, Venezuela');
		case 'CEBUP':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Cebu City, Philippines');
		case 'CHICA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Chicago, Illinois, United States');
		case 'CIUJU':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Ciudad Juarez, Mexico');
		case 'COCHA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Cochabamba, Bolivia');
		case 'COLJU':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Colonia Juarez, Mexico');
		case 'COLSC':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Columbia, South Carolina, United States');
		case 'COLUM':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Columbus, Ohio, United States');
		case 'COPEN':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Copenhagen, Denmark');
		case 'CORDO':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Cordoba, Argentina');
		case 'CRIVE':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Columbia River, Washington, United States');
		case 'CURIT':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Curitiba, Brazil');
		case 'DALLA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Dallas, Texas, United States');
		case 'DENVE':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Denver, Colorado, United States');
		case 'DETRO':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Detroit, Michigan, United States');
		case 'DRAPE':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Draper, Utah, United States');
		case 'EDMON':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Edmonton, Alberta, Canada');
		case 'EHOUS':
			return /* I18N: Location of an historic LDS church temple - http://en.wikipedia.org/wiki/Endowment_house */ I18N::translate('Endowment House');
		case 'FORTL':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Fort Lauderdale, Florida, United States');
		case 'FRANK':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Frankfurt am Main, Germany');
		case 'FREIB':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Freiburg, Germany');
		case 'FRESN':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Fresno, California, United States');
		case 'FUKUO':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Fukuoka, Japan');
		case 'GILAV':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Gila Valley, Arizona, United States');
		case 'GILBE':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Gilbert, Arizona, United States');
		case 'GUADA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Guadalajara, Mexico');
		case 'GUATE':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Guatemala City, Guatemala');
		case 'GUAYA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Guayaquil, Ecuador');
		case 'HAGUE':
			return /* I18N: Location of an LDS church temple */ I18N::translate('The Hague, Netherlands');
		case 'HALIF':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Halifax, Nova Scotia, Canada');
		case 'HARTF':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Hartford, Connecticut, United States');
		case 'HAWAI':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Laie, Hawaii, United States');
		case 'HELSI':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Helsinki, Finland');
		case 'HERMO':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Hermosillo, Mexico');
		case 'HKONG':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Hong Kong');
		case 'HOUST':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Houston, Texas, United States');
		case 'IFALL':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Idaho Falls, Idaho, United States');
		case 'INDIA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Indianapolis, Indiana, United States');
		case 'JOHAN':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Johannesburg, South Africa');
		case 'JRIVE':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Jordan River, Utah, United States');
		case 'KANSA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Kansas City, Missouri, United States');
		case 'KONA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Kona, Hawaii, United States');
		case 'KYIV':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Kiev, Ukraine');
		case 'LANGE':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Los Angeles, California, United States');
		case 'LIMA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Lima, Peru');
		case 'LOGAN':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Logan, Utah, United States');
		case 'LONDO':
			return /* I18N: Location of an LDS church temple */ I18N::translate('London, England');
		case 'LOUIS':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Louisville, Kentucky, United States');
		case 'LUBBO':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Lubbock, Texas, United States');
		case 'LVEGA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Las Vegas, Nevada, United States');
		case 'MADRI':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Madrid, Spain');
		case 'MANAU':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Manaus, Brazil');
		case 'MANHA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Manhattan, New York, United States');
		case 'MANIL':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Manila, Philippines');
		case 'MANTI':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Manti, Utah, United States');
		case 'MEDFO':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Medford, Oregon, United States');
		case 'MELBO':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Melbourne, Australia');
		case 'MEMPH':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Memphis, Tennessee, United States');
		case 'MERID':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Merida, Mexico');
		case 'MEXIC':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Mexico City, Mexico');
		case 'MNTVD':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Montevideo, Uruguay');
		case 'MONTE':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Monterrey, Mexico');
		case 'MONTI':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Monticello, Utah, United States');
		case 'MONTR':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Montreal, Quebec, Canada');
		case 'MTIMP':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Mount Timpanogos, Utah, United States');
		case 'NASHV':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Nashville, Tennessee, United States');
		case 'NAUV2':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Nauvoo (new), Illinois, United States');
		case 'NAUVO':
			return /* I18N: Location of an historic LDS church temple */ I18N::translate('Nauvoo (original), Illinois, United States');
		case 'NBEAC':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Newport Beach, California, United States');
		case 'NUKUA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Nuku’Alofa, Tonga');
		case 'NYORK':
			return /* I18N: Location of an historic LDS church temple */ I18N::translate('New York, New York, United States');
		case 'NZEAL':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Hamilton, New Zealand');
		case 'OAKLA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Oakland, California, United States');
		case 'OAXAC':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Oaxaca, Mexico');
		case 'OGDEN':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Ogden, Utah, United States');
		case 'OKLAH':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Oklahoma City, Oklahoma, United States');
		case 'OQUIR':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Oquirrh Mountain, Utah, United States');
		case 'ORLAN':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Orlando, Florida, United States');
		case 'PALEG':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Porto Alegre, Brazil');
		case 'PALMY':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Palmyra, New York, United States');
		case 'PANAM':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Panama City, Panama');
		case 'PAPEE':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Papeete, Tahiti');
		case 'PAYSO':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Payson, Utah, United States');
		case 'PERTH':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Perth, Australia');
		case 'PHOEN':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Phoenix, Arizona, United States');
		case 'POFFI':
			return /* I18N: I18N: Location of an historic LDS church temple - http://en.wikipedia.org/wiki/President_of_the_Church */ I18N::translate('President’s Office');
		case 'PORTL':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Portland, Oregon, United States');
		case 'PREST':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Preston, England');
		case 'PROCC':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Provo City Center, Utah, United States');
		case 'PROVO':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Provo, Utah, United States');
		case 'QUETZ':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Quetzaltenango, Guatemala');
		case 'RALEI':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Raleigh, North Carolina, United States');
		case 'RECIF':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Recife, Brazil');
		case 'REDLA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Redlands, California, United States');
		case 'REGIN':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Regina, Saskatchewan, Canada');
		case 'RENO':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Reno, Nevada, United States');
		case 'REXBU':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Rexburg, Idaho, United States');
		case 'SACRA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Sacramento, California, United States');
		case 'SANSA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('San Salvador, El Salvador');
		case 'SANTI':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Santiago, Chile');
		case 'SANTO':
			return /* I18N: Location of an LDS church temple */ I18N::translate('San Antonio, Texas, United States');
		case 'SDIEG':
			return /* I18N: Location of an LDS church temple */ I18N::translate('San Diego, California, United States');
		case 'SDOMI':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Santo Domingo, Dominican Republic');
		case 'SEATT':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Seattle, Washington, United States');
		case 'SEOUL':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Seoul, Korea');
		case 'SGEOR':
			return /* I18N: Location of an LDS church temple */ I18N::translate('St. George, Utah, United States');
		case 'SJOSE':
			return /* I18N: Location of an LDS church temple */ I18N::translate('San Jose, Costa Rica');
		case 'SLAKE':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Salt Lake City, Utah, United States');
		case 'SLOUI':
			return /* I18N: Location of an LDS church temple */ I18N::translate('St. Louis, Missouri, United States');
		case 'SNOWF':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Snowflake, Arizona, United States');
		case 'SPAUL':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Sao Paulo, Brazil');
		case 'SPMIN':
			return /* I18N: Location of an LDS church temple */ I18N::translate('St. Paul, Minnesota, United States');
		case 'SPOKA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Spokane, Washington, United States');
		case 'STOCK':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Stockholm, Sweden');
		case 'SUVA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Suva, Fiji');
		case 'SWISS':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Bern, Switzerland');
		case 'SYDNE':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Sydney, Australia');
		case 'TAIPE':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Taipei, Taiwan');
		case 'TAMPI':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Tampico, Mexico');
		case 'TEGUC':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Tegucigalpa, Honduras');
		case 'TGUTI':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Tuxtla Gutierrez, Mexico');
		case 'TIJUA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Tijuana, Mexico');
		case 'TOKYO':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Tokyo, Japan');
		case 'TORNO':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Toronto, Ontario, Canada');
		case 'TRUJI':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Trujillo, Peru');
		case 'TWINF':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Twin Falls, Idaho, United States');
		case 'VANCO':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Vancouver, British Columbia, Canada');
		case 'VERAC':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Veracruz, Mexico');
		case 'VERNA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Vernal, Utah, United States');
		case 'VILLA':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Villa Hermosa, Mexico');
		case 'WASHI':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Washington, District of Columbia, United States');
		case 'WINTE':
			return /* I18N: Location of an LDS church temple */ I18N::translate('Winter Quarters, Nebraska, United States');
		default:
			return $temple_code;
		}
	}

	/**
	 * A sorted list of all temple names
	 *
	 * @return string[]
	 */
	public static function templeNames() {
		$temple_names = [];
		foreach (self::templeCodes() as $temple_code) {
			$temple_names[$temple_code] = self::templeName($temple_code);
		}
		uasort($temple_names, '\Fisharebest\Webtrees\I18N::strcasecmp');

		return $temple_names;
	}
}