GeoIP2-php/doc/v0.6.1/class-GeoIp2.Model.Country.html
2014-05-03 09:22:09 -07:00

379 lines
9.2 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class GeoIp2\Model\Country | GeoIP2 PHP API v0.6.1</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?1800964632"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-GeoIp2.html">GeoIp2<span></span></a>
<ul>
<li><a href="namespace-GeoIp2.Database.html">Database</a>
</li>
<li><a href="namespace-GeoIp2.Exception.html">Exception</a>
</li>
<li class="active"><a href="namespace-GeoIp2.Model.html">Model</a>
</li>
<li><a href="namespace-GeoIp2.Record.html">Record</a>
</li>
<li><a href="namespace-GeoIp2.WebService.html">WebService</a>
</li>
</ul></li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-GeoIp2.Model.City.html">City</a></li>
<li><a href="class-GeoIp2.Model.CityIspOrg.html">CityIspOrg</a></li>
<li class="active"><a href="class-GeoIp2.Model.Country.html">Country</a></li>
<li><a href="class-GeoIp2.Model.Omni.html">Omni</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-GeoIp2.Model.html" title="Summary of GeoIp2\Model"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
<li>
<a href="geoip2-php-api-v0-6-1-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
</li>
</ul>
</div>
<div id="content" class="class">
<h1>Class Country</h1>
<div class="description">
<p>This class provides a model for the data returned by the GeoIP2 Country end
point.</p>
<p>The only difference between the City, City/ISP/Org, and Omni model classes is
which fields in each record may be populated. See <a
href="http://dev.maxmind.com/geoip/geoip2/web-services">http://dev.maxmind.com/geoip/geoip2/web-services</a>
more details.</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<b><span>GeoIp2\Model\Country</span></b>
implements
<a href="class-JsonSerializable.html"><span>JsonSerializable</span></a>
</dd>
</dl>
<div>
<h4>Direct known subclasses</h4>
<a href="class-GeoIp2.Model.City.html">GeoIp2\Model\City</a>
</div>
<div>
<h4>Indirect known subclasses</h4>
<a href="class-GeoIp2.Model.CityIspOrg.html">GeoIp2\Model\CityIspOrg</a>,
<a href="class-GeoIp2.Model.Omni.html">GeoIp2\Model\Omni</a>
</div>
<div class="info">
<b>Namespace:</b> <a href="namespace-GeoIp2.html">GeoIp2</a>\<a href="namespace-GeoIp2.Model.html">Model</a><br />
<b>Located at</b> <a href="source-class-GeoIp2.Model.Country.html#5-108" title="Go to source code">GeoIp2/Model/Country.php</a><br />
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="jsonSerialize" id="_jsonSerialize">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_jsonSerialize">#</a>
<code><a href="source-class-GeoIp2.Model.Country.html#104-107" title="Go to source code">jsonSerialize</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
<h4>Implementation of</h4>
<div class="list"><code><a href="class-JsonSerializable.html#_jsonSerialize">JsonSerializable::jsonSerialize()</a></code></div>
</div>
</div></td>
</tr>
</table>
<table class="summary" id="magicProperties">
<caption>Magic properties summary</caption>
<tr data-order="continent" id="m$continent">
<td class="attributes"><code>
public
<code><a href="class-GeoIp2.Record.Continent.html">GeoIp2\Record\Continent</a></code>
</code></td>
<td class="name">
<a href="source-class-GeoIp2.Model.Country.html#13-14" title="Go to source code"><var>$continent</var></a>
</td>
<td class="description"><div>
<a href="#m$continent" class="anchor">#</a>
<div class="description short">
<p>Continent data for the requested IP address.</p>
</div>
<div class="description detailed hidden">
<p>Continent data for the requested IP address.</p>
</div>
</div></td>
</tr>
<tr data-order="country" id="m$country">
<td class="attributes"><code>
public
<code><a href="class-GeoIp2.Record.Country.html">GeoIp2\Record\Country</a></code>
</code></td>
<td class="name">
<a href="source-class-GeoIp2.Model.Country.html#16-18" title="Go to source code"><var>$country</var></a>
</td>
<td class="description"><div>
<a href="#m$country" class="anchor">#</a>
<div class="description short">
<p>Country data for the requested IP address. This object represents the country
where MaxMind believes the end user is located.</p>
</div>
<div class="description detailed hidden">
<p>Country data for the requested IP address. This object represents the country
where MaxMind believes the end user is located.</p>
</div>
</div></td>
</tr>
<tr data-order="maxmind" id="m$maxmind">
<td class="attributes"><code>
public
<code><a href="class-GeoIp2.Record.MaxMind.html">GeoIp2\Record\MaxMind</a></code>
</code></td>
<td class="name">
<a href="source-class-GeoIp2.Model.Country.html#20-21" title="Go to source code"><var>$maxmind</var></a>
</td>
<td class="description"><div>
<a href="#m$maxmind" class="anchor">#</a>
<div class="description short">
<p>Data related to your MaxMind account.</p>
</div>
<div class="description detailed hidden">
<p>Data related to your MaxMind account.</p>
</div>
</div></td>
</tr>
<tr data-order="registeredCountry" id="m$registeredCountry">
<td class="attributes"><code>
public
<code><a href="class-GeoIp2.Record.Country.html">GeoIp2\Record\Country</a></code>
</code></td>
<td class="name">
<a href="source-class-GeoIp2.Model.Country.html#23-26" title="Go to source code"><var>$registeredCountry</var></a>
</td>
<td class="description"><div>
<a href="#m$registeredCountry" class="anchor">#</a>
<div class="description short">
<p>Registered country data for the requested IP address. This record represents
the country where the ISP has registered a given IP block and may differ from
the user's country.</p>
</div>
<div class="description detailed hidden">
<p>Registered country data for the requested IP address. This record represents
the country where the ISP has registered a given IP block and may differ from
the user's country.</p>
</div>
</div></td>
</tr>
<tr data-order="representedCountry" id="m$representedCountry">
<td class="attributes"><code>
public
<code><a href="class-GeoIp2.Record.RepresentedCountry.html">GeoIp2\Record\RepresentedCountry</a></code>
</code></td>
<td class="name">
<a href="source-class-GeoIp2.Model.Country.html#28-31" title="Go to source code"><var>$representedCountry</var></a>
</td>
<td class="description"><div>
<a href="#m$representedCountry" class="anchor">#</a>
<div class="description short">
<p>Represented country data for the requested IP address. The represented
country is used for things like military bases or embassies. It is only present
when the represented country differs from the country.</p>
</div>
<div class="description detailed hidden">
<p>Represented country data for the requested IP address. The represented
country is used for things like military bases or embassies. It is only present
when the represented country differs from the country.</p>
</div>
</div></td>
</tr>
<tr data-order="traits" id="m$traits">
<td class="attributes"><code>
public
<code><a href="class-GeoIp2.Record.Traits.html">GeoIp2\Record\Traits</a></code>
</code></td>
<td class="name">
<a href="source-class-GeoIp2.Model.Country.html#33-34" title="Go to source code"><var>$traits</var></a>
</td>
<td class="description"><div>
<a href="#m$traits" class="anchor">#</a>
<div class="description short">
<p>Data for the traits of the requested IP address.</p>
</div>
<div class="description detailed hidden">
<p>Data for the traits of the requested IP address.</p>
</div>
</div></td>
</tr>
</table>
</div>
<div id="footer">
GeoIP2 PHP API v0.6.1 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>