File: geoip-id-by-name.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (133 lines) | stat: -rw-r--r-- 2,946 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<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 speed</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 country
   and region 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 net speed is to be looked-up.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the net speed.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>geoip_id_by_name</function> example</title>
    <para>
     This will output the net speed 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
-->