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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.geoip-db-get-all-info" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>geoip_db_get_all_info</refname>
<refpurpose>Returns detailed information about all GeoIP database types</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>geoip_db_get_all_info</methodname>
<void />
</methodsynopsis>
<para>
The <function>geoip_db_get_all_info</function> function will return
detailed information as a multi-dimensional array about all the
GeoIP database types.
</para>
<para>
This function is available even if no databases are installed. It
will simply list them as non-available.
</para>
<para>
The names of the different keys of the returning associative array are as follows:
</para>
<para>
<itemizedlist>
<listitem>
<simpara>
"available" -- Boolean, indicate if DB is available (see
<function>geoip_db_avail</function>)
</simpara>
</listitem>
<listitem>
<simpara>
"description" -- The database description
</simpara>
</listitem>
<listitem>
<simpara>
"filename" -- The database filename on disk (see
<function>geoip_db_filename</function>)
</simpara>
</listitem>
</itemizedlist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the associative array.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>geoip_db_get_all_info</function> example</title>
<para>
This will print the array containing all the information.
</para>
<programlisting role="php">
<![CDATA[
<?php
$infos = geoip_db_get_all_info();
if (is_array($infos)) {
var_dump($infos);
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(11) {
[1]=>
array(3) {
["available"]=>
bool(true)
["description"]=>
string(21) "GeoIP Country Edition"
["filename"]=>
string(32) "/usr/share/GeoIP/GeoIP.dat"
}
[ ... ]
[11]=>
array(3) {
["available"]=>
bool(false)
["description"]=>
string(25) "GeoIP Domain Name Edition"
["filename"]=>
string(38) "/usr/share/GeoIP/GeoIPDomain.dat"
}
}
]]>
</screen>
</example>
</para>
<para>
<example>
<title>A <function>geoip_db_get_all_info</function> example</title>
<para>
You can use the various constants as keys to get only parts of the information.
</para>
<programlisting role="php">
<![CDATA[
<?php
$infos = geoip_db_get_all_info();
if ($infos[GEOIP_COUNTRY_EDITION]['available']) {
echo $infos[GEOIP_COUNTRY_EDITION]['description'];
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
GeoIP Country Edition
]]>
</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
-->
|
