<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Get textual country representation</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="gender-gender.construct.html">Gender\Gender::__construct</a></div>
<div class="next" style="text-align: right; float: right;"><a href="gender-gender.get.html">Gender\Gender::get</a></div>
<div class="up"><a href="class.gender.html">Gender\Gender</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="gender-gender.country" class="refentry">
<div class="refnamediv">
<h1 class="refname">Gender\Gender::country</h1>
<p class="verinfo">(PECL gender >= 0.8.0)</p><p class="refpurpose"><span class="refname">Gender\Gender::country</span> — <span class="dc-title">Get textual country representation</span></p>
</div>
<div class="refsect1 description" id="refsect1-gender-gender.country-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><strong>Gender\Gender::country</strong></span>
( <span class="methodparam"><span class="type">integer</span> <code class="parameter">$country</code></span>
)</div>
<p class="para rdfs-comment">
Returns the textual representation of a country from a Gender class
constant.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-gender-gender.country-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">country</code></em></span>
<dd>
<p class="para">
A country ID specified by a <a href="class.gender.html" class="classname">Gender\Gender</a> class
constant.
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-gender-gender.country-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an array with the short and full names of the country on success
or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-gender-gender.country-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2471">
<p><strong>Example #1 Using <span class="methodname"><strong>Gender\Gender::country()</strong></span></strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
$gender = new Gender\Gender;<br />var_dump($gender->country(Gender\Gender::BRITAIN));</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
array(2) {
'country_short' =>
string(2) "UK"
'country' =>
string(13) "Great Britain"
}
</pre></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="gender-gender.construct.html">Gender\Gender::__construct</a></div>
<div class="next" style="text-align: right; float: right;"><a href="gender-gender.get.html">Gender\Gender::get</a></div>
<div class="up"><a href="class.gender.html">Gender\Gender</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
