File: geoip-continent-code-by-name.xml

package info (click to toggle)
php-doc 20241205~git.dfcbb86%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 70,956 kB
  • sloc: xml: 968,269; php: 23,883; javascript: 671; sh: 177; makefile: 37
file content (143 lines) | stat: -rw-r--r-- 3,406 bytes parent folder | download | duplicates (2)
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
134
135
136
137
138
139
140
141
142
143
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.geoip-continent-code-by-name" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>geoip_continent_code_by_name</refname>
  <refpurpose>Get the two letter continent code</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>geoip_continent_code_by_name</methodname>
   <methodparam><type>string</type><parameter>hostname</parameter></methodparam>
  </methodsynopsis>

  <para>
   The <function>geoip_continent_code_by_name</function> function will return
   the two letter continent code corresponding to a hostname or an IP address.
  </para>

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>hostname</parameter></term>
     <listitem>
      <para>
       The hostname or IP address whose location is to be looked-up.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the two letter continent code on success, or &false; if the
   address cannot be found in the database.
  </para>
  <table>
   <title>Continent codes</title>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>Code</entry>
      <entry>Continent name</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry><literal>AF</literal></entry>
      <entry>Africa</entry>
     </row>
     <row>
      <entry><literal>AN</literal></entry>
      <entry>Antarctica</entry>
     </row>
     <row>
      <entry><literal>AS</literal></entry>
      <entry>Asia</entry>
     </row>
     <row>
      <entry><literal>EU</literal></entry>
      <entry>Europe</entry>
     </row>
     <row>
      <entry><literal>NA</literal></entry>
      <entry>North america</entry>
     </row>
     <row>
      <entry><literal>OC</literal></entry>
      <entry>Oceania</entry>
     </row>
     <row>
      <entry><literal>SA</literal></entry>
      <entry>South america</entry>
     </row>
    </tbody>
   </tgroup>
  </table>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>geoip_continent_code_by_name</function> example</title>
    <para>
     This will print where the host example.com is located.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$continent = geoip_continent_code_by_name('www.example.com');
if ($continent) {
    echo 'This host is located in: ' . $continent;
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
 This host is located in: NA
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>geoip_country_code_by_name</function></member>
   </simplelist>
  </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
-->