php-doc-en/reference/geoip/functions/geoip-id-by-name.xml
2010-08-03 09:26:49 +00:00

133 lines
2.9 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.geoip-id-by-name" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>geoip_id_by_name</refname>
<refpurpose>Get the Internet connection type</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>geoip_id_by_name</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
</methodsynopsis>
<para>
The <function>geoip_id_by_name</function> function will return the Internet
connection type corresponding to a hostname or an IP address.
</para>
<para>
The return value is numeric and can be compared to the following constants:
</para>
<para>
<itemizedlist>
<listitem>
<simpara>
GEOIP_UNKNOWN_SPEED
</simpara>
</listitem>
<listitem>
<simpara>
GEOIP_DIALUP_SPEED
</simpara>
</listitem>
<listitem>
<simpara>
GEOIP_CABLEDSL_SPEED
</simpara>
</listitem>
<listitem>
<simpara>
GEOIP_CORPORATE_SPEED
</simpara>
</listitem>
</itemizedlist>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>hostname</parameter></term>
<listitem>
<para>
The hostname or IP address whose connection type is to be looked-up.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the connection type.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>geoip_id_by_name</function> example</title>
<para>
This will output the connection type of the host example.com.
</para>
<programlisting role="php">
<![CDATA[
<?php
$netspeed = geoip_id_by_name('www.example.com');
echo 'The connection type is ';
switch ($netspeed) {
case GEOIP_DIALUP_SPEED:
echo 'dial-up';
break;
case GEOIP_CABLEDSL_SPEED:
echo 'cable or DSL';
break;
case GEOIP_CORPORATE_SPEED:
echo 'corporate';
break;
case GEOIP_UNKNOWN_SPEED:
default:
echo 'unknown';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
The connection type is corporate
]]>
</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
-->