<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.geoip-db-avail" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>geoip_db_avail</refname>
  <refpurpose>Determine if GeoIP Database is available</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>geoip_db_avail</methodname>
   <methodparam><type>int</type><parameter>database</parameter></methodparam>
  </methodsynopsis>

  <para>
   The <function>geoip_db_avail</function> function returns if the corresponding
   GeoIP Database is available and can be opened on disk.
  </para>

  <para>
   It does not indicate if the file is a proper database, only if it is readable.
  </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 &true; is database exists, &false; if not found, or &null; on error.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>geoip_db_avail</function> example</title>
    <para>
     This will output the current database version string.
    </para>
    <programlisting role="php">
<![CDATA[
<?php

if (geoip_db_avail(GEOIP_COUNTRY_EDITION))
    print geoip_database_info(GEOIP_COUNTRY_EDITION);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
GEO-106FREE 20080801 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
-->