geoip-region-name-by-code.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: takagi Status: ready -->
<refentry xml:id="function.geoip-region-name-by-code" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>geoip_region_name_by_code</refname>
  <refpurpose>国コードと地域コードから地域名を返す</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>geoip_region_name_by_code</methodname>
   <methodparam><type>string</type><parameter>country_code</parameter></methodparam>
   <methodparam><type>string</type><parameter>region_code</parameter></methodparam>
  </methodsynopsis>

  <para>
   <function>geoip_region_name_by_code</function> 関数は、
   国コードと地域コードの組み合わせに対応する地域名を返します。
  </para>
  <para>
   アメリカの場合、地域コードは各州の名前を二文字で略したものとなります。
   カナダの場合、地域コードは Canada Post による二文字の州コードに対応します。
  </para>
  <para>
   それ以外の場所では、GeoIP は FIPS 10-4 コードを用いて地域を表します。
   FIPS 10-4 コードの詳細な一覧は
   <link xlink:href="&url.maxmind.fips;">&url.maxmind.fips;</link> で確認できます。
  </para>
  <para>
   この関数は、GeoIP Library バージョン 1.4.1 以降を使っている場合に使用可能です。
   データは直接 GeoIP Library から受け取り、データベースは使用しません。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>country_code</parameter></term>
     <listitem>
      <para>
       二文字の国コード
       (<function>geoip_country_code_by_name</function> を参照ください)。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>region_code</parameter></term>
     <listitem>
      <para>
       二文字 (あるいは二桁) の地域コード
       (<function>geoip_region_by_name</function> を参照ください)。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   成功した場合は地域名、国コードと地域コードの組に対応する地域が見つからなかった場合は
   &false; を返します。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>US/Canada の地域コードを使用した <function>geoip_region_name_by_code</function> の例</title>
    <para>
     これは、国 CA (カナダ)、地域 QC (ケベック) に対応する地域名を表示します。
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$region = geoip_region_name_by_code('CA', 'QC');
if ($region) {
    echo 'Region name for CA/QC is: ' . $region;
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Region name for CA/QC is: Quebec
]]>
    </screen>
   </example>
   <example>
    <title>FIPS コードを使用した <function>geoip_region_name_by_code</function> の例</title>
    <para>
     これは、国 JP (日本)、地域 01 に対応する地域名を表示します。
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$region = geoip_region_name_by_code('JP', '01');
if ($region) {
    echo 'Region name for JP/01 is: ' . $region;
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Region name for JP/01 is: Aichi
]]>
    </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
-->