This is a handy little class I wrote because I didn’t want to keep re-creating lists of U.S. states on contact forms. It’s pretty simple, containing arrays of state and country names, with the standard two-letter abbreviations used for the keys, and just a few methods for looking up a state or country, and for building the HTML <option> lists for use in a <select> construct.
<?php
/*************************************************************************
* *
* class.geo_codes.inc *
* *
*************************************************************************
* *
* Provides lists of country and state abbreviations, with some *
* helper functions *
* *
* Copyright (c) 2003 Jon Abernathy <jon@chuggnutt.com> *
* All rights reserved. *
* *
* This script 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 2 of the License, or *
* (at your option) any later version. *
* *
* The GNU General Public License can be found at *
* http://www.gnu.org/copyleft/gpl.html. *
* *
* This script 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. *
* *
* Author(s): Jon Abernathy <jon@chuggnutt.com> *
* *
* Last modified: 05/01/03 *
* *
*************************************************************************/
/**
* Provides lookup lists of country and state abbreviations and support functions.
*
* @author Jon Abernathy <jon@chuggnutt.com>
* @version 1.0
*/
class geo_codes
{
/**
* List of countries, keyed on standard two-letter abbreviations.
*
* @var array $country_list
* @access public
*/
var $country_list = array(
'AD' => 'Andorra',
'AE' => 'United Arab Emirates',
'AF' => 'Afghanistan',
'AG' => 'Antigua and Barbuda',
'AI' => 'Anguilla',
'AL' => 'Albania',
'AM' => 'Armenia',
'AN' => 'Netherlands Antilles',
'AO' => 'Angola',
'AQ' => 'Antarctica',
'AR' => 'Argentina',
'AS' => 'American Samoa',
'AT' => 'Austria',
'AU' => 'Australia',
'AW' => 'Aruba',
'AZ' => 'Azerbaijan',
'BA' => 'Bosnia and Herzegovina',
'BB' => 'Barbados',
'BD' => 'Bangladesh',
'BE' => 'Belgium',
'BF' => 'Burkina Faso',
'BG' => 'Bulgaria',
'BH' => 'Bahrain',
'BI' => 'Burundi',
'BJ' => 'Benin',
'BM' => 'Bermuda',
'BN' => 'Brunei Darussalam',
'BO' => 'Bolivia',
'BR' => 'Brazil',
'BS' => 'Bahamas',
'BT' => 'Bhutan',
'BV' => 'Bouvet Island',
'BW' => 'Botswana',
'BY' => 'Belarus',
'BZ' => 'Belize',
'CA' => 'Canada',
'CC' => 'Cocos (Keeling) Islands',
'CF' => 'Central African Republic',
'CG' => 'Congo',
'CH' => 'Switzerland',
'CI' => 'Cote D\'Ivoire (Ivory Coast)',
'CK' => 'Cook Islands',
'CL' => 'Chile',
'CM' => 'Cameroon',
'CN' => 'China',
'CO' => 'Colombia',
'CR' => 'Costa Rica',
'CS' => 'Czechoslovakia (former)',
'CU' => 'Cuba',
'CV' => 'Cape Verde',
'CX' => 'Christmas Island',
'CY' => 'Cyprus',
'CZ' => 'Czech Republic',
'DE' => 'Germany',
'DJ' => 'Djibouti',
'DK' => 'Denmark',
'DM' => 'Dominica',
'DO' => 'Dominican Republic',
'DZ' => 'Algeria',
'EC' => 'Ecuador',
'EE' => 'Estonia',
'EG' => 'Egypt',
'EH' => 'Western Sahara',
'ER' => 'Eritrea',
'ES' => 'Spain',
'ET' => 'Ethiopia',
'FI' => 'Finland',
'FJ' => 'Fiji',
'FK' => 'Falkland Islands (Malvinas)',
'FM' => 'Micronesia',
'FO' => 'Faroe Islands',
'FR' => 'France',
'FX' => 'France, Metropolitan',
'GA' => 'Gabon',
'GB' => 'Great Britain (UK)',
'GD' => 'Grenada',
'GE' => 'Georgia',
'GF' => 'French Guiana',
'GH' => 'Ghana',
'GI' => 'Gibraltar',
'GL' => 'Greenland',
'GM' => 'Gambia',
'GN' => 'Guinea',
'GP' => 'Guadeloupe',
'GQ' => 'Equatorial Guinea',
'GR' => 'Greece',
'GS' => 'S. Georgia and S. Sandwich Isls.',
'GT' => 'Guatemala',
'GU' => 'Guam',
'GW' => 'Guinea-Bissau',
'GY' => 'Guyana',
'HK' => 'Hong Kong',
'HM' => 'Heard and McDonald Islands',
'HN' => 'Honduras',
'HR' => 'Croatia (Hrvatska)',
'HT' => 'Haiti',
'HU' => 'Hungary',
'ID' => 'Indonesia',
'IE' => 'Ireland',
'IL' => 'Israel',
'IN' => 'India',
'IO' => 'British Indian Ocean Territory',
'IQ' => 'Iraq',
'IR' => 'Iran',
'IS' => 'Iceland',
'IT' => 'Italy',
'JM' => 'Jamaica',
'JO' => 'Jordan',
'JP' => 'Japan',
'KE' => 'Kenya',
'KG' => 'Kyrgyzstan',
'KH' => 'Cambodia',
'KI' => 'Kiribati',
'KM' => 'Comoros',
'KN' => 'Saint Kitts and Nevis',
'KP' => 'Korea (North)',
'KR' => 'Korea (South)',
'KW' => 'Kuwait',
'KY' => 'Cayman Islands',
'KZ' => 'Kazakhstan',
'LA' => 'Laos',
'LB' => 'Lebanon',
'LC' => 'Saint Lucia',
'LI' => 'Liechtenstein',
'LK' => 'Sri Lanka',
'LR' => 'Liberia',
'LS' => 'Lesotho',
'LT' => 'Lithuania',
'LU' => 'Luxembourg',
'LV' => 'Latvia',
'LY' => 'Libya',
'MA' => 'Morocco',
'MC' => 'Monaco',
'MD' => 'Moldova',
'MG' => 'Madagascar',
'MH' => 'Marshall Islands',
'MK' => 'Macedonia',
'ML' => 'Mali',
'MM' => 'Myanmar',
'MN' => 'Mongolia',
'MO' => 'Macau',
'MP' => 'Northern Mariana Islands',
'MQ' => 'Martinique',
'MR' => 'Mauritania',
'MS' => 'Montserrat',
'MT' => 'Malta',
'MU' => 'Mauritius',
'MV' => 'Maldives',
'MW' => 'Malawi',
'MX' => 'Mexico',
'MY' => 'Malaysia',
'MZ' => 'Mozambique',
'NA' => 'Namibia',
'NC' => 'New Caledonia',
'NE' => 'Niger',
'NF' => 'Norfolk Island',
'NG' => 'Nigeria',
'NI' => 'Nicaragua',
'NL' => 'Netherlands',
'NO' => 'Norway',
'NP' => 'Nepal',
'NR' => 'Nauru',
'NT' => 'Neutral Zone',
'NU' => 'Niue',
'NZ' => 'New Zealand (Aotearoa)',
'OM' => 'Oman',
'PA' => 'Panama',
'PE' => 'Peru',
'PF' => 'French Polynesia',
'PG' => 'Papua New Guinea',
'PH' => 'Philippines',
'PK' => 'Pakistan',
'PL' => 'Poland',
'PM' => 'St. Pierre and Miquelon',
'PN' => 'Pitcairn',
'PR' => 'Puerto Rico',
'PT' => 'Portugal',
'PW' => 'Palau',
'PY' => 'Paraguay',
'QA' => 'Qatar',
'RE' => 'Reunion',
'RO' => 'Romania',
'RU' => 'Russian Federation',
'RW' => 'Rwanda',
'SA' => 'Saudi Arabia',
'SB' => 'Solomon Islands',
'SC' => 'Seychelles',
'SD' => 'Sudan',
'SE' => 'Sweden',
'SG' => 'Singapore',
'SH' => 'St. Helena',
'SI' => 'Slovenia',
'SJ' => 'Svalbard and Jan Mayen Islands',
'SK' => 'Slovak Republic',
'SL' => 'Sierra Leone',
'SM' => 'San Marino',
'SN' => 'Senegal',
'SO' => 'Somalia',
'SR' => 'Suriname',
'ST' => 'Sao Tome and Principe',
'SU' => 'USSR (former)',
'SV' => 'El Salvador',
'SY' => 'Syria',
'SZ' => 'Swaziland',
'TC' => 'Turks and Caicos Islands',
'TD' => 'Chad',
'TF' => 'French Southern Territories',
'TG' => 'Togo',
'TH' => 'Thailand',
'TJ' => 'Tajikistan',
'TK' => 'Tokelau',
'TM' => 'Turkmenistan',
'TN' => 'Tunisia',
'TO' => 'Tonga',
'TP' => 'East Timor',
'TR' => 'Turkey',
'TT' => 'Trinidad and Tobago',
'TV' => 'Tuvalu',
'TW' => 'Taiwan',
'TZ' => 'Tanzania',
'UA' => 'Ukraine',
'UG' => 'Uganda',
'UK' => 'United Kingdom',
'UM' => 'US Minor Outlying Islands',
'US' => 'United States',
'UY' => 'Uruguay',
'UZ' => 'Uzbekistan',
'VA' => 'Vatican City State (Holy See)',
'VC' => 'Saint Vincent and the Grenadines',
'VE' => 'Venezuela',
'VG' => 'Virgin Islands (British)',
'VI' => 'Virgin Islands (U.S.)',
'VN' => 'Viet Nam',
'VU' => 'Vanuatu',
'WF' => 'Wallis and Futuna Islands',
'WS' => 'Samoa',
'YE' => 'Yemen',
'YT' => 'Mayotte',
'YU' => 'Yugoslavia',
'ZA' => 'South Africa',
'ZM' => 'Zambia',
'ZR' => 'Zaire',
'ZW' => 'Zimbabwe'
);
/**
* List of states in the US, keyed on standard two-letter abbreviations.
*
* @var array $state_list
* @access public
*/
var $state_list = array(
'AL' => 'Alabama',
'AK' => 'Alaska',
'AZ' => 'Arizona',
'AR' => 'Arkansas',
'CA' => 'California',
'CO' => 'Colorado',
'CT' => 'Conneticut',
'DE' => 'Delaware',
'FL' => 'Florida',
'GA' => 'Georgia',
'HI' => 'Hawaii',
'ID' => 'Idaho',
'IL' => 'Illinois',
'IN' => 'Indiana',
'IA' => 'Iowa',
'KS' => 'Kansas',
'KY' => 'Kentucky',
'LA' => 'Louisiana',
'ME' => 'Maine',
'MD' => 'Maryland',
'MA' => 'Massachusetts',
'MI' => 'Michigan',
'MN' => 'Minnesota',
'MS' => 'Mississippi',
'MO' => 'Missouri',
'MT' => 'Montana',
'NE' => 'Nebraska',
'NV' => 'Nevada',
'NH' => 'New Hampshire',
'NJ' => 'New Jersey',
'NM' => 'New Mexico',
'NY' => 'New York',
'NC' => 'North Carolina',
'ND' => 'North Dakota',
'OH' => 'Ohio',
'OK' => 'Oklahoma',
'OR' => 'Oregon',
'PA' => 'Pennsylvania',
'RI' => 'Rhode Island',
'SC' => 'South Carolina',
'SD' => 'South Dakota',
'TN' => 'Tennessee',
'TX' => 'Texas',
'UT' => 'Utah',
'VT' => 'Vermont',
'VA' => 'Virginia',
'WA' => 'Washington',
'DC' => 'Washington, DC',
'WV' => 'West Virginia',
'WI' => 'Wisconsin',
'WY' => 'Wyoming'
);
/**
* List of Canadian provinces, keyed on standard two-letter abbreviations.
*
* @var array $canadian_state_list
* @access public
*/
var $canadian_state_list = array(
'AB' => 'Alberta',
'BC' => 'British Columbia',
'MB' => 'Manitoba',
'NB' => 'New Brunswick',
'NF' => 'Newfoundland',
'NT' => 'Northwest Territories',
'NS' => 'Nova Scotia',
'NU' => 'Nunavut',
'ON' => 'Ontario',
'PE' => 'Prince Edward Island',
'QC' => 'Quebec',
'SK' => 'Saskatchewan',
'YT' => 'Yukon'
);
/**
* Returns the full country name, looked up by country abbreviation code.
*
* @param string $code Two letter country code
* @access public
* @return string Name of the country, or original country code if not found
*/
function get_country( $code = 'US' )
{
$ucode = strtoupper($code);
if ( isset($this->country_list[$ucode]) ) {
return $this->country_list[$ucode];
}
return $code;
}
/**
* Returns the full state name, looked up by state abbreviation code.
*
* Checks first the US states, then the Canadian provinces if the
* US state was not found.
*
* @param string $code Two letter state code
* @access public
* @return string Name of the state, or original state code if not found
*/
function get_state( $code )
{
$ucode = strtoupper($code);
if ( isset($this->state_list[$ucode]) ) {
return $this->state_list[$ucode];
}
if ( isset($this->canadian_state_list[$ucode]) ) {
return $this->canadian_state_list[$ucode];
}
return $code;
}
/**
* Builds an option list of states for use with HTML form select elements.
*
* @param string $selected State code to mark as selected in the list
* @param boolean $first_blank TRUE if the first item in the list should
* be a blank line
* @param boolean $canada TRUE to include Canadian provinces in the list
* @access public
* @return string
*/
function build_state_options( $selected = '', $first_blank = true, $canada = false )
{
if ( !empty($selected) ) {
$selected = strtoupper($selected);
}
$output = '';
if ( $first_blank ) {
$output .= "<option value=\"\"> </option>\n";
}
foreach ( $this->state_list as $code => $state ) {
$output .= "<option value=\"$code\"";
if ( $code == $selected ) {
$output .= " selected";
}
$output .= ">$state</option>\n";
}
if ( $canada ) {
foreach ( $this->canadian_state_list as $code => $state ) {
$output .= "<option value=\"$code\"";
if ( $code == $selected ) {
$output .= ' selected';
}
$output .= ">$state</option>\n";
}
}
return $output;
}
/**
* Builds an option list of countries for use with HTML form select elements.
*
* @param string $selected Country code to mark as selected in the list
* @param boolean $first_blank TRUE if the first item in the list should
* be a blank line
* @access public
* @return string
*/
function build_country_options( $selected = '', $first_blank = true )
{
if ( !empty($selected) ) {
$selected = strtoupper($selected);
}
$output = '';
if ( $first_blank ) {
$output .= "<option value=\"\"> </option>\n";
}
foreach ( $this->country_list as $code => $country ) {
$output .= "<option value=\"$code\"";
if ( $code == $selected ) {
$output .= ' selected';
}
$output .= ">$country</option>\n";
}
return $output;
}
}
?>