geoip-db-get-all-info.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: cbac1ecf71d754707d69bdc344c4031c157eaa54 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="function.geoip-db-get-all-info" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>geoip_db_get_all_info</refname>
  <refpurpose>Retourne des informations détaillées sur tous les types de bases de données GeoIP</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>geoip_db_get_all_info</methodname>
   <void />
  </methodsynopsis>

  <para>
   La fonction <function>geoip_db_get_all_info</function> retourne des informations
   détaillées, sous la forme d'un tableau multidimensionnel, sur
   tous les types de bases de données GeoIP.
  </para>
  <para>
   Cette fonction est disponible même si aucune base de données n'est installée.
   Elle listera simplement les bases de données comme étant non disponibles.
  </para>
  <para>
   Les noms des différentes clés du tableau associatif retourné, sont les suivantes :
  </para>
  <para>
   <itemizedlist>
    <listitem>
     <simpara>
      <literal>"available"</literal> : Booléen, indique si la base de données est disponible (voir la fonction
      <function>geoip_db_avail</function>)
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>"description"</literal> : La description de la base de données
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>"filename"</literal> : Le nom du fichier contenant la base de données sur le disque (voir la fonction
      <function>geoip_db_filename</function>)
     </simpara>
    </listitem>
   </itemizedlist>
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne un tableau associatif.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>geoip_db_get_all_info</function></title>
    <para>
     Ceci affichera un tableau contenant toutes les informations.
    </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>Exemple avec <function>geoip_db_get_all_info</function></title>
    <para>
     Vous pouvez utiliser diverses constantes comme clés, pour récupérer uniquement
     des parties d'informations.
    </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
-->