mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
Documentation for new GeoIP functions
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@271778 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Olivier Hill
parent
df568acad3
commit
43a0976de0
3 changed files with 281 additions and 1 deletions
139
reference/geoip/functions/geoip-region-name-by-code.xml
Normal file
139
reference/geoip/functions/geoip-region-name-by-code.xml
Normal file
|
|
@ -0,0 +1,139 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<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>Returns the region name for some country and region code combo</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>
|
||||
The <function>geoip_region_name_by_code</function> function will return the region
|
||||
name corresponding to a country and region code combo.
|
||||
</para>
|
||||
<para>
|
||||
In the United States, the region code corresponds to the two-letter abbreviation
|
||||
of each state. In Canada, the region code corresponds to the two-letter province or
|
||||
territory code as attributed by Canada Post.
|
||||
</para>
|
||||
<para>
|
||||
For the rest of the world, GeoIP uses FIPS 10-4 codes to represent regions.
|
||||
You can check <link xlink:href="&url.maxmind.fips;">&url.maxmind.fips;</link>
|
||||
for a detailed list of FIPS 10-4 codes.
|
||||
</para>
|
||||
<para>
|
||||
This function is always available if using GeoIP Library version 1.4.1 or newer. The
|
||||
data is taken directly from the GeoIP Library and not from any database.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>country_code</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The two-letter country code (see
|
||||
<function>geoip_country_code_by_name</function>)
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>region_code</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The two-letter (or digit) region code (see
|
||||
<function>geoip_region_by_name</function>)
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the region name on success, or &false; if the country and region code
|
||||
combo cannot be found.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title>A <function>geoip_region_name_by_code</function> example using region code for US/Canada</title>
|
||||
<para>
|
||||
This will print the region name for country CA (Canada), region QC (Quebec).
|
||||
</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>A <function>geoip_region_name_by_code</function> example using FIPS codes</title>
|
||||
<para>
|
||||
This will print the region name for country JP (Japan), region 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:"../../../../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
|
||||
-->
|
||||
|
|
@ -0,0 +1,139 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<refentry xml:id="function.geoip-time-zone-by-country-and-region" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>geoip_time_zone_by_country_and_region</refname>
|
||||
<refpurpose>Returns the time zone for some country and region code combo</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>geoip_time_zone_by_country_and_region</methodname>
|
||||
<methodparam><type>string</type><parameter>country_code</parameter></methodparam>
|
||||
<methodparam><type>string</type><parameter>region_code</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<para>
|
||||
The <function>geoip_time_zone_by_country_and_region</function> function will return the
|
||||
time zone corresponding to a country and region code combo.
|
||||
</para>
|
||||
<para>
|
||||
In the United States, the region code corresponds to the two-letter abbreviation
|
||||
of each state. In Canada, the region code corresponds to the two-letter province or
|
||||
territory code as attributed by Canada Post.
|
||||
</para>
|
||||
<para>
|
||||
For the rest of the world, GeoIP uses FIPS 10-4 codes to represent regions.
|
||||
You can check <link xlink:href="&url.maxmind.fips;">&url.maxmind.fips;</link>
|
||||
for a detailed list of FIPS 10-4 codes.
|
||||
</para>
|
||||
<para>
|
||||
This function is always available if using GeoIP Library version 1.4.1 or newer. The
|
||||
data is taken directly from the GeoIP Library and not from any database.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>country_code</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The two-letter country code (see
|
||||
<function>geoip_country_code_by_name</function>)
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>region_code</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The two-letter (or digit) region code (see
|
||||
<function>geoip_region_by_name</function>)
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the time zone on success, or &false; if the country and region code
|
||||
combo cannot be found.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title>A <function>geoip_time_zone_by_country_and_region</function> example using region code for US/Canada</title>
|
||||
<para>
|
||||
This will print the time zone for country CA (Canada), region QC (Quebec).
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$timezone = geoip_time_zone_by_country_and_region('CA', 'QC');
|
||||
if ($timezone) {
|
||||
echo 'Time zone for CA/QC is: ' . $timezone;
|
||||
}
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
Time zone for CA/QC is: America/Montreal
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
<example>
|
||||
<title>A <function>geoip_time_zone_by_country_and_region</function> example using FIPS codes</title>
|
||||
<para>
|
||||
This will print the time zone for country JP (Japan), region 01 (Aichi).
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$timezone = geoip_time_zone_by_country_and_region('JP', '01');
|
||||
if ($timezone) {
|
||||
echo 'Time zone for JP/01 is: ' . $timezone;
|
||||
}
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
Time zone for JP/01 is: Asia/Tokyo
|
||||
]]>
|
||||
</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:"../../../../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
|
||||
-->
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='utf-8'?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!--
|
||||
Do NOT translate this file
|
||||
-->
|
||||
|
|
@ -17,6 +17,8 @@
|
|||
<function name='geoip_org_by_name' from='PECL geoip >= 0.2.0'/>
|
||||
<function name='geoip_record_by_name' from='PECL geoip >= 0.2.0'/>
|
||||
<function name='geoip_region_by_name' from='PECL geoip >= 0.2.0'/>
|
||||
<function name='geoip_region_name_by_code' from='PECL geoip >= 1.0.4'/>
|
||||
<function name='geoip_time_zone_by_country_and_region' from='PECL geoip >= 1.0.4'/>
|
||||
</versions>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
|||
Loading…
Reference in a new issue