php-doc-en/reference/geoip/functions/geoip-domain-by-name.xml
Christoph Michael Becker 4754397753 Revert revision 351727 from phpdoc/en/trunk:
Document false and null return types

Cf. <https://news-web.php.net/php.doc.cvs/17645>.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351729 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-28 17:58:32 +00:00

100 lines
2.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.geoip-domain-by-name" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>geoip_domain_by_name</refname>
<refpurpose>Get the second level domain name</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>geoip_domain_by_name</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
</methodsynopsis>
<para>
The <function>geoip_domain_by_name</function> function will return the second level
domain names associated with a hostname or an IP address.
</para>
<para>
This function is currently only available to users who have bought a commercial
GeoIP Domain Edition. A warning will be issued if the proper database cannot be
located.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>hostname</parameter></term>
<listitem>
<para>
The hostname or IP address.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the domain name 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_domain_by_name</function> example</title>
<para>
This will output the domain associated with IP 61.106.139.1.
</para>
<programlisting role="php">
<![CDATA[
<?php
$domain = geoip_domain_by_name('61.106.139.1');
if ($domain) {
echo 'The domain is: '. $domain;
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
The domain is: von.co.kr
]]>
</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
-->