php-doc-en/reference/geoip/functions/geoip-database-info.xml
Joe Watkins e25450d9dc many bugs
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@328365 c90b9560-bf6c-de11-be94-00142212c4b1
2012-11-15 13:40:31 +00:00

97 lines
2.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.geoip-database-info" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>geoip_database_info</refname>
<refpurpose>Get GeoIP Database information</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>geoip_database_info</methodname>
<methodparam choice="opt"><type>int</type><parameter>database</parameter><initializer>GEOIP_COUNTRY_EDITION</initializer></methodparam>
</methodsynopsis>
<para>
The <function>geoip_database_info</function> function returns the corresponding
GeoIP Database version as it is defined inside the binary file.
</para>
<para>
If this function is called without arguments, it returns the version
of the GeoIP Free Country Edition.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>database</parameter></term>
<listitem>
<para>
The database type as an integer. You can use the
<link linkend="geoip.constants">various constants</link> defined with
this extension (ie: GEOIP_*_EDITION).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the corresponding database version, or &null; on error.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>geoip_database_info</function> example</title>
<para>
This will output information regarding the database.
</para>
<programlisting role="php">
<![CDATA[
<?php
print geoip_database_info(GEOIP_COUNTRY_EDITION);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
GEO-106FREE 20060801 Build 1 Copyright (c) 2006 MaxMind LLC All Rights Reserved
]]>
</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
-->