php-doc-en/reference/geoip/functions/geoip-setup-custom-directory.xml
2018-01-25 15:34:22 +00:00

94 lines
2.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.geoip-setup-custom-directory" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>geoip_setup_custom_directory</refname>
<refpurpose>Set a custom directory for the GeoIP database</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>geoip_setup_custom_directory</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
</methodsynopsis>
<para>
The <function>geoip_setup_custom_directory</function> function will change the
default directory of the GeoIP database. This is equivalent to changing
<link linkend="ini.geoip.custom-directory">geoip.custom_directory</link>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
The full path of where the GeoIP database is on disk.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>geoip_setup_custom_directory</function> example</title>
<para>
This will change the GeoIP default database path.
</para>
<programlisting role="php">
<![CDATA[
<?php
geoip_setup_custom_directory('/some/other/path');
print geoip_db_filename(GEOIP_COUNTRY_EDITION);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
/some/other/path/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:"~/.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
-->