php-doc-en/reference/geoip/functions/geoip-record-by-name.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.geoip-record-by-name" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>geoip_record_by_name</refname>
  <refpurpose>Returns the detailed City information found in the GeoIP Database</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>geoip_record_by_name</methodname>
   <methodparam><type>string</type><parameter>hostname</parameter></methodparam>
  </methodsynopsis>

  <para>
   The <function>geoip_record_by_name</function> function will return the
   record information corresponding to a hostname or an IP address.
  </para>
  <para>
   This function is available for both GeoLite City Edition and commercial GeoIP
   City Edition. A warning will be issued if the proper database cannot be
   located.
  </para>
  <para>
   The names of the different keys of the returning associative array are as follows:
  </para>
  <para>
   <itemizedlist>
    <listitem>
     <simpara>
      "continent_code" -- Two letter continent code (as of version 1.0.4 with 
      libgeoip 1.4.3 or newer)
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "country_code" -- Two letter country code (see
      <function>geoip_country_code_by_name</function>)
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "country_code3" -- Three letter country code (see
      <function>geoip_country_code3_by_name</function>)
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "country_name" -- The country name (see
      <function>geoip_country_name_by_name</function>)
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "region" -- The region code (ex: CA for California)
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "city" -- The city.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "postal_code" -- The Postal Code, FSA or Zip Code.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "latitude" -- The Latitude as signed double.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "longitude" -- The Longitude as signed double.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "dma_code" -- Designated Market Area code (USA and Canada only)
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "area_code" -- The PSTN area code (ex: 212)
     </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 record is to be looked-up.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the associative array on success, or &false; if the address 
   cannot be found in the database.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>PECL geoip 1.0.4</entry>
       <entry>
        Adding the continent_code with GeoIP Library 1.4.3 or newer only
       </entry>
      </row>
      <row>
       <entry>PECL geoip 1.0.3</entry>
       <entry>
        Adding country_code3 and country_name
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>geoip_record_by_name</function> example</title>
    <para>
     This will print the array containing the record of host example.com.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$record = geoip_record_by_name('www.example.com');
if ($record) {
    print_r($record);
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Array
(
    [continent_code] => NA
    [country_code] => US
    [country_code3] => USA
    [country_name] => United States
    [region] => CA
    [city] => Marina Del Rey
    [postal_code] => 
    [latitude] => 33.9776992798
    [longitude] => -118.435096741
    [dma_code] => 803
    [area_code] => 310
)
]]>
    </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
-->