sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Adding missing documentation for geoip_continent_code_by_name()

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@271606 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Olivier Hill 2008-12-19 14:21:04 +00:00
parent b5d3fb1520
commit 51210b616f
2 changed files with 104 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

102
reference/geoip/functions/geoip-continent-code-by-name.xml Normal file
View file

@ -0,0 +1,102 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<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>
</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:"../../../../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
-->

3
reference/geoip/versions.xml
View file

@ -1,9 +1,10 @@
<?xml version='1.0' encoding='utf-8'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!--
Do NOT translate this file
-->
<versions>
<function name='geoip_continent_code_by_name' from='PECL geoip &gt;= 1.0.3'/>
<function name='geoip_country_code3_by_name' from='PECL geoip &gt;= 0.2.0'/>
<function name='geoip_country_code_by_name' from='PECL geoip &gt;= 0.2.0'/>
<function name='geoip_country_name_by_name' from='PECL geoip &gt;= 0.2.0'/>