geoip-region-name-by-code.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 4754397753fd79f1c846868b66a2448babab1c54 Maintainer: aur Status: ready -->
<!-- Reviewed: no -->
<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>
   В США код региона соответствует двухбуквенному сокращению каждому штату.
   В Канаде код региона соответствует двухбуквенному сокращению имени провинции или
   территории, присвоенный почтовой службой Канады.
  </para>
  <para>
   Для остального мира GeoIP использует коды FIPS 10-4 для представления региона.
   Смотрите также <link xlink:href="&url.maxmind.fips;">&url.maxmind.fips;</link>
   -- детальный список кодов FIPS 10-4.
  </para>
  <para>
   Данная функция всегда доступна при использовании библиотеки GeoIP версии 1.4.1 и новее.
   Данные берутся непосредственно из библиотеки GeoIP, а не из какой-либо базы.
  </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>Пример использования <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 'Название региона для CA/QC: ' . $region;
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Название региона для CA/QC: Quebec
]]>
    </screen>
   </example>
   <example>
    <title>Пример использования <function>geoip_region_name_by_code</function>, используя коды FIPS</title>
    <para>
     Будет выведено имя региона для страны JP (Япония), региона 01 (префектура Айти).
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$region = geoip_region_name_by_code('JP', '01');
if ($region) {
    echo 'Название региона для JP/01: ' . $region;
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Название региона для JP/01: 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
-->