~ubuntu-branches/ubuntu/intrepid/perl-doc-html/intrepid

<div id="breadCrumbs"><a href="../index.html">Home</a> > <a href="../index-modules-A.html">Core modules</a> > <a href="../index-modules-L.html">L</a> > Locale::Country</div>

<div id="contentBody"><div class="title_container"><div class="page_title">Locale::Country</div></div><ul><li><a href="#SYNOPSIS">SYNOPSIS</a><li><a href="#DESCRIPTION">DESCRIPTION</a><li><a href="#CONVERSION-ROUTINES">CONVERSION ROUTINES</a><li><a href="#QUERY-ROUTINES">QUERY ROUTINES</a><li><a href="#SEMI-PRIVATE-ROUTINES">SEMI-PRIVATE ROUTINES</a><ul><li><a href="#alias_code">alias_code</a><li><a href="#rename_country">rename_country</a></ul><li><a href="#EXAMPLES">EXAMPLES</a><li><a href="#DOMAIN-NAMES">DOMAIN NAMES</a><li><a href="#KNOWN-BUGS-AND-LIMITATIONS">KNOWN BUGS AND LIMITATIONS</a><li><a href="#SEE-ALSO">SEE ALSO</a><li><a href="#AUTHOR">AUTHOR</a><li><a href="#COPYRIGHT">COPYRIGHT</a></ul><a name="SYNOPSIS"></a><h1>SYNOPSIS</h1>

<pre class="verbatim"> <a class="l_k" href="../functions/use.html">use</a> <a class="l_w" href="../Locale/Country.html">Locale::Country</a>;

$country = code2country('jp'); # $country gets 'Japan'

$code = country2code('Norway'); # $code gets 'no'

@codes = all_country_codes();

@names = all_country_names();

# semi-private routines

<pre class="verbatim"> <a class="l_k" href="../functions/use.html">use</a> Locale::Country;</pre>

<pre class="verbatim"> $country = code2country('jp'); # $country gets 'Japan'

<pre class="verbatim"> @codes = all_country_codes();

@names = all_country_names();</pre>

<pre class="verbatim"> # semi-private routines

Locale::Country::alias_code('uk' => 'gb');

Locale::Country::rename_country('gb' => 'Great Britain');</pre>

<a name="DESCRIPTION"></a><h1>DESCRIPTION</h1>

The <code class="inline"><a class="l_w" href="../Locale/Country.html">Locale::Country</a></code> module provides access to the ISO

The <code class="inline">Locale::Country</code>

module provides access to the ISO

codes for identifying countries, as defined in ISO 3166-1.

100

You can either access the codes via the <a href="#conversion-routines">"conversion routines"</a>

100

101

(described below), or with the two functions which return lists

104

105

<ul>

105

106

<li><a name="*alpha-2*"></a>alpha-2

106

107

Two letter codes, such as 'tv' for Tuvalu.

107

This code set is identified with the symbol <code class="inline">LOCALE_CODE_ALPHA_2</code>

108

This code set is identified with the symbol <code class="inline">LOCALE_CODE_ALPHA_2</code>

108

109

.

109

110

</li>

110

111

<li><a name="*alpha-3*"></a>alpha-3

111

112

Three letter codes, such as 'brb' for Barbados.

112

This code set is identified with the symbol <code class="inline">LOCALE_CODE_ALPHA_3</code>

113

This code set is identified with the symbol <code class="inline">LOCALE_CODE_ALPHA_3</code>

113

114

.

114

115

</li>

115

116

<li><a name="*numeric*"></a>numeric

116

117

Numeric codes, such as 064 for Bhutan.

117

This code set is identified with the symbol <code class="inline">LOCALE_CODE_NUMERIC</code>

118

This code set is identified with the symbol <code class="inline">LOCALE_CODE_NUMERIC</code>

118

119

.

119

120

</li>

120

121

</ul>

133

134

is "us", so country2code('United States') returns 'us'.

134

135

Now the following will also return 'us':

135

136

<pre class="verbatim"> country2code('United States of America')

136

country2code('USA') </pre><a name="CONVERSION-ROUTINES"></a><h1>CONVERSION ROUTINES</h1>

137

country2code('USA')</pre><a name="CONVERSION-ROUTINES"></a><h1>CONVERSION ROUTINES</h1>

137

138

There are three conversion routines: <code class="inline">code2country()</code>

138

139

, <code class="inline">country2code()</code>

139

140

152

153

country code, if such exists.

153

154

If the argument could not be identified as a country name,

154

155

then <code class="inline"><a class="l_k" href="../functions/undef.html">undef</a></code> will be returned:

155

<pre class="verbatim"> $code = country2code('Norway', LOCALE_CODE_ALPHA_3);

156

<pre class="verbatim"> $code = country2code('Norway', LOCALE_CODE_ALPHA_3);

156

157

# $code will now be 'nor'</pre>

157

158

The case of the country name is not important.

158

159

See the section <a href="#KNOWN-BUGS-AND-LIMITATIONS">"KNOWN BUGS AND LIMITATIONS"</a> below.

161

162

This function takes a country code from one code set,

162

163

and returns the corresponding code from another code set.

163

164

<pre class="verbatim"> $alpha2 = country_code2code('fin',

164

LOCALE_CODE_ALPHA_3, LOCALE_CODE_ALPHA_2);

165

LOCALE_CODE_ALPHA_3, LOCALE_CODE_ALPHA_2);

165

166

# $alpha2 will now be 'fi'</pre>

166

167

If the code passed is not a valid country code in

167

168

the first code set, or if there isn't a code for the

173

174

There are two function which can be used to obtain a list of all codes,

174

175

or all country names:

175

176

<ul>

176

<li><a name="'all_country_codes(-%5b-CODESET-%5d-)'"></a><code class="inline">all_country_codes( [ CODESET ] )</code>

177

<li><a name="'all_country_codes(-%5b-CODESET-%5d-)'"></a><code class="inline">all_country_codes( [ CODESET ] )</code>

177

178

178

179

Returns a list of all two-letter country codes.

179

180

The codes are guaranteed to be all lower-case,

180

181

and not in any particular order.

181

182

</li>

182

<li><a name="'all_country_names(-%5b-CODESET-%5d-)'"></a><code class="inline">all_country_names( [ CODESET ] )</code>

183

<li><a name="'all_country_names(-%5b-CODESET-%5d-)'"></a><code class="inline">all_country_names( [ CODESET ] )</code>

183

184

184

185

Returns a list of all country names for which there is a corresponding

185

186

country code in the specified code set.

198

199

package name.

199

200

<a name="alias_code"></a><h2>alias_code</h2>

200

201

Define a new code as an alias for an existing code:

201

<pre class="verbatim"> Locale::Country::alias_code( ALIAS => CODE [, CODESET ] )</pre>

202

<pre class="verbatim"> Locale::Country::alias_code( ALIAS => CODE [, CODESET ] )</pre>

202

203

This feature was added as a mechanism for handling

203

204

a "uk" code. The ISO standard says that the two-letter code for

204

205

"United Kingdom" is "gb", whereas domain names are all .uk.

228

229

function.

229

230

The user is prompted for a country code, and then told the corresponding

230

231

country name:

231

<pre class="verbatim"> $| = 1; # turn off buffering

232

233

<a class="l_k" href="../functions/print.html">print</a> "Enter country code: ";

232

<pre class="verbatim"> $| = 1; # turn off buffering</pre>

233

<pre class="verbatim"> <a class="l_k" href="../functions/print.html">print</a> "Enter country code: ";

234

<a class="l_k" href="../functions/chop.html">chop</a>($code = <STDIN>);

235

$country = code2country($code, LOCALE_CODE_ALPHA_2);

235

$country = code2country($code, LOCALE_CODE_ALPHA_2);

236

if (<a class="l_k" href="../functions/defined.html">defined</a> $country)

237

{

238

<a class="l_k" href="../functions/print.html">print</a> "$code = $country\n";

323

324

</form>

325

326

326

327

<h2>Labels:</h2>

327

328

328

329

Older »