GeoIP2-php/doc/v2.1.0/class-GeoIp2.Record.Postal.html
2014-10-29 10:12:11 -07:00

225 lines
5.2 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class GeoIp2\Record\Postal | GeoIP2 PHP API v2.1.0</title>
<link rel="stylesheet" href="resources/style.css?1648332946">
</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><a href="namespace-GeoIp2.Model.html">Model</a>
</li>
<li class="active"><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.Record.AbstractPlaceRecord.html">AbstractPlaceRecord</a></li>
<li><a href="class-GeoIp2.Record.AbstractRecord.html">AbstractRecord</a></li>
<li><a href="class-GeoIp2.Record.City.html">City</a></li>
<li><a href="class-GeoIp2.Record.Continent.html">Continent</a></li>
<li><a href="class-GeoIp2.Record.Country.html">Country</a></li>
<li><a href="class-GeoIp2.Record.Location.html">Location</a></li>
<li><a href="class-GeoIp2.Record.MaxMind.html">MaxMind</a></li>
<li class="active"><a href="class-GeoIp2.Record.Postal.html">Postal</a></li>
<li><a href="class-GeoIp2.Record.RepresentedCountry.html">RepresentedCountry</a></li>
<li><a href="class-GeoIp2.Record.Subdivision.html">Subdivision</a></li>
<li><a href="class-GeoIp2.Record.Traits.html">Traits</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" placeholder="Search">
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-GeoIp2.Record.html" title="Summary of GeoIp2\Record"><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>
</ul>
</div>
<div id="content" class="class">
<h1>Class Postal</h1>
<div class="description">
<p>Contains data for the postal record associated with an IP address</p>
<p>This record is returned by all the end points except the Country end point.</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-GeoIp2.Record.AbstractRecord.html"><span>GeoIp2\Record\AbstractRecord</span></a>
implements
<a href="class-JsonSerializable.html"><span>JsonSerializable</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by">
<b><span>GeoIp2\Record\Postal</span></b>
</dd>
</dl>
<div class="info">
<b>Namespace:</b> GeoIp2\Record<br>
<b>Located at</b> <a href="source-class-GeoIp2.Record.Postal.html#5-25" title="Go to source code">GeoIp2/Record/Postal.php</a><br>
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-GeoIp2.Record.AbstractRecord.html#methods">GeoIp2\Record\AbstractRecord</a></caption>
<tr>
<td><code>
<a href="class-GeoIp2.Record.AbstractRecord.html#___isset">__isset()</a>,
<a href="class-GeoIp2.Record.AbstractRecord.html#_jsonSerialize">jsonSerialize()</a>
</code></td>
</tr>
</table>
<table class="summary properties" id="magicProperties">
<caption>Magic properties summary</caption>
<tr data-order="code" id="m$code">
<td class="attributes"><code>
public
string
</code></td>
<td class="name">
<a href="source-class-GeoIp2.Record.Postal.html#10-13" title="Go to source code"><var>$code</var></a>
<div class="description short">
<p>The postal code of the location. Postal codes are not available for all countries. In some countries, this will only contain part of the postal code. This attribute is returned by all end points except the Country end point.</p>
</div>
<div class="description detailed hidden">
</div>
</td>
</tr>
<tr data-order="confidence" id="m$confidence">
<td class="attributes"><code>
public
integer
</code></td>
<td class="name">
<a href="source-class-GeoIp2.Record.Postal.html#15-17" title="Go to source code"><var>$confidence</var></a>
<div class="description short">
<p>A value from 0-100 indicating MaxMind's confidence that the postal code is correct. This attribute is only available from the Insights end point.</p>
</div>
<div class="description detailed hidden">
</div>
</td>
</tr>
</table>
</div>
<div id="footer">
GeoIP2 PHP API v2.1.0 API documentation generated by <a href="http://apigen.org">ApiGen</a>
</div>
</div>
</div>
<script src="resources/combined.js?721046668"></script>
<script src="elementlist.js?1983305385"></script>
</body>
</html>