1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.geoip-region-by-name" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>geoip_region_by_name</refname>
<refpurpose>Get the country code and region</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>geoip_region_by_name</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
</methodsynopsis>
<para>
The <function>geoip_region_by_name</function> function will return the country
and region corresponding to a hostname or an IP address.
</para>
<para>
This function is currently only available to users who have bought a commercial
GeoIP Region Edition. A warning will be issued if the proper database cannot be
located.
</para>
<para>
The names of the different keys of the returning associative array are as follows:
</para>
<para>
<itemizedlist>
<listitem>
<simpara>
"country_code" -- Two letter country code (see
<function>geoip_country_code_by_name</function>)
</simpara>
</listitem>
<listitem>
<simpara>
"region" -- The region code (ex: CA for California)
</simpara>
</listitem>
</itemizedlist>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>hostname</parameter></term>
<listitem>
<para>
The hostname or IP address whose region is to be looked-up.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the associative array on success, or &false; if the address
cannot be found in the database.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>geoip_region_by_name</function> example</title>
<para>
This will print the array containing the country code and region
of the host example.com.
</para>
<programlisting role="php">
<![CDATA[
<?php
$region = geoip_region_by_name('www.example.com');
if ($region) {
print_r($region);
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Array
(
[country_code] => US
[region] => CA
)
]]>
</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
-->
|
