cvs: phpdoc /en/reference/geoip/functions geoip-db-avail.xml geoip-db-filename.xml geoip-db-get-all-info.xml

ohill Thu Aug 23 12:52:07 2007 UTC Added files: /phpdoc/en/reference/geoip/functions geoip-db-avail.xml geoip-db-filename.xml geoip-db-get-all-info.xml Log: Documenting new functions found in newer releases

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/geoip/functions/geoip-db-avail.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/geoip/functions/geoip-db-avail.xml +++ phpdoc/en/reference/geoip/functions/geoip-db-avail.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/geoip/functions/geoip-db-filename.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/geoip/functions/geoip-db-filename.xml +++ phpdoc/en/reference/geoip/functions/geoip-db-filename.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="function.geoip-db-filename" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>geoip_db_filename</refname> <refpurpose>Returns the filename of the corresponding GeoIP Database</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>geoip_db_filename</methodname> <methodparam><type>int</type><parameter>database</parameter></methodparam> </methodsynopsis> <para> The <function>geoip_db_filename</function> function returns the filename of the corresponding GeoIP Database. </para> <para> It does not indicate if the file exists or not on disk, only where the library is looking for the database. </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 filename of the corresponding database, 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 print geoip_db_filename(GEOIP_COUNTRY_EDITION); ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ /usr/share/GeoIP/GeoIP.dat ]]> </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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/geoip/functions/geoip-db-get-all-info.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/geoip/functions/geoip-db-get-all-info.xml +++ phpdoc/en/reference/geoip/functions/geoip-db-get-all-info.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <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 informations about all GeoIP database types</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>array</type><methodname>geoip_db_get_all_info</methodname> </methodsynopsis> <para> The <function>geoip_db_get_all_info</function> function will return detailed informations 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 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>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:"../../../../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 -->