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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.geoip-record-by-name" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>geoip_record_by_name</refname>
<refpurpose>Returns the detailed City information found in the GeoIP Database</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>geoip_record_by_name</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
</methodsynopsis>
<para>
The <function>geoip_record_by_name</function> function will return the
record information corresponding to a hostname or an IP address.
</para>
<para>
This function is available for both GeoLite City Edition and commercial GeoIP
City 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>
"continent_code" -- Two letter continent code (as of version 1.0.4 with
libgeoip 1.4.3 or newer)
</simpara>
</listitem>
<listitem>
<simpara>
"country_code" -- Two letter country code (see
<function>geoip_country_code_by_name</function>)
</simpara>
</listitem>
<listitem>
<simpara>
"country_code3" -- Three letter country code (see
<function>geoip_country_code3_by_name</function>)
</simpara>
</listitem>
<listitem>
<simpara>
"country_name" -- The country name (see
<function>geoip_country_name_by_name</function>)
</simpara>
</listitem>
<listitem>
<simpara>
"region" -- The region code (ex: CA for California)
</simpara>
</listitem>
<listitem>
<simpara>
"city" -- The city.
</simpara>
</listitem>
<listitem>
<simpara>
"postal_code" -- The Postal Code, FSA or Zip Code.
</simpara>
</listitem>
<listitem>
<simpara>
"latitude" -- The Latitude as signed <type>float</type>.
</simpara>
</listitem>
<listitem>
<simpara>
"longitude" -- The Longitude as signed <type>float</type>.
</simpara>
</listitem>
<listitem>
<simpara>
"dma_code" -- Designated Market Area code (USA and Canada only)
</simpara>
</listitem>
<listitem>
<simpara>
"area_code" -- The PSTN area code (ex: 212)
</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 record 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="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>PECL geoip 1.0.4</entry>
<entry>
Adding the continent_code with GeoIP Library 1.4.3 or newer only
</entry>
</row>
<row>
<entry>PECL geoip 1.0.3</entry>
<entry>
Adding country_code3 and country_name
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>geoip_record_by_name</function> example</title>
<para>
This will print the array containing the record of host example.com.
</para>
<programlisting role="php">
<![CDATA[
<?php
$record = geoip_record_by_name('www.example.com');
if ($record) {
print_r($record);
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Array
(
[continent_code] => NA
[country_code] => US
[country_code3] => USA
[country_name] => United States
[region] => CA
[city] => Marina Del Rey
[postal_code] =>
[latitude] => 33.9776992798
[longitude] => -118.435096741
[dma_code] => 803
[area_code] => 310
)
]]>
</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
-->
|
