country.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b95d28e6ec86e4a71e012737d36ebdc1cf009180 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="gender-gender.country" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>Gender\Gender::country</refname>
  <refpurpose>Récupère la représentation textuelle d'un pays</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>Gender\Gender::country</methodname>
   <methodparam><type>int</type><parameter>country</parameter></methodparam>
  </methodsynopsis>
  <para>
   Récupère la représentation textuelle d'un pays depuis
   la constante de la classe Gender.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>country</parameter></term>
    <listitem>
     <para>
      Identifiant du pays (correspond à une constante de la classe
      <classname>Gender\Gender</classname>).
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne un tableau contenant les noms courts et longs
   du pays en cas de succès &return.falseforfailure;.
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <methodname>Gender\Gender::country</methodname></title>
    <programlisting role="php">
<![CDATA[
$gender = new Gender\Gender;
var_dump($gender->country(Gender\Gender::BRITAIN));
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(2) {
  'country_short' =>
  string(2) "UK"
  'country' =>
  string(13) "Great Britain"
}
]]>
    </screen>
   </example>
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->