mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
153 lines
3.3 KiB
XML
153 lines
3.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<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
|
|
-->
|