Updated for v0.4.0
This commit is contained in:
Gregory Oschwald
parent
171f261684
commit
cbffa448cd
132
doc/v0.4.0/404.html
Normal file
132
doc/v0.4.0/404.html
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
<meta name="robots" content="noindex" />
|
||||
|
||||
<title>Page not found | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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><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.Database.Reader.html">GeoIp2\Database\Reader</a></li>
|
||||
<li><a href="class-GeoIp2.Model.City.html">GeoIp2\Model\City</a></li>
|
||||
<li><a href="class-GeoIp2.Model.CityIspOrg.html">GeoIp2\Model\CityIspOrg</a></li>
|
||||
<li><a href="class-GeoIp2.Model.Country.html">GeoIp2\Model\Country</a></li>
|
||||
<li><a href="class-GeoIp2.Model.Omni.html">GeoIp2\Model\Omni</a></li>
|
||||
<li><a href="class-GeoIp2.Record.AbstractPlaceRecord.html">GeoIp2\Record\AbstractPlaceRecord</a></li>
|
||||
<li><a href="class-GeoIp2.Record.AbstractRecord.html">GeoIp2\Record\AbstractRecord</a></li>
|
||||
<li><a href="class-GeoIp2.Record.City.html">GeoIp2\Record\City</a></li>
|
||||
<li><a href="class-GeoIp2.Record.Continent.html">GeoIp2\Record\Continent</a></li>
|
||||
<li><a href="class-GeoIp2.Record.Country.html">GeoIp2\Record\Country</a></li>
|
||||
<li><a href="class-GeoIp2.Record.Location.html">GeoIp2\Record\Location</a></li>
|
||||
<li><a href="class-GeoIp2.Record.MaxMind.html">GeoIp2\Record\MaxMind</a></li>
|
||||
<li><a href="class-GeoIp2.Record.Postal.html">GeoIp2\Record\Postal</a></li>
|
||||
<li><a href="class-GeoIp2.Record.RepresentedCountry.html">GeoIp2\Record\RepresentedCountry</a></li>
|
||||
<li><a href="class-GeoIp2.Record.Subdivision.html">GeoIp2\Record\Subdivision</a></li>
|
||||
<li><a href="class-GeoIp2.Record.Traits.html">GeoIp2\Record\Traits</a></li>
|
||||
<li><a href="class-GeoIp2.WebService.Client.html">GeoIp2\WebService\Client</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<h3>Exceptions</h3>
|
||||
<ul>
|
||||
<li><a href="class-Exception.html">Exception</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.AddressNotFoundException.html">GeoIp2\Exception\AddressNotFoundException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.AuthenticationException.html">GeoIp2\Exception\AuthenticationException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.GeoIp2Exception.html">GeoIp2\Exception\GeoIp2Exception</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.HttpException.html">GeoIp2\Exception\HttpException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.InvalidRequestException.html">GeoIp2\Exception\InvalidRequestException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.OutOfQueriesException.html">GeoIp2\Exception\OutOfQueriesException</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>
|
||||
<span>Namespace</span> </li>
|
||||
<li>
|
||||
<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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
<h1>Page not found</h1>
|
||||
<p>The requested page could not be found.</p>
|
||||
<p>You have probably clicked on a link that is outdated and points to a page that does not exist any more or you have made an typing error in the address.</p>
|
||||
<p>To continue please try to find requested page in the menu, take a look at <a href="tree.html">the tree view</a> of the whole project or use search field on the top.</p>
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
514
doc/v0.4.0/class-Exception.html
Normal file
514
doc/v0.4.0/class-Exception.html
Normal file
|
|
@ -0,0 +1,514 @@
|
|||
<!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 Exception | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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><a href="namespace-GeoIp2.Record.html">Record</a>
|
||||
</li>
|
||||
<li><a href="namespace-GeoIp2.WebService.html">WebService</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li class="active"><a href="namespace-PHP.html">PHP</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<hr />
|
||||
|
||||
|
||||
<div id="elements">
|
||||
|
||||
|
||||
|
||||
<h3>Exceptions</h3>
|
||||
<ul>
|
||||
<li class="active"><a href="class-Exception.html">Exception</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-PHP.html" title="Summary of PHP"><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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="class">
|
||||
<h1>Class Exception</h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div>
|
||||
<h4>Direct known subclasses</h4>
|
||||
<a href="class-GeoIp2.Exception.GeoIp2Exception.html">GeoIp2\Exception\GeoIp2Exception</a>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<h4>Indirect known subclasses</h4>
|
||||
<a href="class-GeoIp2.Exception.AddressNotFoundException.html">GeoIp2\Exception\AddressNotFoundException</a>,
|
||||
<a href="class-GeoIp2.Exception.AuthenticationException.html">GeoIp2\Exception\AuthenticationException</a>,
|
||||
<a href="class-GeoIp2.Exception.HttpException.html">GeoIp2\Exception\HttpException</a>,
|
||||
<a href="class-GeoIp2.Exception.InvalidRequestException.html">GeoIp2\Exception\InvalidRequestException</a>,
|
||||
<a href="class-GeoIp2.Exception.OutOfQueriesException.html">GeoIp2\Exception\OutOfQueriesException</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="info">
|
||||
|
||||
<b>PHP Extension:</b> <a href="http://php.net/manual" title="Go to PHP documentation">Core</a><br />
|
||||
|
||||
|
||||
|
||||
<b>Documented at</b> <a href="http://php.net/manual/class.exception.php" title="Go to PHP documentation">php.net</a><br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="methods">
|
||||
<caption>Methods summary</caption>
|
||||
<tr data-order="__construct" id="___construct">
|
||||
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
|
||||
|
||||
</code>
|
||||
</td>
|
||||
|
||||
<td class="name"><div>
|
||||
<a class="anchor" href="#___construct">#</a>
|
||||
<code><a href="http://php.net/manual/exception.construct.php" title="Go to PHP documentation">__construct</a>( <span>mixed <var>$message</var></span>, <span>mixed <var>$code</var></span>, <span>mixed <var>$previous</var></span> )</code>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="getMessage" id="_getMessage">
|
||||
|
||||
<td class="attributes"><code>
|
||||
final public
|
||||
|
||||
|
||||
</code>
|
||||
</td>
|
||||
|
||||
<td class="name"><div>
|
||||
<a class="anchor" href="#_getMessage">#</a>
|
||||
<code><a href="http://php.net/manual/exception.getmessage.php" title="Go to PHP documentation">getMessage</a>( )</code>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="getCode" id="_getCode">
|
||||
|
||||
<td class="attributes"><code>
|
||||
final public
|
||||
|
||||
|
||||
</code>
|
||||
</td>
|
||||
|
||||
<td class="name"><div>
|
||||
<a class="anchor" href="#_getCode">#</a>
|
||||
<code><a href="http://php.net/manual/exception.getcode.php" title="Go to PHP documentation">getCode</a>( )</code>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="getFile" id="_getFile">
|
||||
|
||||
<td class="attributes"><code>
|
||||
final public
|
||||
|
||||
|
||||
</code>
|
||||
</td>
|
||||
|
||||
<td class="name"><div>
|
||||
<a class="anchor" href="#_getFile">#</a>
|
||||
<code><a href="http://php.net/manual/exception.getfile.php" title="Go to PHP documentation">getFile</a>( )</code>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="getLine" id="_getLine">
|
||||
|
||||
<td class="attributes"><code>
|
||||
final public
|
||||
|
||||
|
||||
</code>
|
||||
</td>
|
||||
|
||||
<td class="name"><div>
|
||||
<a class="anchor" href="#_getLine">#</a>
|
||||
<code><a href="http://php.net/manual/exception.getline.php" title="Go to PHP documentation">getLine</a>( )</code>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="getTrace" id="_getTrace">
|
||||
|
||||
<td class="attributes"><code>
|
||||
final public
|
||||
|
||||
|
||||
</code>
|
||||
</td>
|
||||
|
||||
<td class="name"><div>
|
||||
<a class="anchor" href="#_getTrace">#</a>
|
||||
<code><a href="http://php.net/manual/exception.gettrace.php" title="Go to PHP documentation">getTrace</a>( )</code>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="getPrevious" id="_getPrevious">
|
||||
|
||||
<td class="attributes"><code>
|
||||
final public
|
||||
|
||||
|
||||
</code>
|
||||
</td>
|
||||
|
||||
<td class="name"><div>
|
||||
<a class="anchor" href="#_getPrevious">#</a>
|
||||
<code><a href="http://php.net/manual/exception.getprevious.php" title="Go to PHP documentation">getPrevious</a>( )</code>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="getTraceAsString" id="_getTraceAsString">
|
||||
|
||||
<td class="attributes"><code>
|
||||
final public
|
||||
|
||||
|
||||
</code>
|
||||
</td>
|
||||
|
||||
<td class="name"><div>
|
||||
<a class="anchor" href="#_getTraceAsString">#</a>
|
||||
<code><a href="http://php.net/manual/exception.gettraceasstring.php" title="Go to PHP documentation">getTraceAsString</a>( )</code>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="__toString" id="___toString">
|
||||
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
|
||||
|
||||
</code>
|
||||
</td>
|
||||
|
||||
<td class="name"><div>
|
||||
<a class="anchor" href="#___toString">#</a>
|
||||
<code><a href="http://php.net/manual/exception.tostring.php" title="Go to PHP documentation">__toString</a>( )</code>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="properties">
|
||||
<caption>Properties summary</caption>
|
||||
<tr data-order="message" id="$message">
|
||||
<td class="attributes"><code>
|
||||
protected
|
||||
string
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="http://php.net/manual/class.exception.php#exception.props.message" title="Go to PHP documentation"><var>$message</var></a>
|
||||
</td>
|
||||
<td class="value"><code><span class="php-quote">''</span></code></td>
|
||||
<td class="description"><div>
|
||||
<a href="#$message" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="code" id="$code">
|
||||
<td class="attributes"><code>
|
||||
protected
|
||||
integer
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="http://php.net/manual/class.exception.php#exception.props.code" title="Go to PHP documentation"><var>$code</var></a>
|
||||
</td>
|
||||
<td class="value"><code><span class="php-num">0</span></code></td>
|
||||
<td class="description"><div>
|
||||
<a href="#$code" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="file" id="$file">
|
||||
<td class="attributes"><code>
|
||||
protected
|
||||
mixed
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="http://php.net/manual/class.exception.php#exception.props.file" title="Go to PHP documentation"><var>$file</var></a>
|
||||
</td>
|
||||
<td class="value"><code></code></td>
|
||||
<td class="description"><div>
|
||||
<a href="#$file" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="line" id="$line">
|
||||
<td class="attributes"><code>
|
||||
protected
|
||||
mixed
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="http://php.net/manual/class.exception.php#exception.props.line" title="Go to PHP documentation"><var>$line</var></a>
|
||||
</td>
|
||||
<td class="value"><code></code></td>
|
||||
<td class="description"><div>
|
||||
<a href="#$line" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
440
doc/v0.4.0/class-GeoIp2.Database.Reader.html
Normal file
440
doc/v0.4.0/class-GeoIp2.Database.Reader.html
Normal file
|
|
@ -0,0 +1,440 @@
|
|||
<!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\Database\Reader | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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 class="active"><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><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 class="active"><a href="class-GeoIp2.Database.Reader.html">Reader</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.Database.html" title="Summary of GeoIp2\Database"><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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="class">
|
||||
<h1>Class Reader</h1>
|
||||
|
||||
|
||||
<div class="description">
|
||||
|
||||
<p>Instances of this class provide a reader for the GeoIP2 database format. IP
|
||||
addresses can be looked up using the <code>country</code> and <code>city</code>
|
||||
methods. We also provide <code>cityIspOrg</code> and <code>omni</code> methods
|
||||
to ease compatibility with the web service client, although we may offer the
|
||||
ability to specify additional databases to replicate these web services in the
|
||||
future (e.g., the ISP/Org database).</p>
|
||||
|
||||
<p><strong>Usage</strong></p>
|
||||
|
||||
<p>The basic API for this class is the same for every database. First, you
|
||||
create a reader object, specifying a file name. You then call the method
|
||||
corresponding to the specific database, passing it the IP address you want to
|
||||
look up.</p>
|
||||
|
||||
<p>If the request succeeds, the method call will return a model class for the
|
||||
method you called. This model in turn contains multiple record classes, each of
|
||||
which represents part of the data returned by the database. If the database does
|
||||
not contain the requested information, the attributes on the record class will
|
||||
have a <code><span class="php-keyword1">null</span></code>
|
||||
value.</p>
|
||||
|
||||
<p>If the address is not in the database, an <code><a href="class-GeoIp2.Exception.AddressNotFoundException.html">GeoIp2\Exception\AddressNotFoundException</a></code> exception will be thrown. If an
|
||||
invalid IP address is passed to one of the methods, a SPL \InvalidArgumentException will be thrown. If the database is corrupt or
|
||||
invalid, a \MaxMind\Db\Reader\InvalidDatabaseException will be
|
||||
thrown.</p>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="info">
|
||||
|
||||
|
||||
<b>Namespace:</b> <a href="namespace-GeoIp2.html">GeoIp2</a>\<a href="namespace-GeoIp2.Database.html">Database</a><br />
|
||||
|
||||
|
||||
<b>Located at</b> <a href="source-class-GeoIp2.Database.Reader.html#12-150" title="Go to source code">GeoIp2/Database/Reader.php</a><br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="methods">
|
||||
<caption>Methods summary</caption>
|
||||
<tr data-order="__construct" id="___construct">
|
||||
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
|
||||
|
||||
</code>
|
||||
</td>
|
||||
|
||||
<td class="name"><div>
|
||||
<a class="anchor" href="#___construct">#</a>
|
||||
<code><a href="source-class-GeoIp2.Database.Reader.html#46-59" title="Go to source code">__construct</a>( <span>string <var>$filename</var></span>, <span>mixed <var>$languages</var> = <span class="php-keyword1">array</span>(<span class="php-quote">'en'</span>) </span> )</code>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>Constructor.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>Constructor.</p>
|
||||
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<div class="list"><dl>
|
||||
<dt><var>$filename</var></dt>
|
||||
<dd><code>string</code><br>$filename The path to the GeoIP2 database file.</dd>
|
||||
<dt><var>$languages</var></dt>
|
||||
<dd></dd>
|
||||
</dl></div>
|
||||
|
||||
|
||||
<h4>Throws</h4>
|
||||
<div class="list">
|
||||
<code>MaxMind\Db\Reader\InvalidDatabaseException</code><br>if the database is corrupt or invalid<br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="city" id="_city">
|
||||
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
<code><a href="class-GeoIp2.Model.City.html">GeoIp2\Model\City</a></code>
|
||||
|
||||
</code>
|
||||
</td>
|
||||
|
||||
<td class="name"><div>
|
||||
<a class="anchor" href="#_city">#</a>
|
||||
<code><a href="source-class-GeoIp2.Database.Reader.html#61-76" title="Go to source code">city</a>( <span>string <var>$ipAddress</var></span> )</code>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>This method returns a GeoIP2 City model.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>This method returns a GeoIP2 City model.</p>
|
||||
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<div class="list"><dl>
|
||||
<dt><var>$ipAddress</var></dt>
|
||||
<dd><code>string</code><br>$ipAddress IPv4 or IPv6 address as a string.</dd>
|
||||
</dl></div>
|
||||
|
||||
<h4>Returns</h4>
|
||||
<div class="list">
|
||||
<code><code><a href="class-GeoIp2.Model.City.html">GeoIp2\Model\City</a></code></code><br />
|
||||
</div>
|
||||
|
||||
<h4>Throws</h4>
|
||||
<div class="list">
|
||||
<code><code><a href="class-GeoIp2.Exception.AddressNotFoundException.html">GeoIp2\Exception\AddressNotFoundException</a></code></code><br>if the address is not in the database.<br />
|
||||
<code>MaxMind\Db\Reader\InvalidDatabaseException</code><br>if the database is corrupt or invalid<br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="country" id="_country">
|
||||
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
<code><a href="class-GeoIp2.Model.Country.html">GeoIp2\Model\Country</a></code>
|
||||
|
||||
</code>
|
||||
</td>
|
||||
|
||||
<td class="name"><div>
|
||||
<a class="anchor" href="#_country">#</a>
|
||||
<code><a href="source-class-GeoIp2.Database.Reader.html#78-93" title="Go to source code">country</a>( <span>string <var>$ipAddress</var></span> )</code>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>This method returns a GeoIP2 Country model.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>This method returns a GeoIP2 Country model.</p>
|
||||
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<div class="list"><dl>
|
||||
<dt><var>$ipAddress</var></dt>
|
||||
<dd><code>string</code><br>$ipAddress IPv4 or IPv6 address as a string.</dd>
|
||||
</dl></div>
|
||||
|
||||
<h4>Returns</h4>
|
||||
<div class="list">
|
||||
<code><code><a href="class-GeoIp2.Model.Country.html">GeoIp2\Model\Country</a></code></code><br />
|
||||
</div>
|
||||
|
||||
<h4>Throws</h4>
|
||||
<div class="list">
|
||||
<code><code><a href="class-GeoIp2.Exception.AddressNotFoundException.html">GeoIp2\Exception\AddressNotFoundException</a></code></code><br>if the address is not in the database.<br />
|
||||
<code>MaxMind\Db\Reader\InvalidDatabaseException</code><br>if the database is corrupt or invalid<br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="cityIspOrg" id="_cityIspOrg">
|
||||
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
<code><a href="class-GeoIp2.Model.CityIspOrg.html">GeoIp2\Model\CityIspOrg</a></code>
|
||||
|
||||
</code>
|
||||
</td>
|
||||
|
||||
<td class="name"><div>
|
||||
<a class="anchor" href="#_cityIspOrg">#</a>
|
||||
<code><a href="source-class-GeoIp2.Database.Reader.html#95-110" title="Go to source code">cityIspOrg</a>( <span>string <var>$ipAddress</var></span> )</code>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>This method returns a GeoIP2 City/ISP/Org model.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>This method returns a GeoIP2 City/ISP/Org model.</p>
|
||||
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<div class="list"><dl>
|
||||
<dt><var>$ipAddress</var></dt>
|
||||
<dd><code>string</code><br>$ipAddress IPv4 or IPv6 address as a string.</dd>
|
||||
</dl></div>
|
||||
|
||||
<h4>Returns</h4>
|
||||
<div class="list">
|
||||
<code><code><a href="class-GeoIp2.Model.CityIspOrg.html">GeoIp2\Model\CityIspOrg</a></code></code><br />
|
||||
</div>
|
||||
|
||||
<h4>Throws</h4>
|
||||
<div class="list">
|
||||
<code><code><a href="class-GeoIp2.Exception.AddressNotFoundException.html">GeoIp2\Exception\AddressNotFoundException</a></code></code><br>if the address is not in the database.<br />
|
||||
<code>MaxMind\Db\Reader\InvalidDatabaseException</code><br>if the database is corrupt or invalid<br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="omni" id="_omni">
|
||||
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
<code><a href="class-GeoIp2.Model.Omni.html">GeoIp2\Model\Omni</a></code>
|
||||
|
||||
</code>
|
||||
</td>
|
||||
|
||||
<td class="name"><div>
|
||||
<a class="anchor" href="#_omni">#</a>
|
||||
<code><a href="source-class-GeoIp2.Database.Reader.html#112-127" title="Go to source code">omni</a>( <span>string <var>$ipAddress</var></span> )</code>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>This method returns a GeoIP2 Omni model.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>This method returns a GeoIP2 Omni model.</p>
|
||||
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<div class="list"><dl>
|
||||
<dt><var>$ipAddress</var></dt>
|
||||
<dd><code>string</code><br>$ipAddress IPv4 or IPv6 address as a string.</dd>
|
||||
</dl></div>
|
||||
|
||||
<h4>Returns</h4>
|
||||
<div class="list">
|
||||
<code><code><a href="class-GeoIp2.Model.Omni.html">GeoIp2\Model\Omni</a></code></code><br />
|
||||
</div>
|
||||
|
||||
<h4>Throws</h4>
|
||||
<div class="list">
|
||||
<code><code><a href="class-GeoIp2.Exception.AddressNotFoundException.html">GeoIp2\Exception\AddressNotFoundException</a></code></code><br>if the address is not in the database.<br />
|
||||
<code>MaxMind\Db\Reader\InvalidDatabaseException</code><br>if the database is corrupt or invalid<br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="close" id="_close">
|
||||
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
|
||||
|
||||
</code>
|
||||
</td>
|
||||
|
||||
<td class="name"><div>
|
||||
<a class="anchor" href="#_close">#</a>
|
||||
<code><a href="source-class-GeoIp2.Database.Reader.html#143-149" title="Go to source code">close</a>( )</code>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>Closes the GeoIP2 database and returns the resources to the system.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>Closes the GeoIP2 database and returns the resources to the system.</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
201
doc/v0.4.0/class-GeoIp2.Exception.AddressNotFoundException.html
Normal file
201
doc/v0.4.0/class-GeoIp2.Exception.AddressNotFoundException.html
Normal file
|
|
@ -0,0 +1,201 @@
|
|||
<!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\Exception\AddressNotFoundException | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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 class="active"><a href="namespace-GeoIp2.Exception.html">Exception</a>
|
||||
</li>
|
||||
<li><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>Exceptions</h3>
|
||||
<ul>
|
||||
<li class="active"><a href="class-GeoIp2.Exception.AddressNotFoundException.html">AddressNotFoundException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.AuthenticationException.html">AuthenticationException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.GeoIp2Exception.html">GeoIp2Exception</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.HttpException.html">HttpException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.InvalidRequestException.html">InvalidRequestException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.OutOfQueriesException.html">OutOfQueriesException</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.Exception.html" title="Summary of GeoIp2\Exception"><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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="class">
|
||||
<h1>Class AddressNotFoundException</h1>
|
||||
|
||||
|
||||
<div class="description">
|
||||
|
||||
<p>This class represents a generic error.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<dl class="tree">
|
||||
<dd style="padding-left:0px">
|
||||
<a href="class-Exception.html"><span>Exception</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:30px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<a href="class-GeoIp2.Exception.GeoIp2Exception.html"><span>GeoIp2\Exception\GeoIp2Exception</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:60px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<b><span>GeoIp2\Exception\AddressNotFoundException</span></b>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="info">
|
||||
|
||||
|
||||
<b>Namespace:</b> <a href="namespace-GeoIp2.html">GeoIp2</a>\<a href="namespace-GeoIp2.Exception.html">Exception</a><br />
|
||||
|
||||
|
||||
<b>Located at</b> <a href="source-class-GeoIp2.Exception.AddressNotFoundException.html#5-10" title="Go to source code">GeoIp2/Exception/AddressNotFoundException.php</a><br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="summary inherited">
|
||||
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
|
||||
<tr>
|
||||
<td><code>
|
||||
<a href="class-Exception.html#___construct">__construct()</a>,
|
||||
<a href="class-Exception.html#___toString">__toString()</a>,
|
||||
<a href="class-Exception.html#_getCode">getCode()</a>,
|
||||
<a href="class-Exception.html#_getFile">getFile()</a>,
|
||||
<a href="class-Exception.html#_getLine">getLine()</a>,
|
||||
<a href="class-Exception.html#_getMessage">getMessage()</a>,
|
||||
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
|
||||
<a href="class-Exception.html#_getTrace">getTrace()</a>,
|
||||
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
|
||||
</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="summary inherited">
|
||||
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
|
||||
<tr>
|
||||
<td><code>
|
||||
<a href="class-Exception.html#$code"><var>$code</var></a>,
|
||||
<a href="class-Exception.html#$file"><var>$file</var></a>,
|
||||
<a href="class-Exception.html#$line"><var>$line</var></a>,
|
||||
<a href="class-Exception.html#$message"><var>$message</var></a>
|
||||
</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
201
doc/v0.4.0/class-GeoIp2.Exception.AuthenticationException.html
Normal file
201
doc/v0.4.0/class-GeoIp2.Exception.AuthenticationException.html
Normal file
|
|
@ -0,0 +1,201 @@
|
|||
<!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\Exception\AuthenticationException | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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 class="active"><a href="namespace-GeoIp2.Exception.html">Exception</a>
|
||||
</li>
|
||||
<li><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>Exceptions</h3>
|
||||
<ul>
|
||||
<li><a href="class-GeoIp2.Exception.AddressNotFoundException.html">AddressNotFoundException</a></li>
|
||||
<li class="active"><a href="class-GeoIp2.Exception.AuthenticationException.html">AuthenticationException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.GeoIp2Exception.html">GeoIp2Exception</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.HttpException.html">HttpException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.InvalidRequestException.html">InvalidRequestException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.OutOfQueriesException.html">OutOfQueriesException</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.Exception.html" title="Summary of GeoIp2\Exception"><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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="class">
|
||||
<h1>Class AuthenticationException</h1>
|
||||
|
||||
|
||||
<div class="description">
|
||||
|
||||
<p>This class represents a generic error.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<dl class="tree">
|
||||
<dd style="padding-left:0px">
|
||||
<a href="class-Exception.html"><span>Exception</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:30px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<a href="class-GeoIp2.Exception.GeoIp2Exception.html"><span>GeoIp2\Exception\GeoIp2Exception</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:60px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<b><span>GeoIp2\Exception\AuthenticationException</span></b>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="info">
|
||||
|
||||
|
||||
<b>Namespace:</b> <a href="namespace-GeoIp2.html">GeoIp2</a>\<a href="namespace-GeoIp2.Exception.html">Exception</a><br />
|
||||
|
||||
|
||||
<b>Located at</b> <a href="source-class-GeoIp2.Exception.AuthenticationException.html#5-10" title="Go to source code">GeoIp2/Exception/AuthenticationException.php</a><br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="summary inherited">
|
||||
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
|
||||
<tr>
|
||||
<td><code>
|
||||
<a href="class-Exception.html#___construct">__construct()</a>,
|
||||
<a href="class-Exception.html#___toString">__toString()</a>,
|
||||
<a href="class-Exception.html#_getCode">getCode()</a>,
|
||||
<a href="class-Exception.html#_getFile">getFile()</a>,
|
||||
<a href="class-Exception.html#_getLine">getLine()</a>,
|
||||
<a href="class-Exception.html#_getMessage">getMessage()</a>,
|
||||
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
|
||||
<a href="class-Exception.html#_getTrace">getTrace()</a>,
|
||||
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
|
||||
</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="summary inherited">
|
||||
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
|
||||
<tr>
|
||||
<td><code>
|
||||
<a href="class-Exception.html#$code"><var>$code</var></a>,
|
||||
<a href="class-Exception.html#$file"><var>$file</var></a>,
|
||||
<a href="class-Exception.html#$line"><var>$line</var></a>,
|
||||
<a href="class-Exception.html#$message"><var>$message</var></a>
|
||||
</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
205
doc/v0.4.0/class-GeoIp2.Exception.GeoIp2Exception.html
Normal file
205
doc/v0.4.0/class-GeoIp2.Exception.GeoIp2Exception.html
Normal file
|
|
@ -0,0 +1,205 @@
|
|||
<!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\Exception\GeoIp2Exception | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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 class="active"><a href="namespace-GeoIp2.Exception.html">Exception</a>
|
||||
</li>
|
||||
<li><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>Exceptions</h3>
|
||||
<ul>
|
||||
<li><a href="class-GeoIp2.Exception.AddressNotFoundException.html">AddressNotFoundException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.AuthenticationException.html">AuthenticationException</a></li>
|
||||
<li class="active"><a href="class-GeoIp2.Exception.GeoIp2Exception.html">GeoIp2Exception</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.HttpException.html">HttpException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.InvalidRequestException.html">InvalidRequestException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.OutOfQueriesException.html">OutOfQueriesException</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.Exception.html" title="Summary of GeoIp2\Exception"><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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="class">
|
||||
<h1>Class GeoIp2Exception</h1>
|
||||
|
||||
|
||||
<div class="description">
|
||||
|
||||
<p>This class represents a generic error.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<dl class="tree">
|
||||
<dd style="padding-left:0px">
|
||||
<a href="class-Exception.html"><span>Exception</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:30px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<b><span>GeoIp2\Exception\GeoIp2Exception</span></b>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<div>
|
||||
<h4>Direct known subclasses</h4>
|
||||
<a href="class-GeoIp2.Exception.AddressNotFoundException.html">GeoIp2\Exception\AddressNotFoundException</a>,
|
||||
<a href="class-GeoIp2.Exception.AuthenticationException.html">GeoIp2\Exception\AuthenticationException</a>,
|
||||
<a href="class-GeoIp2.Exception.HttpException.html">GeoIp2\Exception\HttpException</a>,
|
||||
<a href="class-GeoIp2.Exception.OutOfQueriesException.html">GeoIp2\Exception\OutOfQueriesException</a>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<h4>Indirect known subclasses</h4>
|
||||
<a href="class-GeoIp2.Exception.InvalidRequestException.html">GeoIp2\Exception\InvalidRequestException</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="info">
|
||||
|
||||
|
||||
<b>Namespace:</b> <a href="namespace-GeoIp2.html">GeoIp2</a>\<a href="namespace-GeoIp2.Exception.html">Exception</a><br />
|
||||
|
||||
|
||||
<b>Located at</b> <a href="source-class-GeoIp2.Exception.GeoIp2Exception.html#5-10" title="Go to source code">GeoIp2/Exception/GeoIp2Exception.php</a><br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="summary inherited">
|
||||
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
|
||||
<tr>
|
||||
<td><code>
|
||||
<a href="class-Exception.html#___construct">__construct()</a>,
|
||||
<a href="class-Exception.html#___toString">__toString()</a>,
|
||||
<a href="class-Exception.html#_getCode">getCode()</a>,
|
||||
<a href="class-Exception.html#_getFile">getFile()</a>,
|
||||
<a href="class-Exception.html#_getLine">getLine()</a>,
|
||||
<a href="class-Exception.html#_getMessage">getMessage()</a>,
|
||||
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
|
||||
<a href="class-Exception.html#_getTrace">getTrace()</a>,
|
||||
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
|
||||
</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="summary inherited">
|
||||
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
|
||||
<tr>
|
||||
<td><code>
|
||||
<a href="class-Exception.html#$code"><var>$code</var></a>,
|
||||
<a href="class-Exception.html#$file"><var>$file</var></a>,
|
||||
<a href="class-Exception.html#$line"><var>$line</var></a>,
|
||||
<a href="class-Exception.html#$message"><var>$message</var></a>
|
||||
</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
268
doc/v0.4.0/class-GeoIp2.Exception.HttpException.html
Normal file
268
doc/v0.4.0/class-GeoIp2.Exception.HttpException.html
Normal file
|
|
@ -0,0 +1,268 @@
|
|||
<!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\Exception\HttpException | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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 class="active"><a href="namespace-GeoIp2.Exception.html">Exception</a>
|
||||
</li>
|
||||
<li><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>Exceptions</h3>
|
||||
<ul>
|
||||
<li><a href="class-GeoIp2.Exception.AddressNotFoundException.html">AddressNotFoundException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.AuthenticationException.html">AuthenticationException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.GeoIp2Exception.html">GeoIp2Exception</a></li>
|
||||
<li class="active"><a href="class-GeoIp2.Exception.HttpException.html">HttpException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.InvalidRequestException.html">InvalidRequestException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.OutOfQueriesException.html">OutOfQueriesException</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.Exception.html" title="Summary of GeoIp2\Exception"><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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="class">
|
||||
<h1>Class HttpException</h1>
|
||||
|
||||
|
||||
<div class="description">
|
||||
|
||||
<p>This class represents an HTTP transport error.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<dl class="tree">
|
||||
<dd style="padding-left:0px">
|
||||
<a href="class-Exception.html"><span>Exception</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:30px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<a href="class-GeoIp2.Exception.GeoIp2Exception.html"><span>GeoIp2\Exception\GeoIp2Exception</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:60px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<b><span>GeoIp2\Exception\HttpException</span></b>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<div>
|
||||
<h4>Direct known subclasses</h4>
|
||||
<a href="class-GeoIp2.Exception.InvalidRequestException.html">GeoIp2\Exception\InvalidRequestException</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="info">
|
||||
|
||||
|
||||
<b>Namespace:</b> <a href="namespace-GeoIp2.html">GeoIp2</a>\<a href="namespace-GeoIp2.Exception.html">Exception</a><br />
|
||||
|
||||
|
||||
<b>Located at</b> <a href="source-class-GeoIp2.Exception.HttpException.html#6-25" title="Go to source code">GeoIp2/Exception/HttpException.php</a><br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="methods">
|
||||
<caption>Methods summary</caption>
|
||||
<tr data-order="__construct" id="___construct">
|
||||
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
|
||||
|
||||
</code>
|
||||
</td>
|
||||
|
||||
<td class="name"><div>
|
||||
<a class="anchor" href="#___construct">#</a>
|
||||
<code><a href="source-class-GeoIp2.Exception.HttpException.html#16-24" title="Go to source code">__construct</a>( <span>mixed <var>$message</var></span>, <span>mixed <var>$httpStatus</var></span>, <span>mixed <var>$uri</var></span>, <span>GeoIp2\Exception\Exception <var>$previous</var> = <span class="php-keyword1">null</span> </span> )</code>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Overrides</h4>
|
||||
<div class="list"><code><a href="class-Exception.html#___construct">Exception::__construct()</a></code></div>
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<table class="summary inherited">
|
||||
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
|
||||
<tr>
|
||||
<td><code>
|
||||
<a href="class-Exception.html#___toString">__toString()</a>,
|
||||
<a href="class-Exception.html#_getCode">getCode()</a>,
|
||||
<a href="class-Exception.html#_getFile">getFile()</a>,
|
||||
<a href="class-Exception.html#_getLine">getLine()</a>,
|
||||
<a href="class-Exception.html#_getMessage">getMessage()</a>,
|
||||
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
|
||||
<a href="class-Exception.html#_getTrace">getTrace()</a>,
|
||||
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
|
||||
</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="properties">
|
||||
<caption>Properties summary</caption>
|
||||
<tr data-order="uri" id="$uri">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
mixed
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Exception.HttpException.html#11-14" title="Go to source code"><var>$uri</var></a>
|
||||
</td>
|
||||
<td class="value"><code></code></td>
|
||||
<td class="description"><div>
|
||||
<a href="#$uri" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>The URI queried</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>The URI queried</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<table class="summary inherited">
|
||||
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
|
||||
<tr>
|
||||
<td><code>
|
||||
<a href="class-Exception.html#$code"><var>$code</var></a>,
|
||||
<a href="class-Exception.html#$file"><var>$file</var></a>,
|
||||
<a href="class-Exception.html#$line"><var>$line</var></a>,
|
||||
<a href="class-Exception.html#$message"><var>$message</var></a>
|
||||
</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
279
doc/v0.4.0/class-GeoIp2.Exception.InvalidRequestException.html
Normal file
279
doc/v0.4.0/class-GeoIp2.Exception.InvalidRequestException.html
Normal file
|
|
@ -0,0 +1,279 @@
|
|||
<!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\Exception\InvalidRequestException | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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 class="active"><a href="namespace-GeoIp2.Exception.html">Exception</a>
|
||||
</li>
|
||||
<li><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>Exceptions</h3>
|
||||
<ul>
|
||||
<li><a href="class-GeoIp2.Exception.AddressNotFoundException.html">AddressNotFoundException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.AuthenticationException.html">AuthenticationException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.GeoIp2Exception.html">GeoIp2Exception</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.HttpException.html">HttpException</a></li>
|
||||
<li class="active"><a href="class-GeoIp2.Exception.InvalidRequestException.html">InvalidRequestException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.OutOfQueriesException.html">OutOfQueriesException</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.Exception.html" title="Summary of GeoIp2\Exception"><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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="class">
|
||||
<h1>Class InvalidRequestException</h1>
|
||||
|
||||
|
||||
<div class="description">
|
||||
|
||||
<p>This class represents an error returned by MaxMind's GeoIP2 web service.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<dl class="tree">
|
||||
<dd style="padding-left:0px">
|
||||
<a href="class-Exception.html"><span>Exception</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:30px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<a href="class-GeoIp2.Exception.GeoIp2Exception.html"><span>GeoIp2\Exception\GeoIp2Exception</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:60px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<a href="class-GeoIp2.Exception.HttpException.html"><span>GeoIp2\Exception\HttpException</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:90px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<b><span>GeoIp2\Exception\InvalidRequestException</span></b>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="info">
|
||||
|
||||
|
||||
<b>Namespace:</b> <a href="namespace-GeoIp2.html">GeoIp2</a>\<a href="namespace-GeoIp2.Exception.html">Exception</a><br />
|
||||
|
||||
|
||||
<b>Located at</b> <a href="source-class-GeoIp2.Exception.InvalidRequestException.html#5-26" title="Go to source code">GeoIp2/Exception/InvalidRequestException.php</a><br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="methods">
|
||||
<caption>Methods summary</caption>
|
||||
<tr data-order="__construct" id="___construct">
|
||||
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
|
||||
|
||||
</code>
|
||||
</td>
|
||||
|
||||
<td class="name"><div>
|
||||
<a class="anchor" href="#___construct">#</a>
|
||||
<code><a href="source-class-GeoIp2.Exception.InvalidRequestException.html#16-25" title="Go to source code">__construct</a>( <span>mixed <var>$message</var></span>, <span>mixed <var>$error</var></span>, <span>mixed <var>$httpStatus</var></span>, <span>mixed <var>$uri</var></span>, <span>GeoIp2\Exception\Exception <var>$previous</var> = <span class="php-keyword1">null</span> </span> )</code>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Overrides</h4>
|
||||
<div class="list"><code><a href="class-GeoIp2.Exception.HttpException.html#___construct">GeoIp2\Exception\HttpException::__construct()</a></code></div>
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<table class="summary inherited">
|
||||
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
|
||||
<tr>
|
||||
<td><code>
|
||||
<a href="class-Exception.html#___toString">__toString()</a>,
|
||||
<a href="class-Exception.html#_getCode">getCode()</a>,
|
||||
<a href="class-Exception.html#_getFile">getFile()</a>,
|
||||
<a href="class-Exception.html#_getLine">getLine()</a>,
|
||||
<a href="class-Exception.html#_getMessage">getMessage()</a>,
|
||||
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
|
||||
<a href="class-Exception.html#_getTrace">getTrace()</a>,
|
||||
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
|
||||
</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="properties">
|
||||
<caption>Properties summary</caption>
|
||||
<tr data-order="error" id="$error">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
mixed
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Exception.InvalidRequestException.html#11-14" title="Go to source code"><var>$error</var></a>
|
||||
</td>
|
||||
<td class="value"><code></code></td>
|
||||
<td class="description"><div>
|
||||
<a href="#$error" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>The code returned by the MaxMind web service</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>The code returned by the MaxMind web service</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<table class="summary inherited">
|
||||
<caption>Properties inherited from <a href="class-GeoIp2.Exception.HttpException.html#properties">GeoIp2\Exception\HttpException</a></caption>
|
||||
<tr>
|
||||
<td><code>
|
||||
<a href="class-GeoIp2.Exception.HttpException.html#$uri"><var>$uri</var></a>
|
||||
</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
<table class="summary inherited">
|
||||
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
|
||||
<tr>
|
||||
<td><code>
|
||||
<a href="class-Exception.html#$code"><var>$code</var></a>,
|
||||
<a href="class-Exception.html#$file"><var>$file</var></a>,
|
||||
<a href="class-Exception.html#$line"><var>$line</var></a>,
|
||||
<a href="class-Exception.html#$message"><var>$message</var></a>
|
||||
</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
201
doc/v0.4.0/class-GeoIp2.Exception.OutOfQueriesException.html
Normal file
201
doc/v0.4.0/class-GeoIp2.Exception.OutOfQueriesException.html
Normal file
|
|
@ -0,0 +1,201 @@
|
|||
<!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\Exception\OutOfQueriesException | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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 class="active"><a href="namespace-GeoIp2.Exception.html">Exception</a>
|
||||
</li>
|
||||
<li><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>Exceptions</h3>
|
||||
<ul>
|
||||
<li><a href="class-GeoIp2.Exception.AddressNotFoundException.html">AddressNotFoundException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.AuthenticationException.html">AuthenticationException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.GeoIp2Exception.html">GeoIp2Exception</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.HttpException.html">HttpException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.InvalidRequestException.html">InvalidRequestException</a></li>
|
||||
<li class="active"><a href="class-GeoIp2.Exception.OutOfQueriesException.html">OutOfQueriesException</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.Exception.html" title="Summary of GeoIp2\Exception"><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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="class">
|
||||
<h1>Class OutOfQueriesException</h1>
|
||||
|
||||
|
||||
<div class="description">
|
||||
|
||||
<p>This class represents a generic error.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<dl class="tree">
|
||||
<dd style="padding-left:0px">
|
||||
<a href="class-Exception.html"><span>Exception</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:30px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<a href="class-GeoIp2.Exception.GeoIp2Exception.html"><span>GeoIp2\Exception\GeoIp2Exception</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:60px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<b><span>GeoIp2\Exception\OutOfQueriesException</span></b>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="info">
|
||||
|
||||
|
||||
<b>Namespace:</b> <a href="namespace-GeoIp2.html">GeoIp2</a>\<a href="namespace-GeoIp2.Exception.html">Exception</a><br />
|
||||
|
||||
|
||||
<b>Located at</b> <a href="source-class-GeoIp2.Exception.OutOfQueriesException.html#5-10" title="Go to source code">GeoIp2/Exception/OutOfQueriesException.php</a><br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="summary inherited">
|
||||
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
|
||||
<tr>
|
||||
<td><code>
|
||||
<a href="class-Exception.html#___construct">__construct()</a>,
|
||||
<a href="class-Exception.html#___toString">__toString()</a>,
|
||||
<a href="class-Exception.html#_getCode">getCode()</a>,
|
||||
<a href="class-Exception.html#_getFile">getFile()</a>,
|
||||
<a href="class-Exception.html#_getLine">getLine()</a>,
|
||||
<a href="class-Exception.html#_getMessage">getMessage()</a>,
|
||||
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
|
||||
<a href="class-Exception.html#_getTrace">getTrace()</a>,
|
||||
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
|
||||
</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="summary inherited">
|
||||
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
|
||||
<tr>
|
||||
<td><code>
|
||||
<a href="class-Exception.html#$code"><var>$code</var></a>,
|
||||
<a href="class-Exception.html#$file"><var>$file</var></a>,
|
||||
<a href="class-Exception.html#$line"><var>$line</var></a>,
|
||||
<a href="class-Exception.html#$message"><var>$message</var></a>
|
||||
</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
464
doc/v0.4.0/class-GeoIp2.Model.City.html
Normal file
464
doc/v0.4.0/class-GeoIp2.Model.City.html
Normal file
|
|
@ -0,0 +1,464 @@
|
|||
<!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\City | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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 class="active"><a href="class-GeoIp2.Model.City.html">City</a></li>
|
||||
<li><a href="class-GeoIp2.Model.CityIspOrg.html">CityIspOrg</a></li>
|
||||
<li><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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="class">
|
||||
<h1>Class City</h1>
|
||||
|
||||
|
||||
<div class="description">
|
||||
|
||||
<p>This class provides a model for the data returned by the GeoIP2 City 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">
|
||||
<a href="class-GeoIp2.Model.Country.html"><span>GeoIp2\Model\Country</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:30px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<b><span>GeoIp2\Model\City</span></b>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<div>
|
||||
<h4>Direct known subclasses</h4>
|
||||
<a href="class-GeoIp2.Model.CityIspOrg.html">GeoIp2\Model\CityIspOrg</a>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<h4>Indirect known subclasses</h4>
|
||||
<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.City.html#5-120" title="Go to source code">GeoIp2/Model/City.php</a><br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="magicProperties">
|
||||
<caption>Magic properties summary</caption>
|
||||
<tr data-order="city" id="m$city">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
<code><a href="class-GeoIp2.Record.City.html">GeoIp2\Record\City</a></code>
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Model.City.html#13-14" title="Go to source code"><var>$city</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$city" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>City data for the requested IP address.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>City data for the requested IP address.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<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.City.html#16-17" 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.City.html#19-21" 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="location" id="m$location">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
<code><a href="class-GeoIp2.Record.Location.html">GeoIp2\Record\Location</a></code>
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Model.City.html#23-24" title="Go to source code"><var>$location</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$location" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>Location data for the requested IP address.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>Location data for the requested IP address.</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.City.html#26-27" 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.City.html#29-32" 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.City.html#34-37" 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="subdivisions" id="m$subdivisions">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
array
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Model.City.html#39-45" title="Go to source code"><var>$subdivisions</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$subdivisions" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>An array of <code><a href="class-GeoIp2.Record.Subdivision.html">GeoIp2\Record\Subdivision</a></code> objects representing the
|
||||
country subdivisions for the requested IP address. The number and type of
|
||||
subdivisions varies by country, but a subdivision is typically a state,
|
||||
province, county, etc. Subdivisions are ordered from most general (largest) to
|
||||
most specific (smallest). If the response did not contain any subdivisions, this
|
||||
method returns an empty array.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>An array of <code><a href="class-GeoIp2.Record.Subdivision.html">GeoIp2\Record\Subdivision</a></code> objects representing the
|
||||
country subdivisions for the requested IP address. The number and type of
|
||||
subdivisions varies by country, but a subdivision is typically a state,
|
||||
province, county, etc. Subdivisions are ordered from most general (largest) to
|
||||
most specific (smallest). If the response did not contain any subdivisions, this
|
||||
method returns an empty array.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="mostSpecificSubdivision" id="m$mostSpecificSubdivision">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
<code><a href="class-GeoIp2.Record.Subdivision.html">GeoIp2\Record\Subdivision</a></code>
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Model.City.html#47-50" title="Go to source code"><var>$mostSpecificSubdivision</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$mostSpecificSubdivision" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>An object representing the most specific subdivision returned. If the
|
||||
response did not contain any subdivisions, this method returns an empty <code><a href="class-GeoIp2.Record.Subdivision.html">GeoIp2\Record\Subdivision</a></code> object.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>An object representing the most specific subdivision returned. If the
|
||||
response did not contain any subdivisions, this method returns an empty <code><a href="class-GeoIp2.Record.Subdivision.html">GeoIp2\Record\Subdivision</a></code> object.</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.City.html#52-53" 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.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
467
doc/v0.4.0/class-GeoIp2.Model.CityIspOrg.html
Normal file
467
doc/v0.4.0/class-GeoIp2.Model.CityIspOrg.html
Normal file
|
|
@ -0,0 +1,467 @@
|
|||
<!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\CityIspOrg | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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 class="active"><a href="class-GeoIp2.Model.CityIspOrg.html">CityIspOrg</a></li>
|
||||
<li><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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="class">
|
||||
<h1>Class CityIspOrg</h1>
|
||||
|
||||
|
||||
<div class="description">
|
||||
|
||||
<p>This class provides a model for the data returned by the GeoIP2 City/ISP/Org
|
||||
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">
|
||||
<a href="class-GeoIp2.Model.Country.html"><span>GeoIp2\Model\Country</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:30px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<a href="class-GeoIp2.Model.City.html"><span>GeoIp2\Model\City</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:60px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<b><span>GeoIp2\Model\CityIspOrg</span></b>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<div>
|
||||
<h4>Direct known subclasses</h4>
|
||||
<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.CityIspOrg.html#5-57" title="Go to source code">GeoIp2/Model/CityIspOrg.php</a><br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="magicProperties">
|
||||
<caption>Magic properties summary</caption>
|
||||
<tr data-order="city" id="m$city">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
<code><a href="class-GeoIp2.Record.City.html">GeoIp2\Record\City</a></code>
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Model.CityIspOrg.html#13-14" title="Go to source code"><var>$city</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$city" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>City data for the requested IP address.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>City data for the requested IP address.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<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.CityIspOrg.html#16-17" 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.CityIspOrg.html#19-21" 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="location" id="m$location">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
<code><a href="class-GeoIp2.Record.Location.html">GeoIp2\Record\Location</a></code>
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Model.CityIspOrg.html#23-24" title="Go to source code"><var>$location</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$location" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>Location data for the requested IP address.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>Location data for the requested IP address.</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.CityIspOrg.html#26-27" 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.CityIspOrg.html#29-32" 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.CityIspOrg.html#34-37" 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="subdivisions" id="m$subdivisions">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
array
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Model.CityIspOrg.html#39-45" title="Go to source code"><var>$subdivisions</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$subdivisions" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>An array of <code><a href="class-GeoIp2.Record.Subdivision.html">GeoIp2\Record\Subdivision</a></code> objects representing the
|
||||
country subdivisions for the requested IP address. The number and type of
|
||||
subdivisions varies by country, but a subdivision is typically a state,
|
||||
province, county, etc. Subdivisions are ordered from most general (largest) to
|
||||
most specific (smallest). If the response did not contain any subdivisions, this
|
||||
method returns an empty array.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>An array of <code><a href="class-GeoIp2.Record.Subdivision.html">GeoIp2\Record\Subdivision</a></code> objects representing the
|
||||
country subdivisions for the requested IP address. The number and type of
|
||||
subdivisions varies by country, but a subdivision is typically a state,
|
||||
province, county, etc. Subdivisions are ordered from most general (largest) to
|
||||
most specific (smallest). If the response did not contain any subdivisions, this
|
||||
method returns an empty array.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="mostSpecificSubdivision" id="m$mostSpecificSubdivision">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
<code><a href="class-GeoIp2.Record.Subdivision.html">GeoIp2\Record\Subdivision</a></code>
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Model.CityIspOrg.html#47-50" title="Go to source code"><var>$mostSpecificSubdivision</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$mostSpecificSubdivision" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>An object representing the most specific subdivision returned. If the
|
||||
response did not contain any subdivisions, this method returns an empty <code><a href="class-GeoIp2.Record.Subdivision.html">GeoIp2\Record\Subdivision</a></code> object.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>An object representing the most specific subdivision returned. If the
|
||||
response did not contain any subdivisions, this method returns an empty <code><a href="class-GeoIp2.Record.Subdivision.html">GeoIp2\Record\Subdivision</a></code> object.</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.CityIspOrg.html#52-53" 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.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
335
doc/v0.4.0/class-GeoIp2.Model.Country.html
Normal file
335
doc/v0.4.0/class-GeoIp2.Model.Country.html
Normal file
|
|
@ -0,0 +1,335 @@
|
|||
<!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.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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-4-0-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>
|
||||
|
||||
|
||||
|
||||
<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-95" title="Go to source code">GeoIp2/Model/Country.php</a><br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
470
doc/v0.4.0/class-GeoIp2.Model.Omni.html
Normal file
470
doc/v0.4.0/class-GeoIp2.Model.Omni.html
Normal file
|
|
@ -0,0 +1,470 @@
|
|||
<!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\Omni | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><a href="class-GeoIp2.Model.Country.html">Country</a></li>
|
||||
<li class="active"><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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="class">
|
||||
<h1>Class Omni</h1>
|
||||
|
||||
|
||||
<div class="description">
|
||||
|
||||
<p>This class provides a model for the data returned by the GeoIP2 Omni 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">
|
||||
<a href="class-GeoIp2.Model.Country.html"><span>GeoIp2\Model\Country</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:30px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<a href="class-GeoIp2.Model.City.html"><span>GeoIp2\Model\City</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:60px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<a href="class-GeoIp2.Model.CityIspOrg.html"><span>GeoIp2\Model\CityIspOrg</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:90px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<b><span>GeoIp2\Model\Omni</span></b>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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.Omni.html#5-57" title="Go to source code">GeoIp2/Model/Omni.php</a><br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="magicProperties">
|
||||
<caption>Magic properties summary</caption>
|
||||
<tr data-order="city" id="m$city">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
<code><a href="class-GeoIp2.Record.City.html">GeoIp2\Record\City</a></code>
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Model.Omni.html#13-14" title="Go to source code"><var>$city</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$city" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>City data for the requested IP address.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>City data for the requested IP address.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<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.Omni.html#16-17" 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.Omni.html#19-21" 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="location" id="m$location">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
<code><a href="class-GeoIp2.Record.Location.html">GeoIp2\Record\Location</a></code>
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Model.Omni.html#23-24" title="Go to source code"><var>$location</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$location" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>Location data for the requested IP address.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>Location data for the requested IP address.</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.Omni.html#26-27" 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.Omni.html#29-32" 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.Omni.html#34-37" 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="subdivisions" id="m$subdivisions">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
array
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Model.Omni.html#39-45" title="Go to source code"><var>$subdivisions</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$subdivisions" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>An array of <code><a href="class-GeoIp2.Record.Subdivision.html">GeoIp2\Record\Subdivision</a></code> objects representing the
|
||||
country subdivisions for the requested IP address. The number and type of
|
||||
subdivisions varies by country, but a subdivision is typically a state,
|
||||
province, county, etc. Subdivisions are ordered from most general (largest) to
|
||||
most specific (smallest). If the response did not contain any subdivisions, this
|
||||
method returns an empty array.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>An array of <code><a href="class-GeoIp2.Record.Subdivision.html">GeoIp2\Record\Subdivision</a></code> objects representing the
|
||||
country subdivisions for the requested IP address. The number and type of
|
||||
subdivisions varies by country, but a subdivision is typically a state,
|
||||
province, county, etc. Subdivisions are ordered from most general (largest) to
|
||||
most specific (smallest). If the response did not contain any subdivisions, this
|
||||
method returns an empty array.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="mostSpecificSubdivision" id="m$mostSpecificSubdivision">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
<code><a href="class-GeoIp2.Record.Subdivision.html">GeoIp2\Record\Subdivision</a></code>
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Model.Omni.html#47-50" title="Go to source code"><var>$mostSpecificSubdivision</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$mostSpecificSubdivision" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>An object representing the most specific subdivision returned. If the
|
||||
response did not contain any subdivisions, this method returns an empty <code><a href="class-GeoIp2.Record.Subdivision.html">GeoIp2\Record\Subdivision</a></code> object.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>An object representing the most specific subdivision returned. If the
|
||||
response did not contain any subdivisions, this method returns an empty <code><a href="class-GeoIp2.Record.Subdivision.html">GeoIp2\Record\Subdivision</a></code> object.</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.Omni.html#52-53" 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.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
178
doc/v0.4.0/class-GeoIp2.Record.AbstractPlaceRecord.html
Normal file
178
doc/v0.4.0/class-GeoIp2.Record.AbstractPlaceRecord.html
Normal file
|
|
@ -0,0 +1,178 @@
|
|||
<!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\Record\AbstractPlaceRecord | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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 class="active"><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><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" />
|
||||
<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.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>
|
||||
<li>
|
||||
<a href="geoip2-php-api-v0-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="class">
|
||||
<h1>Class AbstractPlaceRecord</h1>
|
||||
|
||||
|
||||
|
||||
<dl class="tree">
|
||||
<dd style="padding-left:0px">
|
||||
<a href="class-GeoIp2.Record.AbstractRecord.html"><span>GeoIp2\Record\AbstractRecord</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:30px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<b><span>GeoIp2\Record\AbstractPlaceRecord</span></b>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<div>
|
||||
<h4>Direct known subclasses</h4>
|
||||
<a href="class-GeoIp2.Record.City.html">GeoIp2\Record\City</a>,
|
||||
<a href="class-GeoIp2.Record.Continent.html">GeoIp2\Record\Continent</a>,
|
||||
<a href="class-GeoIp2.Record.Country.html">GeoIp2\Record\Country</a>,
|
||||
<a href="class-GeoIp2.Record.Subdivision.html">GeoIp2\Record\Subdivision</a>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<h4>Indirect known subclasses</h4>
|
||||
<a href="class-GeoIp2.Record.RepresentedCountry.html">GeoIp2\Record\RepresentedCountry</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="info">
|
||||
<b>Abstract</b><br />
|
||||
|
||||
<b>Namespace:</b> <a href="namespace-GeoIp2.html">GeoIp2</a>\<a href="namespace-GeoIp2.Record.html">Record</a><br />
|
||||
|
||||
|
||||
<b>Located at</b> <a href="source-class-GeoIp2.Record.AbstractPlaceRecord.html#5-38" title="Go to source code">GeoIp2/Record/AbstractPlaceRecord.php</a><br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
169
doc/v0.4.0/class-GeoIp2.Record.AbstractRecord.html
Normal file
169
doc/v0.4.0/class-GeoIp2.Record.AbstractRecord.html
Normal file
|
|
@ -0,0 +1,169 @@
|
|||
<!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\Record\AbstractRecord | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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 class="active"><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><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" />
|
||||
<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.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>
|
||||
<li>
|
||||
<a href="geoip2-php-api-v0-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="class">
|
||||
<h1>Class AbstractRecord</h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div>
|
||||
<h4>Direct known subclasses</h4>
|
||||
<a href="class-GeoIp2.Record.AbstractPlaceRecord.html">GeoIp2\Record\AbstractPlaceRecord</a>,
|
||||
<a href="class-GeoIp2.Record.Location.html">GeoIp2\Record\Location</a>,
|
||||
<a href="class-GeoIp2.Record.MaxMind.html">GeoIp2\Record\MaxMind</a>,
|
||||
<a href="class-GeoIp2.Record.Postal.html">GeoIp2\Record\Postal</a>,
|
||||
<a href="class-GeoIp2.Record.Traits.html">GeoIp2\Record\Traits</a>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<h4>Indirect known subclasses</h4>
|
||||
<a href="class-GeoIp2.Record.City.html">GeoIp2\Record\City</a>,
|
||||
<a href="class-GeoIp2.Record.Continent.html">GeoIp2\Record\Continent</a>,
|
||||
<a href="class-GeoIp2.Record.Country.html">GeoIp2\Record\Country</a>,
|
||||
<a href="class-GeoIp2.Record.RepresentedCountry.html">GeoIp2\Record\RepresentedCountry</a>,
|
||||
<a href="class-GeoIp2.Record.Subdivision.html">GeoIp2\Record\Subdivision</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="info">
|
||||
<b>Abstract</b><br />
|
||||
|
||||
<b>Namespace:</b> <a href="namespace-GeoIp2.html">GeoIp2</a>\<a href="namespace-GeoIp2.Record.html">Record</a><br />
|
||||
|
||||
|
||||
<b>Located at</b> <a href="source-class-GeoIp2.Record.AbstractRecord.html#5-34" title="Go to source code">GeoIp2/Record/AbstractRecord.php</a><br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
297
doc/v0.4.0/class-GeoIp2.Record.City.html
Normal file
297
doc/v0.4.0/class-GeoIp2.Record.City.html
Normal file
|
|
@ -0,0 +1,297 @@
|
|||
<!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\Record\City | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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 class="active"><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><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" />
|
||||
<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.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>
|
||||
<li>
|
||||
<a href="geoip2-php-api-v0-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="class">
|
||||
<h1>Class City</h1>
|
||||
|
||||
|
||||
<div class="description">
|
||||
|
||||
<p>City-level data 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>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:30px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<a href="class-GeoIp2.Record.AbstractPlaceRecord.html"><span>GeoIp2\Record\AbstractPlaceRecord</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:60px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<b><span>GeoIp2\Record\City</span></b>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="info">
|
||||
|
||||
|
||||
<b>Namespace:</b> <a href="namespace-GeoIp2.html">GeoIp2</a>\<a href="namespace-GeoIp2.Record.html">Record</a><br />
|
||||
|
||||
|
||||
<b>Located at</b> <a href="source-class-GeoIp2.Record.City.html#5-29" title="Go to source code">GeoIp2/Record/City.php</a><br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="magicProperties">
|
||||
<caption>Magic properties summary</caption>
|
||||
<tr data-order="confidence" id="m$confidence">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
integer
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.City.html#10-12" title="Go to source code"><var>$confidence</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$confidence" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>A value from 0-100 indicating MaxMind's confidence that the city is correct.
|
||||
This attribute is only available from the Omni end point.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>A value from 0-100 indicating MaxMind's confidence that the city is correct.
|
||||
This attribute is only available from the Omni end point.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="geonameId" id="m$geonameId">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
integer
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.City.html#14-15" title="Go to source code"><var>$geonameId</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$geonameId" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>The GeoName ID for the city. This attribute is returned by all end
|
||||
points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>The GeoName ID for the city. This attribute is returned by all end
|
||||
points.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="name" id="m$name">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
string
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.City.html#17-18" title="Go to source code"><var>$name</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$name" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>The name of the city based on the languages list passed to the constructor.
|
||||
This attribute is returned by all end points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>The name of the city based on the languages list passed to the constructor.
|
||||
This attribute is returned by all end points.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="names" id="m$names">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
array
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.City.html#20-21" title="Go to source code"><var>$names</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$names" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>A array map where the keys are language codes and the values are names. This
|
||||
attribute is returned by all end points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>A array map where the keys are language codes and the values are names. This
|
||||
attribute is returned by all end points.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
296
doc/v0.4.0/class-GeoIp2.Record.Continent.html
Normal file
296
doc/v0.4.0/class-GeoIp2.Record.Continent.html
Normal file
|
|
@ -0,0 +1,296 @@
|
|||
<!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\Record\Continent | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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 class="active"><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><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" />
|
||||
<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.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>
|
||||
<li>
|
||||
<a href="geoip2-php-api-v0-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="class">
|
||||
<h1>Class Continent</h1>
|
||||
|
||||
|
||||
<div class="description">
|
||||
|
||||
<p>Contains data for the continent record associated with an IP address</p>
|
||||
|
||||
<p>This record is returned by all the end points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<dl class="tree">
|
||||
<dd style="padding-left:0px">
|
||||
<a href="class-GeoIp2.Record.AbstractRecord.html"><span>GeoIp2\Record\AbstractRecord</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:30px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<a href="class-GeoIp2.Record.AbstractPlaceRecord.html"><span>GeoIp2\Record\AbstractPlaceRecord</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:60px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<b><span>GeoIp2\Record\Continent</span></b>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="info">
|
||||
|
||||
|
||||
<b>Namespace:</b> <a href="namespace-GeoIp2.html">GeoIp2</a>\<a href="namespace-GeoIp2.Record.html">Record</a><br />
|
||||
|
||||
|
||||
<b>Located at</b> <a href="source-class-GeoIp2.Record.Continent.html#5-33" title="Go to source code">GeoIp2/Record/Continent.php</a><br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="summary" 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.Continent.html#10-11" title="Go to source code"><var>$code</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$code" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>A two character continent code like "NA" (North America) or "OC" (Oceania).
|
||||
This attribute is returned by all end points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>A two character continent code like "NA" (North America) or "OC" (Oceania).
|
||||
This attribute is returned by all end points.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="geonameId" id="m$geonameId">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
integer
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Continent.html#13-14" title="Go to source code"><var>$geonameId</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$geonameId" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>The GeoName ID for the continent. This attribute is returned by all end
|
||||
points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>The GeoName ID for the continent. This attribute is returned by all end
|
||||
points.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="name" id="m$name">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
string
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Continent.html#16-18" title="Go to source code"><var>$name</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$name" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>Returns the name of the continent based on the languages list passed to the
|
||||
constructor. This attribute is returned by all end points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>Returns the name of the continent based on the languages list passed to the
|
||||
constructor. This attribute is returned by all end points.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="names" id="m$names">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
array
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Continent.html#20-21" title="Go to source code"><var>$names</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$names" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>An array map where the keys are language codes and the values are names. This
|
||||
attribute is returned by all end points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>An array map where the keys are language codes and the values are names. This
|
||||
attribute is returned by all end points.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
328
doc/v0.4.0/class-GeoIp2.Record.Country.html
Normal file
328
doc/v0.4.0/class-GeoIp2.Record.Country.html
Normal file
|
|
@ -0,0 +1,328 @@
|
|||
<!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\Record\Country | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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 class="active"><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><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" />
|
||||
<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.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>
|
||||
<li>
|
||||
<a href="geoip2-php-api-v0-4-0-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>Contains data for the country record associated with an IP address</p>
|
||||
|
||||
<p>This record is returned by all the end points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<dl class="tree">
|
||||
<dd style="padding-left:0px">
|
||||
<a href="class-GeoIp2.Record.AbstractRecord.html"><span>GeoIp2\Record\AbstractRecord</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:30px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<a href="class-GeoIp2.Record.AbstractPlaceRecord.html"><span>GeoIp2\Record\AbstractPlaceRecord</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:60px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<b><span>GeoIp2\Record\Country</span></b>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<div>
|
||||
<h4>Direct known subclasses</h4>
|
||||
<a href="class-GeoIp2.Record.RepresentedCountry.html">GeoIp2\Record\RepresentedCountry</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="info">
|
||||
|
||||
|
||||
<b>Namespace:</b> <a href="namespace-GeoIp2.html">GeoIp2</a>\<a href="namespace-GeoIp2.Record.html">Record</a><br />
|
||||
|
||||
|
||||
<b>Located at</b> <a href="source-class-GeoIp2.Record.Country.html#5-38" title="Go to source code">GeoIp2/Record/Country.php</a><br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="magicProperties">
|
||||
<caption>Magic properties summary</caption>
|
||||
<tr data-order="confidence" id="m$confidence">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
integer
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Country.html#10-12" title="Go to source code"><var>$confidence</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$confidence" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>A value from 0-100 indicating MaxMind's confidence that the country is
|
||||
correct. This attribute is only available from the Omni end point.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>A value from 0-100 indicating MaxMind's confidence that the country is
|
||||
correct. This attribute is only available from the Omni end point.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="geonameId" id="m$geonameId">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
integer
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Country.html#14-15" title="Go to source code"><var>$geonameId</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$geonameId" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>The GeoName ID for the country. This attribute is returned by all end
|
||||
points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>The GeoName ID for the country. This attribute is returned by all end
|
||||
points.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="isoCode" id="m$isoCode">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
string
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Country.html#17-19" title="Go to source code"><var>$isoCode</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$isoCode" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>The <a href="http://en.wikipedia.org/wiki/ISO_3166-1">two-character ISO 3166-1 alpha code</a> for the country. This attribute is returned
|
||||
by all end points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>The <a href="http://en.wikipedia.org/wiki/ISO_3166-1">two-character ISO 3166-1 alpha code</a> for the country. This attribute is returned
|
||||
by all end points.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="name" id="m$name">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
string
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Country.html#21-22" title="Go to source code"><var>$name</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$name" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>The name of the country based on the languages list passed to the
|
||||
constructor. This attribute is returned by all end points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>The name of the country based on the languages list passed to the
|
||||
constructor. This attribute is returned by all end points.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="names" id="m$names">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
array
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Country.html#24-25" title="Go to source code"><var>$names</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$names" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>An array map where the keys are language codes and the values are names. This
|
||||
attribute is returned by all end points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>An array map where the keys are language codes and the values are names. This
|
||||
attribute is returned by all end points.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
322
doc/v0.4.0/class-GeoIp2.Record.Location.html
Normal file
322
doc/v0.4.0/class-GeoIp2.Record.Location.html
Normal file
|
|
@ -0,0 +1,322 @@
|
|||
<!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\Record\Location | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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 class="active"><a href="class-GeoIp2.Record.Location.html">Location</a></li>
|
||||
<li><a href="class-GeoIp2.Record.MaxMind.html">MaxMind</a></li>
|
||||
<li><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" />
|
||||
<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.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>
|
||||
<li>
|
||||
<a href="geoip2-php-api-v0-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="class">
|
||||
<h1>Class Location</h1>
|
||||
|
||||
|
||||
<div class="description">
|
||||
|
||||
<p>Contains data for the location 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>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:30px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<b><span>GeoIp2\Record\Location</span></b>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="info">
|
||||
|
||||
|
||||
<b>Namespace:</b> <a href="namespace-GeoIp2.html">GeoIp2</a>\<a href="namespace-GeoIp2.Record.html">Record</a><br />
|
||||
|
||||
|
||||
<b>Located at</b> <a href="source-class-GeoIp2.Record.Location.html#5-48" title="Go to source code">GeoIp2/Record/Location.php</a><br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="magicProperties">
|
||||
<caption>Magic properties summary</caption>
|
||||
<tr data-order="accuracyRadius" id="m$accuracyRadius">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
integer
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Location.html#10-12" title="Go to source code"><var>$accuracyRadius</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$accuracyRadius" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>The radius in kilometers around the specified location where the IP address
|
||||
is likely to be. This attribute is only available from the Omni end point.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>The radius in kilometers around the specified location where the IP address
|
||||
is likely to be. This attribute is only available from the Omni end point.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="latitude" id="m$latitude">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
float
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Location.html#14-16" title="Go to source code"><var>$latitude</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$latitude" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>The latitude of the location as a floating point number. This attribute is
|
||||
returned by all end points except the Country end point.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>The latitude of the location as a floating point number. This attribute is
|
||||
returned by all end points except the Country end point.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="longitude" id="m$longitude">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
float
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Location.html#18-20" title="Go to source code"><var>$longitude</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$longitude" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>The longitude of the location as a floating point number. This attribute is
|
||||
returned by all end points except the Country end point.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>The longitude of the location as a floating point number. This attribute is
|
||||
returned by all end points except the Country end point.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="metroCode" id="m$metroCode">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
integer
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Location.html#22-27" title="Go to source code"><var>$metroCode</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$metroCode" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>The metro code of the location if the location is in the US. MaxMind returns
|
||||
the same metro codes as the <a href="https://developers.google.com/adwords/api/docs/appendix/cities-DMAregions">Google AdWords API</a>. This attribute is returned by all end points except the
|
||||
Country end point.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>The metro code of the location if the location is in the US. MaxMind returns
|
||||
the same metro codes as the <a href="https://developers.google.com/adwords/api/docs/appendix/cities-DMAregions">Google AdWords API</a>. This attribute is returned by all end points except the
|
||||
Country end point.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="timeZone" id="m$timeZone">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
string
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Location.html#29-32" title="Go to source code"><var>$timeZone</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$timeZone" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>The time zone associated with location, as specified by the <a href="http://www.iana.org/time-zones">IANA
|
||||
Time Zone Database</a>, e.g., "America/New_York". This attribute is returned by all
|
||||
end points except the Country end point.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>The time zone associated with location, as specified by the <a href="http://www.iana.org/time-zones">IANA
|
||||
Time Zone Database</a>, e.g., "America/New_York". This attribute is returned by all
|
||||
end points except the Country end point.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
205
doc/v0.4.0/class-GeoIp2.Record.MaxMind.html
Normal file
205
doc/v0.4.0/class-GeoIp2.Record.MaxMind.html
Normal file
|
|
@ -0,0 +1,205 @@
|
|||
<!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\Record\MaxMind | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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 class="active"><a href="class-GeoIp2.Record.MaxMind.html">MaxMind</a></li>
|
||||
<li><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" />
|
||||
<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.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>
|
||||
<li>
|
||||
<a href="geoip2-php-api-v0-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="class">
|
||||
<h1>Class MaxMind</h1>
|
||||
|
||||
|
||||
<div class="description">
|
||||
|
||||
<p>Contains data about your account.</p>
|
||||
|
||||
<p>This record is returned by all the end points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<dl class="tree">
|
||||
<dd style="padding-left:0px">
|
||||
<a href="class-GeoIp2.Record.AbstractRecord.html"><span>GeoIp2\Record\AbstractRecord</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:30px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<b><span>GeoIp2\Record\MaxMind</span></b>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="info">
|
||||
|
||||
|
||||
<b>Namespace:</b> <a href="namespace-GeoIp2.html">GeoIp2</a>\<a href="namespace-GeoIp2.Record.html">Record</a><br />
|
||||
|
||||
|
||||
<b>Located at</b> <a href="source-class-GeoIp2.Record.MaxMind.html#5-19" title="Go to source code">GeoIp2/Record/MaxMind.php</a><br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="magicProperties">
|
||||
<caption>Magic properties summary</caption>
|
||||
<tr data-order="queriesRemaining" id="m$queriesRemaining">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
integer
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.MaxMind.html#10-11" title="Go to source code"><var>$queriesRemaining</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$queriesRemaining" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>The number of remaining queries you have for the end point you are
|
||||
calling.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>The number of remaining queries you have for the end point you are
|
||||
calling.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
236
doc/v0.4.0/class-GeoIp2.Record.Postal.html
Normal file
236
doc/v0.4.0/class-GeoIp2.Record.Postal.html
Normal file
|
|
@ -0,0 +1,236 @@
|
|||
<!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\Record\Postal | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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" />
|
||||
<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.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>
|
||||
<li>
|
||||
<a href="geoip2-php-api-v0-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</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>
|
||||
|
||||
|
||||
|
||||
</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> <a href="namespace-GeoIp2.html">GeoIp2</a>\<a href="namespace-GeoIp2.Record.html">Record</a><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" 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>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$code" class="anchor">#</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">
|
||||
|
||||
<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></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>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$confidence" class="anchor">#</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 Omni end point.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>A value from 0-100 indicating MaxMind's confidence that the postal code is
|
||||
correct. This attribute is only available from the Omni end point.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
367
doc/v0.4.0/class-GeoIp2.Record.RepresentedCountry.html
Normal file
367
doc/v0.4.0/class-GeoIp2.Record.RepresentedCountry.html
Normal file
|
|
@ -0,0 +1,367 @@
|
|||
<!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\Record\RepresentedCountry | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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><a href="class-GeoIp2.Record.Postal.html">Postal</a></li>
|
||||
<li class="active"><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" />
|
||||
<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.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>
|
||||
<li>
|
||||
<a href="geoip2-php-api-v0-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="class">
|
||||
<h1>Class RepresentedCountry</h1>
|
||||
|
||||
|
||||
<div class="description">
|
||||
|
||||
<p>Contains data for the represented country associated with an IP address</p>
|
||||
|
||||
<p>This class contains the country-level data associated with an IP address for
|
||||
the IP's represented country. The represented country is the country represented
|
||||
by something like a military base or embassy.</p>
|
||||
|
||||
<p>This record is returned by all the end points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<dl class="tree">
|
||||
<dd style="padding-left:0px">
|
||||
<a href="class-GeoIp2.Record.AbstractRecord.html"><span>GeoIp2\Record\AbstractRecord</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:30px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<a href="class-GeoIp2.Record.AbstractPlaceRecord.html"><span>GeoIp2\Record\AbstractPlaceRecord</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:60px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<a href="class-GeoIp2.Record.Country.html"><span>GeoIp2\Record\Country</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:90px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<b><span>GeoIp2\Record\RepresentedCountry</span></b>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="info">
|
||||
|
||||
|
||||
<b>Namespace:</b> <a href="namespace-GeoIp2.html">GeoIp2</a>\<a href="namespace-GeoIp2.Record.html">Record</a><br />
|
||||
|
||||
|
||||
<b>Located at</b> <a href="source-class-GeoIp2.Record.RepresentedCountry.html#5-45" title="Go to source code">GeoIp2/Record/RepresentedCountry.php</a><br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="magicProperties">
|
||||
<caption>Magic properties summary</caption>
|
||||
<tr data-order="confidence" id="m$confidence">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
integer
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.RepresentedCountry.html#14-16" title="Go to source code"><var>$confidence</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$confidence" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>A value from 0-100 indicating MaxMind's confidence that the country is
|
||||
correct. This attribute is only available from the Omni end point.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>A value from 0-100 indicating MaxMind's confidence that the country is
|
||||
correct. This attribute is only available from the Omni end point.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="geonameId" id="m$geonameId">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
integer
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.RepresentedCountry.html#18-19" title="Go to source code"><var>$geonameId</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$geonameId" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>The GeoName ID for the country. This attribute is returned by all end
|
||||
points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>The GeoName ID for the country. This attribute is returned by all end
|
||||
points.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="isoCode" id="m$isoCode">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
string
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.RepresentedCountry.html#21-23" title="Go to source code"><var>$isoCode</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$isoCode" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>The <a href="http://en.wikipedia.org/wiki/ISO_3166-1">two-character ISO 3166-1 alpha code</a> for the country. This attribute is returned
|
||||
by all end points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>The <a href="http://en.wikipedia.org/wiki/ISO_3166-1">two-character ISO 3166-1 alpha code</a> for the country. This attribute is returned
|
||||
by all end points.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="name" id="m$name">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
string
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.RepresentedCountry.html#25-26" title="Go to source code"><var>$name</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$name" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>The name of the country based on the languages list passed to the
|
||||
constructor. This attribute is returned by all end points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>The name of the country based on the languages list passed to the
|
||||
constructor. This attribute is returned by all end points.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="names" id="m$names">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
array
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.RepresentedCountry.html#28-29" title="Go to source code"><var>$names</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$names" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>An array map where the keys are language codes and the values are names. This
|
||||
attribute is returned by all end points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>An array map where the keys are language codes and the values are names. This
|
||||
attribute is returned by all end points.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="type" id="m$type">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
string
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.RepresentedCountry.html#31-34" title="Go to source code"><var>$type</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$type" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>A string indicating the type of entity that is representing the country.
|
||||
Currently we only return <code>military</code> but this could expand to include
|
||||
other types such as <code>embassy</code> in the future. Returned by all
|
||||
endpoints.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>A string indicating the type of entity that is representing the country.
|
||||
Currently we only return <code>military</code> but this could expand to include
|
||||
other types such as <code>embassy</code> in the future. Returned by all
|
||||
endpoints.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
329
doc/v0.4.0/class-GeoIp2.Record.Subdivision.html
Normal file
329
doc/v0.4.0/class-GeoIp2.Record.Subdivision.html
Normal file
|
|
@ -0,0 +1,329 @@
|
|||
<!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\Record\Subdivision | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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><a href="class-GeoIp2.Record.Postal.html">Postal</a></li>
|
||||
<li><a href="class-GeoIp2.Record.RepresentedCountry.html">RepresentedCountry</a></li>
|
||||
<li class="active"><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" />
|
||||
<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.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>
|
||||
<li>
|
||||
<a href="geoip2-php-api-v0-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="class">
|
||||
<h1>Class Subdivision</h1>
|
||||
|
||||
|
||||
<div class="description">
|
||||
|
||||
<p>Contains data for the subdivisions 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>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:30px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<a href="class-GeoIp2.Record.AbstractPlaceRecord.html"><span>GeoIp2\Record\AbstractPlaceRecord</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:60px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<b><span>GeoIp2\Record\Subdivision</span></b>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="info">
|
||||
|
||||
|
||||
<b>Namespace:</b> <a href="namespace-GeoIp2.html">GeoIp2</a>\<a href="namespace-GeoIp2.Record.html">Record</a><br />
|
||||
|
||||
|
||||
<b>Located at</b> <a href="source-class-GeoIp2.Record.Subdivision.html#5-42" title="Go to source code">GeoIp2/Record/Subdivision.php</a><br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="magicProperties">
|
||||
<caption>Magic properties summary</caption>
|
||||
<tr data-order="confidence" id="m$confidence">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
integer
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Subdivision.html#11-13" title="Go to source code"><var>$confidence</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$confidence" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>This is a value from 0-100 indicating MaxMind's confidence that the
|
||||
subdivision is correct. This attribute is only available from the Omni end
|
||||
point.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>This is a value from 0-100 indicating MaxMind's confidence that the
|
||||
subdivision is correct. This attribute is only available from the Omni end
|
||||
point.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="geonameId" id="m$geonameId">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
integer
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Subdivision.html#15-16" title="Go to source code"><var>$geonameId</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$geonameId" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>This is a GeoName ID for the subdivision. This attribute is returned by all
|
||||
end points except Country.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>This is a GeoName ID for the subdivision. This attribute is returned by all
|
||||
end points except Country.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="isoCode" id="m$isoCode">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
string
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Subdivision.html#18-21" title="Go to source code"><var>$isoCode</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$isoCode" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>This is a string up to three characters long contain the subdivision portion
|
||||
of the <a href="http://en.wikipedia.org/wiki/ISO_3166-2">ISO 3166-2 code</a>. This attribute is returned by all end points except
|
||||
Country.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>This is a string up to three characters long contain the subdivision portion
|
||||
of the <a href="http://en.wikipedia.org/wiki/ISO_3166-2">ISO 3166-2 code</a>. This attribute is returned by all end points except
|
||||
Country.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="name" id="m$name">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
string
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Subdivision.html#23-25" title="Go to source code"><var>$name</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$name" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>The name of the subdivision based on the languages list passed to the
|
||||
constructor. This attribute is returned by all end points except Country.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>The name of the subdivision based on the languages list passed to the
|
||||
constructor. This attribute is returned by all end points except Country.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="names" id="m$names">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
array
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Subdivision.html#27-29" title="Go to source code"><var>$names</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$names" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>An array map where the keys are language codes and the values are names. This
|
||||
attribute is returned by all end points except Country.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>An array map where the keys are language codes and the values are names. This
|
||||
attribute is returned by all end points except Country.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
505
doc/v0.4.0/class-GeoIp2.Record.Traits.html
Normal file
505
doc/v0.4.0/class-GeoIp2.Record.Traits.html
Normal file
|
|
@ -0,0 +1,505 @@
|
|||
<!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\Record\Traits | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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><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 class="active"><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" />
|
||||
<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.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>
|
||||
<li>
|
||||
<a href="geoip2-php-api-v0-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="class">
|
||||
<h1>Class Traits</h1>
|
||||
|
||||
|
||||
<div class="description">
|
||||
|
||||
<p>Contains data for the traits record associated with an IP address</p>
|
||||
|
||||
<p>This record is returned by all the end points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<dl class="tree">
|
||||
<dd style="padding-left:0px">
|
||||
<a href="class-GeoIp2.Record.AbstractRecord.html"><span>GeoIp2\Record\AbstractRecord</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:30px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<b><span>GeoIp2\Record\Traits</span></b>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="info">
|
||||
|
||||
|
||||
<b>Namespace:</b> <a href="namespace-GeoIp2.html">GeoIp2</a>\<a href="namespace-GeoIp2.Record.html">Record</a><br />
|
||||
|
||||
|
||||
<b>Located at</b> <a href="source-class-GeoIp2.Record.Traits.html#5-87" title="Go to source code">GeoIp2/Record/Traits.php</a><br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="magicProperties">
|
||||
<caption>Magic properties summary</caption>
|
||||
<tr data-order="autonomousSystemNumber" id="m$autonomousSystemNumber">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
integer
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Traits.html#11-14" title="Go to source code"><var>$autonomousSystemNumber</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$autonomousSystemNumber" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>The <a href="http://en.wikipedia.org/wiki/Autonomous_system_(Internet)">autonomous system number</a> associated with the IP address. This attribute is only
|
||||
available from the City/ISP/Org and Omni end points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>The <a href="http://en.wikipedia.org/wiki/Autonomous_system_(Internet)">autonomous system number</a> associated with the IP address. This attribute is only
|
||||
available from the City/ISP/Org and Omni end points.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="autonomousSystemOrganization" id="m$autonomousSystemOrganization">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
string
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Traits.html#16-20" title="Go to source code"><var>$autonomousSystemOrganization</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$autonomousSystemOrganization" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>The organization associated with the registered <a href="http://en.wikipedia.org/wiki/Autonomous_system_(Internet)">autonomous system number</a> for the IP address. This attribute is only available
|
||||
from the City/ISP/Org and Omni end points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>The organization associated with the registered <a href="http://en.wikipedia.org/wiki/Autonomous_system_(Internet)">autonomous system number</a> for the IP address. This attribute is only available
|
||||
from the City/ISP/Org and Omni end points.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="domain" id="m$domain">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
string
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Traits.html#22-25" title="Go to source code"><var>$domain</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$domain" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>The second level domain associated with the IP address. This will be
|
||||
something like "example.com" or "example.co.uk", not "foo.example.com". This
|
||||
attribute is only available from the City/ISP/Org and Omni end points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>The second level domain associated with the IP address. This will be
|
||||
something like "example.com" or "example.co.uk", not "foo.example.com". This
|
||||
attribute is only available from the City/ISP/Org and Omni end points.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="ipAddress" id="m$ipAddress">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
string
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Traits.html#27-32" title="Go to source code"><var>$ipAddress</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$ipAddress" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>The IP address that the data in the model is for. If you performed a "me"
|
||||
lookup against the web service, this will be the externally routable IP address
|
||||
for the system the code is running on. If the system is behind a NAT, this may
|
||||
differ from the IP address locally assigned to it. This attribute is returned by
|
||||
all end points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>The IP address that the data in the model is for. If you performed a "me"
|
||||
lookup against the web service, this will be the externally routable IP address
|
||||
for the system the code is running on. If the system is behind a NAT, this may
|
||||
differ from the IP address locally assigned to it. This attribute is returned by
|
||||
all end points.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="isAnonymousProxy" id="m$isAnonymousProxy">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
boolean
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Traits.html#34-36" title="Go to source code"><var>$isAnonymousProxy</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$isAnonymousProxy" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>This is true if the IP is an anonymous proxy. See <a href="http://dev.maxmind.com/faq/geoip#anonproxy">http://dev.maxmind.com/faq/geoip#anonproxy</a>
|
||||
for further details. This attribute is returned by all end points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>This is true if the IP is an anonymous proxy. See <a href="http://dev.maxmind.com/faq/geoip#anonproxy">http://dev.maxmind.com/faq/geoip#anonproxy</a>
|
||||
for further details. This attribute is returned by all end points.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="isSatelliteProvider" id="m$isSatelliteProvider">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
boolean
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Traits.html#38-40" title="Go to source code"><var>$isSatelliteProvider</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$isSatelliteProvider" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>This is true if the IP belongs to a satellite Internet provider. This
|
||||
attribute is returned by all end points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>This is true if the IP belongs to a satellite Internet provider. This
|
||||
attribute is returned by all end points.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="isp" id="m$isp">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
string
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Traits.html#42-44" title="Go to source code"><var>$isp</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$isp" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>The name of the ISP associated with the IP address. This attribute is only
|
||||
available from the City/ISP/Org and Omni end points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>The name of the ISP associated with the IP address. This attribute is only
|
||||
available from the City/ISP/Org and Omni end points.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="organization" id="m$organization">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
string
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Traits.html#46-48" title="Go to source code"><var>$organization</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$organization" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>The name of the organization associated with the IP address. This attribute
|
||||
is only available from the City/ISP/Org and Omni end points.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>The name of the organization associated with the IP address. This attribute
|
||||
is only available from the City/ISP/Org and Omni end points.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="userType" id="m$userType">
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
string
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-GeoIp2.Record.Traits.html#50-69" title="Go to source code"><var>$userType</var></a>
|
||||
</td>
|
||||
<td class="description"><div>
|
||||
<a href="#m$userType" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>The user type associated with the IP address. This can be one of the
|
||||
following values:</p>
|
||||
|
||||
<ul>
|
||||
<li>business</li>
|
||||
|
||||
<li>cafe</li>
|
||||
|
||||
<li>cellular</li>
|
||||
|
||||
<li>college</li>
|
||||
|
||||
<li>content_delivery_network</li>
|
||||
|
||||
<li>dialup</li>
|
||||
|
||||
<li>government</li>
|
||||
|
||||
<li>hosting</li>
|
||||
|
||||
<li>library</li>
|
||||
|
||||
<li>military</li>
|
||||
|
||||
<li>residential</li>
|
||||
|
||||
<li>router</li>
|
||||
|
||||
<li>school</li>
|
||||
|
||||
<li>search_engine_spider</li>
|
||||
|
||||
<li>traveler</li>
|
||||
</ul>
|
||||
|
||||
<p>This attribute is only available from the Omni end point.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>The user type associated with the IP address. This can be one of the
|
||||
following values:</p>
|
||||
|
||||
<ul>
|
||||
<li>business</li>
|
||||
|
||||
<li>cafe</li>
|
||||
|
||||
<li>cellular</li>
|
||||
|
||||
<li>college</li>
|
||||
|
||||
<li>content_delivery_network</li>
|
||||
|
||||
<li>dialup</li>
|
||||
|
||||
<li>government</li>
|
||||
|
||||
<li>hosting</li>
|
||||
|
||||
<li>library</li>
|
||||
|
||||
<li>military</li>
|
||||
|
||||
<li>residential</li>
|
||||
|
||||
<li>router</li>
|
||||
|
||||
<li>school</li>
|
||||
|
||||
<li>search_engine_spider</li>
|
||||
|
||||
<li>traveler</li>
|
||||
</ul>
|
||||
|
||||
<p>This attribute is only available from the Omni end point.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
454
doc/v0.4.0/class-GeoIp2.WebService.Client.html
Normal file
454
doc/v0.4.0/class-GeoIp2.WebService.Client.html
Normal file
|
|
@ -0,0 +1,454 @@
|
|||
<!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\WebService\Client | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><a href="namespace-GeoIp2.Model.html">Model</a>
|
||||
</li>
|
||||
<li><a href="namespace-GeoIp2.Record.html">Record</a>
|
||||
</li>
|
||||
<li class="active"><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 class="active"><a href="class-GeoIp2.WebService.Client.html">Client</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.WebService.html" title="Summary of GeoIp2\WebService"><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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="class">
|
||||
<h1>Class Client</h1>
|
||||
|
||||
|
||||
<div class="description">
|
||||
|
||||
<p>This class provides a client API for all the GeoIP2 web service's end points.
|
||||
The end points are Country, City, City/ISP/Org, and Omni. Each end point returns
|
||||
a different set of data about an IP address, with Country returning the least
|
||||
data and Omni the most.</p>
|
||||
|
||||
<p>Each web service end point is represented by a different model class, and
|
||||
these model classes in turn contain multiple Record classes. The record classes
|
||||
have attributes which contain data about the IP address.</p>
|
||||
|
||||
<p>If the web service does not return a particular piece of data for an IP
|
||||
address, the associated attribute is not populated.</p>
|
||||
|
||||
<p>The web service may not return any information for an entire record, in which
|
||||
case all of the attributes for that record class will be empty.</p>
|
||||
|
||||
<p><strong>Usage</strong></p>
|
||||
|
||||
<p>The basic API for this class is the same for all of the web service end
|
||||
points. First you create a web service object with your MaxMind <code><span
|
||||
class="php-var">$userId</span></code> and <code><span
|
||||
class="php-var">$licenseKey</span></code>, then you call the method
|
||||
corresponding to a specific end point, passing it the IP address you want to
|
||||
look up.</p>
|
||||
|
||||
<p>If the request succeeds, the method call will return a model class for the
|
||||
end point you called. This model in turn contains multiple record classes, each
|
||||
of which represents part of the data returned by the web service.</p>
|
||||
|
||||
<p>If the request fails, the client class throws an exception.</p>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="info">
|
||||
|
||||
|
||||
<b>Namespace:</b> <a href="namespace-GeoIp2.html">GeoIp2</a>\<a href="namespace-GeoIp2.WebService.html">WebService</a><br />
|
||||
|
||||
|
||||
<b>Located at</b> <a href="source-class-GeoIp2.WebService.Client.html#20-364" title="Go to source code">GeoIp2/WebService/Client.php</a><br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="methods">
|
||||
<caption>Methods summary</caption>
|
||||
<tr data-order="__construct" id="___construct">
|
||||
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
|
||||
|
||||
</code>
|
||||
</td>
|
||||
|
||||
<td class="name"><div>
|
||||
<a class="anchor" href="#___construct">#</a>
|
||||
<code><a href="source-class-GeoIp2.WebService.Client.html#59-83" title="Go to source code">__construct</a>( <span>integer <var>$userId</var></span>, <span>string <var>$licenseKey</var></span>, <span>array <var>$languages</var> = <span class="php-keyword1">array</span>(<span class="php-quote">'en'</span>)</span>, <span>string <var>$host</var> = <span class="php-quote">'geoip.maxmind.com'</span></span>, <span>object <var>$guzzleClient</var> = <span class="php-keyword1">null</span> </span> )</code>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>Constructor.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>Constructor.</p>
|
||||
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<div class="list"><dl>
|
||||
<dt><var>$userId</var></dt>
|
||||
<dd><code>integer</code><br>$userId Your MaxMind user ID</dd>
|
||||
<dt><var>$licenseKey</var></dt>
|
||||
<dd><code>string</code><br>$licenseKey Your MaxMind license key</dd>
|
||||
<dt><var>$languages</var></dt>
|
||||
<dd><code>array</code><br>$languages List of language codes to use in name property from most preferred to
|
||||
least preferred.</dd>
|
||||
<dt><var>$host</var></dt>
|
||||
<dd><code>string</code><br>$host Optional host parameter</dd>
|
||||
<dt><var>$guzzleClient</var></dt>
|
||||
<dd><code>object</code><br>$guzzleClient Optional Guzzle client to use (to facilitate unit testing).</dd>
|
||||
</dl></div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="city" id="_city">
|
||||
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
<code><a href="class-GeoIp2.Model.City.html">GeoIp2\Model\City</a></code>
|
||||
|
||||
</code>
|
||||
</td>
|
||||
|
||||
<td class="name"><div>
|
||||
<a class="anchor" href="#_city">#</a>
|
||||
<code><a href="source-class-GeoIp2.WebService.Client.html#85-115" title="Go to source code">city</a>( <span>string <var>$ipAddress</var> = <span class="php-quote">'me'</span></span> )</code>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>This method calls the GeoIP2 City endpoint.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>This method calls the GeoIP2 City endpoint.</p>
|
||||
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<div class="list"><dl>
|
||||
<dt><var>$ipAddress</var></dt>
|
||||
<dd><code>string</code><br>$ipAddress IPv4 or IPv6 address as a string. If no address is provided, the
|
||||
address that the web service is called from will be used.</dd>
|
||||
</dl></div>
|
||||
|
||||
<h4>Returns</h4>
|
||||
<div class="list">
|
||||
<code><code><a href="class-GeoIp2.Model.City.html">GeoIp2\Model\City</a></code></code><br />
|
||||
</div>
|
||||
|
||||
<h4>Throws</h4>
|
||||
<div class="list">
|
||||
<code><code><a href="class-GeoIp2.Exception.AddressNotFoundException.html">GeoIp2\Exception\AddressNotFoundException</a></code></code><br>if the address you provided is not in our database (e.g., a private address).<br />
|
||||
<code><code><a href="class-GeoIp2.Exception.AuthenticationException.html">GeoIp2\Exception\AuthenticationException</a></code></code><br>if there is a problem with the user ID or license key that you provided.<br />
|
||||
<code>GeoIp2\Exception\QutOfQueriesException</code><br>if your account is out of queries.<br />
|
||||
<code>GeoIp2\Exception\InvalidRequestException}</code><br>if your request was received by the web service but is invalid for some other
|
||||
reason. This may indicate an issue with this API. Please report the error to
|
||||
MaxMind.<br />
|
||||
<code><code><a href="class-GeoIp2.Exception.HttpException.html">GeoIp2\Exception\HttpException</a></code></code><br>if an unexpected HTTP error code or message was returned. This could indicate a
|
||||
problem with the connection between your server and the web service or that the
|
||||
web service returned an invalid document or 500 error code.<br />
|
||||
<code><code><a href="class-GeoIp2.Exception.GeoIp2Exception.html">GeoIp2\Exception\GeoIp2Exception</a></code></code><br>This serves as the parent class to the above exceptions. It will be thrown
|
||||
directly if a 200 status code is returned but the body is invalid.<br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="country" id="_country">
|
||||
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
<code><a href="class-GeoIp2.Model.Country.html">GeoIp2\Model\Country</a></code>
|
||||
|
||||
</code>
|
||||
</td>
|
||||
|
||||
<td class="name"><div>
|
||||
<a class="anchor" href="#_country">#</a>
|
||||
<code><a href="source-class-GeoIp2.WebService.Client.html#117-147" title="Go to source code">country</a>( <span>string <var>$ipAddress</var> = <span class="php-quote">'me'</span></span> )</code>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>This method calls the GeoIP2 Country endpoint.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>This method calls the GeoIP2 Country endpoint.</p>
|
||||
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<div class="list"><dl>
|
||||
<dt><var>$ipAddress</var></dt>
|
||||
<dd><code>string</code><br>$ipAddress IPv4 or IPv6 address as a string. If no address is provided, the
|
||||
address that the web service is called from will be used.</dd>
|
||||
</dl></div>
|
||||
|
||||
<h4>Returns</h4>
|
||||
<div class="list">
|
||||
<code><code><a href="class-GeoIp2.Model.Country.html">GeoIp2\Model\Country</a></code></code><br />
|
||||
</div>
|
||||
|
||||
<h4>Throws</h4>
|
||||
<div class="list">
|
||||
<code><code><a href="class-GeoIp2.Exception.AddressNotFoundException.html">GeoIp2\Exception\AddressNotFoundException</a></code></code><br>if the address you provided is not in our database (e.g., a private address).<br />
|
||||
<code><code><a href="class-GeoIp2.Exception.AuthenticationException.html">GeoIp2\Exception\AuthenticationException</a></code></code><br>if there is a problem with the user ID or license key that you provided.<br />
|
||||
<code>GeoIp2\Exception\QutOfQueriesException</code><br>if your account is out of queries.<br />
|
||||
<code>GeoIp2\Exception\InvalidRequestException}</code><br>if your request was received by the web service but is invalid for some other
|
||||
reason. This may indicate an issue with this API. Please report the error to
|
||||
MaxMind.<br />
|
||||
<code><code><a href="class-GeoIp2.Exception.HttpException.html">GeoIp2\Exception\HttpException</a></code></code><br>if an unexpected HTTP error code or message was returned. This could indicate a
|
||||
problem with the connection between your server and the web service or that the
|
||||
web service returned an invalid document or 500 error code.<br />
|
||||
<code><code><a href="class-GeoIp2.Exception.GeoIp2Exception.html">GeoIp2\Exception\GeoIp2Exception</a></code></code><br>This serves as the parent class to the above exceptions. It will be thrown
|
||||
directly if a 200 status code is returned but the body is invalid.<br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="cityIspOrg" id="_cityIspOrg">
|
||||
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
<code><a href="class-GeoIp2.Model.CityIspOrg.html">GeoIp2\Model\CityIspOrg</a></code>
|
||||
|
||||
</code>
|
||||
</td>
|
||||
|
||||
<td class="name"><div>
|
||||
<a class="anchor" href="#_cityIspOrg">#</a>
|
||||
<code><a href="source-class-GeoIp2.WebService.Client.html#149-179" title="Go to source code">cityIspOrg</a>( <span>string <var>$ipAddress</var> = <span class="php-quote">'me'</span></span> )</code>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>This method calls the GeoIP2 City/ISP/Org endpoint.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>This method calls the GeoIP2 City/ISP/Org endpoint.</p>
|
||||
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<div class="list"><dl>
|
||||
<dt><var>$ipAddress</var></dt>
|
||||
<dd><code>string</code><br>$ipAddress IPv4 or IPv6 address as a string. If no address is provided, the
|
||||
address that the web service is called from will be used.</dd>
|
||||
</dl></div>
|
||||
|
||||
<h4>Returns</h4>
|
||||
<div class="list">
|
||||
<code><code><a href="class-GeoIp2.Model.CityIspOrg.html">GeoIp2\Model\CityIspOrg</a></code></code><br />
|
||||
</div>
|
||||
|
||||
<h4>Throws</h4>
|
||||
<div class="list">
|
||||
<code><code><a href="class-GeoIp2.Exception.AddressNotFoundException.html">GeoIp2\Exception\AddressNotFoundException</a></code></code><br>if the address you provided is not in our database (e.g., a private address).<br />
|
||||
<code><code><a href="class-GeoIp2.Exception.AuthenticationException.html">GeoIp2\Exception\AuthenticationException</a></code></code><br>if there is a problem with the user ID or license key that you provided.<br />
|
||||
<code>GeoIp2\Exception\QutOfQueriesException</code><br>if your account is out of queries.<br />
|
||||
<code>GeoIp2\Exception\InvalidRequestException}</code><br>if your request was received by the web service but is invalid for some other
|
||||
reason. This may indicate an issue with this API. Please report the error to
|
||||
MaxMind.<br />
|
||||
<code><code><a href="class-GeoIp2.Exception.HttpException.html">GeoIp2\Exception\HttpException</a></code></code><br>if an unexpected HTTP error code or message was returned. This could indicate a
|
||||
problem with the connection between your server and the web service or that the
|
||||
web service returned an invalid document or 500 error code.<br />
|
||||
<code><code><a href="class-GeoIp2.Exception.GeoIp2Exception.html">GeoIp2\Exception\GeoIp2Exception</a></code></code><br>This serves as the parent class to the above exceptions. It will be thrown
|
||||
directly if a 200 status code is returned but the body is invalid.<br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="omni" id="_omni">
|
||||
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
<code><a href="class-GeoIp2.Model.Omni.html">GeoIp2\Model\Omni</a></code>
|
||||
|
||||
</code>
|
||||
</td>
|
||||
|
||||
<td class="name"><div>
|
||||
<a class="anchor" href="#_omni">#</a>
|
||||
<code><a href="source-class-GeoIp2.WebService.Client.html#181-211" title="Go to source code">omni</a>( <span>string <var>$ipAddress</var> = <span class="php-quote">'me'</span></span> )</code>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>This method calls the GeoIP2 Omni endpoint.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>This method calls the GeoIP2 Omni endpoint.</p>
|
||||
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<div class="list"><dl>
|
||||
<dt><var>$ipAddress</var></dt>
|
||||
<dd><code>string</code><br>$ipAddress IPv4 or IPv6 address as a string. If no address is provided, the
|
||||
address that the web service is called from will be used.</dd>
|
||||
</dl></div>
|
||||
|
||||
<h4>Returns</h4>
|
||||
<div class="list">
|
||||
<code><code><a href="class-GeoIp2.Model.Omni.html">GeoIp2\Model\Omni</a></code></code><br />
|
||||
</div>
|
||||
|
||||
<h4>Throws</h4>
|
||||
<div class="list">
|
||||
<code><code><a href="class-GeoIp2.Exception.AddressNotFoundException.html">GeoIp2\Exception\AddressNotFoundException</a></code></code><br>if the address you provided is not in our database (e.g., a private address).<br />
|
||||
<code><code><a href="class-GeoIp2.Exception.AuthenticationException.html">GeoIp2\Exception\AuthenticationException</a></code></code><br>if there is a problem with the user ID or license key that you provided.<br />
|
||||
<code>GeoIp2\Exception\QutOfQueriesException</code><br>if your account is out of queries.<br />
|
||||
<code>GeoIp2\Exception\InvalidRequestException}</code><br>if your request was received by the web service but is invalid for some other
|
||||
reason. This may indicate an issue with this API. Please report the error to
|
||||
MaxMind.<br />
|
||||
<code><code><a href="class-GeoIp2.Exception.HttpException.html">GeoIp2\Exception\HttpException</a></code></code><br>if an unexpected HTTP error code or message was returned. This could indicate a
|
||||
problem with the connection between your server and the web service or that the
|
||||
web service returned an invalid document or 500 error code.<br />
|
||||
<code><code><a href="class-GeoIp2.Exception.GeoIp2Exception.html">GeoIp2\Exception\GeoIp2Exception</a></code></code><br>This serves as the parent class to the above exceptions. It will be thrown
|
||||
directly if a 200 status code is returned but the body is invalid.<br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
3
doc/v0.4.0/elementlist.js
Normal file
3
doc/v0.4.0/elementlist.js
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
|
||||
var ApiGen = ApiGen || {};
|
||||
ApiGen.elements = [["c","Exception"],["c","GeoIp2\\Database\\Reader"],["c","GeoIp2\\Exception\\AddressNotFoundException"],["c","GeoIp2\\Exception\\AuthenticationException"],["c","GeoIp2\\Exception\\GeoIp2Exception"],["c","GeoIp2\\Exception\\HttpException"],["c","GeoIp2\\Exception\\InvalidRequestException"],["c","GeoIp2\\Exception\\OutOfQueriesException"],["c","GeoIp2\\Model\\City"],["c","GeoIp2\\Model\\CityIspOrg"],["c","GeoIp2\\Model\\Country"],["c","GeoIp2\\Model\\Omni"],["c","GeoIp2\\Record\\AbstractPlaceRecord"],["c","GeoIp2\\Record\\AbstractRecord"],["c","GeoIp2\\Record\\City"],["c","GeoIp2\\Record\\Continent"],["c","GeoIp2\\Record\\Country"],["c","GeoIp2\\Record\\Location"],["c","GeoIp2\\Record\\MaxMind"],["c","GeoIp2\\Record\\Postal"],["c","GeoIp2\\Record\\RepresentedCountry"],["c","GeoIp2\\Record\\Subdivision"],["c","GeoIp2\\Record\\Traits"],["c","GeoIp2\\WebService\\Client"]];
|
||||
BIN
doc/v0.4.0/geoip2-php-api-v0-4-0-api-documentation.zip
Normal file
BIN
doc/v0.4.0/geoip2-php-api-v0-4-0-api-documentation.zip
Normal file
Binary file not shown.
154
doc/v0.4.0/index.html
Normal file
154
doc/v0.4.0/index.html
Normal file
|
|
@ -0,0 +1,154 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
|
||||
<title>GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js"></script>
|
||||
<script type="text/javascript" src="elementlist.js"></script>
|
||||
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
|
||||
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div id="left">
|
||||
<div id="menu">
|
||||
<span>Overview</span>
|
||||
|
||||
<div id="groups">
|
||||
<h3>Namespaces</h3>
|
||||
<ul>
|
||||
<li><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><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.Database.Reader.html">GeoIp2\Database\Reader</a></li>
|
||||
<li><a href="class-GeoIp2.Model.City.html">GeoIp2\Model\City</a></li>
|
||||
<li><a href="class-GeoIp2.Model.CityIspOrg.html">GeoIp2\Model\CityIspOrg</a></li>
|
||||
<li><a href="class-GeoIp2.Model.Country.html">GeoIp2\Model\Country</a></li>
|
||||
<li><a href="class-GeoIp2.Model.Omni.html">GeoIp2\Model\Omni</a></li>
|
||||
<li><a href="class-GeoIp2.Record.AbstractPlaceRecord.html">GeoIp2\Record\AbstractPlaceRecord</a></li>
|
||||
<li><a href="class-GeoIp2.Record.AbstractRecord.html">GeoIp2\Record\AbstractRecord</a></li>
|
||||
<li><a href="class-GeoIp2.Record.City.html">GeoIp2\Record\City</a></li>
|
||||
<li><a href="class-GeoIp2.Record.Continent.html">GeoIp2\Record\Continent</a></li>
|
||||
<li><a href="class-GeoIp2.Record.Country.html">GeoIp2\Record\Country</a></li>
|
||||
<li><a href="class-GeoIp2.Record.Location.html">GeoIp2\Record\Location</a></li>
|
||||
<li><a href="class-GeoIp2.Record.MaxMind.html">GeoIp2\Record\MaxMind</a></li>
|
||||
<li><a href="class-GeoIp2.Record.Postal.html">GeoIp2\Record\Postal</a></li>
|
||||
<li><a href="class-GeoIp2.Record.RepresentedCountry.html">GeoIp2\Record\RepresentedCountry</a></li>
|
||||
<li><a href="class-GeoIp2.Record.Subdivision.html">GeoIp2\Record\Subdivision</a></li>
|
||||
<li><a href="class-GeoIp2.Record.Traits.html">GeoIp2\Record\Traits</a></li>
|
||||
<li><a href="class-GeoIp2.WebService.Client.html">GeoIp2\WebService\Client</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<h3>Exceptions</h3>
|
||||
<ul>
|
||||
<li><a href="class-Exception.html">Exception</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.AddressNotFoundException.html">GeoIp2\Exception\AddressNotFoundException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.AuthenticationException.html">GeoIp2\Exception\AuthenticationException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.GeoIp2Exception.html">GeoIp2\Exception\GeoIp2Exception</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.HttpException.html">GeoIp2\Exception\HttpException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.InvalidRequestException.html">GeoIp2\Exception\InvalidRequestException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.OutOfQueriesException.html">GeoIp2\Exception\OutOfQueriesException</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" autofocus />
|
||||
<input type="submit" value="Search" />
|
||||
</form>
|
||||
|
||||
<div id="navigation">
|
||||
<ul>
|
||||
<li class="active">
|
||||
<span>Overview</span> </li>
|
||||
<li>
|
||||
<span>Namespace</span> </li>
|
||||
<li>
|
||||
<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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
<h1>GeoIP2 PHP API v0.4.0</h1>
|
||||
|
||||
|
||||
<table class="summary" id="namespaces">
|
||||
<caption>Namespaces summary</caption>
|
||||
<tr>
|
||||
<td class="name"><a href="namespace-GeoIp2.html">GeoIp2</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="namespace-GeoIp2.Database.html">GeoIp2\Database</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="namespace-GeoIp2.Exception.html">GeoIp2\Exception</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="namespace-GeoIp2.Model.html">GeoIp2\Model</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="namespace-GeoIp2.Record.html">GeoIp2\Record</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="namespace-GeoIp2.WebService.html">GeoIp2\WebService</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="namespace-PHP.html">PHP</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
123
doc/v0.4.0/namespace-GeoIp2.Database.html
Normal file
123
doc/v0.4.0/namespace-GeoIp2.Database.html
Normal file
|
|
@ -0,0 +1,123 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
|
||||
<title>Namespace GeoIp2\Database | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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 class="active"><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><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.Database.Reader.html">Reader</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 class="active">
|
||||
<span>Namespace</span> </li>
|
||||
<li>
|
||||
<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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="namespace">
|
||||
<h1>Namespace <a href="namespace-GeoIp2.html">GeoIp2</a>\Database</h1>
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="classes">
|
||||
<caption>Classes summary</caption>
|
||||
<tr>
|
||||
<td class="name"><a href="class-GeoIp2.Database.Reader.html">Reader</a></td>
|
||||
<td>Instances of this class provide a reader for the GeoIP2 database format. IP
|
||||
addresses can be looked up using the <code>country</code> and <code>city</code>
|
||||
methods. We also provide <code>cityIspOrg</code> and <code>omni</code> methods
|
||||
to ease compatibility with the web service client, although we may offer the
|
||||
ability to specify additional databases to replicate these web services in the
|
||||
future (e.g., the ISP/Org database).
|
||||
<!-- by Texy2! --></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
142
doc/v0.4.0/namespace-GeoIp2.Exception.html
Normal file
142
doc/v0.4.0/namespace-GeoIp2.Exception.html
Normal file
|
|
@ -0,0 +1,142 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
|
||||
<title>Namespace GeoIp2\Exception | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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 class="active"><a href="namespace-GeoIp2.Exception.html">Exception</a>
|
||||
</li>
|
||||
<li><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>Exceptions</h3>
|
||||
<ul>
|
||||
<li><a href="class-GeoIp2.Exception.AddressNotFoundException.html">AddressNotFoundException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.AuthenticationException.html">AuthenticationException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.GeoIp2Exception.html">GeoIp2Exception</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.HttpException.html">HttpException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.InvalidRequestException.html">InvalidRequestException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.OutOfQueriesException.html">OutOfQueriesException</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 class="active">
|
||||
<span>Namespace</span> </li>
|
||||
<li>
|
||||
<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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="namespace">
|
||||
<h1>Namespace <a href="namespace-GeoIp2.html">GeoIp2</a>\Exception</h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="exceptions">
|
||||
<caption>Exceptions summary</caption>
|
||||
<tr>
|
||||
<td class="name"><a href="class-GeoIp2.Exception.AddressNotFoundException.html">AddressNotFoundException</a></td>
|
||||
<td>This class represents a generic error.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="class-GeoIp2.Exception.AuthenticationException.html">AuthenticationException</a></td>
|
||||
<td>This class represents a generic error.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="class-GeoIp2.Exception.GeoIp2Exception.html">GeoIp2Exception</a></td>
|
||||
<td>This class represents a generic error.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="class-GeoIp2.Exception.HttpException.html">HttpException</a></td>
|
||||
<td>This class represents an HTTP transport error.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="class-GeoIp2.Exception.InvalidRequestException.html">InvalidRequestException</a></td>
|
||||
<td>This class represents an error returned by MaxMind's GeoIP2 web service.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="class-GeoIp2.Exception.OutOfQueriesException.html">OutOfQueriesException</a></td>
|
||||
<td>This class represents a generic error.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
134
doc/v0.4.0/namespace-GeoIp2.Model.html
Normal file
134
doc/v0.4.0/namespace-GeoIp2.Model.html
Normal file
|
|
@ -0,0 +1,134 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
|
||||
<title>Namespace GeoIp2\Model | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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 class="active">
|
||||
<span>Namespace</span> </li>
|
||||
<li>
|
||||
<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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="namespace">
|
||||
<h1>Namespace <a href="namespace-GeoIp2.html">GeoIp2</a>\Model</h1>
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="classes">
|
||||
<caption>Classes summary</caption>
|
||||
<tr>
|
||||
<td class="name"><a href="class-GeoIp2.Model.City.html">City</a></td>
|
||||
<td>This class provides a model for the data returned by the GeoIP2 City end point.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="class-GeoIp2.Model.CityIspOrg.html">CityIspOrg</a></td>
|
||||
<td>This class provides a model for the data returned by the GeoIP2 City/ISP/Org end
|
||||
point.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="class-GeoIp2.Model.Country.html">Country</a></td>
|
||||
<td>This class provides a model for the data returned by the GeoIP2 Country end
|
||||
point.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="class-GeoIp2.Model.Omni.html">Omni</a></td>
|
||||
<td>This class provides a model for the data returned by the GeoIP2 Omni end point.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
167
doc/v0.4.0/namespace-GeoIp2.Record.html
Normal file
167
doc/v0.4.0/namespace-GeoIp2.Record.html
Normal file
|
|
@ -0,0 +1,167 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
|
||||
<title>Namespace GeoIp2\Record | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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><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" />
|
||||
<input type="submit" value="Search" />
|
||||
</form>
|
||||
|
||||
<div id="navigation">
|
||||
<ul>
|
||||
<li>
|
||||
<a href="index.html" title="Overview"><span>Overview</span></a>
|
||||
</li>
|
||||
<li class="active">
|
||||
<span>Namespace</span> </li>
|
||||
<li>
|
||||
<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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="namespace">
|
||||
<h1>Namespace <a href="namespace-GeoIp2.html">GeoIp2</a>\Record</h1>
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="classes">
|
||||
<caption>Classes summary</caption>
|
||||
<tr>
|
||||
<td class="name"><a href="class-GeoIp2.Record.AbstractPlaceRecord.html">AbstractPlaceRecord</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="class-GeoIp2.Record.AbstractRecord.html">AbstractRecord</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="class-GeoIp2.Record.City.html">City</a></td>
|
||||
<td>City-level data associated with an IP address.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="class-GeoIp2.Record.Continent.html">Continent</a></td>
|
||||
<td>Contains data for the continent record associated with an IP address</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="class-GeoIp2.Record.Country.html">Country</a></td>
|
||||
<td>Contains data for the country record associated with an IP address</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="class-GeoIp2.Record.Location.html">Location</a></td>
|
||||
<td>Contains data for the location record associated with an IP address</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="class-GeoIp2.Record.MaxMind.html">MaxMind</a></td>
|
||||
<td>Contains data about your account.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="class-GeoIp2.Record.Postal.html">Postal</a></td>
|
||||
<td>Contains data for the postal record associated with an IP address</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="class-GeoIp2.Record.RepresentedCountry.html">RepresentedCountry</a></td>
|
||||
<td>Contains data for the represented country associated with an IP address</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="class-GeoIp2.Record.Subdivision.html">Subdivision</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="class-GeoIp2.Record.Traits.html">Traits</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
120
doc/v0.4.0/namespace-GeoIp2.WebService.html
Normal file
120
doc/v0.4.0/namespace-GeoIp2.WebService.html
Normal file
|
|
@ -0,0 +1,120 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
|
||||
<title>Namespace GeoIp2\WebService | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><a href="namespace-GeoIp2.Model.html">Model</a>
|
||||
</li>
|
||||
<li><a href="namespace-GeoIp2.Record.html">Record</a>
|
||||
</li>
|
||||
<li class="active"><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.WebService.Client.html">Client</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 class="active">
|
||||
<span>Namespace</span> </li>
|
||||
<li>
|
||||
<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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="namespace">
|
||||
<h1>Namespace <a href="namespace-GeoIp2.html">GeoIp2</a>\WebService</h1>
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="classes">
|
||||
<caption>Classes summary</caption>
|
||||
<tr>
|
||||
<td class="name"><a href="class-GeoIp2.WebService.Client.html">Client</a></td>
|
||||
<td>This class provides a client API for all the GeoIP2 web service's end points.
|
||||
The end points are Country, City, City/ISP/Org, and Omni. Each end point returns
|
||||
a different set of data about an IP address, with Country returning the least
|
||||
data and Omni the most.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
123
doc/v0.4.0/namespace-GeoIp2.html
Normal file
123
doc/v0.4.0/namespace-GeoIp2.html
Normal file
|
|
@ -0,0 +1,123 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
|
||||
<title>Namespace GeoIp2 | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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>
|
||||
|
||||
|
||||
|
||||
<div id="elements">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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 class="active">
|
||||
<span>Namespace</span> </li>
|
||||
<li>
|
||||
<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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="namespace">
|
||||
<h1>Namespace GeoIp2</h1>
|
||||
|
||||
<table class="summary" id="namespaces">
|
||||
<caption>Namespaces summary</caption>
|
||||
<tr>
|
||||
<td class="name"><a href="namespace-GeoIp2.Database.html">GeoIp2\Database</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="namespace-GeoIp2.Exception.html">GeoIp2\Exception</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="namespace-GeoIp2.Model.html">GeoIp2\Model</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="namespace-GeoIp2.Record.html">GeoIp2\Record</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="namespace-GeoIp2.WebService.html">GeoIp2\WebService</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
117
doc/v0.4.0/namespace-PHP.html
Normal file
117
doc/v0.4.0/namespace-PHP.html
Normal file
|
|
@ -0,0 +1,117 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
|
||||
<title>Namespace PHP | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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><a href="namespace-GeoIp2.Record.html">Record</a>
|
||||
</li>
|
||||
<li><a href="namespace-GeoIp2.WebService.html">WebService</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li class="active"><a href="namespace-PHP.html">PHP</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<hr />
|
||||
|
||||
|
||||
<div id="elements">
|
||||
|
||||
|
||||
|
||||
<h3>Exceptions</h3>
|
||||
<ul>
|
||||
<li><a href="class-Exception.html">Exception</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 class="active">
|
||||
<span>Namespace</span> </li>
|
||||
<li>
|
||||
<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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="namespace">
|
||||
<h1>Namespace PHP</h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="exceptions">
|
||||
<caption>Exceptions summary</caption>
|
||||
<tr>
|
||||
<td class="name"><a href="class-Exception.html">Exception</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
BIN
doc/v0.4.0/resources/collapsed.png
Normal file
BIN
doc/v0.4.0/resources/collapsed.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 238 B |
1264
doc/v0.4.0/resources/combined.js
Normal file
1264
doc/v0.4.0/resources/combined.js
Normal file
File diff suppressed because one or more lines are too long
BIN
doc/v0.4.0/resources/footer.png
Normal file
BIN
doc/v0.4.0/resources/footer.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 8.0 KiB |
BIN
doc/v0.4.0/resources/inherit.png
Normal file
BIN
doc/v0.4.0/resources/inherit.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 152 B |
BIN
doc/v0.4.0/resources/resize.png
Normal file
BIN
doc/v0.4.0/resources/resize.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 216 B |
BIN
doc/v0.4.0/resources/sort.png
Normal file
BIN
doc/v0.4.0/resources/sort.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 171 B |
608
doc/v0.4.0/resources/style.css
Normal file
608
doc/v0.4.0/resources/style.css
Normal file
|
|
@ -0,0 +1,608 @@
|
|||
/*!
|
||||
* ApiGen 2.8.0 - API documentation generator for PHP 5.3+
|
||||
*
|
||||
* Copyright (c) 2010-2011 David Grudl (http://davidgrudl.com)
|
||||
* Copyright (c) 2011-2012 Jaroslav Hanslík (https://github.com/kukulich)
|
||||
* Copyright (c) 2011-2012 Ondřej Nešpor (https://github.com/Andrewsville)
|
||||
*
|
||||
* For the full copyright and license information, please view
|
||||
* the file LICENSE.md that was distributed with this source code.
|
||||
*/
|
||||
|
||||
body {
|
||||
font: 13px/1.5 Verdana, 'Geneva CE', lucida, sans-serif;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
background: #ffffff;
|
||||
color: #333333;
|
||||
}
|
||||
|
||||
h1, h2, h3, h4, caption {
|
||||
font-family: 'Trebuchet MS', 'Geneva CE', lucida, sans-serif;
|
||||
color: #053368;
|
||||
}
|
||||
|
||||
h1 {
|
||||
color: #1e5eb6;
|
||||
font-size: 230%;
|
||||
font-weight: normal;
|
||||
margin: .3em 0;
|
||||
}
|
||||
|
||||
h2 {
|
||||
color: #1e5eb6;
|
||||
font-size: 150%;
|
||||
font-weight: normal;
|
||||
margin: -.3em 0 .3em 0;
|
||||
}
|
||||
|
||||
h3 {
|
||||
font-size: 1.6em;
|
||||
font-weight: normal;
|
||||
margin-bottom: 2px;
|
||||
}
|
||||
|
||||
h4 {
|
||||
font-size: 100%;
|
||||
font-weight: bold;
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
caption {
|
||||
border: 1px solid #cccccc;
|
||||
background: #ecede5;
|
||||
font-weight: bold;
|
||||
font-size: 1.2em;
|
||||
padding: 3px 5px;
|
||||
text-align: left;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
p {
|
||||
margin: .7em 0 1em;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
hr {
|
||||
margin: 2em 0 1em;
|
||||
border: none;
|
||||
border-top: 1px solid #cccccc;
|
||||
height: 0;
|
||||
}
|
||||
|
||||
a {
|
||||
color: #006aeb;
|
||||
padding: 3px 1px;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
h1 a {
|
||||
color: #1e5eb6;
|
||||
}
|
||||
|
||||
a:hover, a:active, a:focus, a:hover b, a:hover var {
|
||||
background-color: #006aeb;
|
||||
color: #ffffff !important;
|
||||
}
|
||||
|
||||
code, var, pre {
|
||||
font-family: monospace;
|
||||
}
|
||||
|
||||
var {
|
||||
font-weight: bold;
|
||||
font-style: normal;
|
||||
color: #ca8a04;
|
||||
}
|
||||
|
||||
pre {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
code a b {
|
||||
color: #000000;
|
||||
}
|
||||
|
||||
.deprecated {
|
||||
text-decoration: line-through;
|
||||
}
|
||||
|
||||
.invalid {
|
||||
color: #e71818;
|
||||
}
|
||||
|
||||
.hidden {
|
||||
display: none;
|
||||
}
|
||||
|
||||
/* Left side */
|
||||
#left {
|
||||
overflow: auto;
|
||||
width: 270px;
|
||||
height: 100%;
|
||||
position: fixed;
|
||||
}
|
||||
|
||||
/* Menu */
|
||||
#menu {
|
||||
padding: 10px;
|
||||
}
|
||||
|
||||
#menu ul {
|
||||
list-style: none;
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
#menu ul ul {
|
||||
padding-left: 10px;
|
||||
}
|
||||
|
||||
#menu li {
|
||||
white-space: nowrap;
|
||||
position: relative;
|
||||
}
|
||||
|
||||
#menu a {
|
||||
display: block;
|
||||
padding: 0 2px;
|
||||
}
|
||||
|
||||
#menu .active > a, #menu > span {
|
||||
color: #333333;
|
||||
background: none;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
#menu .active > a.invalid {
|
||||
color: #e71818;
|
||||
}
|
||||
|
||||
#menu .active > a:hover, #menu .active > a:active, #menu .active > a:focus {
|
||||
background-color: #006aeb;
|
||||
}
|
||||
|
||||
#menu #groups span {
|
||||
position: absolute;
|
||||
top: 4px;
|
||||
right: 2px;
|
||||
cursor: pointer;
|
||||
display: block;
|
||||
width: 12px;
|
||||
height: 12px;
|
||||
background: url('collapsed.png') transparent 0 0 no-repeat;
|
||||
}
|
||||
|
||||
#menu #groups span:hover {
|
||||
background-position: -12px 0;
|
||||
}
|
||||
|
||||
#menu #groups span.collapsed {
|
||||
background-position: 0 -12px;
|
||||
}
|
||||
|
||||
#menu #groups span.collapsed:hover {
|
||||
background-position: -12px -12px;
|
||||
}
|
||||
|
||||
#menu #groups ul.collapsed {
|
||||
display: none;
|
||||
}
|
||||
|
||||
/* Right side */
|
||||
#right {
|
||||
overflow: auto;
|
||||
margin-left: 275px;
|
||||
height: 100%;
|
||||
position: fixed;
|
||||
left: 0;
|
||||
right: 0;
|
||||
}
|
||||
|
||||
#rightInner {
|
||||
max-width: 1000px;
|
||||
min-width: 350px;
|
||||
}
|
||||
|
||||
/* Search */
|
||||
#search {
|
||||
float: right;
|
||||
margin: 3px 8px;
|
||||
}
|
||||
|
||||
#search input.text {
|
||||
padding: 3px 5px;
|
||||
width: 250px;
|
||||
}
|
||||
|
||||
/* Autocomplete */
|
||||
.ac_results {
|
||||
padding: 0;
|
||||
border: 1px solid #cccccc;
|
||||
background-color: #ffffff;
|
||||
overflow: hidden;
|
||||
z-index: 99999;
|
||||
}
|
||||
|
||||
.ac_results ul {
|
||||
width: 100%;
|
||||
list-style-position: outside;
|
||||
list-style: none;
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.ac_results li {
|
||||
margin: 0;
|
||||
padding: 2px 5px;
|
||||
cursor: default;
|
||||
display: block;
|
||||
font: 12px 'Trebuchet MS', 'Geneva CE', lucida, sans-serif;
|
||||
line-height: 16px;
|
||||
overflow: hidden;
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
.ac_results li strong {
|
||||
color: #000000;
|
||||
}
|
||||
|
||||
.ac_odd {
|
||||
background-color: #eeeeee;
|
||||
}
|
||||
|
||||
.ac_over {
|
||||
background-color: #006aeb;
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
.ac_results li.ac_over strong {
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
/* Navigation */
|
||||
#navigation {
|
||||
padding: 3px 8px;
|
||||
background-color: #f6f6f4;
|
||||
height: 26px;
|
||||
}
|
||||
|
||||
#navigation ul {
|
||||
list-style: none;
|
||||
margin: 0 8px 4px 0;
|
||||
padding: 0;
|
||||
overflow: hidden;
|
||||
float: left;
|
||||
}
|
||||
|
||||
#navigation ul + ul {
|
||||
border-left: 1px solid #000000;
|
||||
padding-left: 8px;
|
||||
}
|
||||
|
||||
#navigation ul li {
|
||||
float: left;
|
||||
margin: 2px;
|
||||
padding: 0 3px;
|
||||
font-family: Verdana, 'Geneva CE', lucida, sans-serif;
|
||||
color: #808080;
|
||||
}
|
||||
|
||||
#navigation ul li.active {
|
||||
background-color: #053368;
|
||||
color: #ffffff;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
#navigation ul li a {
|
||||
color: #000000;
|
||||
font-weight: bold;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
#navigation ul li span {
|
||||
float: left;
|
||||
padding: 0 3px;
|
||||
}
|
||||
|
||||
#navigation ul li a:hover span, #navigation ul li a:active span, #navigation ul li a:focus span {
|
||||
background-color: #006aeb;
|
||||
}
|
||||
|
||||
/* Content */
|
||||
#content {
|
||||
clear: both;
|
||||
padding: 5px 15px;
|
||||
}
|
||||
|
||||
.description pre {
|
||||
padding: .6em;
|
||||
background: #fcfcf7;
|
||||
}
|
||||
|
||||
#content > .description {
|
||||
background: #ecede5;
|
||||
padding: 1px 8px;
|
||||
margin: 1.2em 0;
|
||||
}
|
||||
|
||||
#content > .description pre {
|
||||
margin: .5em 0;
|
||||
}
|
||||
|
||||
dl.tree {
|
||||
margin: 1.2em 0;
|
||||
}
|
||||
|
||||
dl.tree dd {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
.info {
|
||||
margin: 1.2em 0;
|
||||
}
|
||||
|
||||
.summary {
|
||||
border: 1px solid #cccccc;
|
||||
border-collapse: collapse;
|
||||
font-size: 1em;
|
||||
width: 100%;
|
||||
margin: 1.2em 0 2.4em;
|
||||
}
|
||||
|
||||
.summary caption {
|
||||
border-width: 1px 1px 0;
|
||||
}
|
||||
|
||||
.summary caption.switchable {
|
||||
background: #ecede5 url('sort.png') no-repeat center right;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.summary td {
|
||||
border: 1px solid #cccccc;
|
||||
margin: 0;
|
||||
padding: 3px 10px;
|
||||
font-size: 1em;
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
.summary td:first-child {
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
#packages.summary td:first-child, #namespaces.summary td:first-child, .inherited.summary td:first-child, .used.summary td:first-child {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.summary tr:hover td {
|
||||
background: #f6f6f4;
|
||||
}
|
||||
|
||||
.summary .description pre {
|
||||
border: .5em solid #ecede5;
|
||||
}
|
||||
|
||||
.summary .description p {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.summary .description p + p, .summary .description ul {
|
||||
margin: 3px 0 0 0;
|
||||
}
|
||||
|
||||
.summary .description.detailed h4 {
|
||||
margin-top: 3px;
|
||||
}
|
||||
|
||||
.summary dl {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.summary dd {
|
||||
margin: 0 0 0 25px;
|
||||
}
|
||||
|
||||
.name, .attributes {
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
.value {
|
||||
white-space: pre-wrap;
|
||||
}
|
||||
|
||||
td.name, td.attributes {
|
||||
width: 1%;
|
||||
}
|
||||
|
||||
.class #methods .name {
|
||||
width: auto;
|
||||
white-space: normal;
|
||||
}
|
||||
|
||||
.class #methods .name > div > code {
|
||||
white-space: pre-wrap;
|
||||
}
|
||||
|
||||
.class #methods .name > div > code span, .function .value > code {
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
.class #methods td.name > div, .class td.description > div {
|
||||
position: relative;
|
||||
padding-right: 1em;
|
||||
}
|
||||
|
||||
.anchor {
|
||||
position: absolute;
|
||||
top: 0;
|
||||
right: 0;
|
||||
line-height: 1;
|
||||
font-size: 85%;
|
||||
margin: 0;
|
||||
color: #006aeb !important;
|
||||
}
|
||||
|
||||
.list {
|
||||
margin: 0 0 5px 25px;
|
||||
}
|
||||
|
||||
div.invalid {
|
||||
background-color: #fae4e0;
|
||||
padding: 10px;
|
||||
}
|
||||
|
||||
/* Splitter */
|
||||
#splitter {
|
||||
position: fixed;
|
||||
height: 100%;
|
||||
width: 5px;
|
||||
left: 270px;
|
||||
background: #1e5eb6 url('resize.png') left center no-repeat;
|
||||
cursor: e-resize;
|
||||
}
|
||||
|
||||
#splitter.active {
|
||||
opacity: .5;
|
||||
}
|
||||
|
||||
/* Footer */
|
||||
#footer {
|
||||
border-top: 1px solid #e9eeef;
|
||||
clear: both;
|
||||
color: #a7a7a7;
|
||||
font-size: 8pt;
|
||||
text-align: center;
|
||||
padding: 20px 0 0;
|
||||
margin: 3em 0 0;
|
||||
height: 90px;
|
||||
background: #ffffff url('footer.png') no-repeat center top;
|
||||
}
|
||||
|
||||
/* Tree */
|
||||
div.tree ul {
|
||||
list-style: none;
|
||||
background: url('tree-vertical.png') left repeat-y;
|
||||
padding: 0;
|
||||
margin-left: 20px;
|
||||
}
|
||||
|
||||
div.tree li {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.tree div {
|
||||
padding-left: 30px;
|
||||
}
|
||||
|
||||
div.tree div.notlast {
|
||||
background: url('tree-hasnext.png') left 10px no-repeat;
|
||||
}
|
||||
|
||||
div.tree div.last {
|
||||
background: url('tree-last.png') left -240px no-repeat;
|
||||
}
|
||||
|
||||
div.tree li.last {
|
||||
background: url('tree-cleaner.png') left center repeat-y;
|
||||
}
|
||||
|
||||
div.tree span.padding {
|
||||
padding-left: 15px;
|
||||
}
|
||||
|
||||
/* Source code */
|
||||
.php-keyword1 {
|
||||
color: #e71818;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.php-keyword2 {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.php-var {
|
||||
color: #d59401;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.php-num {
|
||||
color: #cd0673;
|
||||
}
|
||||
|
||||
.php-quote {
|
||||
color: #008000;
|
||||
}
|
||||
|
||||
.php-comment {
|
||||
color: #929292;
|
||||
}
|
||||
|
||||
.xlang {
|
||||
color: #ff0000;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
span.l {
|
||||
display: block;
|
||||
}
|
||||
|
||||
span.l.selected {
|
||||
background: #f6f6f4;
|
||||
}
|
||||
|
||||
span.l a {
|
||||
color: #333333;
|
||||
}
|
||||
|
||||
span.l a:hover, div.l a:active, div.l a:focus {
|
||||
background: transparent;
|
||||
color: #333333 !important;
|
||||
}
|
||||
|
||||
span.l .php-var a {
|
||||
color: #d59401;
|
||||
}
|
||||
|
||||
span.l .php-var a:hover, span.l .php-var a:active, span.l .php-var a:focus {
|
||||
color: #d59401 !important;
|
||||
}
|
||||
|
||||
span.l a.l {
|
||||
padding-left: 2px;
|
||||
color: #c0c0c0;
|
||||
}
|
||||
|
||||
span.l a.l:hover, span.l a.l:active, span.l a.l:focus {
|
||||
background: transparent;
|
||||
color: #c0c0c0 !important;
|
||||
}
|
||||
|
||||
#rightInner.medium #navigation {
|
||||
height: 52px;
|
||||
}
|
||||
|
||||
#rightInner.medium #navigation ul:first-child + ul {
|
||||
clear: left;
|
||||
border: none;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
#rightInner.medium .name, #rightInner.medium .attributes {
|
||||
white-space: normal;
|
||||
}
|
||||
|
||||
#rightInner.small #search {
|
||||
float: left;
|
||||
}
|
||||
|
||||
#rightInner.small #navigation {
|
||||
height: 78px;
|
||||
}
|
||||
|
||||
#rightInner.small #navigation ul:first-child {
|
||||
clear: both;
|
||||
}
|
||||
BIN
doc/v0.4.0/resources/tree-cleaner.png
Normal file
BIN
doc/v0.4.0/resources/tree-cleaner.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 126 B |
BIN
doc/v0.4.0/resources/tree-hasnext.png
Normal file
BIN
doc/v0.4.0/resources/tree-hasnext.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 128 B |
BIN
doc/v0.4.0/resources/tree-last.png
Normal file
BIN
doc/v0.4.0/resources/tree-last.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 172 B |
BIN
doc/v0.4.0/resources/tree-vertical.png
Normal file
BIN
doc/v0.4.0/resources/tree-vertical.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 127 B |
253
doc/v0.4.0/source-class-GeoIp2.Database.Reader.html
Normal file
253
doc/v0.4.0/source-class-GeoIp2.Database.Reader.html
Normal file
|
|
@ -0,0 +1,253 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
<meta name="robots" content="noindex" />
|
||||
|
||||
<title>File GeoIp2/Database/Reader.php | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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 class="active"><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><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 class="active"><a href="class-GeoIp2.Database.Reader.html">Reader</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.Database.html" title="Summary of GeoIp2\Database"><span>Namespace</span></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="class-GeoIp2.Database.Reader.html" title="Summary of GeoIp2\Database\Reader"><span>Class</span></a>
|
||||
</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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
||||
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
|
||||
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">namespace</span> GeoIp2\Database;
|
||||
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a>
|
||||
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-keyword1">use</span> GeoIp2\Exception\AddressNotFoundException;
|
||||
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-keyword1">use</span> GeoIp2\Model\City;
|
||||
</span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-keyword1">use</span> GeoIp2\Model\CityIspOrg;
|
||||
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-keyword1">use</span> GeoIp2\Model\Country;
|
||||
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">use</span> GeoIp2\Model\Omni;
|
||||
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-keyword1">use</span> MaxMind\Db\Reader <span class="php-keyword1">as</span> DbReader;
|
||||
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a>
|
||||
</span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment">/**
|
||||
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> * Instances of this class provide a reader for the GeoIP2 database format.
|
||||
</span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment"> * IP addresses can be looked up using the <code>country</code>
|
||||
</span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment"> * and <code>city</code> methods. We also provide <code>cityIspOrg</code>
|
||||
</span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment"> * and <code>omni</code> methods to ease compatibility with the web service
|
||||
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * client, although we may offer the ability to specify additional databases
|
||||
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> * to replicate these web services in the future (e.g., the ISP/Org database).
|
||||
</span></span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-comment"> *
|
||||
</span></span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-comment"> * **Usage**
|
||||
</span></span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment"> *
|
||||
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * The basic API for this class is the same for every database. First, you
|
||||
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> * create a reader object, specifying a file name. You then call the method
|
||||
</span></span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-comment"> * corresponding to the specific database, passing it the IP address you want
|
||||
</span></span><span id="25" class="l"><a class="l" href="#25"> 25: </a><span class="php-comment"> * to look up.
|
||||
</span></span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment"> *
|
||||
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * If the request succeeds, the method call will return a model class for
|
||||
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> * the method you called. This model in turn contains multiple record classes,
|
||||
</span></span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-comment"> * each of which represents part of the data returned by the database. If
|
||||
</span></span><span id="30" class="l"><a class="l" href="#30"> 30: </a><span class="php-comment"> * the database does not contain the requested information, the attributes
|
||||
</span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment"> * on the record class will have a <code>null</code> value.
|
||||
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> *
|
||||
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> * If the address is not in the database, an
|
||||
</span></span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-comment"> * {@link \GeoIp2\Exception\AddressNotFoundException} exception will be
|
||||
</span></span><span id="35" class="l"><a class="l" href="#35"> 35: </a><span class="php-comment"> * thrown. If an invalid IP address is passed to one of the methods, a
|
||||
</span></span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment"> * SPL {@link \InvalidArgumentException} will be thrown. If the database is
|
||||
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * corrupt or invalid, a {@link \MaxMind\Db\Reader\InvalidDatabaseException}
|
||||
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> * will be thrown.
|
||||
</span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment"> *
|
||||
</span></span><span id="40" class="l"><a class="l" href="#40"> 40: </a><span class="php-comment"> */</span>
|
||||
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-keyword1">class</span> <a id="Reader" href="#Reader">Reader</a>
|
||||
</span><span id="42" class="l"><a class="l" href="#42"> 42: </a>{
|
||||
</span><span id="43" class="l"><a class="l" href="#43"> 43: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$dbReader" href="#$dbReader">$dbReader</a></span>;
|
||||
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$languages" href="#$languages">$languages</a></span>;
|
||||
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a>
|
||||
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a> <span class="php-comment">/**
|
||||
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * Constructor.
|
||||
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> *
|
||||
</span></span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-comment"> * @param string $filename The path to the GeoIP2 database file.
|
||||
</span></span><span id="50" class="l"><a class="l" href="#50"> 50: </a><span class="php-comment"> * @throws \MaxMind\Db\Reader\InvalidDatabaseException if the database
|
||||
</span></span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment"> * is corrupt or invalid
|
||||
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> */</span>
|
||||
</span><span id="53" class="l"><a class="l" href="#53"> 53: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>(
|
||||
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a> <span class="php-var">$filename</span>,
|
||||
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a> <span class="php-var">$languages</span> = <span class="php-keyword1">array</span>(<span class="php-quote">'en'</span>)
|
||||
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a> ) {
|
||||
</span><span id="57" class="l"><a class="l" href="#57"> 57: </a> <span class="php-var">$this</span>->dbReader = <span class="php-keyword1">new</span> DbReader(<span class="php-var">$filename</span>);
|
||||
</span><span id="58" class="l"><a class="l" href="#58"> 58: </a> <span class="php-var">$this</span>->languages = <span class="php-var">$languages</span>;
|
||||
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a> }
|
||||
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a>
|
||||
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a> <span class="php-comment">/**
|
||||
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * This method returns a GeoIP2 City model.
|
||||
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> *
|
||||
</span></span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-comment"> * @param string $ipAddress IPv4 or IPv6 address as a string.
|
||||
</span></span><span id="65" class="l"><a class="l" href="#65"> 65: </a><span class="php-comment"> *
|
||||
</span></span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment"> * @return \GeoIp2\Model\City
|
||||
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> *
|
||||
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> * @throws \GeoIp2\Exception\AddressNotFoundException if the address is
|
||||
</span></span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-comment"> * not in the database.
|
||||
</span></span><span id="70" class="l"><a class="l" href="#70"> 70: </a><span class="php-comment"> * @throws \MaxMind\Db\Reader\InvalidDatabaseException if the database
|
||||
</span></span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment"> * is corrupt or invalid
|
||||
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> */</span>
|
||||
</span><span id="73" class="l"><a class="l" href="#73"> 73: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_city" href="#_city">city</a>(<span class="php-var">$ipAddress</span>)
|
||||
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a> {
|
||||
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->modelFor(<span class="php-quote">'City'</span>, <span class="php-var">$ipAddress</span>);
|
||||
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a> }
|
||||
</span><span id="77" class="l"><a class="l" href="#77"> 77: </a>
|
||||
</span><span id="78" class="l"><a class="l" href="#78"> 78: </a> <span class="php-comment">/**
|
||||
</span></span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-comment"> * This method returns a GeoIP2 Country model.
|
||||
</span></span><span id="80" class="l"><a class="l" href="#80"> 80: </a><span class="php-comment"> *
|
||||
</span></span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment"> * @param string $ipAddress IPv4 or IPv6 address as a string.
|
||||
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> *
|
||||
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> * @return \GeoIp2\Model\Country
|
||||
</span></span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-comment"> *
|
||||
</span></span><span id="85" class="l"><a class="l" href="#85"> 85: </a><span class="php-comment"> * @throws \GeoIp2\Exception\AddressNotFoundException if the address is
|
||||
</span></span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment"> * not in the database.
|
||||
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * @throws \MaxMind\Db\Reader\InvalidDatabaseException if the database
|
||||
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> * is corrupt or invalid
|
||||
</span></span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-comment"> */</span>
|
||||
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_country" href="#_country">country</a>(<span class="php-var">$ipAddress</span>)
|
||||
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a> {
|
||||
</span><span id="92" class="l"><a class="l" href="#92"> 92: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->modelFor(<span class="php-quote">'Country'</span>, <span class="php-var">$ipAddress</span>);
|
||||
</span><span id="93" class="l"><a class="l" href="#93"> 93: </a> }
|
||||
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a>
|
||||
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a> <span class="php-comment">/**
|
||||
</span></span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment"> * This method returns a GeoIP2 City/ISP/Org model.
|
||||
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> *
|
||||
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> * @param string $ipAddress IPv4 or IPv6 address as a string.
|
||||
</span></span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-comment"> *
|
||||
</span></span><span id="100" class="l"><a class="l" href="#100">100: </a><span class="php-comment"> * @return \GeoIp2\Model\CityIspOrg
|
||||
</span></span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment"> *
|
||||
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * @throws \GeoIp2\Exception\AddressNotFoundException if the address is
|
||||
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> * not in the database.
|
||||
</span></span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-comment"> * @throws \MaxMind\Db\Reader\InvalidDatabaseException if the database
|
||||
</span></span><span id="105" class="l"><a class="l" href="#105">105: </a><span class="php-comment"> * is corrupt or invalid
|
||||
</span></span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment"> */</span>
|
||||
</span><span id="107" class="l"><a class="l" href="#107">107: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_cityIspOrg" href="#_cityIspOrg">cityIspOrg</a>(<span class="php-var">$ipAddress</span>)
|
||||
</span><span id="108" class="l"><a class="l" href="#108">108: </a> {
|
||||
</span><span id="109" class="l"><a class="l" href="#109">109: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->modelFor(<span class="php-quote">'CityIspOrg'</span>, <span class="php-var">$ipAddress</span>);
|
||||
</span><span id="110" class="l"><a class="l" href="#110">110: </a> }
|
||||
</span><span id="111" class="l"><a class="l" href="#111">111: </a>
|
||||
</span><span id="112" class="l"><a class="l" href="#112">112: </a> <span class="php-comment">/**
|
||||
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> * This method returns a GeoIP2 Omni model.
|
||||
</span></span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-comment"> *
|
||||
</span></span><span id="115" class="l"><a class="l" href="#115">115: </a><span class="php-comment"> * @param string $ipAddress IPv4 or IPv6 address as a string.
|
||||
</span></span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment"> *
|
||||
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * @return \GeoIp2\Model\Omni
|
||||
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> *
|
||||
</span></span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-comment"> * @throws \GeoIp2\Exception\AddressNotFoundException if the address is
|
||||
</span></span><span id="120" class="l"><a class="l" href="#120">120: </a><span class="php-comment"> * not in the database.
|
||||
</span></span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment"> * @throws \MaxMind\Db\Reader\InvalidDatabaseException if the database
|
||||
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * is corrupt or invalid
|
||||
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> */</span>
|
||||
</span><span id="124" class="l"><a class="l" href="#124">124: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_omni" href="#_omni">omni</a>(<span class="php-var">$ipAddress</span>)
|
||||
</span><span id="125" class="l"><a class="l" href="#125">125: </a> {
|
||||
</span><span id="126" class="l"><a class="l" href="#126">126: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->modelFor(<span class="php-quote">'Omni'</span>, <span class="php-var">$ipAddress</span>);
|
||||
</span><span id="127" class="l"><a class="l" href="#127">127: </a> }
|
||||
</span><span id="128" class="l"><a class="l" href="#128">128: </a>
|
||||
</span><span id="129" class="l"><a class="l" href="#129">129: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> <a id="_modelFor" href="#_modelFor">modelFor</a>(<span class="php-var">$class</span>, <span class="php-var">$ipAddress</span>)
|
||||
</span><span id="130" class="l"><a class="l" href="#130">130: </a> {
|
||||
</span><span id="131" class="l"><a class="l" href="#131">131: </a> <span class="php-var">$record</span> = <span class="php-var">$this</span>->dbReader->get(<span class="php-var">$ipAddress</span>);
|
||||
</span><span id="132" class="l"><a class="l" href="#132">132: </a> <span class="php-keyword1">if</span> (<span class="php-var">$record</span> === <span class="php-keyword1">null</span>) {
|
||||
</span><span id="133" class="l"><a class="l" href="#133">133: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> AddressNotFoundException(
|
||||
</span><span id="134" class="l"><a class="l" href="#134">134: </a> <span class="php-quote">"The address </span><span class="php-var">$ipAddress</span><span class="php-quote"> is not in the database."</span>
|
||||
</span><span id="135" class="l"><a class="l" href="#135">135: </a> );
|
||||
</span><span id="136" class="l"><a class="l" href="#136">136: </a> }
|
||||
</span><span id="137" class="l"><a class="l" href="#137">137: </a> <span class="php-var">$record</span>[<span class="php-quote">'traits'</span>][<span class="php-quote">'ip_address'</span>] = <span class="php-var">$ipAddress</span>;
|
||||
</span><span id="138" class="l"><a class="l" href="#138">138: </a> <span class="php-var">$class</span> = <span class="php-quote">"GeoIp2\\Model\\"</span> . <span class="php-var">$class</span>;
|
||||
</span><span id="139" class="l"><a class="l" href="#139">139: </a>
|
||||
</span><span id="140" class="l"><a class="l" href="#140">140: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">new</span> <span class="php-var">$class</span>(<span class="php-var">$record</span>, <span class="php-var">$this</span>->languages);
|
||||
</span><span id="141" class="l"><a class="l" href="#141">141: </a> }
|
||||
</span><span id="142" class="l"><a class="l" href="#142">142: </a>
|
||||
</span><span id="143" class="l"><a class="l" href="#143">143: </a> <span class="php-comment">/**
|
||||
</span></span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-comment"> * Closes the GeoIP2 database and returns the resources to the system.
|
||||
</span></span><span id="145" class="l"><a class="l" href="#145">145: </a><span class="php-comment"> */</span>
|
||||
</span><span id="146" class="l"><a class="l" href="#146">146: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_close" href="#_close">close</a>()
|
||||
</span><span id="147" class="l"><a class="l" href="#147">147: </a> {
|
||||
</span><span id="148" class="l"><a class="l" href="#148">148: </a> <span class="php-var">$this</span>->dbReader->close();
|
||||
</span><span id="149" class="l"><a class="l" href="#149">149: </a> }
|
||||
</span><span id="150" class="l"><a class="l" href="#150">150: </a>}
|
||||
</span><span id="151" class="l"><a class="l" href="#151">151: </a></span></code></pre>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,118 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
<meta name="robots" content="noindex" />
|
||||
|
||||
<title>File GeoIp2/Exception/AddressNotFoundException.php | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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 class="active"><a href="namespace-GeoIp2.Exception.html">Exception</a>
|
||||
</li>
|
||||
<li><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>Exceptions</h3>
|
||||
<ul>
|
||||
<li class="active"><a href="class-GeoIp2.Exception.AddressNotFoundException.html">AddressNotFoundException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.AuthenticationException.html">AuthenticationException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.GeoIp2Exception.html">GeoIp2Exception</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.HttpException.html">HttpException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.InvalidRequestException.html">InvalidRequestException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.OutOfQueriesException.html">OutOfQueriesException</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.Exception.html" title="Summary of GeoIp2\Exception"><span>Namespace</span></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="class-GeoIp2.Exception.AddressNotFoundException.html" title="Summary of GeoIp2\Exception\AddressNotFoundException"><span>Class</span></a>
|
||||
</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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
||||
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
|
||||
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">namespace</span> GeoIp2\Exception;
|
||||
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a>
|
||||
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment">/**
|
||||
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * This class represents a generic error.
|
||||
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> */</span>
|
||||
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-keyword1">class</span> <a id="AddressNotFoundException" href="#AddressNotFoundException">AddressNotFoundException</a> <span class="php-keyword1">extends</span> GeoIp2Exception
|
||||
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a>{
|
||||
</span><span id="10" class="l"><a class="l" href="#10">10: </a>}
|
||||
</span><span id="11" class="l"><a class="l" href="#11">11: </a></span></code></pre>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,118 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
<meta name="robots" content="noindex" />
|
||||
|
||||
<title>File GeoIp2/Exception/AuthenticationException.php | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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 class="active"><a href="namespace-GeoIp2.Exception.html">Exception</a>
|
||||
</li>
|
||||
<li><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>Exceptions</h3>
|
||||
<ul>
|
||||
<li><a href="class-GeoIp2.Exception.AddressNotFoundException.html">AddressNotFoundException</a></li>
|
||||
<li class="active"><a href="class-GeoIp2.Exception.AuthenticationException.html">AuthenticationException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.GeoIp2Exception.html">GeoIp2Exception</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.HttpException.html">HttpException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.InvalidRequestException.html">InvalidRequestException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.OutOfQueriesException.html">OutOfQueriesException</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.Exception.html" title="Summary of GeoIp2\Exception"><span>Namespace</span></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="class-GeoIp2.Exception.AuthenticationException.html" title="Summary of GeoIp2\Exception\AuthenticationException"><span>Class</span></a>
|
||||
</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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
||||
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
|
||||
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">namespace</span> GeoIp2\Exception;
|
||||
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a>
|
||||
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment">/**
|
||||
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * This class represents a generic error.
|
||||
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> */</span>
|
||||
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-keyword1">class</span> <a id="AuthenticationException" href="#AuthenticationException">AuthenticationException</a> <span class="php-keyword1">extends</span> GeoIp2Exception
|
||||
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a>{
|
||||
</span><span id="10" class="l"><a class="l" href="#10">10: </a>}
|
||||
</span><span id="11" class="l"><a class="l" href="#11">11: </a></span></code></pre>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
118
doc/v0.4.0/source-class-GeoIp2.Exception.GeoIp2Exception.html
Normal file
118
doc/v0.4.0/source-class-GeoIp2.Exception.GeoIp2Exception.html
Normal file
|
|
@ -0,0 +1,118 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
<meta name="robots" content="noindex" />
|
||||
|
||||
<title>File GeoIp2/Exception/GeoIp2Exception.php | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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 class="active"><a href="namespace-GeoIp2.Exception.html">Exception</a>
|
||||
</li>
|
||||
<li><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>Exceptions</h3>
|
||||
<ul>
|
||||
<li><a href="class-GeoIp2.Exception.AddressNotFoundException.html">AddressNotFoundException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.AuthenticationException.html">AuthenticationException</a></li>
|
||||
<li class="active"><a href="class-GeoIp2.Exception.GeoIp2Exception.html">GeoIp2Exception</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.HttpException.html">HttpException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.InvalidRequestException.html">InvalidRequestException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.OutOfQueriesException.html">OutOfQueriesException</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.Exception.html" title="Summary of GeoIp2\Exception"><span>Namespace</span></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="class-GeoIp2.Exception.GeoIp2Exception.html" title="Summary of GeoIp2\Exception\GeoIp2Exception"><span>Class</span></a>
|
||||
</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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
||||
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
|
||||
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">namespace</span> GeoIp2\Exception;
|
||||
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a>
|
||||
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment">/**
|
||||
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * This class represents a generic error.
|
||||
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> */</span>
|
||||
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-keyword1">class</span> <a id="GeoIp2Exception" href="#GeoIp2Exception">GeoIp2Exception</a> <span class="php-keyword1">extends</span> \Exception
|
||||
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a>{
|
||||
</span><span id="10" class="l"><a class="l" href="#10">10: </a>}
|
||||
</span><span id="11" class="l"><a class="l" href="#11">11: </a></span></code></pre>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
133
doc/v0.4.0/source-class-GeoIp2.Exception.HttpException.html
Normal file
133
doc/v0.4.0/source-class-GeoIp2.Exception.HttpException.html
Normal file
|
|
@ -0,0 +1,133 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
<meta name="robots" content="noindex" />
|
||||
|
||||
<title>File GeoIp2/Exception/HttpException.php | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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 class="active"><a href="namespace-GeoIp2.Exception.html">Exception</a>
|
||||
</li>
|
||||
<li><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>Exceptions</h3>
|
||||
<ul>
|
||||
<li><a href="class-GeoIp2.Exception.AddressNotFoundException.html">AddressNotFoundException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.AuthenticationException.html">AuthenticationException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.GeoIp2Exception.html">GeoIp2Exception</a></li>
|
||||
<li class="active"><a href="class-GeoIp2.Exception.HttpException.html">HttpException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.InvalidRequestException.html">InvalidRequestException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.OutOfQueriesException.html">OutOfQueriesException</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.Exception.html" title="Summary of GeoIp2\Exception"><span>Namespace</span></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="class-GeoIp2.Exception.HttpException.html" title="Summary of GeoIp2\Exception\HttpException"><span>Class</span></a>
|
||||
</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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
||||
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
|
||||
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">namespace</span> GeoIp2\Exception;
|
||||
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a>
|
||||
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment">/**
|
||||
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * This class represents an HTTP transport error.
|
||||
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> */</span>
|
||||
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a>
|
||||
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">class</span> <a id="HttpException" href="#HttpException">HttpException</a> <span class="php-keyword1">extends</span> GeoIp2Exception
|
||||
</span><span id="10" class="l"><a class="l" href="#10">10: </a>{
|
||||
</span><span id="11" class="l"><a class="l" href="#11">11: </a> <span class="php-comment">/**
|
||||
</span></span><span id="12" class="l"><a class="l" href="#12">12: </a><span class="php-comment"> * The URI queried
|
||||
</span></span><span id="13" class="l"><a class="l" href="#13">13: </a><span class="php-comment"> */</span>
|
||||
</span><span id="14" class="l"><a class="l" href="#14">14: </a> <span class="php-keyword1">public</span> <span class="php-var"><a id="$uri" href="#$uri">$uri</a></span>;
|
||||
</span><span id="15" class="l"><a class="l" href="#15">15: </a>
|
||||
</span><span id="16" class="l"><a class="l" href="#16">16: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>(
|
||||
</span><span id="17" class="l"><a class="l" href="#17">17: </a> <span class="php-var">$message</span>,
|
||||
</span><span id="18" class="l"><a class="l" href="#18">18: </a> <span class="php-var">$httpStatus</span>,
|
||||
</span><span id="19" class="l"><a class="l" href="#19">19: </a> <span class="php-var">$uri</span>,
|
||||
</span><span id="20" class="l"><a class="l" href="#20">20: </a> Exception <span class="php-var">$previous</span> = <span class="php-keyword1">null</span>
|
||||
</span><span id="21" class="l"><a class="l" href="#21">21: </a> ) {
|
||||
</span><span id="22" class="l"><a class="l" href="#22">22: </a> <span class="php-var">$this</span>->uri = <span class="php-var">$uri</span>;
|
||||
</span><span id="23" class="l"><a class="l" href="#23">23: </a> parent::__construct(<span class="php-var">$message</span>, <span class="php-var">$httpStatus</span>, <span class="php-var">$previous</span>);
|
||||
</span><span id="24" class="l"><a class="l" href="#24">24: </a> }
|
||||
</span><span id="25" class="l"><a class="l" href="#25">25: </a>}
|
||||
</span><span id="26" class="l"><a class="l" href="#26">26: </a></span></code></pre>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,134 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
<meta name="robots" content="noindex" />
|
||||
|
||||
<title>File GeoIp2/Exception/InvalidRequestException.php | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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 class="active"><a href="namespace-GeoIp2.Exception.html">Exception</a>
|
||||
</li>
|
||||
<li><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>Exceptions</h3>
|
||||
<ul>
|
||||
<li><a href="class-GeoIp2.Exception.AddressNotFoundException.html">AddressNotFoundException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.AuthenticationException.html">AuthenticationException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.GeoIp2Exception.html">GeoIp2Exception</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.HttpException.html">HttpException</a></li>
|
||||
<li class="active"><a href="class-GeoIp2.Exception.InvalidRequestException.html">InvalidRequestException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.OutOfQueriesException.html">OutOfQueriesException</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.Exception.html" title="Summary of GeoIp2\Exception"><span>Namespace</span></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="class-GeoIp2.Exception.InvalidRequestException.html" title="Summary of GeoIp2\Exception\InvalidRequestException"><span>Class</span></a>
|
||||
</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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
||||
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
|
||||
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">namespace</span> GeoIp2\Exception;
|
||||
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a>
|
||||
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment">/**
|
||||
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * This class represents an error returned by MaxMind's GeoIP2
|
||||
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * web service.
|
||||
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> */</span>
|
||||
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">class</span> <a id="InvalidRequestException" href="#InvalidRequestException">InvalidRequestException</a> <span class="php-keyword1">extends</span> HttpException
|
||||
</span><span id="10" class="l"><a class="l" href="#10">10: </a>{
|
||||
</span><span id="11" class="l"><a class="l" href="#11">11: </a> <span class="php-comment">/**
|
||||
</span></span><span id="12" class="l"><a class="l" href="#12">12: </a><span class="php-comment"> * The code returned by the MaxMind web service
|
||||
</span></span><span id="13" class="l"><a class="l" href="#13">13: </a><span class="php-comment"> */</span>
|
||||
</span><span id="14" class="l"><a class="l" href="#14">14: </a> <span class="php-keyword1">public</span> <span class="php-var"><a id="$error" href="#$error">$error</a></span>;
|
||||
</span><span id="15" class="l"><a class="l" href="#15">15: </a>
|
||||
</span><span id="16" class="l"><a class="l" href="#16">16: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>(
|
||||
</span><span id="17" class="l"><a class="l" href="#17">17: </a> <span class="php-var">$message</span>,
|
||||
</span><span id="18" class="l"><a class="l" href="#18">18: </a> <span class="php-var">$error</span>,
|
||||
</span><span id="19" class="l"><a class="l" href="#19">19: </a> <span class="php-var">$httpStatus</span>,
|
||||
</span><span id="20" class="l"><a class="l" href="#20">20: </a> <span class="php-var">$uri</span>,
|
||||
</span><span id="21" class="l"><a class="l" href="#21">21: </a> Exception <span class="php-var">$previous</span> = <span class="php-keyword1">null</span>
|
||||
</span><span id="22" class="l"><a class="l" href="#22">22: </a> ) {
|
||||
</span><span id="23" class="l"><a class="l" href="#23">23: </a> <span class="php-var">$this</span>->error = <span class="php-var">$error</span>;
|
||||
</span><span id="24" class="l"><a class="l" href="#24">24: </a> parent::__construct(<span class="php-var">$message</span>, <span class="php-var">$httpStatus</span>, <span class="php-var">$uri</span>, <span class="php-var">$previous</span>);
|
||||
</span><span id="25" class="l"><a class="l" href="#25">25: </a> }
|
||||
</span><span id="26" class="l"><a class="l" href="#26">26: </a>}
|
||||
</span><span id="27" class="l"><a class="l" href="#27">27: </a></span></code></pre>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,118 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
<meta name="robots" content="noindex" />
|
||||
|
||||
<title>File GeoIp2/Exception/OutOfQueriesException.php | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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 class="active"><a href="namespace-GeoIp2.Exception.html">Exception</a>
|
||||
</li>
|
||||
<li><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>Exceptions</h3>
|
||||
<ul>
|
||||
<li><a href="class-GeoIp2.Exception.AddressNotFoundException.html">AddressNotFoundException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.AuthenticationException.html">AuthenticationException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.GeoIp2Exception.html">GeoIp2Exception</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.HttpException.html">HttpException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.InvalidRequestException.html">InvalidRequestException</a></li>
|
||||
<li class="active"><a href="class-GeoIp2.Exception.OutOfQueriesException.html">OutOfQueriesException</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.Exception.html" title="Summary of GeoIp2\Exception"><span>Namespace</span></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="class-GeoIp2.Exception.OutOfQueriesException.html" title="Summary of GeoIp2\Exception\OutOfQueriesException"><span>Class</span></a>
|
||||
</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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
||||
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
|
||||
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">namespace</span> GeoIp2\Exception;
|
||||
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a>
|
||||
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment">/**
|
||||
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * This class represents a generic error.
|
||||
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> */</span>
|
||||
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-keyword1">class</span> <a id="OutOfQueriesException" href="#OutOfQueriesException">OutOfQueriesException</a> <span class="php-keyword1">extends</span> GeoIp2Exception
|
||||
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a>{
|
||||
</span><span id="10" class="l"><a class="l" href="#10">10: </a>}
|
||||
</span><span id="11" class="l"><a class="l" href="#11">11: </a></span></code></pre>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
226
doc/v0.4.0/source-class-GeoIp2.Model.City.html
Normal file
226
doc/v0.4.0/source-class-GeoIp2.Model.City.html
Normal file
|
|
@ -0,0 +1,226 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
<meta name="robots" content="noindex" />
|
||||
|
||||
<title>File GeoIp2/Model/City.php | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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 class="active"><a href="class-GeoIp2.Model.City.html">City</a></li>
|
||||
<li><a href="class-GeoIp2.Model.CityIspOrg.html">CityIspOrg</a></li>
|
||||
<li><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>
|
||||
<a href="class-GeoIp2.Model.City.html" title="Summary of GeoIp2\Model\City"><span>Class</span></a>
|
||||
</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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
||||
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
|
||||
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">namespace</span> GeoIp2\Model;
|
||||
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a>
|
||||
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment">/**
|
||||
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * This class provides a model for the data returned by the GeoIP2
|
||||
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * City end point.
|
||||
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> *
|
||||
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * The only difference between the City, City/ISP/Org, and Omni model
|
||||
</span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment"> * classes is which fields in each record may be populated. See
|
||||
</span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment"> * http://dev.maxmind.com/geoip/geoip2/web-services more details.
|
||||
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> *
|
||||
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> * @property \GeoIp2\Record\City $city City data for the requested IP
|
||||
</span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment"> * address.
|
||||
</span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment"> *
|
||||
</span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment"> * @property \GeoIp2\Record\Continent $continent Continent data for the
|
||||
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * requested IP address.
|
||||
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> *
|
||||
</span></span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-comment"> * @property \GeoIp2\Record\Country $country Country data for the requested
|
||||
</span></span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-comment"> * IP address. This object represents the country where MaxMind believes the
|
||||
</span></span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment"> * end user is located.
|
||||
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> *
|
||||
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> * @property \GeoIp2\Record\Location $location Location data for the
|
||||
</span></span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-comment"> * requested IP address.
|
||||
</span></span><span id="25" class="l"><a class="l" href="#25"> 25: </a><span class="php-comment"> *
|
||||
</span></span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment"> * @property \GeoIp2\Record\MaxMind $maxmind Data related to your MaxMind
|
||||
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * account.
|
||||
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> *
|
||||
</span></span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-comment"> * @property \GeoIp2\Record\Country $registeredCountry Registered country
|
||||
</span></span><span id="30" class="l"><a class="l" href="#30"> 30: </a><span class="php-comment"> * data for the requested IP address. This record represents the country
|
||||
</span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment"> * where the ISP has registered a given IP block and may differ from the
|
||||
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * user's country.
|
||||
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> *
|
||||
</span></span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-comment"> * @property \GeoIp2\Record\RepresentedCountry $representedCountry
|
||||
</span></span><span id="35" class="l"><a class="l" href="#35"> 35: </a><span class="php-comment"> * Represented country data for the requested IP address. The represented
|
||||
</span></span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment"> * country is used for things like military bases or embassies. It is only
|
||||
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * present when the represented country differs from the country.
|
||||
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> *
|
||||
</span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment"> * @property array $subdivisions An array of {@link \GeoIp2\Record\Subdivision}
|
||||
</span></span><span id="40" class="l"><a class="l" href="#40"> 40: </a><span class="php-comment"> * objects representing the country subdivisions for the requested IP
|
||||
</span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment"> * address. The number and type of subdivisions varies by country, but a
|
||||
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * subdivision is typically a state, province, county, etc. Subdivisions
|
||||
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> * are ordered from most general (largest) to most specific (smallest).
|
||||
</span></span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-comment"> * If the response did not contain any subdivisions, this method returns
|
||||
</span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a><span class="php-comment"> * an empty array.
|
||||
</span></span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment"> *
|
||||
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * @property \GeoIp2\Record\Subdivision $mostSpecificSubdivision An object
|
||||
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> * representing the most specific subdivision returned. If the response
|
||||
</span></span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-comment"> * did not contain any subdivisions, this method returns an empty
|
||||
</span></span><span id="50" class="l"><a class="l" href="#50"> 50: </a><span class="php-comment"> * {@link \GeoIp2\Record\Subdivision} object.
|
||||
</span></span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment"> *
|
||||
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * @property \GeoIp2\Record\Traits $traits Data for the traits of the
|
||||
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> * requested IP address.
|
||||
</span></span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-comment"> */</span>
|
||||
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a><span class="php-keyword1">class</span> <a id="City" href="#City">City</a> <span class="php-keyword1">extends</span> Country
|
||||
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a>{
|
||||
</span><span id="57" class="l"><a class="l" href="#57"> 57: </a> <span class="php-comment">/**
|
||||
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> * @ignore
|
||||
</span></span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-comment"> */</span>
|
||||
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$city" href="#$city">$city</a></span>;
|
||||
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a> <span class="php-comment">/**
|
||||
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * @ignore
|
||||
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> */</span>
|
||||
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$location" href="#$location">$location</a></span>;
|
||||
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a> <span class="php-comment">/**
|
||||
</span></span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment"> * @ignore
|
||||
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> */</span>
|
||||
</span><span id="68" class="l"><a class="l" href="#68"> 68: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$postal" href="#$postal">$postal</a></span>;
|
||||
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a> <span class="php-comment">/**
|
||||
</span></span><span id="70" class="l"><a class="l" href="#70"> 70: </a><span class="php-comment"> * @ignore
|
||||
</span></span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment"> */</span>
|
||||
</span><span id="72" class="l"><a class="l" href="#72"> 72: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$subdivisions" href="#$subdivisions">$subdivisions</a></span> = <span class="php-keyword1">array</span>();
|
||||
</span><span id="73" class="l"><a class="l" href="#73"> 73: </a>
|
||||
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a> <span class="php-comment">/**
|
||||
</span></span><span id="75" class="l"><a class="l" href="#75"> 75: </a><span class="php-comment"> * @ignore
|
||||
</span></span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment"> */</span>
|
||||
</span><span id="77" class="l"><a class="l" href="#77"> 77: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>(<span class="php-var">$raw</span>, <span class="php-var">$languages</span>)
|
||||
</span><span id="78" class="l"><a class="l" href="#78"> 78: </a> {
|
||||
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a> parent::__construct(<span class="php-var">$raw</span>, <span class="php-var">$languages</span>);
|
||||
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a>
|
||||
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a> <span class="php-var">$this</span>->city = <span class="php-keyword1">new</span> \GeoIp2\Record\City(<span class="php-var">$this</span>->get(<span class="php-quote">'city'</span>), <span class="php-var">$languages</span>);
|
||||
</span><span id="82" class="l"><a class="l" href="#82"> 82: </a> <span class="php-var">$this</span>->location = <span class="php-keyword1">new</span> \GeoIp2\Record\Location(<span class="php-var">$this</span>->get(<span class="php-quote">'location'</span>));
|
||||
</span><span id="83" class="l"><a class="l" href="#83"> 83: </a> <span class="php-var">$this</span>->postal = <span class="php-keyword1">new</span> \GeoIp2\Record\Postal(<span class="php-var">$this</span>->get(<span class="php-quote">'postal'</span>));
|
||||
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a>
|
||||
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a> <span class="php-var">$this</span>->createSubdivisions(<span class="php-var">$raw</span>, <span class="php-var">$languages</span>);
|
||||
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a> }
|
||||
</span><span id="87" class="l"><a class="l" href="#87"> 87: </a>
|
||||
</span><span id="88" class="l"><a class="l" href="#88"> 88: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> <a id="_createSubdivisions" href="#_createSubdivisions">createSubdivisions</a>(<span class="php-var">$raw</span>, <span class="php-var">$languages</span>)
|
||||
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a> {
|
||||
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword1">isset</span>(<span class="php-var">$raw</span>[<span class="php-quote">'subdivisions'</span>])) {
|
||||
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a> <span class="php-keyword1">return</span>;
|
||||
</span><span id="92" class="l"><a class="l" href="#92"> 92: </a> }
|
||||
</span><span id="93" class="l"><a class="l" href="#93"> 93: </a>
|
||||
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a> <span class="php-keyword1">foreach</span> (<span class="php-var">$raw</span>[<span class="php-quote">'subdivisions'</span>] <span class="php-keyword1">as</span> <span class="php-var">$sub</span>) {
|
||||
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a> <span class="php-keyword2">array_push</span>(
|
||||
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a> <span class="php-var">$this</span>->subdivisions,
|
||||
</span><span id="97" class="l"><a class="l" href="#97"> 97: </a> <span class="php-keyword1">new</span> \GeoIp2\Record\Subdivision(<span class="php-var">$sub</span>, <span class="php-var">$languages</span>)
|
||||
</span><span id="98" class="l"><a class="l" href="#98"> 98: </a> );
|
||||
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a> }
|
||||
</span><span id="100" class="l"><a class="l" href="#100">100: </a> }
|
||||
</span><span id="101" class="l"><a class="l" href="#101">101: </a>
|
||||
</span><span id="102" class="l"><a class="l" href="#102">102: </a> <span class="php-comment">/**
|
||||
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> * @ignore
|
||||
</span></span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-comment"> */</span>
|
||||
</span><span id="105" class="l"><a class="l" href="#105">105: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___get" href="#___get">__get</a>(<span class="php-var">$attr</span>)
|
||||
</span><span id="106" class="l"><a class="l" href="#106">106: </a> {
|
||||
</span><span id="107" class="l"><a class="l" href="#107">107: </a> <span class="php-keyword1">if</span> (<span class="php-var">$attr</span> == <span class="php-quote">'mostSpecificSubdivision'</span>) {
|
||||
</span><span id="108" class="l"><a class="l" href="#108">108: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-><span class="php-var">$attr</span>();
|
||||
</span><span id="109" class="l"><a class="l" href="#109">109: </a> } <span class="php-keyword1">else</span> {
|
||||
</span><span id="110" class="l"><a class="l" href="#110">110: </a> <span class="php-keyword1">return</span> parent::__get(<span class="php-var">$attr</span>);
|
||||
</span><span id="111" class="l"><a class="l" href="#111">111: </a> }
|
||||
</span><span id="112" class="l"><a class="l" href="#112">112: </a> }
|
||||
</span><span id="113" class="l"><a class="l" href="#113">113: </a>
|
||||
</span><span id="114" class="l"><a class="l" href="#114">114: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> <a id="_mostSpecificSubdivision" href="#_mostSpecificSubdivision">mostSpecificSubdivision</a>()
|
||||
</span><span id="115" class="l"><a class="l" href="#115">115: </a> {
|
||||
</span><span id="116" class="l"><a class="l" href="#116">116: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">empty</span>(<span class="php-var">$this</span>->subdivisions)?
|
||||
</span><span id="117" class="l"><a class="l" href="#117">117: </a> <span class="php-keyword1">new</span> \GeoIp2\Record\Subdivision(<span class="php-keyword1">array</span>(), <span class="php-var">$this</span>->languages):
|
||||
</span><span id="118" class="l"><a class="l" href="#118">118: </a> <span class="php-keyword2">end</span>(<span class="php-var">$this</span>->subdivisions);
|
||||
</span><span id="119" class="l"><a class="l" href="#119">119: </a> }
|
||||
</span><span id="120" class="l"><a class="l" href="#120">120: </a>}
|
||||
</span><span id="121" class="l"><a class="l" href="#121">121: </a></span></code></pre>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
163
doc/v0.4.0/source-class-GeoIp2.Model.CityIspOrg.html
Normal file
163
doc/v0.4.0/source-class-GeoIp2.Model.CityIspOrg.html
Normal file
|
|
@ -0,0 +1,163 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
<meta name="robots" content="noindex" />
|
||||
|
||||
<title>File GeoIp2/Model/CityIspOrg.php | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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 class="active"><a href="class-GeoIp2.Model.CityIspOrg.html">CityIspOrg</a></li>
|
||||
<li><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>
|
||||
<a href="class-GeoIp2.Model.CityIspOrg.html" title="Summary of GeoIp2\Model\CityIspOrg"><span>Class</span></a>
|
||||
</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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
||||
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
|
||||
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">namespace</span> GeoIp2\Model;
|
||||
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a>
|
||||
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment">/**
|
||||
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * This class provides a model for the data returned by the GeoIP2
|
||||
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * City/ISP/Org end point.
|
||||
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> *
|
||||
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * The only difference between the City, City/ISP/Org, and Omni model
|
||||
</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment"> * classes is which fields in each record may be populated. See
|
||||
</span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment"> * http://dev.maxmind.com/geoip/geoip2/web-services more details.
|
||||
</span></span><span id="12" class="l"><a class="l" href="#12">12: </a><span class="php-comment"> *
|
||||
</span></span><span id="13" class="l"><a class="l" href="#13">13: </a><span class="php-comment"> * @property \GeoIp2\Record\City $city City data for the requested IP
|
||||
</span></span><span id="14" class="l"><a class="l" href="#14">14: </a><span class="php-comment"> * address.
|
||||
</span></span><span id="15" class="l"><a class="l" href="#15">15: </a><span class="php-comment"> *
|
||||
</span></span><span id="16" class="l"><a class="l" href="#16">16: </a><span class="php-comment"> * @property \GeoIp2\Record\Continent $continent Continent data for the
|
||||
</span></span><span id="17" class="l"><a class="l" href="#17">17: </a><span class="php-comment"> * requested IP address.
|
||||
</span></span><span id="18" class="l"><a class="l" href="#18">18: </a><span class="php-comment"> *
|
||||
</span></span><span id="19" class="l"><a class="l" href="#19">19: </a><span class="php-comment"> * @property \GeoIp2\Record\Country $country Country data for the requested
|
||||
</span></span><span id="20" class="l"><a class="l" href="#20">20: </a><span class="php-comment"> * IP address. This object represents the country where MaxMind believes the
|
||||
</span></span><span id="21" class="l"><a class="l" href="#21">21: </a><span class="php-comment"> * end user is located.
|
||||
</span></span><span id="22" class="l"><a class="l" href="#22">22: </a><span class="php-comment"> *
|
||||
</span></span><span id="23" class="l"><a class="l" href="#23">23: </a><span class="php-comment"> * @property \GeoIp2\Record\Location $location Location data for the
|
||||
</span></span><span id="24" class="l"><a class="l" href="#24">24: </a><span class="php-comment"> * requested IP address.
|
||||
</span></span><span id="25" class="l"><a class="l" href="#25">25: </a><span class="php-comment"> *
|
||||
</span></span><span id="26" class="l"><a class="l" href="#26">26: </a><span class="php-comment"> * @property \GeoIp2\Record\MaxMind $maxmind Data related to your MaxMind
|
||||
</span></span><span id="27" class="l"><a class="l" href="#27">27: </a><span class="php-comment"> * account.
|
||||
</span></span><span id="28" class="l"><a class="l" href="#28">28: </a><span class="php-comment"> *
|
||||
</span></span><span id="29" class="l"><a class="l" href="#29">29: </a><span class="php-comment"> * @property \GeoIp2\Record\Country $registeredCountry Registered country
|
||||
</span></span><span id="30" class="l"><a class="l" href="#30">30: </a><span class="php-comment"> * data for the requested IP address. This record represents the country
|
||||
</span></span><span id="31" class="l"><a class="l" href="#31">31: </a><span class="php-comment"> * where the ISP has registered a given IP block and may differ from the
|
||||
</span></span><span id="32" class="l"><a class="l" href="#32">32: </a><span class="php-comment"> * user's country.
|
||||
</span></span><span id="33" class="l"><a class="l" href="#33">33: </a><span class="php-comment"> *
|
||||
</span></span><span id="34" class="l"><a class="l" href="#34">34: </a><span class="php-comment"> * @property \GeoIp2\Record\RepresentedCountry $representedCountry
|
||||
</span></span><span id="35" class="l"><a class="l" href="#35">35: </a><span class="php-comment"> * Represented country data for the requested IP address. The represented
|
||||
</span></span><span id="36" class="l"><a class="l" href="#36">36: </a><span class="php-comment"> * country is used for things like military bases or embassies. It is only
|
||||
</span></span><span id="37" class="l"><a class="l" href="#37">37: </a><span class="php-comment"> * present when the represented country differs from the country.
|
||||
</span></span><span id="38" class="l"><a class="l" href="#38">38: </a><span class="php-comment"> *
|
||||
</span></span><span id="39" class="l"><a class="l" href="#39">39: </a><span class="php-comment"> * @property array $subdivisions An array of {@link \GeoIp2\Record\Subdivision}
|
||||
</span></span><span id="40" class="l"><a class="l" href="#40">40: </a><span class="php-comment"> * objects representing the country subdivisions for the requested IP
|
||||
</span></span><span id="41" class="l"><a class="l" href="#41">41: </a><span class="php-comment"> * address. The number and type of subdivisions varies by country, but a
|
||||
</span></span><span id="42" class="l"><a class="l" href="#42">42: </a><span class="php-comment"> * subdivision is typically a state, province, county, etc. Subdivisions
|
||||
</span></span><span id="43" class="l"><a class="l" href="#43">43: </a><span class="php-comment"> * are ordered from most general (largest) to most specific (smallest).
|
||||
</span></span><span id="44" class="l"><a class="l" href="#44">44: </a><span class="php-comment"> * If the response did not contain any subdivisions, this method returns
|
||||
</span></span><span id="45" class="l"><a class="l" href="#45">45: </a><span class="php-comment"> * an empty array.
|
||||
</span></span><span id="46" class="l"><a class="l" href="#46">46: </a><span class="php-comment"> *
|
||||
</span></span><span id="47" class="l"><a class="l" href="#47">47: </a><span class="php-comment"> * @property \GeoIp2\Record\Subdivision $mostSpecificSubdivision An object
|
||||
</span></span><span id="48" class="l"><a class="l" href="#48">48: </a><span class="php-comment"> * representing the most specific subdivision returned. If the response
|
||||
</span></span><span id="49" class="l"><a class="l" href="#49">49: </a><span class="php-comment"> * did not contain any subdivisions, this method returns an empty
|
||||
</span></span><span id="50" class="l"><a class="l" href="#50">50: </a><span class="php-comment"> * {@link \GeoIp2\Record\Subdivision} object.
|
||||
</span></span><span id="51" class="l"><a class="l" href="#51">51: </a><span class="php-comment"> *
|
||||
</span></span><span id="52" class="l"><a class="l" href="#52">52: </a><span class="php-comment"> * @property \GeoIp2\Record\Traits $traits Data for the traits of the
|
||||
</span></span><span id="53" class="l"><a class="l" href="#53">53: </a><span class="php-comment"> * requested IP address.
|
||||
</span></span><span id="54" class="l"><a class="l" href="#54">54: </a><span class="php-comment"> */</span>
|
||||
</span><span id="55" class="l"><a class="l" href="#55">55: </a><span class="php-keyword1">class</span> <a id="CityIspOrg" href="#CityIspOrg">CityIspOrg</a> <span class="php-keyword1">extends</span> City
|
||||
</span><span id="56" class="l"><a class="l" href="#56">56: </a>{
|
||||
</span><span id="57" class="l"><a class="l" href="#57">57: </a>}
|
||||
</span><span id="58" class="l"><a class="l" href="#58">58: </a></span></code></pre>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
201
doc/v0.4.0/source-class-GeoIp2.Model.Country.html
Normal file
201
doc/v0.4.0/source-class-GeoIp2.Model.Country.html
Normal file
|
|
@ -0,0 +1,201 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
<meta name="robots" content="noindex" />
|
||||
|
||||
<title>File GeoIp2/Model/Country.php | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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>
|
||||
<a href="class-GeoIp2.Model.Country.html" title="Summary of GeoIp2\Model\Country"><span>Class</span></a>
|
||||
</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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
||||
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
|
||||
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">namespace</span> GeoIp2\Model;
|
||||
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a>
|
||||
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment">/**
|
||||
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * This class provides a model for the data returned by the GeoIP2 Country
|
||||
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * end point.
|
||||
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> *
|
||||
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * The only difference between the City, City/ISP/Org, and Omni model
|
||||
</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment"> * classes is which fields in each record may be populated. See
|
||||
</span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment"> * http://dev.maxmind.com/geoip/geoip2/web-services more details.
|
||||
</span></span><span id="12" class="l"><a class="l" href="#12">12: </a><span class="php-comment"> *
|
||||
</span></span><span id="13" class="l"><a class="l" href="#13">13: </a><span class="php-comment"> * @property \GeoIp2\Record\Continent $continent Continent data for the
|
||||
</span></span><span id="14" class="l"><a class="l" href="#14">14: </a><span class="php-comment"> * requested IP address.
|
||||
</span></span><span id="15" class="l"><a class="l" href="#15">15: </a><span class="php-comment"> *
|
||||
</span></span><span id="16" class="l"><a class="l" href="#16">16: </a><span class="php-comment"> * @property \GeoIp2\Record\Country $country Country data for the requested
|
||||
</span></span><span id="17" class="l"><a class="l" href="#17">17: </a><span class="php-comment"> * IP address. This object represents the country where MaxMind believes the
|
||||
</span></span><span id="18" class="l"><a class="l" href="#18">18: </a><span class="php-comment"> * end user is located.
|
||||
</span></span><span id="19" class="l"><a class="l" href="#19">19: </a><span class="php-comment"> *
|
||||
</span></span><span id="20" class="l"><a class="l" href="#20">20: </a><span class="php-comment"> * @property \GeoIp2\Record\MaxMind $maxmind Data related to your MaxMind
|
||||
</span></span><span id="21" class="l"><a class="l" href="#21">21: </a><span class="php-comment"> * account.
|
||||
</span></span><span id="22" class="l"><a class="l" href="#22">22: </a><span class="php-comment"> *
|
||||
</span></span><span id="23" class="l"><a class="l" href="#23">23: </a><span class="php-comment"> * @property \GeoIp2\Record\Country $registeredCountry Registered country
|
||||
</span></span><span id="24" class="l"><a class="l" href="#24">24: </a><span class="php-comment"> * data for the requested IP address. This record represents the country
|
||||
</span></span><span id="25" class="l"><a class="l" href="#25">25: </a><span class="php-comment"> * where the ISP has registered a given IP block and may differ from the
|
||||
</span></span><span id="26" class="l"><a class="l" href="#26">26: </a><span class="php-comment"> * user's country.
|
||||
</span></span><span id="27" class="l"><a class="l" href="#27">27: </a><span class="php-comment"> *
|
||||
</span></span><span id="28" class="l"><a class="l" href="#28">28: </a><span class="php-comment"> * @property \GeoIp2\Record\RepresentedCountry $representedCountry
|
||||
</span></span><span id="29" class="l"><a class="l" href="#29">29: </a><span class="php-comment"> * Represented country data for the requested IP address. The represented
|
||||
</span></span><span id="30" class="l"><a class="l" href="#30">30: </a><span class="php-comment"> * country is used for things like military bases or embassies. It is only
|
||||
</span></span><span id="31" class="l"><a class="l" href="#31">31: </a><span class="php-comment"> * present when the represented country differs from the country.
|
||||
</span></span><span id="32" class="l"><a class="l" href="#32">32: </a><span class="php-comment"> *
|
||||
</span></span><span id="33" class="l"><a class="l" href="#33">33: </a><span class="php-comment"> * @property \GeoIp2\Record\Traits $traits Data for the traits of the
|
||||
</span></span><span id="34" class="l"><a class="l" href="#34">34: </a><span class="php-comment"> * requested IP address.
|
||||
</span></span><span id="35" class="l"><a class="l" href="#35">35: </a><span class="php-comment"> */</span>
|
||||
</span><span id="36" class="l"><a class="l" href="#36">36: </a><span class="php-keyword1">class</span> <a id="Country" href="#Country">Country</a>
|
||||
</span><span id="37" class="l"><a class="l" href="#37">37: </a>{
|
||||
</span><span id="38" class="l"><a class="l" href="#38">38: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$continent" href="#$continent">$continent</a></span>;
|
||||
</span><span id="39" class="l"><a class="l" href="#39">39: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$country" href="#$country">$country</a></span>;
|
||||
</span><span id="40" class="l"><a class="l" href="#40">40: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$languages" href="#$languages">$languages</a></span>;
|
||||
</span><span id="41" class="l"><a class="l" href="#41">41: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$maxmind" href="#$maxmind">$maxmind</a></span>;
|
||||
</span><span id="42" class="l"><a class="l" href="#42">42: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$registeredCountry" href="#$registeredCountry">$registeredCountry</a></span>;
|
||||
</span><span id="43" class="l"><a class="l" href="#43">43: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$representedCountry" href="#$representedCountry">$representedCountry</a></span>;
|
||||
</span><span id="44" class="l"><a class="l" href="#44">44: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$traits" href="#$traits">$traits</a></span>;
|
||||
</span><span id="45" class="l"><a class="l" href="#45">45: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$raw" href="#$raw">$raw</a></span>;
|
||||
</span><span id="46" class="l"><a class="l" href="#46">46: </a>
|
||||
</span><span id="47" class="l"><a class="l" href="#47">47: </a> <span class="php-comment">/**
|
||||
</span></span><span id="48" class="l"><a class="l" href="#48">48: </a><span class="php-comment"> * @ignore
|
||||
</span></span><span id="49" class="l"><a class="l" href="#49">49: </a><span class="php-comment"> */</span>
|
||||
</span><span id="50" class="l"><a class="l" href="#50">50: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>(<span class="php-var">$raw</span>, <span class="php-var">$languages</span>)
|
||||
</span><span id="51" class="l"><a class="l" href="#51">51: </a> {
|
||||
</span><span id="52" class="l"><a class="l" href="#52">52: </a> <span class="php-var">$this</span>->raw = <span class="php-var">$raw</span>;
|
||||
</span><span id="53" class="l"><a class="l" href="#53">53: </a>
|
||||
</span><span id="54" class="l"><a class="l" href="#54">54: </a> <span class="php-var">$this</span>->continent = <span class="php-keyword1">new</span> \GeoIp2\Record\Continent(
|
||||
</span><span id="55" class="l"><a class="l" href="#55">55: </a> <span class="php-var">$this</span>->get(<span class="php-quote">'continent'</span>),
|
||||
</span><span id="56" class="l"><a class="l" href="#56">56: </a> <span class="php-var">$languages</span>
|
||||
</span><span id="57" class="l"><a class="l" href="#57">57: </a> );
|
||||
</span><span id="58" class="l"><a class="l" href="#58">58: </a> <span class="php-var">$this</span>->country = <span class="php-keyword1">new</span> \GeoIp2\Record\Country(
|
||||
</span><span id="59" class="l"><a class="l" href="#59">59: </a> <span class="php-var">$this</span>->get(<span class="php-quote">'country'</span>),
|
||||
</span><span id="60" class="l"><a class="l" href="#60">60: </a> <span class="php-var">$languages</span>
|
||||
</span><span id="61" class="l"><a class="l" href="#61">61: </a> );
|
||||
</span><span id="62" class="l"><a class="l" href="#62">62: </a> <span class="php-var">$this</span>->maxmind = <span class="php-keyword1">new</span> \GeoIp2\Record\MaxMind(<span class="php-var">$this</span>->get(<span class="php-quote">'maxmind'</span>));
|
||||
</span><span id="63" class="l"><a class="l" href="#63">63: </a> <span class="php-var">$this</span>->registeredCountry = <span class="php-keyword1">new</span> \GeoIp2\Record\Country(
|
||||
</span><span id="64" class="l"><a class="l" href="#64">64: </a> <span class="php-var">$this</span>->get(<span class="php-quote">'registered_country'</span>),
|
||||
</span><span id="65" class="l"><a class="l" href="#65">65: </a> <span class="php-var">$languages</span>
|
||||
</span><span id="66" class="l"><a class="l" href="#66">66: </a> );
|
||||
</span><span id="67" class="l"><a class="l" href="#67">67: </a> <span class="php-var">$this</span>->representedCountry = <span class="php-keyword1">new</span> \GeoIp2\Record\RepresentedCountry(
|
||||
</span><span id="68" class="l"><a class="l" href="#68">68: </a> <span class="php-var">$this</span>->get(<span class="php-quote">'represented_country'</span>),
|
||||
</span><span id="69" class="l"><a class="l" href="#69">69: </a> <span class="php-var">$languages</span>
|
||||
</span><span id="70" class="l"><a class="l" href="#70">70: </a> );
|
||||
</span><span id="71" class="l"><a class="l" href="#71">71: </a> <span class="php-var">$this</span>->traits = <span class="php-keyword1">new</span> \GeoIp2\Record\Traits(<span class="php-var">$this</span>->get(<span class="php-quote">'traits'</span>));
|
||||
</span><span id="72" class="l"><a class="l" href="#72">72: </a>
|
||||
</span><span id="73" class="l"><a class="l" href="#73">73: </a> <span class="php-var">$this</span>->languages = <span class="php-var">$languages</span>;
|
||||
</span><span id="74" class="l"><a class="l" href="#74">74: </a> }
|
||||
</span><span id="75" class="l"><a class="l" href="#75">75: </a>
|
||||
</span><span id="76" class="l"><a class="l" href="#76">76: </a> <span class="php-comment">/**
|
||||
</span></span><span id="77" class="l"><a class="l" href="#77">77: </a><span class="php-comment"> * @ignore
|
||||
</span></span><span id="78" class="l"><a class="l" href="#78">78: </a><span class="php-comment"> */</span>
|
||||
</span><span id="79" class="l"><a class="l" href="#79">79: </a> <span class="php-keyword1">protected</span> <span class="php-keyword1">function</span> <a id="_get" href="#_get">get</a>(<span class="php-var">$field</span>)
|
||||
</span><span id="80" class="l"><a class="l" href="#80">80: </a> {
|
||||
</span><span id="81" class="l"><a class="l" href="#81">81: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">isset</span>(<span class="php-var">$this</span>->raw[<span class="php-var">$field</span>]) ? <span class="php-var">$this</span>->raw[<span class="php-var">$field</span>] : <span class="php-keyword1">array</span>();
|
||||
</span><span id="82" class="l"><a class="l" href="#82">82: </a> }
|
||||
</span><span id="83" class="l"><a class="l" href="#83">83: </a>
|
||||
</span><span id="84" class="l"><a class="l" href="#84">84: </a> <span class="php-comment">/**
|
||||
</span></span><span id="85" class="l"><a class="l" href="#85">85: </a><span class="php-comment"> * @ignore
|
||||
</span></span><span id="86" class="l"><a class="l" href="#86">86: </a><span class="php-comment"> */</span>
|
||||
</span><span id="87" class="l"><a class="l" href="#87">87: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___get" href="#___get">__get</a> (<span class="php-var">$attr</span>)
|
||||
</span><span id="88" class="l"><a class="l" href="#88">88: </a> {
|
||||
</span><span id="89" class="l"><a class="l" href="#89">89: </a> <span class="php-keyword1">if</span> (<span class="php-var">$attr</span> != <span class="php-quote">"instance"</span> && <span class="php-keyword1">isset</span>(<span class="php-var">$this</span>-><span class="php-var">$attr</span>)) {
|
||||
</span><span id="90" class="l"><a class="l" href="#90">90: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-><span class="php-var">$attr</span>;
|
||||
</span><span id="91" class="l"><a class="l" href="#91">91: </a> }
|
||||
</span><span id="92" class="l"><a class="l" href="#92">92: </a>
|
||||
</span><span id="93" class="l"><a class="l" href="#93">93: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> \RuntimeException(<span class="php-quote">"Unknown attribute: </span><span class="php-var">$attr</span><span class="php-quote">"</span>);
|
||||
</span><span id="94" class="l"><a class="l" href="#94">94: </a> }
|
||||
</span><span id="95" class="l"><a class="l" href="#95">95: </a>}
|
||||
</span><span id="96" class="l"><a class="l" href="#96">96: </a></span></code></pre>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
163
doc/v0.4.0/source-class-GeoIp2.Model.Omni.html
Normal file
163
doc/v0.4.0/source-class-GeoIp2.Model.Omni.html
Normal file
|
|
@ -0,0 +1,163 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
<meta name="robots" content="noindex" />
|
||||
|
||||
<title>File GeoIp2/Model/Omni.php | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><a href="class-GeoIp2.Model.Country.html">Country</a></li>
|
||||
<li class="active"><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>
|
||||
<a href="class-GeoIp2.Model.Omni.html" title="Summary of GeoIp2\Model\Omni"><span>Class</span></a>
|
||||
</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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
||||
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
|
||||
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">namespace</span> GeoIp2\Model;
|
||||
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a>
|
||||
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment">/**
|
||||
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * This class provides a model for the data returned by the GeoIP2
|
||||
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * Omni end point.
|
||||
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> *
|
||||
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * The only difference between the City, City/ISP/Org, and Omni model
|
||||
</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment"> * classes is which fields in each record may be populated. See
|
||||
</span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment"> * http://dev.maxmind.com/geoip/geoip2/web-services more details.
|
||||
</span></span><span id="12" class="l"><a class="l" href="#12">12: </a><span class="php-comment"> *
|
||||
</span></span><span id="13" class="l"><a class="l" href="#13">13: </a><span class="php-comment"> * @property \GeoIp2\Record\City $city City data for the requested IP
|
||||
</span></span><span id="14" class="l"><a class="l" href="#14">14: </a><span class="php-comment"> * address.
|
||||
</span></span><span id="15" class="l"><a class="l" href="#15">15: </a><span class="php-comment"> *
|
||||
</span></span><span id="16" class="l"><a class="l" href="#16">16: </a><span class="php-comment"> * @property \GeoIp2\Record\Continent $continent Continent data for the
|
||||
</span></span><span id="17" class="l"><a class="l" href="#17">17: </a><span class="php-comment"> * requested IP address.
|
||||
</span></span><span id="18" class="l"><a class="l" href="#18">18: </a><span class="php-comment"> *
|
||||
</span></span><span id="19" class="l"><a class="l" href="#19">19: </a><span class="php-comment"> * @property \GeoIp2\Record\Country $country Country data for the requested
|
||||
</span></span><span id="20" class="l"><a class="l" href="#20">20: </a><span class="php-comment"> * IP address. This object represents the country where MaxMind believes the
|
||||
</span></span><span id="21" class="l"><a class="l" href="#21">21: </a><span class="php-comment"> * end user is located.
|
||||
</span></span><span id="22" class="l"><a class="l" href="#22">22: </a><span class="php-comment"> *
|
||||
</span></span><span id="23" class="l"><a class="l" href="#23">23: </a><span class="php-comment"> * @property \GeoIp2\Record\Location $location Location data for the
|
||||
</span></span><span id="24" class="l"><a class="l" href="#24">24: </a><span class="php-comment"> * requested IP address.
|
||||
</span></span><span id="25" class="l"><a class="l" href="#25">25: </a><span class="php-comment"> *
|
||||
</span></span><span id="26" class="l"><a class="l" href="#26">26: </a><span class="php-comment"> * @property \GeoIp2\Record\MaxMind $maxmind Data related to your MaxMind
|
||||
</span></span><span id="27" class="l"><a class="l" href="#27">27: </a><span class="php-comment"> * account.
|
||||
</span></span><span id="28" class="l"><a class="l" href="#28">28: </a><span class="php-comment"> *
|
||||
</span></span><span id="29" class="l"><a class="l" href="#29">29: </a><span class="php-comment"> * @property \GeoIp2\Record\Country $registeredCountry Registered country
|
||||
</span></span><span id="30" class="l"><a class="l" href="#30">30: </a><span class="php-comment"> * data for the requested IP address. This record represents the country
|
||||
</span></span><span id="31" class="l"><a class="l" href="#31">31: </a><span class="php-comment"> * where the ISP has registered a given IP block and may differ from the
|
||||
</span></span><span id="32" class="l"><a class="l" href="#32">32: </a><span class="php-comment"> * user's country.
|
||||
</span></span><span id="33" class="l"><a class="l" href="#33">33: </a><span class="php-comment"> *
|
||||
</span></span><span id="34" class="l"><a class="l" href="#34">34: </a><span class="php-comment"> * @property \GeoIp2\Record\RepresentedCountry $representedCountry
|
||||
</span></span><span id="35" class="l"><a class="l" href="#35">35: </a><span class="php-comment"> * Represented country data for the requested IP address. The represented
|
||||
</span></span><span id="36" class="l"><a class="l" href="#36">36: </a><span class="php-comment"> * country is used for things like military bases or embassies. It is only
|
||||
</span></span><span id="37" class="l"><a class="l" href="#37">37: </a><span class="php-comment"> * present when the represented country differs from the country.
|
||||
</span></span><span id="38" class="l"><a class="l" href="#38">38: </a><span class="php-comment"> *
|
||||
</span></span><span id="39" class="l"><a class="l" href="#39">39: </a><span class="php-comment"> * @property array $subdivisions An array of {@link \GeoIp2\Record\Subdivision}
|
||||
</span></span><span id="40" class="l"><a class="l" href="#40">40: </a><span class="php-comment"> * objects representing the country subdivisions for the requested IP
|
||||
</span></span><span id="41" class="l"><a class="l" href="#41">41: </a><span class="php-comment"> * address. The number and type of subdivisions varies by country, but a
|
||||
</span></span><span id="42" class="l"><a class="l" href="#42">42: </a><span class="php-comment"> * subdivision is typically a state, province, county, etc. Subdivisions
|
||||
</span></span><span id="43" class="l"><a class="l" href="#43">43: </a><span class="php-comment"> * are ordered from most general (largest) to most specific (smallest).
|
||||
</span></span><span id="44" class="l"><a class="l" href="#44">44: </a><span class="php-comment"> * If the response did not contain any subdivisions, this method returns
|
||||
</span></span><span id="45" class="l"><a class="l" href="#45">45: </a><span class="php-comment"> * an empty array.
|
||||
</span></span><span id="46" class="l"><a class="l" href="#46">46: </a><span class="php-comment"> *
|
||||
</span></span><span id="47" class="l"><a class="l" href="#47">47: </a><span class="php-comment"> * @property \GeoIp2\Record\Subdivision $mostSpecificSubdivision An object
|
||||
</span></span><span id="48" class="l"><a class="l" href="#48">48: </a><span class="php-comment"> * representing the most specific subdivision returned. If the response
|
||||
</span></span><span id="49" class="l"><a class="l" href="#49">49: </a><span class="php-comment"> * did not contain any subdivisions, this method returns an empty
|
||||
</span></span><span id="50" class="l"><a class="l" href="#50">50: </a><span class="php-comment"> * {@link \GeoIp2\Record\Subdivision} object.
|
||||
</span></span><span id="51" class="l"><a class="l" href="#51">51: </a><span class="php-comment"> *
|
||||
</span></span><span id="52" class="l"><a class="l" href="#52">52: </a><span class="php-comment"> * @property \GeoIp2\Record\Traits $traits Data for the traits of the
|
||||
</span></span><span id="53" class="l"><a class="l" href="#53">53: </a><span class="php-comment"> * requested IP address.
|
||||
</span></span><span id="54" class="l"><a class="l" href="#54">54: </a><span class="php-comment"> */</span>
|
||||
</span><span id="55" class="l"><a class="l" href="#55">55: </a><span class="php-keyword1">class</span> <a id="Omni" href="#Omni">Omni</a> <span class="php-keyword1">extends</span> CityIspOrg
|
||||
</span><span id="56" class="l"><a class="l" href="#56">56: </a>{
|
||||
</span><span id="57" class="l"><a class="l" href="#57">57: </a>}
|
||||
</span><span id="58" class="l"><a class="l" href="#58">58: </a></span></code></pre>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
151
doc/v0.4.0/source-class-GeoIp2.Record.AbstractPlaceRecord.html
Normal file
151
doc/v0.4.0/source-class-GeoIp2.Record.AbstractPlaceRecord.html
Normal file
|
|
@ -0,0 +1,151 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
<meta name="robots" content="noindex" />
|
||||
|
||||
<title>File GeoIp2/Record/AbstractPlaceRecord.php | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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 class="active"><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><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" />
|
||||
<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.Record.html" title="Summary of GeoIp2\Record"><span>Namespace</span></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="class-GeoIp2.Record.AbstractPlaceRecord.html" title="Summary of GeoIp2\Record\AbstractPlaceRecord"><span>Class</span></a>
|
||||
</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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
||||
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
|
||||
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">namespace</span> GeoIp2\Record;
|
||||
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a>
|
||||
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-keyword1">abstract</span> <span class="php-keyword1">class</span> <a id="AbstractPlaceRecord" href="#AbstractPlaceRecord">AbstractPlaceRecord</a> <span class="php-keyword1">extends</span> AbstractRecord
|
||||
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a>{
|
||||
</span><span id="7" class="l"><a class="l" href="#7"> 7: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$languages" href="#$languages">$languages</a></span>;
|
||||
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a>
|
||||
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a> <span class="php-comment">/**
|
||||
</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment"> * @ignore
|
||||
</span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment"> */</span>
|
||||
</span><span id="12" class="l"><a class="l" href="#12">12: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>(<span class="php-var">$record</span>, <span class="php-var">$languages</span>)
|
||||
</span><span id="13" class="l"><a class="l" href="#13">13: </a> {
|
||||
</span><span id="14" class="l"><a class="l" href="#14">14: </a> <span class="php-var">$this</span>->languages = <span class="php-var">$languages</span>;
|
||||
</span><span id="15" class="l"><a class="l" href="#15">15: </a> parent::__construct(<span class="php-var">$record</span>);
|
||||
</span><span id="16" class="l"><a class="l" href="#16">16: </a> }
|
||||
</span><span id="17" class="l"><a class="l" href="#17">17: </a>
|
||||
</span><span id="18" class="l"><a class="l" href="#18">18: </a> <span class="php-comment">/**
|
||||
</span></span><span id="19" class="l"><a class="l" href="#19">19: </a><span class="php-comment"> * @ignore
|
||||
</span></span><span id="20" class="l"><a class="l" href="#20">20: </a><span class="php-comment"> */</span>
|
||||
</span><span id="21" class="l"><a class="l" href="#21">21: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___get" href="#___get">__get</a>(<span class="php-var">$attr</span>)
|
||||
</span><span id="22" class="l"><a class="l" href="#22">22: </a> {
|
||||
</span><span id="23" class="l"><a class="l" href="#23">23: </a> <span class="php-keyword1">if</span> (<span class="php-var">$attr</span> == <span class="php-quote">'name'</span>) {
|
||||
</span><span id="24" class="l"><a class="l" href="#24">24: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->name();
|
||||
</span><span id="25" class="l"><a class="l" href="#25">25: </a> } <span class="php-keyword1">else</span> {
|
||||
</span><span id="26" class="l"><a class="l" href="#26">26: </a> <span class="php-keyword1">return</span> parent::__get(<span class="php-var">$attr</span>);
|
||||
</span><span id="27" class="l"><a class="l" href="#27">27: </a> }
|
||||
</span><span id="28" class="l"><a class="l" href="#28">28: </a> }
|
||||
</span><span id="29" class="l"><a class="l" href="#29">29: </a>
|
||||
</span><span id="30" class="l"><a class="l" href="#30">30: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> <a id="_name" href="#_name">name</a>()
|
||||
</span><span id="31" class="l"><a class="l" href="#31">31: </a> {
|
||||
</span><span id="32" class="l"><a class="l" href="#32">32: </a> <span class="php-keyword1">foreach</span> (<span class="php-var">$this</span>->languages <span class="php-keyword1">as</span> <span class="php-var">$language</span>) {
|
||||
</span><span id="33" class="l"><a class="l" href="#33">33: </a> <span class="php-keyword1">if</span> (<span class="php-keyword1">isset</span>(<span class="php-var">$this</span>->names[<span class="php-var">$language</span>])) {
|
||||
</span><span id="34" class="l"><a class="l" href="#34">34: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->names[<span class="php-var">$language</span>];
|
||||
</span><span id="35" class="l"><a class="l" href="#35">35: </a> }
|
||||
</span><span id="36" class="l"><a class="l" href="#36">36: </a> }
|
||||
</span><span id="37" class="l"><a class="l" href="#37">37: </a> }
|
||||
</span><span id="38" class="l"><a class="l" href="#38">38: </a>}
|
||||
</span><span id="39" class="l"><a class="l" href="#39">39: </a></span></code></pre>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
147
doc/v0.4.0/source-class-GeoIp2.Record.AbstractRecord.html
Normal file
147
doc/v0.4.0/source-class-GeoIp2.Record.AbstractRecord.html
Normal file
|
|
@ -0,0 +1,147 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
<meta name="robots" content="noindex" />
|
||||
|
||||
<title>File GeoIp2/Record/AbstractRecord.php | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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 class="active"><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><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" />
|
||||
<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.Record.html" title="Summary of GeoIp2\Record"><span>Namespace</span></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="class-GeoIp2.Record.AbstractRecord.html" title="Summary of GeoIp2\Record\AbstractRecord"><span>Class</span></a>
|
||||
</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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
||||
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
|
||||
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">namespace</span> GeoIp2\Record;
|
||||
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a>
|
||||
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-keyword1">abstract</span> <span class="php-keyword1">class</span> <a id="AbstractRecord" href="#AbstractRecord">AbstractRecord</a>
|
||||
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a>{
|
||||
</span><span id="7" class="l"><a class="l" href="#7"> 7: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$record" href="#$record">$record</a></span>;
|
||||
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a>
|
||||
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a> <span class="php-comment">/**
|
||||
</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment"> * @ignore
|
||||
</span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment"> */</span>
|
||||
</span><span id="12" class="l"><a class="l" href="#12">12: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>(<span class="php-var">$record</span>)
|
||||
</span><span id="13" class="l"><a class="l" href="#13">13: </a> {
|
||||
</span><span id="14" class="l"><a class="l" href="#14">14: </a> <span class="php-var">$this</span>->record = <span class="php-var">$record</span>;
|
||||
</span><span id="15" class="l"><a class="l" href="#15">15: </a> }
|
||||
</span><span id="16" class="l"><a class="l" href="#16">16: </a>
|
||||
</span><span id="17" class="l"><a class="l" href="#17">17: </a> <span class="php-comment">/**
|
||||
</span></span><span id="18" class="l"><a class="l" href="#18">18: </a><span class="php-comment"> * @ignore
|
||||
</span></span><span id="19" class="l"><a class="l" href="#19">19: </a><span class="php-comment"> */</span>
|
||||
</span><span id="20" class="l"><a class="l" href="#20">20: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___get" href="#___get">__get</a>(<span class="php-var">$attr</span>)
|
||||
</span><span id="21" class="l"><a class="l" href="#21">21: </a> {
|
||||
</span><span id="22" class="l"><a class="l" href="#22">22: </a> <span class="php-var">$valid</span> = <span class="php-keyword2">in_array</span>(<span class="php-var">$attr</span>, <span class="php-var">$this</span>->validAttributes);
|
||||
</span><span id="23" class="l"><a class="l" href="#23">23: </a> <span class="php-comment">// XXX - kind of ugly but greatly reduces boilerplate code</span>
|
||||
</span><span id="24" class="l"><a class="l" href="#24">24: </a> <span class="php-var">$key</span> = <span class="php-keyword2">strtolower</span>(<span class="php-keyword2">preg_replace</span>(<span class="php-quote">'/([A-Z])/'</span>, <span class="php-quote">'_\1'</span>, <span class="php-var">$attr</span>));
|
||||
</span><span id="25" class="l"><a class="l" href="#25">25: </a>
|
||||
</span><span id="26" class="l"><a class="l" href="#26">26: </a> <span class="php-keyword1">if</span> (<span class="php-var">$valid</span> && <span class="php-keyword1">isset</span>(<span class="php-var">$this</span>->record[<span class="php-var">$key</span>])) {
|
||||
</span><span id="27" class="l"><a class="l" href="#27">27: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->record[<span class="php-var">$key</span>];
|
||||
</span><span id="28" class="l"><a class="l" href="#28">28: </a> } <span class="php-keyword1">elseif</span> (<span class="php-var">$valid</span>) {
|
||||
</span><span id="29" class="l"><a class="l" href="#29">29: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">null</span>;
|
||||
</span><span id="30" class="l"><a class="l" href="#30">30: </a> } <span class="php-keyword1">else</span> {
|
||||
</span><span id="31" class="l"><a class="l" href="#31">31: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> \RuntimeException(<span class="php-quote">"Unknown attribute: </span><span class="php-var">$attr</span><span class="php-quote">"</span>);
|
||||
</span><span id="32" class="l"><a class="l" href="#32">32: </a> }
|
||||
</span><span id="33" class="l"><a class="l" href="#33">33: </a> }
|
||||
</span><span id="34" class="l"><a class="l" href="#34">34: </a>}
|
||||
</span><span id="35" class="l"><a class="l" href="#35">35: </a></span></code></pre>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
142
doc/v0.4.0/source-class-GeoIp2.Record.City.html
Normal file
142
doc/v0.4.0/source-class-GeoIp2.Record.City.html
Normal file
|
|
@ -0,0 +1,142 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
<meta name="robots" content="noindex" />
|
||||
|
||||
<title>File GeoIp2/Record/City.php | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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 class="active"><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><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" />
|
||||
<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.Record.html" title="Summary of GeoIp2\Record"><span>Namespace</span></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="class-GeoIp2.Record.City.html" title="Summary of GeoIp2\Record\City"><span>Class</span></a>
|
||||
</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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
||||
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
|
||||
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">namespace</span> GeoIp2\Record;
|
||||
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a>
|
||||
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment">/**
|
||||
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * City-level data associated with an IP address.
|
||||
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> *
|
||||
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> * This record is returned by all the end points except the Country end point.
|
||||
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> *
|
||||
</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment"> * @property int $confidence A value from 0-100 indicating MaxMind's
|
||||
</span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment"> * confidence that the city is correct. This attribute is only available
|
||||
</span></span><span id="12" class="l"><a class="l" href="#12">12: </a><span class="php-comment"> * from the Omni end point.
|
||||
</span></span><span id="13" class="l"><a class="l" href="#13">13: </a><span class="php-comment"> *
|
||||
</span></span><span id="14" class="l"><a class="l" href="#14">14: </a><span class="php-comment"> * @property int $geonameId The GeoName ID for the city. This attribute
|
||||
</span></span><span id="15" class="l"><a class="l" href="#15">15: </a><span class="php-comment"> * is returned by all end points.
|
||||
</span></span><span id="16" class="l"><a class="l" href="#16">16: </a><span class="php-comment"> *
|
||||
</span></span><span id="17" class="l"><a class="l" href="#17">17: </a><span class="php-comment"> * @property string $name The name of the city based on the languages list
|
||||
</span></span><span id="18" class="l"><a class="l" href="#18">18: </a><span class="php-comment"> * passed to the constructor. This attribute is returned by all end points.
|
||||
</span></span><span id="19" class="l"><a class="l" href="#19">19: </a><span class="php-comment"> *
|
||||
</span></span><span id="20" class="l"><a class="l" href="#20">20: </a><span class="php-comment"> * @property array $names A array map where the keys are language codes
|
||||
</span></span><span id="21" class="l"><a class="l" href="#21">21: </a><span class="php-comment"> * and the values are names. This attribute is returned by all end points.
|
||||
</span></span><span id="22" class="l"><a class="l" href="#22">22: </a><span class="php-comment"> */</span>
|
||||
</span><span id="23" class="l"><a class="l" href="#23">23: </a><span class="php-keyword1">class</span> <a id="City" href="#City">City</a> <span class="php-keyword1">extends</span> AbstractPlaceRecord
|
||||
</span><span id="24" class="l"><a class="l" href="#24">24: </a>{
|
||||
</span><span id="25" class="l"><a class="l" href="#25">25: </a> <span class="php-comment">/**
|
||||
</span></span><span id="26" class="l"><a class="l" href="#26">26: </a><span class="php-comment"> * @ignore
|
||||
</span></span><span id="27" class="l"><a class="l" href="#27">27: </a><span class="php-comment"> */</span>
|
||||
</span><span id="28" class="l"><a class="l" href="#28">28: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$validAttributes" href="#$validAttributes">$validAttributes</a></span> = <span class="php-keyword1">array</span>(<span class="php-quote">'confidence'</span>, <span class="php-quote">'geonameId'</span>, <span class="php-quote">'names'</span>);
|
||||
</span><span id="29" class="l"><a class="l" href="#29">29: </a>}
|
||||
</span><span id="30" class="l"><a class="l" href="#30">30: </a></span></code></pre>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
146
doc/v0.4.0/source-class-GeoIp2.Record.Continent.html
Normal file
146
doc/v0.4.0/source-class-GeoIp2.Record.Continent.html
Normal file
|
|
@ -0,0 +1,146 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
<meta name="robots" content="noindex" />
|
||||
|
||||
<title>File GeoIp2/Record/Continent.php | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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 class="active"><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><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" />
|
||||
<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.Record.html" title="Summary of GeoIp2\Record"><span>Namespace</span></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="class-GeoIp2.Record.Continent.html" title="Summary of GeoIp2\Record\Continent"><span>Class</span></a>
|
||||
</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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
||||
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
|
||||
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">namespace</span> GeoIp2\Record;
|
||||
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a>
|
||||
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment">/**
|
||||
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * Contains data for the continent record associated with an IP address
|
||||
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> *
|
||||
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> * This record is returned by all the end points.
|
||||
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> *
|
||||
</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment"> * @property string $code A two character continent code like "NA" (North
|
||||
</span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment"> * America) or "OC" (Oceania). This attribute is returned by all end points.
|
||||
</span></span><span id="12" class="l"><a class="l" href="#12">12: </a><span class="php-comment"> *
|
||||
</span></span><span id="13" class="l"><a class="l" href="#13">13: </a><span class="php-comment"> * @property int $geonameId The GeoName ID for the continent. This attribute
|
||||
</span></span><span id="14" class="l"><a class="l" href="#14">14: </a><span class="php-comment"> * is returned by all end points.
|
||||
</span></span><span id="15" class="l"><a class="l" href="#15">15: </a><span class="php-comment"> *
|
||||
</span></span><span id="16" class="l"><a class="l" href="#16">16: </a><span class="php-comment"> * @property string $name Returns the name of the continent based on the
|
||||
</span></span><span id="17" class="l"><a class="l" href="#17">17: </a><span class="php-comment"> * languages list passed to the constructor. This attribute is returned by
|
||||
</span></span><span id="18" class="l"><a class="l" href="#18">18: </a><span class="php-comment"> * all end points.
|
||||
</span></span><span id="19" class="l"><a class="l" href="#19">19: </a><span class="php-comment"> *
|
||||
</span></span><span id="20" class="l"><a class="l" href="#20">20: </a><span class="php-comment"> * @property array $names An array map where the keys are language codes
|
||||
</span></span><span id="21" class="l"><a class="l" href="#21">21: </a><span class="php-comment"> * and the values are names. This attribute is returned by all end points.
|
||||
</span></span><span id="22" class="l"><a class="l" href="#22">22: </a><span class="php-comment"> */</span>
|
||||
</span><span id="23" class="l"><a class="l" href="#23">23: </a><span class="php-keyword1">class</span> <a id="Continent" href="#Continent">Continent</a> <span class="php-keyword1">extends</span> AbstractPlaceRecord
|
||||
</span><span id="24" class="l"><a class="l" href="#24">24: </a>{
|
||||
</span><span id="25" class="l"><a class="l" href="#25">25: </a> <span class="php-comment">/**
|
||||
</span></span><span id="26" class="l"><a class="l" href="#26">26: </a><span class="php-comment"> * @ignore
|
||||
</span></span><span id="27" class="l"><a class="l" href="#27">27: </a><span class="php-comment"> */</span>
|
||||
</span><span id="28" class="l"><a class="l" href="#28">28: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$validAttributes" href="#$validAttributes">$validAttributes</a></span> = <span class="php-keyword1">array</span>(
|
||||
</span><span id="29" class="l"><a class="l" href="#29">29: </a> <span class="php-quote">'code'</span>,
|
||||
</span><span id="30" class="l"><a class="l" href="#30">30: </a> <span class="php-quote">'geonameId'</span>,
|
||||
</span><span id="31" class="l"><a class="l" href="#31">31: </a> <span class="php-quote">'names'</span>
|
||||
</span><span id="32" class="l"><a class="l" href="#32">32: </a> );
|
||||
</span><span id="33" class="l"><a class="l" href="#33">33: </a>}
|
||||
</span><span id="34" class="l"><a class="l" href="#34">34: </a></span></code></pre>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
151
doc/v0.4.0/source-class-GeoIp2.Record.Country.html
Normal file
151
doc/v0.4.0/source-class-GeoIp2.Record.Country.html
Normal file
|
|
@ -0,0 +1,151 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
<meta name="robots" content="noindex" />
|
||||
|
||||
<title>File GeoIp2/Record/Country.php | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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 class="active"><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><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" />
|
||||
<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.Record.html" title="Summary of GeoIp2\Record"><span>Namespace</span></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="class-GeoIp2.Record.Country.html" title="Summary of GeoIp2\Record\Country"><span>Class</span></a>
|
||||
</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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
||||
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
|
||||
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">namespace</span> GeoIp2\Record;
|
||||
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a>
|
||||
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment">/**
|
||||
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * Contains data for the country record associated with an IP address
|
||||
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> *
|
||||
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> * This record is returned by all the end points.
|
||||
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> *
|
||||
</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment"> * @property int $confidence A value from 0-100 indicating MaxMind's
|
||||
</span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment"> * confidence that the country is correct. This attribute is only available
|
||||
</span></span><span id="12" class="l"><a class="l" href="#12">12: </a><span class="php-comment"> * from the Omni end point.
|
||||
</span></span><span id="13" class="l"><a class="l" href="#13">13: </a><span class="php-comment"> *
|
||||
</span></span><span id="14" class="l"><a class="l" href="#14">14: </a><span class="php-comment"> * @property int $geonameId The GeoName ID for the country. This attribute is
|
||||
</span></span><span id="15" class="l"><a class="l" href="#15">15: </a><span class="php-comment"> * returned by all end points.
|
||||
</span></span><span id="16" class="l"><a class="l" href="#16">16: </a><span class="php-comment"> *
|
||||
</span></span><span id="17" class="l"><a class="l" href="#17">17: </a><span class="php-comment"> * @property string $isoCode The {@link http://en.wikipedia.org/wiki/ISO_3166-1
|
||||
</span></span><span id="18" class="l"><a class="l" href="#18">18: </a><span class="php-comment"> * two-character ISO 3166-1 alpha code} for the country. This attribute is
|
||||
</span></span><span id="19" class="l"><a class="l" href="#19">19: </a><span class="php-comment"> * returned by all end points.
|
||||
</span></span><span id="20" class="l"><a class="l" href="#20">20: </a><span class="php-comment"> *
|
||||
</span></span><span id="21" class="l"><a class="l" href="#21">21: </a><span class="php-comment"> * @property string $name The name of the country based on the languages list
|
||||
</span></span><span id="22" class="l"><a class="l" href="#22">22: </a><span class="php-comment"> * passed to the constructor. This attribute is returned by all end points.
|
||||
</span></span><span id="23" class="l"><a class="l" href="#23">23: </a><span class="php-comment"> *
|
||||
</span></span><span id="24" class="l"><a class="l" href="#24">24: </a><span class="php-comment"> * @property array $names An array map where the keys are language codes and
|
||||
</span></span><span id="25" class="l"><a class="l" href="#25">25: </a><span class="php-comment"> * the values are names. This attribute is returned by all end points.
|
||||
</span></span><span id="26" class="l"><a class="l" href="#26">26: </a><span class="php-comment"> */</span>
|
||||
</span><span id="27" class="l"><a class="l" href="#27">27: </a><span class="php-keyword1">class</span> <a id="Country" href="#Country">Country</a> <span class="php-keyword1">extends</span> AbstractPlaceRecord
|
||||
</span><span id="28" class="l"><a class="l" href="#28">28: </a>{
|
||||
</span><span id="29" class="l"><a class="l" href="#29">29: </a> <span class="php-comment">/**
|
||||
</span></span><span id="30" class="l"><a class="l" href="#30">30: </a><span class="php-comment"> * @ignore
|
||||
</span></span><span id="31" class="l"><a class="l" href="#31">31: </a><span class="php-comment"> */</span>
|
||||
</span><span id="32" class="l"><a class="l" href="#32">32: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$validAttributes" href="#$validAttributes">$validAttributes</a></span> = <span class="php-keyword1">array</span>(
|
||||
</span><span id="33" class="l"><a class="l" href="#33">33: </a> <span class="php-quote">'confidence'</span>,
|
||||
</span><span id="34" class="l"><a class="l" href="#34">34: </a> <span class="php-quote">'geonameId'</span>,
|
||||
</span><span id="35" class="l"><a class="l" href="#35">35: </a> <span class="php-quote">'isoCode'</span>,
|
||||
</span><span id="36" class="l"><a class="l" href="#36">36: </a> <span class="php-quote">'names'</span>
|
||||
</span><span id="37" class="l"><a class="l" href="#37">37: </a> );
|
||||
</span><span id="38" class="l"><a class="l" href="#38">38: </a>}
|
||||
</span><span id="39" class="l"><a class="l" href="#39">39: </a></span></code></pre>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
161
doc/v0.4.0/source-class-GeoIp2.Record.Location.html
Normal file
161
doc/v0.4.0/source-class-GeoIp2.Record.Location.html
Normal file
|
|
@ -0,0 +1,161 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
<meta name="robots" content="noindex" />
|
||||
|
||||
<title>File GeoIp2/Record/Location.php | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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 class="active"><a href="class-GeoIp2.Record.Location.html">Location</a></li>
|
||||
<li><a href="class-GeoIp2.Record.MaxMind.html">MaxMind</a></li>
|
||||
<li><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" />
|
||||
<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.Record.html" title="Summary of GeoIp2\Record"><span>Namespace</span></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="class-GeoIp2.Record.Location.html" title="Summary of GeoIp2\Record\Location"><span>Class</span></a>
|
||||
</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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
||||
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
|
||||
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">namespace</span> GeoIp2\Record;
|
||||
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a>
|
||||
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment">/**
|
||||
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * Contains data for the location record associated with an IP address
|
||||
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> *
|
||||
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> * This record is returned by all the end points except the Country end point.
|
||||
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> *
|
||||
</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment"> * @property int $accuracyRadius The radius in kilometers around the
|
||||
</span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment"> * specified location where the IP address is likely to be. This attribute
|
||||
</span></span><span id="12" class="l"><a class="l" href="#12">12: </a><span class="php-comment"> * is only available from the Omni end point.
|
||||
</span></span><span id="13" class="l"><a class="l" href="#13">13: </a><span class="php-comment"> *
|
||||
</span></span><span id="14" class="l"><a class="l" href="#14">14: </a><span class="php-comment"> * @property float $latitude The latitude of the location as a floating
|
||||
</span></span><span id="15" class="l"><a class="l" href="#15">15: </a><span class="php-comment"> * point number. This attribute is returned by all end points except the
|
||||
</span></span><span id="16" class="l"><a class="l" href="#16">16: </a><span class="php-comment"> * Country end point.
|
||||
</span></span><span id="17" class="l"><a class="l" href="#17">17: </a><span class="php-comment"> *
|
||||
</span></span><span id="18" class="l"><a class="l" href="#18">18: </a><span class="php-comment"> * @property float $longitude The longitude of the location as a
|
||||
</span></span><span id="19" class="l"><a class="l" href="#19">19: </a><span class="php-comment"> * floating point number. This attribute is returned by all end points
|
||||
</span></span><span id="20" class="l"><a class="l" href="#20">20: </a><span class="php-comment"> * except the Country end point.
|
||||
</span></span><span id="21" class="l"><a class="l" href="#21">21: </a><span class="php-comment"> *
|
||||
</span></span><span id="22" class="l"><a class="l" href="#22">22: </a><span class="php-comment"> * @property int $metroCode The metro code of the location if the location
|
||||
</span></span><span id="23" class="l"><a class="l" href="#23">23: </a><span class="php-comment"> * is in the US. MaxMind returns the same metro codes as the
|
||||
</span></span><span id="24" class="l"><a class="l" href="#24">24: </a><span class="php-comment"> * {@link
|
||||
</span></span><span id="25" class="l"><a class="l" href="#25">25: </a><span class="php-comment"> * https://developers.google.com/adwords/api/docs/appendix/cities-DMAregions
|
||||
</span></span><span id="26" class="l"><a class="l" href="#26">26: </a><span class="php-comment"> * Google AdWords API}. This attribute is returned by all end points except
|
||||
</span></span><span id="27" class="l"><a class="l" href="#27">27: </a><span class="php-comment"> * the Country end point.
|
||||
</span></span><span id="28" class="l"><a class="l" href="#28">28: </a><span class="php-comment"> *
|
||||
</span></span><span id="29" class="l"><a class="l" href="#29">29: </a><span class="php-comment"> * @property string $timeZone The time zone associated with location, as
|
||||
</span></span><span id="30" class="l"><a class="l" href="#30">30: </a><span class="php-comment"> * specified by the {@link http://www.iana.org/time-zones IANA Time Zone
|
||||
</span></span><span id="31" class="l"><a class="l" href="#31">31: </a><span class="php-comment"> * Database}, e.g., "America/New_York". This attribute is returned by all
|
||||
</span></span><span id="32" class="l"><a class="l" href="#32">32: </a><span class="php-comment"> * end points except the Country end point.
|
||||
</span></span><span id="33" class="l"><a class="l" href="#33">33: </a><span class="php-comment"> */</span>
|
||||
</span><span id="34" class="l"><a class="l" href="#34">34: </a><span class="php-keyword1">class</span> <a id="Location" href="#Location">Location</a> <span class="php-keyword1">extends</span> AbstractRecord
|
||||
</span><span id="35" class="l"><a class="l" href="#35">35: </a>{
|
||||
</span><span id="36" class="l"><a class="l" href="#36">36: </a> <span class="php-comment">/**
|
||||
</span></span><span id="37" class="l"><a class="l" href="#37">37: </a><span class="php-comment"> * @ignore
|
||||
</span></span><span id="38" class="l"><a class="l" href="#38">38: </a><span class="php-comment"> */</span>
|
||||
</span><span id="39" class="l"><a class="l" href="#39">39: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$validAttributes" href="#$validAttributes">$validAttributes</a></span> = <span class="php-keyword1">array</span>(
|
||||
</span><span id="40" class="l"><a class="l" href="#40">40: </a> <span class="php-quote">'accuracyRadius'</span>,
|
||||
</span><span id="41" class="l"><a class="l" href="#41">41: </a> <span class="php-quote">'latitude'</span>,
|
||||
</span><span id="42" class="l"><a class="l" href="#42">42: </a> <span class="php-quote">'longitude'</span>,
|
||||
</span><span id="43" class="l"><a class="l" href="#43">43: </a> <span class="php-quote">'metroCode'</span>,
|
||||
</span><span id="44" class="l"><a class="l" href="#44">44: </a> <span class="php-quote">'postalCode'</span>,
|
||||
</span><span id="45" class="l"><a class="l" href="#45">45: </a> <span class="php-quote">'postalConfidence'</span>,
|
||||
</span><span id="46" class="l"><a class="l" href="#46">46: </a> <span class="php-quote">'timeZone'</span>
|
||||
</span><span id="47" class="l"><a class="l" href="#47">47: </a> );
|
||||
</span><span id="48" class="l"><a class="l" href="#48">48: </a>}
|
||||
</span><span id="49" class="l"><a class="l" href="#49">49: </a></span></code></pre>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
132
doc/v0.4.0/source-class-GeoIp2.Record.MaxMind.html
Normal file
132
doc/v0.4.0/source-class-GeoIp2.Record.MaxMind.html
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
<meta name="robots" content="noindex" />
|
||||
|
||||
<title>File GeoIp2/Record/MaxMind.php | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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 class="active"><a href="class-GeoIp2.Record.MaxMind.html">MaxMind</a></li>
|
||||
<li><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" />
|
||||
<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.Record.html" title="Summary of GeoIp2\Record"><span>Namespace</span></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="class-GeoIp2.Record.MaxMind.html" title="Summary of GeoIp2\Record\MaxMind"><span>Class</span></a>
|
||||
</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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
||||
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
|
||||
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">namespace</span> GeoIp2\Record;
|
||||
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a>
|
||||
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment">/**
|
||||
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * Contains data about your account.
|
||||
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> *
|
||||
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> * This record is returned by all the end points.
|
||||
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> *
|
||||
</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment"> * @property int $queriesRemaining The number of remaining queries you have
|
||||
</span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment"> * for the end point you are calling.
|
||||
</span></span><span id="12" class="l"><a class="l" href="#12">12: </a><span class="php-comment"> */</span>
|
||||
</span><span id="13" class="l"><a class="l" href="#13">13: </a><span class="php-keyword1">class</span> <a id="MaxMind" href="#MaxMind">MaxMind</a> <span class="php-keyword1">extends</span> AbstractRecord
|
||||
</span><span id="14" class="l"><a class="l" href="#14">14: </a>{
|
||||
</span><span id="15" class="l"><a class="l" href="#15">15: </a> <span class="php-comment">/**
|
||||
</span></span><span id="16" class="l"><a class="l" href="#16">16: </a><span class="php-comment"> * @ignore
|
||||
</span></span><span id="17" class="l"><a class="l" href="#17">17: </a><span class="php-comment"> */</span>
|
||||
</span><span id="18" class="l"><a class="l" href="#18">18: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$validAttributes" href="#$validAttributes">$validAttributes</a></span> = <span class="php-keyword1">array</span>(<span class="php-quote">'queriesRemaining'</span>);
|
||||
</span><span id="19" class="l"><a class="l" href="#19">19: </a>}
|
||||
</span><span id="20" class="l"><a class="l" href="#20">20: </a></span></code></pre>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
138
doc/v0.4.0/source-class-GeoIp2.Record.Postal.html
Normal file
138
doc/v0.4.0/source-class-GeoIp2.Record.Postal.html
Normal file
|
|
@ -0,0 +1,138 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
<meta name="robots" content="noindex" />
|
||||
|
||||
<title>File GeoIp2/Record/Postal.php | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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" />
|
||||
<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.Record.html" title="Summary of GeoIp2\Record"><span>Namespace</span></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="class-GeoIp2.Record.Postal.html" title="Summary of GeoIp2\Record\Postal"><span>Class</span></a>
|
||||
</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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
||||
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
|
||||
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">namespace</span> GeoIp2\Record;
|
||||
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a>
|
||||
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment">/**
|
||||
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * Contains data for the postal record associated with an IP address
|
||||
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> *
|
||||
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> * This record is returned by all the end points except the Country end point.
|
||||
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> *
|
||||
</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment"> * @property string $code The postal code of the location. Postal codes are
|
||||
</span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment"> * not available for all countries. In some countries, this will only contain
|
||||
</span></span><span id="12" class="l"><a class="l" href="#12">12: </a><span class="php-comment"> * part of the postal code. This attribute is returned by all end points
|
||||
</span></span><span id="13" class="l"><a class="l" href="#13">13: </a><span class="php-comment"> * except the Country end point.
|
||||
</span></span><span id="14" class="l"><a class="l" href="#14">14: </a><span class="php-comment"> *
|
||||
</span></span><span id="15" class="l"><a class="l" href="#15">15: </a><span class="php-comment"> * @property int $confidence A value from 0-100 indicating MaxMind's
|
||||
</span></span><span id="16" class="l"><a class="l" href="#16">16: </a><span class="php-comment"> * confidence that the postal code is correct. This attribute is only
|
||||
</span></span><span id="17" class="l"><a class="l" href="#17">17: </a><span class="php-comment"> * available from the Omni end point.
|
||||
</span></span><span id="18" class="l"><a class="l" href="#18">18: </a><span class="php-comment"> */</span>
|
||||
</span><span id="19" class="l"><a class="l" href="#19">19: </a><span class="php-keyword1">class</span> <a id="Postal" href="#Postal">Postal</a> <span class="php-keyword1">extends</span> AbstractRecord
|
||||
</span><span id="20" class="l"><a class="l" href="#20">20: </a>{
|
||||
</span><span id="21" class="l"><a class="l" href="#21">21: </a> <span class="php-comment">/**
|
||||
</span></span><span id="22" class="l"><a class="l" href="#22">22: </a><span class="php-comment"> * @ignore
|
||||
</span></span><span id="23" class="l"><a class="l" href="#23">23: </a><span class="php-comment"> */</span>
|
||||
</span><span id="24" class="l"><a class="l" href="#24">24: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$validAttributes" href="#$validAttributes">$validAttributes</a></span> = <span class="php-keyword1">array</span>(<span class="php-quote">'code'</span>, <span class="php-quote">'confidence'</span>);
|
||||
</span><span id="25" class="l"><a class="l" href="#25">25: </a>}
|
||||
</span><span id="26" class="l"><a class="l" href="#26">26: </a></span></code></pre>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
158
doc/v0.4.0/source-class-GeoIp2.Record.RepresentedCountry.html
Normal file
158
doc/v0.4.0/source-class-GeoIp2.Record.RepresentedCountry.html
Normal file
|
|
@ -0,0 +1,158 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
<meta name="robots" content="noindex" />
|
||||
|
||||
<title>File GeoIp2/Record/RepresentedCountry.php | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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><a href="class-GeoIp2.Record.Postal.html">Postal</a></li>
|
||||
<li class="active"><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" />
|
||||
<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.Record.html" title="Summary of GeoIp2\Record"><span>Namespace</span></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="class-GeoIp2.Record.RepresentedCountry.html" title="Summary of GeoIp2\Record\RepresentedCountry"><span>Class</span></a>
|
||||
</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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
||||
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
|
||||
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">namespace</span> GeoIp2\Record;
|
||||
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a>
|
||||
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment">/**
|
||||
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * Contains data for the represented country associated with an IP address
|
||||
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> *
|
||||
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> * This class contains the country-level data associated with an IP address
|
||||
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * for the IP's represented country. The represented country is the country
|
||||
</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment"> * represented by something like a military base or embassy.
|
||||
</span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment"> *
|
||||
</span></span><span id="12" class="l"><a class="l" href="#12">12: </a><span class="php-comment"> * This record is returned by all the end points.
|
||||
</span></span><span id="13" class="l"><a class="l" href="#13">13: </a><span class="php-comment"> *
|
||||
</span></span><span id="14" class="l"><a class="l" href="#14">14: </a><span class="php-comment"> * @property int $confidence A value from 0-100 indicating MaxMind's
|
||||
</span></span><span id="15" class="l"><a class="l" href="#15">15: </a><span class="php-comment"> * confidence that the country is correct. This attribute is only available
|
||||
</span></span><span id="16" class="l"><a class="l" href="#16">16: </a><span class="php-comment"> * from the Omni end point.
|
||||
</span></span><span id="17" class="l"><a class="l" href="#17">17: </a><span class="php-comment"> *
|
||||
</span></span><span id="18" class="l"><a class="l" href="#18">18: </a><span class="php-comment"> * @property int $geonameId The GeoName ID for the country. This attribute is
|
||||
</span></span><span id="19" class="l"><a class="l" href="#19">19: </a><span class="php-comment"> * returned by all end points.
|
||||
</span></span><span id="20" class="l"><a class="l" href="#20">20: </a><span class="php-comment"> *
|
||||
</span></span><span id="21" class="l"><a class="l" href="#21">21: </a><span class="php-comment"> * @property string $isoCode The {@link http://en.wikipedia.org/wiki/ISO_3166-1
|
||||
</span></span><span id="22" class="l"><a class="l" href="#22">22: </a><span class="php-comment"> * two-character ISO 3166-1 alpha code} for the country. This attribute is
|
||||
</span></span><span id="23" class="l"><a class="l" href="#23">23: </a><span class="php-comment"> * returned by all end points.
|
||||
</span></span><span id="24" class="l"><a class="l" href="#24">24: </a><span class="php-comment"> *
|
||||
</span></span><span id="25" class="l"><a class="l" href="#25">25: </a><span class="php-comment"> * @property string $name The name of the country based on the languages list
|
||||
</span></span><span id="26" class="l"><a class="l" href="#26">26: </a><span class="php-comment"> * passed to the constructor. This attribute is returned by all end points.
|
||||
</span></span><span id="27" class="l"><a class="l" href="#27">27: </a><span class="php-comment"> *
|
||||
</span></span><span id="28" class="l"><a class="l" href="#28">28: </a><span class="php-comment"> * @property array $names An array map where the keys are language codes and
|
||||
</span></span><span id="29" class="l"><a class="l" href="#29">29: </a><span class="php-comment"> * the values are names. This attribute is returned by all end points.
|
||||
</span></span><span id="30" class="l"><a class="l" href="#30">30: </a><span class="php-comment"> *
|
||||
</span></span><span id="31" class="l"><a class="l" href="#31">31: </a><span class="php-comment"> * @property string $type A string indicating the type of entity that is
|
||||
</span></span><span id="32" class="l"><a class="l" href="#32">32: </a><span class="php-comment"> * representing the country. Currently we only return <code>military</code>
|
||||
</span></span><span id="33" class="l"><a class="l" href="#33">33: </a><span class="php-comment"> * but this could expand to include other types such as <code>embassy</code>
|
||||
</span></span><span id="34" class="l"><a class="l" href="#34">34: </a><span class="php-comment"> * in the future. Returned by all endpoints.
|
||||
</span></span><span id="35" class="l"><a class="l" href="#35">35: </a><span class="php-comment"> */</span>
|
||||
</span><span id="36" class="l"><a class="l" href="#36">36: </a><span class="php-keyword1">class</span> <a id="RepresentedCountry" href="#RepresentedCountry">RepresentedCountry</a> <span class="php-keyword1">extends</span> Country
|
||||
</span><span id="37" class="l"><a class="l" href="#37">37: </a>{
|
||||
</span><span id="38" class="l"><a class="l" href="#38">38: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$validAttributes" href="#$validAttributes">$validAttributes</a></span> = <span class="php-keyword1">array</span>(
|
||||
</span><span id="39" class="l"><a class="l" href="#39">39: </a> <span class="php-quote">'confidence'</span>,
|
||||
</span><span id="40" class="l"><a class="l" href="#40">40: </a> <span class="php-quote">'geonameId'</span>,
|
||||
</span><span id="41" class="l"><a class="l" href="#41">41: </a> <span class="php-quote">'isoCode'</span>,
|
||||
</span><span id="42" class="l"><a class="l" href="#42">42: </a> <span class="php-quote">'namespace'</span>,
|
||||
</span><span id="43" class="l"><a class="l" href="#43">43: </a> <span class="php-quote">'type'</span>
|
||||
</span><span id="44" class="l"><a class="l" href="#44">44: </a> );
|
||||
</span><span id="45" class="l"><a class="l" href="#45">45: </a>}
|
||||
</span><span id="46" class="l"><a class="l" href="#46">46: </a></span></code></pre>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
155
doc/v0.4.0/source-class-GeoIp2.Record.Subdivision.html
Normal file
155
doc/v0.4.0/source-class-GeoIp2.Record.Subdivision.html
Normal file
|
|
@ -0,0 +1,155 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
<meta name="robots" content="noindex" />
|
||||
|
||||
<title>File GeoIp2/Record/Subdivision.php | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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><a href="class-GeoIp2.Record.Postal.html">Postal</a></li>
|
||||
<li><a href="class-GeoIp2.Record.RepresentedCountry.html">RepresentedCountry</a></li>
|
||||
<li class="active"><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" />
|
||||
<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.Record.html" title="Summary of GeoIp2\Record"><span>Namespace</span></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="class-GeoIp2.Record.Subdivision.html" title="Summary of GeoIp2\Record\Subdivision"><span>Class</span></a>
|
||||
</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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
||||
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
|
||||
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">namespace</span> GeoIp2\Record;
|
||||
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a>
|
||||
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment">/**
|
||||
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> *
|
||||
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * Contains data for the subdivisions associated with an IP address
|
||||
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> *
|
||||
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * This record is returned by all the end points except the Country end point.
|
||||
</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment"> *
|
||||
</span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment"> * @property int $confidence This is a value from 0-100 indicating MaxMind's
|
||||
</span></span><span id="12" class="l"><a class="l" href="#12">12: </a><span class="php-comment"> * confidence that the subdivision is correct. This attribute is only
|
||||
</span></span><span id="13" class="l"><a class="l" href="#13">13: </a><span class="php-comment"> * available from the Omni end point.
|
||||
</span></span><span id="14" class="l"><a class="l" href="#14">14: </a><span class="php-comment"> *
|
||||
</span></span><span id="15" class="l"><a class="l" href="#15">15: </a><span class="php-comment"> * @property int $geonameId This is a GeoName ID for the subdivision. This
|
||||
</span></span><span id="16" class="l"><a class="l" href="#16">16: </a><span class="php-comment"> * attribute is returned by all end points except Country.
|
||||
</span></span><span id="17" class="l"><a class="l" href="#17">17: </a><span class="php-comment"> *
|
||||
</span></span><span id="18" class="l"><a class="l" href="#18">18: </a><span class="php-comment"> * @property string $isoCode This is a string up to three characters long
|
||||
</span></span><span id="19" class="l"><a class="l" href="#19">19: </a><span class="php-comment"> * contain the subdivision portion of the {@link
|
||||
</span></span><span id="20" class="l"><a class="l" href="#20">20: </a><span class="php-comment"> * http://en.wikipedia.org/wiki/ISO_3166-2 ISO 3166-2 code}. This attribute
|
||||
</span></span><span id="21" class="l"><a class="l" href="#21">21: </a><span class="php-comment"> * is returned by all end points except Country.
|
||||
</span></span><span id="22" class="l"><a class="l" href="#22">22: </a><span class="php-comment"> *
|
||||
</span></span><span id="23" class="l"><a class="l" href="#23">23: </a><span class="php-comment"> * @property string $name The name of the subdivision based on the languages
|
||||
</span></span><span id="24" class="l"><a class="l" href="#24">24: </a><span class="php-comment"> * list passed to the constructor. This attribute is returned by all end
|
||||
</span></span><span id="25" class="l"><a class="l" href="#25">25: </a><span class="php-comment"> * points except Country.
|
||||
</span></span><span id="26" class="l"><a class="l" href="#26">26: </a><span class="php-comment"> *
|
||||
</span></span><span id="27" class="l"><a class="l" href="#27">27: </a><span class="php-comment"> * @property array $names An array map where the keys are language codes and
|
||||
</span></span><span id="28" class="l"><a class="l" href="#28">28: </a><span class="php-comment"> * the values are names. This attribute is returned by all end points except
|
||||
</span></span><span id="29" class="l"><a class="l" href="#29">29: </a><span class="php-comment"> * Country.
|
||||
</span></span><span id="30" class="l"><a class="l" href="#30">30: </a><span class="php-comment">*/</span>
|
||||
</span><span id="31" class="l"><a class="l" href="#31">31: </a><span class="php-keyword1">class</span> <a id="Subdivision" href="#Subdivision">Subdivision</a> <span class="php-keyword1">extends</span> AbstractPlaceRecord
|
||||
</span><span id="32" class="l"><a class="l" href="#32">32: </a>{
|
||||
</span><span id="33" class="l"><a class="l" href="#33">33: </a> <span class="php-comment">/**
|
||||
</span></span><span id="34" class="l"><a class="l" href="#34">34: </a><span class="php-comment"> * @ignore
|
||||
</span></span><span id="35" class="l"><a class="l" href="#35">35: </a><span class="php-comment"> */</span>
|
||||
</span><span id="36" class="l"><a class="l" href="#36">36: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$validAttributes" href="#$validAttributes">$validAttributes</a></span> = <span class="php-keyword1">array</span>(
|
||||
</span><span id="37" class="l"><a class="l" href="#37">37: </a> <span class="php-quote">'confidence'</span>,
|
||||
</span><span id="38" class="l"><a class="l" href="#38">38: </a> <span class="php-quote">'geonameId'</span>,
|
||||
</span><span id="39" class="l"><a class="l" href="#39">39: </a> <span class="php-quote">'isoCode'</span>,
|
||||
</span><span id="40" class="l"><a class="l" href="#40">40: </a> <span class="php-quote">'names'</span>
|
||||
</span><span id="41" class="l"><a class="l" href="#41">41: </a> );
|
||||
</span><span id="42" class="l"><a class="l" href="#42">42: </a>}
|
||||
</span><span id="43" class="l"><a class="l" href="#43">43: </a></span></code></pre>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
200
doc/v0.4.0/source-class-GeoIp2.Record.Traits.html
Normal file
200
doc/v0.4.0/source-class-GeoIp2.Record.Traits.html
Normal file
|
|
@ -0,0 +1,200 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
<meta name="robots" content="noindex" />
|
||||
|
||||
<title>File GeoIp2/Record/Traits.php | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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><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 class="active"><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" />
|
||||
<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.Record.html" title="Summary of GeoIp2\Record"><span>Namespace</span></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="class-GeoIp2.Record.Traits.html" title="Summary of GeoIp2\Record\Traits"><span>Class</span></a>
|
||||
</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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
||||
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
|
||||
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">namespace</span> GeoIp2\Record;
|
||||
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a>
|
||||
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment">/**
|
||||
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> *
|
||||
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * Contains data for the traits record associated with an IP address
|
||||
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> *
|
||||
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * This record is returned by all the end points.
|
||||
</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment"> *
|
||||
</span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment"> * @property int $autonomousSystemNumber The {@link
|
||||
</span></span><span id="12" class="l"><a class="l" href="#12">12: </a><span class="php-comment"> * http://en.wikipedia.org/wiki/Autonomous_system_(Internet) autonomous
|
||||
</span></span><span id="13" class="l"><a class="l" href="#13">13: </a><span class="php-comment"> * system number} associated with the IP address. This attribute is only
|
||||
</span></span><span id="14" class="l"><a class="l" href="#14">14: </a><span class="php-comment"> * available from the City/ISP/Org and Omni end points.
|
||||
</span></span><span id="15" class="l"><a class="l" href="#15">15: </a><span class="php-comment"> *
|
||||
</span></span><span id="16" class="l"><a class="l" href="#16">16: </a><span class="php-comment"> * @property string $autonomousSystemOrganization The organization
|
||||
</span></span><span id="17" class="l"><a class="l" href="#17">17: </a><span class="php-comment"> * associated with the registered {@link
|
||||
</span></span><span id="18" class="l"><a class="l" href="#18">18: </a><span class="php-comment"> * http://en.wikipedia.org/wiki/Autonomous_system_(Internet) autonomous
|
||||
</span></span><span id="19" class="l"><a class="l" href="#19">19: </a><span class="php-comment"> * system number} for the IP address. This attribute is only available from
|
||||
</span></span><span id="20" class="l"><a class="l" href="#20">20: </a><span class="php-comment"> * the City/ISP/Org and Omni end points.
|
||||
</span></span><span id="21" class="l"><a class="l" href="#21">21: </a><span class="php-comment"> *
|
||||
</span></span><span id="22" class="l"><a class="l" href="#22">22: </a><span class="php-comment"> * @property string $domain The second level domain associated with the
|
||||
</span></span><span id="23" class="l"><a class="l" href="#23">23: </a><span class="php-comment"> * IP address. This will be something like "example.com" or "example.co.uk",
|
||||
</span></span><span id="24" class="l"><a class="l" href="#24">24: </a><span class="php-comment"> * not "foo.example.com". This attribute is only available from the
|
||||
</span></span><span id="25" class="l"><a class="l" href="#25">25: </a><span class="php-comment"> * City/ISP/Org and Omni end points.
|
||||
</span></span><span id="26" class="l"><a class="l" href="#26">26: </a><span class="php-comment"> *
|
||||
</span></span><span id="27" class="l"><a class="l" href="#27">27: </a><span class="php-comment"> * @property string $ipAddress The IP address that the data in the model
|
||||
</span></span><span id="28" class="l"><a class="l" href="#28">28: </a><span class="php-comment"> * is for. If you performed a "me" lookup against the web service, this
|
||||
</span></span><span id="29" class="l"><a class="l" href="#29">29: </a><span class="php-comment"> * will be the externally routable IP address for the system the code is
|
||||
</span></span><span id="30" class="l"><a class="l" href="#30">30: </a><span class="php-comment"> * running on. If the system is behind a NAT, this may differ from the IP
|
||||
</span></span><span id="31" class="l"><a class="l" href="#31">31: </a><span class="php-comment"> * address locally assigned to it. This attribute is returned by all end
|
||||
</span></span><span id="32" class="l"><a class="l" href="#32">32: </a><span class="php-comment"> * points.
|
||||
</span></span><span id="33" class="l"><a class="l" href="#33">33: </a><span class="php-comment"> *
|
||||
</span></span><span id="34" class="l"><a class="l" href="#34">34: </a><span class="php-comment"> * @property boolean $isAnonymousProxy This is true if the IP is an
|
||||
</span></span><span id="35" class="l"><a class="l" href="#35">35: </a><span class="php-comment"> * anonymous proxy. See {@link http://dev.maxmind.com/faq/geoip#anonproxy}
|
||||
</span></span><span id="36" class="l"><a class="l" href="#36">36: </a><span class="php-comment"> * for further details. This attribute is returned by all end points.
|
||||
</span></span><span id="37" class="l"><a class="l" href="#37">37: </a><span class="php-comment"> *
|
||||
</span></span><span id="38" class="l"><a class="l" href="#38">38: </a><span class="php-comment"> * @property boolean $isSatelliteProvider This is true if the IP belongs
|
||||
</span></span><span id="39" class="l"><a class="l" href="#39">39: </a><span class="php-comment"> * to a satellite Internet provider. This attribute is returned by all
|
||||
</span></span><span id="40" class="l"><a class="l" href="#40">40: </a><span class="php-comment"> * end points.
|
||||
</span></span><span id="41" class="l"><a class="l" href="#41">41: </a><span class="php-comment"> *
|
||||
</span></span><span id="42" class="l"><a class="l" href="#42">42: </a><span class="php-comment"> * @property string $isp The name of the ISP associated with the IP address.
|
||||
</span></span><span id="43" class="l"><a class="l" href="#43">43: </a><span class="php-comment"> * This attribute is only available from the City/ISP/Org and Omni end
|
||||
</span></span><span id="44" class="l"><a class="l" href="#44">44: </a><span class="php-comment"> * points.
|
||||
</span></span><span id="45" class="l"><a class="l" href="#45">45: </a><span class="php-comment"> *
|
||||
</span></span><span id="46" class="l"><a class="l" href="#46">46: </a><span class="php-comment"> * @property string $organization The name of the organization associated
|
||||
</span></span><span id="47" class="l"><a class="l" href="#47">47: </a><span class="php-comment"> * with the IP address. This attribute is only available from the City/ISP/Org
|
||||
</span></span><span id="48" class="l"><a class="l" href="#48">48: </a><span class="php-comment"> * and Omni end points.
|
||||
</span></span><span id="49" class="l"><a class="l" href="#49">49: </a><span class="php-comment"> *
|
||||
</span></span><span id="50" class="l"><a class="l" href="#50">50: </a><span class="php-comment"> * @property string $userType <p>The user type associated with the IP
|
||||
</span></span><span id="51" class="l"><a class="l" href="#51">51: </a><span class="php-comment"> * address. This can be one of the following values:</p>
|
||||
</span></span><span id="52" class="l"><a class="l" href="#52">52: </a><span class="php-comment"> * <ul>
|
||||
</span></span><span id="53" class="l"><a class="l" href="#53">53: </a><span class="php-comment"> * <li>business
|
||||
</span></span><span id="54" class="l"><a class="l" href="#54">54: </a><span class="php-comment"> * <li>cafe
|
||||
</span></span><span id="55" class="l"><a class="l" href="#55">55: </a><span class="php-comment"> * <li>cellular
|
||||
</span></span><span id="56" class="l"><a class="l" href="#56">56: </a><span class="php-comment"> * <li>college
|
||||
</span></span><span id="57" class="l"><a class="l" href="#57">57: </a><span class="php-comment"> * <li>content_delivery_network
|
||||
</span></span><span id="58" class="l"><a class="l" href="#58">58: </a><span class="php-comment"> * <li>dialup
|
||||
</span></span><span id="59" class="l"><a class="l" href="#59">59: </a><span class="php-comment"> * <li>government
|
||||
</span></span><span id="60" class="l"><a class="l" href="#60">60: </a><span class="php-comment"> * <li>hosting
|
||||
</span></span><span id="61" class="l"><a class="l" href="#61">61: </a><span class="php-comment"> * <li>library
|
||||
</span></span><span id="62" class="l"><a class="l" href="#62">62: </a><span class="php-comment"> * <li>military
|
||||
</span></span><span id="63" class="l"><a class="l" href="#63">63: </a><span class="php-comment"> * <li>residential
|
||||
</span></span><span id="64" class="l"><a class="l" href="#64">64: </a><span class="php-comment"> * <li>router
|
||||
</span></span><span id="65" class="l"><a class="l" href="#65">65: </a><span class="php-comment"> * <li>school
|
||||
</span></span><span id="66" class="l"><a class="l" href="#66">66: </a><span class="php-comment"> * <li>search_engine_spider
|
||||
</span></span><span id="67" class="l"><a class="l" href="#67">67: </a><span class="php-comment"> * <li>traveler
|
||||
</span></span><span id="68" class="l"><a class="l" href="#68">68: </a><span class="php-comment"> * </ul>
|
||||
</span></span><span id="69" class="l"><a class="l" href="#69">69: </a><span class="php-comment"> * <p>This attribute is only available from the Omni end point.</p>
|
||||
</span></span><span id="70" class="l"><a class="l" href="#70">70: </a><span class="php-comment"> */</span>
|
||||
</span><span id="71" class="l"><a class="l" href="#71">71: </a><span class="php-keyword1">class</span> <a id="Traits" href="#Traits">Traits</a> <span class="php-keyword1">extends</span> AbstractRecord
|
||||
</span><span id="72" class="l"><a class="l" href="#72">72: </a>{
|
||||
</span><span id="73" class="l"><a class="l" href="#73">73: </a> <span class="php-comment">/**
|
||||
</span></span><span id="74" class="l"><a class="l" href="#74">74: </a><span class="php-comment"> * @ignore
|
||||
</span></span><span id="75" class="l"><a class="l" href="#75">75: </a><span class="php-comment"> */</span>
|
||||
</span><span id="76" class="l"><a class="l" href="#76">76: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$validAttributes" href="#$validAttributes">$validAttributes</a></span> = <span class="php-keyword1">array</span>(
|
||||
</span><span id="77" class="l"><a class="l" href="#77">77: </a> <span class="php-quote">'autonomousSystemNumber'</span>,
|
||||
</span><span id="78" class="l"><a class="l" href="#78">78: </a> <span class="php-quote">'autonomousSystemOrganization'</span>,
|
||||
</span><span id="79" class="l"><a class="l" href="#79">79: </a> <span class="php-quote">'domain'</span>,
|
||||
</span><span id="80" class="l"><a class="l" href="#80">80: </a> <span class="php-quote">'isAnonymousProxy'</span>,
|
||||
</span><span id="81" class="l"><a class="l" href="#81">81: </a> <span class="php-quote">'isSatelliteProvider'</span>,
|
||||
</span><span id="82" class="l"><a class="l" href="#82">82: </a> <span class="php-quote">'isp'</span>,
|
||||
</span><span id="83" class="l"><a class="l" href="#83">83: </a> <span class="php-quote">'ipAddress'</span>,
|
||||
</span><span id="84" class="l"><a class="l" href="#84">84: </a> <span class="php-quote">'organization'</span>,
|
||||
</span><span id="85" class="l"><a class="l" href="#85">85: </a> <span class="php-quote">'userType'</span>
|
||||
</span><span id="86" class="l"><a class="l" href="#86">86: </a> );
|
||||
</span><span id="87" class="l"><a class="l" href="#87">87: </a>}
|
||||
</span><span id="88" class="l"><a class="l" href="#88">88: </a></span></code></pre>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
467
doc/v0.4.0/source-class-GeoIp2.WebService.Client.html
Normal file
467
doc/v0.4.0/source-class-GeoIp2.WebService.Client.html
Normal file
|
|
@ -0,0 +1,467 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
<meta name="robots" content="noindex" />
|
||||
|
||||
<title>File GeoIp2/WebService/Client.php | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><a href="namespace-GeoIp2.Model.html">Model</a>
|
||||
</li>
|
||||
<li><a href="namespace-GeoIp2.Record.html">Record</a>
|
||||
</li>
|
||||
<li class="active"><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 class="active"><a href="class-GeoIp2.WebService.Client.html">Client</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.WebService.html" title="Summary of GeoIp2\WebService"><span>Namespace</span></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="class-GeoIp2.WebService.Client.html" title="Summary of GeoIp2\WebService\Client"><span>Class</span></a>
|
||||
</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-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
||||
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
|
||||
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">namespace</span> GeoIp2\WebService;
|
||||
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a>
|
||||
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-keyword1">use</span> GeoIp2\Exception\GeoIp2Exception;
|
||||
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-keyword1">use</span> GeoIp2\Exception\HttpException;
|
||||
</span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-keyword1">use</span> GeoIp2\Exception\AddressNotFoundException;
|
||||
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-keyword1">use</span> GeoIp2\Exception\AuthenticationException;
|
||||
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">use</span> GeoIp2\Exception\InvalidRequestException;
|
||||
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-keyword1">use</span> GeoIp2\Exception\OutOfQueriesException;
|
||||
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-keyword1">use</span> GeoIp2\Model\City;
|
||||
</span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-keyword1">use</span> GeoIp2\Model\CityIspOrg;
|
||||
</span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-keyword1">use</span> GeoIp2\Model\Country;
|
||||
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-keyword1">use</span> GeoIp2\Model\Omni;
|
||||
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-keyword1">use</span> Guzzle\Http\Client <span class="php-keyword1">as</span> GuzzleClient;
|
||||
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-keyword1">use</span> Guzzle\Common\Exception\RuntimeException;
|
||||
</span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-keyword1">use</span> Guzzle\Http\Exception\ClientErrorResponseException;
|
||||
</span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-keyword1">use</span> Guzzle\Http\Exception\ServerErrorResponseException;
|
||||
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a>
|
||||
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-comment">/**
|
||||
</span></span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment"> * This class provides a client API for all the GeoIP2 web service's
|
||||
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * end points. The end points are Country, City, City/ISP/Org, and Omni. Each
|
||||
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> * end point returns a different set of data about an IP address, with Country
|
||||
</span></span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-comment"> * returning the least data and Omni the most.
|
||||
</span></span><span id="25" class="l"><a class="l" href="#25"> 25: </a><span class="php-comment"> *
|
||||
</span></span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment"> * Each web service end point is represented by a different model class, and
|
||||
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * these model classes in turn contain multiple Record classes. The record
|
||||
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> * classes have attributes which contain data about the IP address.
|
||||
</span></span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-comment"> *
|
||||
</span></span><span id="30" class="l"><a class="l" href="#30"> 30: </a><span class="php-comment"> * If the web service does not return a particular piece of data for an IP
|
||||
</span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment"> * address, the associated attribute is not populated.
|
||||
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> *
|
||||
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> * The web service may not return any information for an entire record, in
|
||||
</span></span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-comment"> * which case all of the attributes for that record class will be empty.
|
||||
</span></span><span id="35" class="l"><a class="l" href="#35"> 35: </a><span class="php-comment"> *
|
||||
</span></span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment"> * **Usage**
|
||||
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> *
|
||||
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> * The basic API for this class is the same for all of the web service end
|
||||
</span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment"> * points. First you create a web service object with your MaxMind
|
||||
</span></span><span id="40" class="l"><a class="l" href="#40"> 40: </a><span class="php-comment"> * <code>$userId</code> and <code>$licenseKey</code>, then you call the method
|
||||
</span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment"> * corresponding to a specific end point, passing it the IP address you want
|
||||
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * to look up.
|
||||
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> *
|
||||
</span></span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-comment"> * If the request succeeds, the method call will return a model class for
|
||||
</span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a><span class="php-comment"> * the end point you called. This model in turn contains multiple record
|
||||
</span></span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment"> * classes, each of which represents part of the data returned by the web
|
||||
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * service.
|
||||
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> *
|
||||
</span></span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-comment"> * If the request fails, the client class throws an exception.
|
||||
</span></span><span id="50" class="l"><a class="l" href="#50"> 50: </a><span class="php-comment"> */</span>
|
||||
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-keyword1">class</span> <a id="Client" href="#Client">Client</a>
|
||||
</span><span id="52" class="l"><a class="l" href="#52"> 52: </a>{
|
||||
</span><span id="53" class="l"><a class="l" href="#53"> 53: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$userId" href="#$userId">$userId</a></span>;
|
||||
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$licenseKey" href="#$licenseKey">$licenseKey</a></span>;
|
||||
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$languages" href="#$languages">$languages</a></span>;
|
||||
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$host" href="#$host">$host</a></span>;
|
||||
</span><span id="57" class="l"><a class="l" href="#57"> 57: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$guzzleClient" href="#$guzzleClient">$guzzleClient</a></span>;
|
||||
</span><span id="58" class="l"><a class="l" href="#58"> 58: </a>
|
||||
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a> <span class="php-comment">/**
|
||||
</span></span><span id="60" class="l"><a class="l" href="#60"> 60: </a><span class="php-comment"> * Constructor.
|
||||
</span></span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment"> *
|
||||
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * @param int $userId Your MaxMind user ID
|
||||
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> * @param string $licenseKey Your MaxMind license key
|
||||
</span></span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-comment"> * @param array $languages List of language codes to use in name property
|
||||
</span></span><span id="65" class="l"><a class="l" href="#65"> 65: </a><span class="php-comment"> * from most preferred to least preferred.
|
||||
</span></span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment"> * @param string $host Optional host parameter
|
||||
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * @param object $guzzleClient Optional Guzzle client to use (to facilitate
|
||||
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> * unit testing).
|
||||
</span></span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-comment"> */</span>
|
||||
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>(
|
||||
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a> <span class="php-var">$userId</span>,
|
||||
</span><span id="72" class="l"><a class="l" href="#72"> 72: </a> <span class="php-var">$licenseKey</span>,
|
||||
</span><span id="73" class="l"><a class="l" href="#73"> 73: </a> <span class="php-var">$languages</span> = <span class="php-keyword1">array</span>(<span class="php-quote">'en'</span>),
|
||||
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a> <span class="php-var">$host</span> = <span class="php-quote">'geoip.maxmind.com'</span>,
|
||||
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a> <span class="php-var">$guzzleClient</span> = <span class="php-keyword1">null</span>
|
||||
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a> ) {
|
||||
</span><span id="77" class="l"><a class="l" href="#77"> 77: </a> <span class="php-var">$this</span>->userId = <span class="php-var">$userId</span>;
|
||||
</span><span id="78" class="l"><a class="l" href="#78"> 78: </a> <span class="php-var">$this</span>->licenseKey = <span class="php-var">$licenseKey</span>;
|
||||
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a> <span class="php-var">$this</span>->languages = <span class="php-var">$languages</span>;
|
||||
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a> <span class="php-var">$this</span>->host = <span class="php-var">$host</span>;
|
||||
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a> <span class="php-comment">// To enable unit testing</span>
|
||||
</span><span id="82" class="l"><a class="l" href="#82"> 82: </a> <span class="php-var">$this</span>->guzzleClient = <span class="php-var">$guzzleClient</span>;
|
||||
</span><span id="83" class="l"><a class="l" href="#83"> 83: </a> }
|
||||
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a>
|
||||
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a> <span class="php-comment">/**
|
||||
</span></span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment"> * This method calls the GeoIP2 City endpoint.
|
||||
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> *
|
||||
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> * @param string $ipAddress IPv4 or IPv6 address as a string. If no
|
||||
</span></span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-comment"> * address is provided, the address that the web service is called
|
||||
</span></span><span id="90" class="l"><a class="l" href="#90"> 90: </a><span class="php-comment"> * from will be used.
|
||||
</span></span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment"> *
|
||||
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * @return \GeoIp2\Model\City
|
||||
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> *
|
||||
</span></span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-comment"> * @throws \GeoIp2\Exception\AddressNotFoundException if the address you
|
||||
</span></span><span id="95" class="l"><a class="l" href="#95"> 95: </a><span class="php-comment"> * provided is not in our database (e.g., a private address).
|
||||
</span></span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment"> * @throws \GeoIp2\Exception\AuthenticationException if there is a problem
|
||||
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * with the user ID or license key that you provided.
|
||||
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> * @throws \GeoIp2\Exception\QutOfQueriesException if your account is out
|
||||
</span></span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-comment"> * of queries.
|
||||
</span></span><span id="100" class="l"><a class="l" href="#100">100: </a><span class="php-comment"> * @throws \GeoIp2\Exception\InvalidRequestException} if your request was
|
||||
</span></span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment"> * received by the web service but is invalid for some other reason.
|
||||
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * This may indicate an issue with this API. Please report the error to
|
||||
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> * MaxMind.
|
||||
</span></span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-comment"> * @throws \GeoIp2\Exception\HttpException if an unexpected HTTP error
|
||||
</span></span><span id="105" class="l"><a class="l" href="#105">105: </a><span class="php-comment"> * code or message was returned. This could indicate a problem with the
|
||||
</span></span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment"> * connection between your server and the web service or that the web
|
||||
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * service returned an invalid document or 500 error code.
|
||||
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> * @throws \GeoIp2\Exception\GeoIp2Exception This serves as the parent
|
||||
</span></span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-comment"> * class to the above exceptions. It will be thrown directly if a 200
|
||||
</span></span><span id="110" class="l"><a class="l" href="#110">110: </a><span class="php-comment"> * status code is returned but the body is invalid.
|
||||
</span></span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment"> */</span>
|
||||
</span><span id="112" class="l"><a class="l" href="#112">112: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_city" href="#_city">city</a>(<span class="php-var">$ipAddress</span> = <span class="php-quote">'me'</span>)
|
||||
</span><span id="113" class="l"><a class="l" href="#113">113: </a> {
|
||||
</span><span id="114" class="l"><a class="l" href="#114">114: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->responseFor(<span class="php-quote">'city'</span>, <span class="php-quote">'City'</span>, <span class="php-var">$ipAddress</span>);
|
||||
</span><span id="115" class="l"><a class="l" href="#115">115: </a> }
|
||||
</span><span id="116" class="l"><a class="l" href="#116">116: </a>
|
||||
</span><span id="117" class="l"><a class="l" href="#117">117: </a> <span class="php-comment">/**
|
||||
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> * This method calls the GeoIP2 Country endpoint.
|
||||
</span></span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-comment"> *
|
||||
</span></span><span id="120" class="l"><a class="l" href="#120">120: </a><span class="php-comment"> * @param string $ipAddress IPv4 or IPv6 address as a string. If no
|
||||
</span></span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment"> * address is provided, the address that the web service is called
|
||||
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * from will be used.
|
||||
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> *
|
||||
</span></span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-comment"> * @return \GeoIp2\Model\Country
|
||||
</span></span><span id="125" class="l"><a class="l" href="#125">125: </a><span class="php-comment"> *
|
||||
</span></span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment"> * @throws \GeoIp2\Exception\AddressNotFoundException if the address you
|
||||
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * provided is not in our database (e.g., a private address).
|
||||
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> * @throws \GeoIp2\Exception\AuthenticationException if there is a problem
|
||||
</span></span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-comment"> * with the user ID or license key that you provided.
|
||||
</span></span><span id="130" class="l"><a class="l" href="#130">130: </a><span class="php-comment"> * @throws \GeoIp2\Exception\QutOfQueriesException if your account is out
|
||||
</span></span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment"> * of queries.
|
||||
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * @throws \GeoIp2\Exception\InvalidRequestException} if your request was
|
||||
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> * received by the web service but is invalid for some other reason.
|
||||
</span></span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-comment"> * This may indicate an issue with this API. Please report the error to
|
||||
</span></span><span id="135" class="l"><a class="l" href="#135">135: </a><span class="php-comment"> * MaxMind.
|
||||
</span></span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment"> * @throws \GeoIp2\Exception\HttpException if an unexpected HTTP error
|
||||
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * code or message was returned. This could indicate a problem with the
|
||||
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> * connection between your server and the web service or that the web
|
||||
</span></span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-comment"> * service returned an invalid document or 500 error code.
|
||||
</span></span><span id="140" class="l"><a class="l" href="#140">140: </a><span class="php-comment"> * @throws \GeoIp2\Exception\GeoIp2Exception This serves as the parent
|
||||
</span></span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment"> * class to the above exceptions. It will be thrown directly if a 200
|
||||
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * status code is returned but the body is invalid.
|
||||
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> */</span>
|
||||
</span><span id="144" class="l"><a class="l" href="#144">144: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_country" href="#_country">country</a>(<span class="php-var">$ipAddress</span> = <span class="php-quote">'me'</span>)
|
||||
</span><span id="145" class="l"><a class="l" href="#145">145: </a> {
|
||||
</span><span id="146" class="l"><a class="l" href="#146">146: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->responseFor(<span class="php-quote">'country'</span>, <span class="php-quote">'Country'</span>, <span class="php-var">$ipAddress</span>);
|
||||
</span><span id="147" class="l"><a class="l" href="#147">147: </a> }
|
||||
</span><span id="148" class="l"><a class="l" href="#148">148: </a>
|
||||
</span><span id="149" class="l"><a class="l" href="#149">149: </a> <span class="php-comment">/**
|
||||
</span></span><span id="150" class="l"><a class="l" href="#150">150: </a><span class="php-comment"> * This method calls the GeoIP2 City/ISP/Org endpoint.
|
||||
</span></span><span id="151" class="l"><a class="l" href="#151">151: </a><span class="php-comment"> *
|
||||
</span></span><span id="152" class="l"><a class="l" href="#152">152: </a><span class="php-comment"> * @param string $ipAddress IPv4 or IPv6 address as a string. If no
|
||||
</span></span><span id="153" class="l"><a class="l" href="#153">153: </a><span class="php-comment"> * address is provided, the address that the web service is called
|
||||
</span></span><span id="154" class="l"><a class="l" href="#154">154: </a><span class="php-comment"> * from will be used.
|
||||
</span></span><span id="155" class="l"><a class="l" href="#155">155: </a><span class="php-comment"> *
|
||||
</span></span><span id="156" class="l"><a class="l" href="#156">156: </a><span class="php-comment"> * @return \GeoIp2\Model\CityIspOrg
|
||||
</span></span><span id="157" class="l"><a class="l" href="#157">157: </a><span class="php-comment"> *
|
||||
</span></span><span id="158" class="l"><a class="l" href="#158">158: </a><span class="php-comment"> * @throws \GeoIp2\Exception\AddressNotFoundException if the address you
|
||||
</span></span><span id="159" class="l"><a class="l" href="#159">159: </a><span class="php-comment"> * provided is not in our database (e.g., a private address).
|
||||
</span></span><span id="160" class="l"><a class="l" href="#160">160: </a><span class="php-comment"> * @throws \GeoIp2\Exception\AuthenticationException if there is a problem
|
||||
</span></span><span id="161" class="l"><a class="l" href="#161">161: </a><span class="php-comment"> * with the user ID or license key that you provided.
|
||||
</span></span><span id="162" class="l"><a class="l" href="#162">162: </a><span class="php-comment"> * @throws \GeoIp2\Exception\QutOfQueriesException if your account is out
|
||||
</span></span><span id="163" class="l"><a class="l" href="#163">163: </a><span class="php-comment"> * of queries.
|
||||
</span></span><span id="164" class="l"><a class="l" href="#164">164: </a><span class="php-comment"> * @throws \GeoIp2\Exception\InvalidRequestException} if your request was
|
||||
</span></span><span id="165" class="l"><a class="l" href="#165">165: </a><span class="php-comment"> * received by the web service but is invalid for some other reason.
|
||||
</span></span><span id="166" class="l"><a class="l" href="#166">166: </a><span class="php-comment"> * This may indicate an issue with this API. Please report the error to
|
||||
</span></span><span id="167" class="l"><a class="l" href="#167">167: </a><span class="php-comment"> * MaxMind.
|
||||
</span></span><span id="168" class="l"><a class="l" href="#168">168: </a><span class="php-comment"> * @throws \GeoIp2\Exception\HttpException if an unexpected HTTP error
|
||||
</span></span><span id="169" class="l"><a class="l" href="#169">169: </a><span class="php-comment"> * code or message was returned. This could indicate a problem with the
|
||||
</span></span><span id="170" class="l"><a class="l" href="#170">170: </a><span class="php-comment"> * connection between your server and the web service or that the web
|
||||
</span></span><span id="171" class="l"><a class="l" href="#171">171: </a><span class="php-comment"> * service returned an invalid document or 500 error code.
|
||||
</span></span><span id="172" class="l"><a class="l" href="#172">172: </a><span class="php-comment"> * @throws \GeoIp2\Exception\GeoIp2Exception This serves as the parent
|
||||
</span></span><span id="173" class="l"><a class="l" href="#173">173: </a><span class="php-comment"> * class to the above exceptions. It will be thrown directly if a 200
|
||||
</span></span><span id="174" class="l"><a class="l" href="#174">174: </a><span class="php-comment"> * status code is returned but the body is invalid.
|
||||
</span></span><span id="175" class="l"><a class="l" href="#175">175: </a><span class="php-comment"> */</span>
|
||||
</span><span id="176" class="l"><a class="l" href="#176">176: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_cityIspOrg" href="#_cityIspOrg">cityIspOrg</a>(<span class="php-var">$ipAddress</span> = <span class="php-quote">'me'</span>)
|
||||
</span><span id="177" class="l"><a class="l" href="#177">177: </a> {
|
||||
</span><span id="178" class="l"><a class="l" href="#178">178: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->responseFor(<span class="php-quote">'city_isp_org'</span>, <span class="php-quote">'CityIspOrg'</span>, <span class="php-var">$ipAddress</span>);
|
||||
</span><span id="179" class="l"><a class="l" href="#179">179: </a> }
|
||||
</span><span id="180" class="l"><a class="l" href="#180">180: </a>
|
||||
</span><span id="181" class="l"><a class="l" href="#181">181: </a> <span class="php-comment">/**
|
||||
</span></span><span id="182" class="l"><a class="l" href="#182">182: </a><span class="php-comment"> * This method calls the GeoIP2 Omni endpoint.
|
||||
</span></span><span id="183" class="l"><a class="l" href="#183">183: </a><span class="php-comment"> *
|
||||
</span></span><span id="184" class="l"><a class="l" href="#184">184: </a><span class="php-comment"> * @param string $ipAddress IPv4 or IPv6 address as a string. If no
|
||||
</span></span><span id="185" class="l"><a class="l" href="#185">185: </a><span class="php-comment"> * address is provided, the address that the web service is called
|
||||
</span></span><span id="186" class="l"><a class="l" href="#186">186: </a><span class="php-comment"> * from will be used.
|
||||
</span></span><span id="187" class="l"><a class="l" href="#187">187: </a><span class="php-comment"> *
|
||||
</span></span><span id="188" class="l"><a class="l" href="#188">188: </a><span class="php-comment"> * @return \GeoIp2\Model\Omni
|
||||
</span></span><span id="189" class="l"><a class="l" href="#189">189: </a><span class="php-comment"> *
|
||||
</span></span><span id="190" class="l"><a class="l" href="#190">190: </a><span class="php-comment"> * @throws \GeoIp2\Exception\AddressNotFoundException if the address you
|
||||
</span></span><span id="191" class="l"><a class="l" href="#191">191: </a><span class="php-comment"> * provided is not in our database (e.g., a private address).
|
||||
</span></span><span id="192" class="l"><a class="l" href="#192">192: </a><span class="php-comment"> * @throws \GeoIp2\Exception\AuthenticationException if there is a problem
|
||||
</span></span><span id="193" class="l"><a class="l" href="#193">193: </a><span class="php-comment"> * with the user ID or license key that you provided.
|
||||
</span></span><span id="194" class="l"><a class="l" href="#194">194: </a><span class="php-comment"> * @throws \GeoIp2\Exception\QutOfQueriesException if your account is out
|
||||
</span></span><span id="195" class="l"><a class="l" href="#195">195: </a><span class="php-comment"> * of queries.
|
||||
</span></span><span id="196" class="l"><a class="l" href="#196">196: </a><span class="php-comment"> * @throws \GeoIp2\Exception\InvalidRequestException} if your request was
|
||||
</span></span><span id="197" class="l"><a class="l" href="#197">197: </a><span class="php-comment"> * received by the web service but is invalid for some other reason.
|
||||
</span></span><span id="198" class="l"><a class="l" href="#198">198: </a><span class="php-comment"> * This may indicate an issue with this API. Please report the error to
|
||||
</span></span><span id="199" class="l"><a class="l" href="#199">199: </a><span class="php-comment"> * MaxMind.
|
||||
</span></span><span id="200" class="l"><a class="l" href="#200">200: </a><span class="php-comment"> * @throws \GeoIp2\Exception\HttpException if an unexpected HTTP error
|
||||
</span></span><span id="201" class="l"><a class="l" href="#201">201: </a><span class="php-comment"> * code or message was returned. This could indicate a problem with the
|
||||
</span></span><span id="202" class="l"><a class="l" href="#202">202: </a><span class="php-comment"> * connection between your server and the web service or that the web
|
||||
</span></span><span id="203" class="l"><a class="l" href="#203">203: </a><span class="php-comment"> * service returned an invalid document or 500 error code.
|
||||
</span></span><span id="204" class="l"><a class="l" href="#204">204: </a><span class="php-comment"> * @throws \GeoIp2\Exception\GeoIp2Exception This serves as the parent
|
||||
</span></span><span id="205" class="l"><a class="l" href="#205">205: </a><span class="php-comment"> * class to the above exceptions. It will be thrown directly if a 200
|
||||
</span></span><span id="206" class="l"><a class="l" href="#206">206: </a><span class="php-comment"> * status code is returned but the body is invalid.
|
||||
</span></span><span id="207" class="l"><a class="l" href="#207">207: </a><span class="php-comment"> */</span>
|
||||
</span><span id="208" class="l"><a class="l" href="#208">208: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_omni" href="#_omni">omni</a>(<span class="php-var">$ipAddress</span> = <span class="php-quote">'me'</span>)
|
||||
</span><span id="209" class="l"><a class="l" href="#209">209: </a> {
|
||||
</span><span id="210" class="l"><a class="l" href="#210">210: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->responseFor(<span class="php-quote">'omni'</span>, <span class="php-quote">'Omni'</span>, <span class="php-var">$ipAddress</span>);
|
||||
</span><span id="211" class="l"><a class="l" href="#211">211: </a> }
|
||||
</span><span id="212" class="l"><a class="l" href="#212">212: </a>
|
||||
</span><span id="213" class="l"><a class="l" href="#213">213: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> <a id="_responseFor" href="#_responseFor">responseFor</a>(<span class="php-var">$endpoint</span>, <span class="php-var">$class</span>, <span class="php-var">$ipAddress</span>)
|
||||
</span><span id="214" class="l"><a class="l" href="#214">214: </a> {
|
||||
</span><span id="215" class="l"><a class="l" href="#215">215: </a> <span class="php-var">$uri</span> = <span class="php-keyword2">implode</span>(<span class="php-quote">'/'</span>, <span class="php-keyword1">array</span>(<span class="php-var">$this</span>->baseUri(), <span class="php-var">$endpoint</span>, <span class="php-var">$ipAddress</span>));
|
||||
</span><span id="216" class="l"><a class="l" href="#216">216: </a>
|
||||
</span><span id="217" class="l"><a class="l" href="#217">217: </a> <span class="php-var">$client</span> = <span class="php-var">$this</span>->guzzleClient ?
|
||||
</span><span id="218" class="l"><a class="l" href="#218">218: </a> <span class="php-var">$this</span>->guzzleClient : <span class="php-keyword1">new</span> GuzzleClient();
|
||||
</span><span id="219" class="l"><a class="l" href="#219">219: </a> <span class="php-var">$request</span> = <span class="php-var">$client</span>->get(<span class="php-var">$uri</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'Accept'</span> => <span class="php-quote">'application/json'</span>));
|
||||
</span><span id="220" class="l"><a class="l" href="#220">220: </a> <span class="php-var">$request</span>->setAuth(<span class="php-var">$this</span>->userId, <span class="php-var">$this</span>->licenseKey);
|
||||
</span><span id="221" class="l"><a class="l" href="#221">221: </a> <span class="php-var">$this</span>->setUserAgent(<span class="php-var">$request</span>);
|
||||
</span><span id="222" class="l"><a class="l" href="#222">222: </a>
|
||||
</span><span id="223" class="l"><a class="l" href="#223">223: </a> <span class="php-keyword1">try</span> {
|
||||
</span><span id="224" class="l"><a class="l" href="#224">224: </a> <span class="php-var">$response</span> = <span class="php-var">$request</span>->send();
|
||||
</span><span id="225" class="l"><a class="l" href="#225">225: </a> } <span class="php-keyword1">catch</span> (ClientErrorResponseException <span class="php-var">$e</span>) {
|
||||
</span><span id="226" class="l"><a class="l" href="#226">226: </a> <span class="php-var">$this</span>->handle4xx(<span class="php-var">$e</span>->getResponse(), <span class="php-var">$uri</span>);
|
||||
</span><span id="227" class="l"><a class="l" href="#227">227: </a> } <span class="php-keyword1">catch</span> (ServerErrorResponseException <span class="php-var">$e</span>) {
|
||||
</span><span id="228" class="l"><a class="l" href="#228">228: </a> <span class="php-var">$this</span>->handle5xx(<span class="php-var">$e</span>->getResponse(), <span class="php-var">$uri</span>);
|
||||
</span><span id="229" class="l"><a class="l" href="#229">229: </a> }
|
||||
</span><span id="230" class="l"><a class="l" href="#230">230: </a>
|
||||
</span><span id="231" class="l"><a class="l" href="#231">231: </a> <span class="php-keyword1">if</span> (<span class="php-var">$response</span> && <span class="php-var">$response</span>->isSuccessful()) {
|
||||
</span><span id="232" class="l"><a class="l" href="#232">232: </a> <span class="php-var">$body</span> = <span class="php-var">$this</span>->handleSuccess(<span class="php-var">$response</span>, <span class="php-var">$uri</span>);
|
||||
</span><span id="233" class="l"><a class="l" href="#233">233: </a> <span class="php-var">$class</span> = <span class="php-quote">"GeoIp2\\Model\\"</span> . <span class="php-var">$class</span>;
|
||||
</span><span id="234" class="l"><a class="l" href="#234">234: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">new</span> <span class="php-var">$class</span>(<span class="php-var">$body</span>, <span class="php-var">$this</span>->languages);
|
||||
</span><span id="235" class="l"><a class="l" href="#235">235: </a> } <span class="php-keyword1">else</span> {
|
||||
</span><span id="236" class="l"><a class="l" href="#236">236: </a> <span class="php-var">$this</span>->handleNon200(<span class="php-var">$response</span>, <span class="php-var">$uri</span>);
|
||||
</span><span id="237" class="l"><a class="l" href="#237">237: </a> }
|
||||
</span><span id="238" class="l"><a class="l" href="#238">238: </a> }
|
||||
</span><span id="239" class="l"><a class="l" href="#239">239: </a>
|
||||
</span><span id="240" class="l"><a class="l" href="#240">240: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> <a id="_handleSuccess" href="#_handleSuccess">handleSuccess</a>(<span class="php-var">$response</span>, <span class="php-var">$uri</span>)
|
||||
</span><span id="241" class="l"><a class="l" href="#241">241: </a> {
|
||||
</span><span id="242" class="l"><a class="l" href="#242">242: </a> <span class="php-keyword1">if</span> (<span class="php-var">$response</span>->getContentLength() == <span class="php-num">0</span>) {
|
||||
</span><span id="243" class="l"><a class="l" href="#243">243: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> GeoIp2Exception(
|
||||
</span><span id="244" class="l"><a class="l" href="#244">244: </a> <span class="php-quote">"Received a 200 response for </span><span class="php-var">$uri</span><span class="php-quote"> but did not "</span> .
|
||||
</span><span id="245" class="l"><a class="l" href="#245">245: </a> <span class="php-quote">"receive a HTTP body."</span>
|
||||
</span><span id="246" class="l"><a class="l" href="#246">246: </a> );
|
||||
</span><span id="247" class="l"><a class="l" href="#247">247: </a> }
|
||||
</span><span id="248" class="l"><a class="l" href="#248">248: </a>
|
||||
</span><span id="249" class="l"><a class="l" href="#249">249: </a> <span class="php-keyword1">try</span> {
|
||||
</span><span id="250" class="l"><a class="l" href="#250">250: </a> <span class="php-keyword1">return</span> <span class="php-var">$response</span>->json();
|
||||
</span><span id="251" class="l"><a class="l" href="#251">251: </a> } <span class="php-keyword1">catch</span> (RuntimeException <span class="php-var">$e</span>) {
|
||||
</span><span id="252" class="l"><a class="l" href="#252">252: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> GeoIp2Exception(
|
||||
</span><span id="253" class="l"><a class="l" href="#253">253: </a> <span class="php-quote">"Received a 200 response for </span><span class="php-var">$uri</span><span class="php-quote"> but could not decode "</span> .
|
||||
</span><span id="254" class="l"><a class="l" href="#254">254: </a> <span class="php-quote">"the response as JSON: "</span> . <span class="php-var">$e</span>->getMessage()
|
||||
</span><span id="255" class="l"><a class="l" href="#255">255: </a> );
|
||||
</span><span id="256" class="l"><a class="l" href="#256">256: </a>
|
||||
</span><span id="257" class="l"><a class="l" href="#257">257: </a> }
|
||||
</span><span id="258" class="l"><a class="l" href="#258">258: </a> }
|
||||
</span><span id="259" class="l"><a class="l" href="#259">259: </a>
|
||||
</span><span id="260" class="l"><a class="l" href="#260">260: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> <a id="_handle4xx" href="#_handle4xx">handle4xx</a>(<span class="php-var">$response</span>, <span class="php-var">$uri</span>)
|
||||
</span><span id="261" class="l"><a class="l" href="#261">261: </a> {
|
||||
</span><span id="262" class="l"><a class="l" href="#262">262: </a> <span class="php-var">$status</span> = <span class="php-var">$response</span>->getStatusCode();
|
||||
</span><span id="263" class="l"><a class="l" href="#263">263: </a>
|
||||
</span><span id="264" class="l"><a class="l" href="#264">264: </a> <span class="php-var">$body</span> = <span class="php-keyword1">array</span>();
|
||||
</span><span id="265" class="l"><a class="l" href="#265">265: </a>
|
||||
</span><span id="266" class="l"><a class="l" href="#266">266: </a> <span class="php-keyword1">if</span> (<span class="php-var">$response</span>->getContentLength() > <span class="php-num">0</span>) {
|
||||
</span><span id="267" class="l"><a class="l" href="#267">267: </a> <span class="php-keyword1">if</span> (<span class="php-keyword2">strstr</span>(<span class="php-var">$response</span>->getContentType(), <span class="php-quote">'json'</span>)) {
|
||||
</span><span id="268" class="l"><a class="l" href="#268">268: </a> <span class="php-keyword1">try</span> {
|
||||
</span><span id="269" class="l"><a class="l" href="#269">269: </a> <span class="php-var">$body</span> = <span class="php-var">$response</span>->json();
|
||||
</span><span id="270" class="l"><a class="l" href="#270">270: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword1">isset</span>(<span class="php-var">$body</span>[<span class="php-quote">'code'</span>]) || !<span class="php-keyword1">isset</span>(<span class="php-var">$body</span>[<span class="php-quote">'error'</span>])) {
|
||||
</span><span id="271" class="l"><a class="l" href="#271">271: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> GeoIp2Exception(
|
||||
</span><span id="272" class="l"><a class="l" href="#272">272: </a> <span class="php-quote">'Response contains JSON but it does not specify '</span> .
|
||||
</span><span id="273" class="l"><a class="l" href="#273">273: </a> <span class="php-quote">'code or error keys: '</span> . <span class="php-var">$response</span>->getBody()
|
||||
</span><span id="274" class="l"><a class="l" href="#274">274: </a> );
|
||||
</span><span id="275" class="l"><a class="l" href="#275">275: </a> }
|
||||
</span><span id="276" class="l"><a class="l" href="#276">276: </a> } <span class="php-keyword1">catch</span> (RuntimeException <span class="php-var">$e</span>) {
|
||||
</span><span id="277" class="l"><a class="l" href="#277">277: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> HttpException(
|
||||
</span><span id="278" class="l"><a class="l" href="#278">278: </a> <span class="php-quote">"Received a </span><span class="php-var">$status</span><span class="php-quote"> error for </span><span class="php-var">$uri</span><span class="php-quote"> but it did not "</span> .
|
||||
</span><span id="279" class="l"><a class="l" href="#279">279: </a> <span class="php-quote">"include the expected JSON body: "</span> .
|
||||
</span><span id="280" class="l"><a class="l" href="#280">280: </a> <span class="php-var">$e</span>->getMessage(),
|
||||
</span><span id="281" class="l"><a class="l" href="#281">281: </a> <span class="php-var">$status</span>,
|
||||
</span><span id="282" class="l"><a class="l" href="#282">282: </a> <span class="php-var">$uri</span>
|
||||
</span><span id="283" class="l"><a class="l" href="#283">283: </a> );
|
||||
</span><span id="284" class="l"><a class="l" href="#284">284: </a> }
|
||||
</span><span id="285" class="l"><a class="l" href="#285">285: </a> } <span class="php-keyword1">else</span> {
|
||||
</span><span id="286" class="l"><a class="l" href="#286">286: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> HttpException(
|
||||
</span><span id="287" class="l"><a class="l" href="#287">287: </a> <span class="php-quote">"Received a </span><span class="php-var">$status</span><span class="php-quote"> error for </span><span class="php-var">$uri</span><span class="php-quote"> with the "</span> .
|
||||
</span><span id="288" class="l"><a class="l" href="#288">288: </a> <span class="php-quote">"following body: "</span> . <span class="php-var">$response</span>->getBody(),
|
||||
</span><span id="289" class="l"><a class="l" href="#289">289: </a> <span class="php-var">$status</span>,
|
||||
</span><span id="290" class="l"><a class="l" href="#290">290: </a> <span class="php-var">$uri</span>
|
||||
</span><span id="291" class="l"><a class="l" href="#291">291: </a> );
|
||||
</span><span id="292" class="l"><a class="l" href="#292">292: </a> }
|
||||
</span><span id="293" class="l"><a class="l" href="#293">293: </a> } <span class="php-keyword1">else</span> {
|
||||
</span><span id="294" class="l"><a class="l" href="#294">294: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> HttpException(
|
||||
</span><span id="295" class="l"><a class="l" href="#295">295: </a> <span class="php-quote">"Received a </span><span class="php-var">$status</span><span class="php-quote"> error for </span><span class="php-var">$uri</span><span class="php-quote"> with no body"</span>,
|
||||
</span><span id="296" class="l"><a class="l" href="#296">296: </a> <span class="php-var">$status</span>,
|
||||
</span><span id="297" class="l"><a class="l" href="#297">297: </a> <span class="php-var">$uri</span>
|
||||
</span><span id="298" class="l"><a class="l" href="#298">298: </a> );
|
||||
</span><span id="299" class="l"><a class="l" href="#299">299: </a> }
|
||||
</span><span id="300" class="l"><a class="l" href="#300">300: </a> <span class="php-var">$this</span>->handleWebServiceError(
|
||||
</span><span id="301" class="l"><a class="l" href="#301">301: </a> <span class="php-var">$body</span>[<span class="php-quote">'error'</span>],
|
||||
</span><span id="302" class="l"><a class="l" href="#302">302: </a> <span class="php-var">$body</span>[<span class="php-quote">'code'</span>],
|
||||
</span><span id="303" class="l"><a class="l" href="#303">303: </a> <span class="php-var">$status</span>,
|
||||
</span><span id="304" class="l"><a class="l" href="#304">304: </a> <span class="php-var">$uri</span>
|
||||
</span><span id="305" class="l"><a class="l" href="#305">305: </a> );
|
||||
</span><span id="306" class="l"><a class="l" href="#306">306: </a> }
|
||||
</span><span id="307" class="l"><a class="l" href="#307">307: </a>
|
||||
</span><span id="308" class="l"><a class="l" href="#308">308: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> <a id="_handleWebServiceError" href="#_handleWebServiceError">handleWebServiceError</a>(<span class="php-var">$message</span>, <span class="php-var">$code</span>, <span class="php-var">$status</span>, <span class="php-var">$uri</span>)
|
||||
</span><span id="309" class="l"><a class="l" href="#309">309: </a> {
|
||||
</span><span id="310" class="l"><a class="l" href="#310">310: </a> <span class="php-keyword1">switch</span> (<span class="php-var">$code</span>) {
|
||||
</span><span id="311" class="l"><a class="l" href="#311">311: </a> <span class="php-keyword1">case</span> <span class="php-quote">'IP_ADDRESS_NOT_FOUND'</span>:
|
||||
</span><span id="312" class="l"><a class="l" href="#312">312: </a> <span class="php-keyword1">case</span> <span class="php-quote">'IP_ADDRESS_RESERVED'</span>:
|
||||
</span><span id="313" class="l"><a class="l" href="#313">313: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> AddressNotFoundException(<span class="php-var">$message</span>);
|
||||
</span><span id="314" class="l"><a class="l" href="#314">314: </a> <span class="php-keyword1">case</span> <span class="php-quote">'AUTHORIZATION_INVALID'</span>:
|
||||
</span><span id="315" class="l"><a class="l" href="#315">315: </a> <span class="php-keyword1">case</span> <span class="php-quote">'LICENSE_KEY_REQUIRED'</span>:
|
||||
</span><span id="316" class="l"><a class="l" href="#316">316: </a> <span class="php-keyword1">case</span> <span class="php-quote">'USER_ID_REQUIRED'</span>:
|
||||
</span><span id="317" class="l"><a class="l" href="#317">317: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> AuthenticationException(<span class="php-var">$message</span>);
|
||||
</span><span id="318" class="l"><a class="l" href="#318">318: </a> <span class="php-keyword1">case</span> <span class="php-quote">'OUT_OF_QUERIES'</span>:
|
||||
</span><span id="319" class="l"><a class="l" href="#319">319: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> OutOfQueriesException(<span class="php-var">$message</span>);
|
||||
</span><span id="320" class="l"><a class="l" href="#320">320: </a> <span class="php-keyword1">default</span>:
|
||||
</span><span id="321" class="l"><a class="l" href="#321">321: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> InvalidRequestException(
|
||||
</span><span id="322" class="l"><a class="l" href="#322">322: </a> <span class="php-var">$message</span>,
|
||||
</span><span id="323" class="l"><a class="l" href="#323">323: </a> <span class="php-var">$code</span>,
|
||||
</span><span id="324" class="l"><a class="l" href="#324">324: </a> <span class="php-var">$status</span>,
|
||||
</span><span id="325" class="l"><a class="l" href="#325">325: </a> <span class="php-var">$uri</span>
|
||||
</span><span id="326" class="l"><a class="l" href="#326">326: </a> );
|
||||
</span><span id="327" class="l"><a class="l" href="#327">327: </a> }
|
||||
</span><span id="328" class="l"><a class="l" href="#328">328: </a> }
|
||||
</span><span id="329" class="l"><a class="l" href="#329">329: </a>
|
||||
</span><span id="330" class="l"><a class="l" href="#330">330: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> <a id="_handle5xx" href="#_handle5xx">handle5xx</a>(<span class="php-var">$response</span>, <span class="php-var">$uri</span>)
|
||||
</span><span id="331" class="l"><a class="l" href="#331">331: </a> {
|
||||
</span><span id="332" class="l"><a class="l" href="#332">332: </a> <span class="php-var">$status</span> = <span class="php-var">$response</span>->getStatusCode();
|
||||
</span><span id="333" class="l"><a class="l" href="#333">333: </a>
|
||||
</span><span id="334" class="l"><a class="l" href="#334">334: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> HttpException(
|
||||
</span><span id="335" class="l"><a class="l" href="#335">335: </a> <span class="php-quote">"Received a server error (</span><span class="php-var">$status</span><span class="php-quote">) for </span><span class="php-var">$uri</span><span class="php-quote">"</span>,
|
||||
</span><span id="336" class="l"><a class="l" href="#336">336: </a> <span class="php-var">$status</span>,
|
||||
</span><span id="337" class="l"><a class="l" href="#337">337: </a> <span class="php-var">$uri</span>
|
||||
</span><span id="338" class="l"><a class="l" href="#338">338: </a> );
|
||||
</span><span id="339" class="l"><a class="l" href="#339">339: </a> }
|
||||
</span><span id="340" class="l"><a class="l" href="#340">340: </a>
|
||||
</span><span id="341" class="l"><a class="l" href="#341">341: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> <a id="_handleNon200" href="#_handleNon200">handleNon200</a>(<span class="php-var">$response</span>, <span class="php-var">$uri</span>)
|
||||
</span><span id="342" class="l"><a class="l" href="#342">342: </a> {
|
||||
</span><span id="343" class="l"><a class="l" href="#343">343: </a> <span class="php-var">$status</span> = <span class="php-var">$response</span>->getStatusCode();
|
||||
</span><span id="344" class="l"><a class="l" href="#344">344: </a>
|
||||
</span><span id="345" class="l"><a class="l" href="#345">345: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> HttpException(
|
||||
</span><span id="346" class="l"><a class="l" href="#346">346: </a> <span class="php-quote">"Received a very surprising HTTP status "</span> .
|
||||
</span><span id="347" class="l"><a class="l" href="#347">347: </a> <span class="php-quote">"(</span><span class="php-var">$status</span><span class="php-quote">) for </span><span class="php-var">$uri</span><span class="php-quote">"</span>,
|
||||
</span><span id="348" class="l"><a class="l" href="#348">348: </a> <span class="php-var">$status</span>,
|
||||
</span><span id="349" class="l"><a class="l" href="#349">349: </a> <span class="php-var">$uri</span>
|
||||
</span><span id="350" class="l"><a class="l" href="#350">350: </a> );
|
||||
</span><span id="351" class="l"><a class="l" href="#351">351: </a> }
|
||||
</span><span id="352" class="l"><a class="l" href="#352">352: </a>
|
||||
</span><span id="353" class="l"><a class="l" href="#353">353: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> <a id="_setUserAgent" href="#_setUserAgent">setUserAgent</a>(<span class="php-var">$request</span>)
|
||||
</span><span id="354" class="l"><a class="l" href="#354">354: </a> {
|
||||
</span><span id="355" class="l"><a class="l" href="#355">355: </a> <span class="php-var">$userAgent</span> = <span class="php-var">$request</span>->getHeader(<span class="php-quote">'User-Agent'</span>);
|
||||
</span><span id="356" class="l"><a class="l" href="#356">356: </a> <span class="php-var">$userAgent</span> = <span class="php-quote">"GeoIP2 PHP API (</span><span class="php-var">$userAgent</span><span class="php-quote">)"</span>;
|
||||
</span><span id="357" class="l"><a class="l" href="#357">357: </a> <span class="php-var">$request</span>->setHeader(<span class="php-quote">'User-Agent'</span>, <span class="php-var">$userAgent</span>);
|
||||
</span><span id="358" class="l"><a class="l" href="#358">358: </a> }
|
||||
</span><span id="359" class="l"><a class="l" href="#359">359: </a>
|
||||
</span><span id="360" class="l"><a class="l" href="#360">360: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> <a id="_baseUri" href="#_baseUri">baseUri</a>()
|
||||
</span><span id="361" class="l"><a class="l" href="#361">361: </a> {
|
||||
</span><span id="362" class="l"><a class="l" href="#362">362: </a> <span class="php-keyword1">return</span> <span class="php-quote">'https://'</span> . <span class="php-var">$this</span>->host . <span class="php-quote">'/geoip/v2.0'</span>;
|
||||
</span><span id="363" class="l"><a class="l" href="#363">363: </a> }
|
||||
</span><span id="364" class="l"><a class="l" href="#364">364: </a>}
|
||||
</span><span id="365" class="l"><a class="l" href="#365">365: </a></span></code></pre>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
311
doc/v0.4.0/tree.html
Normal file
311
doc/v0.4.0/tree.html
Normal file
|
|
@ -0,0 +1,311 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
|
||||
<title>Tree | GeoIP2 PHP API v0.4.0</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?394153670"></script>
|
||||
<script type="text/javascript" src="elementlist.js?2763436952"></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><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><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.Database.Reader.html">GeoIp2\Database\Reader</a></li>
|
||||
<li><a href="class-GeoIp2.Model.City.html">GeoIp2\Model\City</a></li>
|
||||
<li><a href="class-GeoIp2.Model.CityIspOrg.html">GeoIp2\Model\CityIspOrg</a></li>
|
||||
<li><a href="class-GeoIp2.Model.Country.html">GeoIp2\Model\Country</a></li>
|
||||
<li><a href="class-GeoIp2.Model.Omni.html">GeoIp2\Model\Omni</a></li>
|
||||
<li><a href="class-GeoIp2.Record.AbstractPlaceRecord.html">GeoIp2\Record\AbstractPlaceRecord</a></li>
|
||||
<li><a href="class-GeoIp2.Record.AbstractRecord.html">GeoIp2\Record\AbstractRecord</a></li>
|
||||
<li><a href="class-GeoIp2.Record.City.html">GeoIp2\Record\City</a></li>
|
||||
<li><a href="class-GeoIp2.Record.Continent.html">GeoIp2\Record\Continent</a></li>
|
||||
<li><a href="class-GeoIp2.Record.Country.html">GeoIp2\Record\Country</a></li>
|
||||
<li><a href="class-GeoIp2.Record.Location.html">GeoIp2\Record\Location</a></li>
|
||||
<li><a href="class-GeoIp2.Record.MaxMind.html">GeoIp2\Record\MaxMind</a></li>
|
||||
<li><a href="class-GeoIp2.Record.Postal.html">GeoIp2\Record\Postal</a></li>
|
||||
<li><a href="class-GeoIp2.Record.RepresentedCountry.html">GeoIp2\Record\RepresentedCountry</a></li>
|
||||
<li><a href="class-GeoIp2.Record.Subdivision.html">GeoIp2\Record\Subdivision</a></li>
|
||||
<li><a href="class-GeoIp2.Record.Traits.html">GeoIp2\Record\Traits</a></li>
|
||||
<li><a href="class-GeoIp2.WebService.Client.html">GeoIp2\WebService\Client</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<h3>Exceptions</h3>
|
||||
<ul>
|
||||
<li><a href="class-Exception.html">Exception</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.AddressNotFoundException.html">GeoIp2\Exception\AddressNotFoundException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.AuthenticationException.html">GeoIp2\Exception\AuthenticationException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.GeoIp2Exception.html">GeoIp2\Exception\GeoIp2Exception</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.HttpException.html">GeoIp2\Exception\HttpException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.InvalidRequestException.html">GeoIp2\Exception\InvalidRequestException</a></li>
|
||||
<li><a href="class-GeoIp2.Exception.OutOfQueriesException.html">GeoIp2\Exception\OutOfQueriesException</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>
|
||||
<span>Namespace</span> </li>
|
||||
<li>
|
||||
<span>Class</span> </li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="active">
|
||||
<span>Tree</span> </li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="geoip2-php-api-v0-4-0-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
<h1>Tree</h1>
|
||||
|
||||
<h3>Classes</h3>
|
||||
<div class="tree">
|
||||
<ul>
|
||||
|
||||
<li><div class="notlast"><a href="class-GeoIp2.Database.Reader.html"><span>GeoIp2\Database\Reader</span></a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</li>
|
||||
|
||||
<li><div class="notlast"><a href="class-GeoIp2.Model.Country.html"><span>GeoIp2\Model\Country</span></a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<ul>
|
||||
|
||||
<li class="last"><div class="last"><a href="class-GeoIp2.Model.City.html"><span>GeoIp2\Model\City</span></a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<ul>
|
||||
|
||||
<li class="last"><div class="last"><a href="class-GeoIp2.Model.CityIspOrg.html"><span>GeoIp2\Model\CityIspOrg</span></a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<ul>
|
||||
|
||||
<li class="last"><div class="last"><a href="class-GeoIp2.Model.Omni.html"><span>GeoIp2\Model\Omni</span></a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</ul></li></ul></li></ul></li>
|
||||
|
||||
<li><div class="notlast"><a href="class-GeoIp2.Record.AbstractRecord.html"><span>GeoIp2\Record\AbstractRecord</span></a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<ul>
|
||||
|
||||
<li><div class="notlast"><a href="class-GeoIp2.Record.AbstractPlaceRecord.html"><span>GeoIp2\Record\AbstractPlaceRecord</span></a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<ul>
|
||||
|
||||
<li><div class="notlast"><a href="class-GeoIp2.Record.City.html"><span>GeoIp2\Record\City</span></a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</li>
|
||||
|
||||
<li><div class="notlast"><a href="class-GeoIp2.Record.Continent.html"><span>GeoIp2\Record\Continent</span></a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</li>
|
||||
|
||||
<li><div class="notlast"><a href="class-GeoIp2.Record.Country.html"><span>GeoIp2\Record\Country</span></a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<ul>
|
||||
|
||||
<li class="last"><div class="last"><a href="class-GeoIp2.Record.RepresentedCountry.html"><span>GeoIp2\Record\RepresentedCountry</span></a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</ul></li>
|
||||
|
||||
<li class="last"><div class="last"><a href="class-GeoIp2.Record.Subdivision.html"><span>GeoIp2\Record\Subdivision</span></a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</ul></li>
|
||||
|
||||
<li><div class="notlast"><a href="class-GeoIp2.Record.Location.html"><span>GeoIp2\Record\Location</span></a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</li>
|
||||
|
||||
<li><div class="notlast"><a href="class-GeoIp2.Record.MaxMind.html"><span>GeoIp2\Record\MaxMind</span></a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</li>
|
||||
|
||||
<li><div class="notlast"><a href="class-GeoIp2.Record.Postal.html"><span>GeoIp2\Record\Postal</span></a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="last"><div class="last"><a href="class-GeoIp2.Record.Traits.html"><span>GeoIp2\Record\Traits</span></a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</ul></li>
|
||||
|
||||
<li class="last"><div class="last"><a href="class-GeoIp2.WebService.Client.html"><span>GeoIp2\WebService\Client</span></a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<h3>Exceptions</h3>
|
||||
<div class="tree">
|
||||
<ul>
|
||||
|
||||
<li class="last"><div class="last"><a href="class-Exception.html"><span>Exception</span></a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<ul>
|
||||
|
||||
<li class="last"><div class="last"><a href="class-GeoIp2.Exception.GeoIp2Exception.html"><span>GeoIp2\Exception\GeoIp2Exception</span></a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<ul>
|
||||
|
||||
<li><div class="notlast"><a href="class-GeoIp2.Exception.AddressNotFoundException.html"><span>GeoIp2\Exception\AddressNotFoundException</span></a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</li>
|
||||
|
||||
<li><div class="notlast"><a href="class-GeoIp2.Exception.AuthenticationException.html"><span>GeoIp2\Exception\AuthenticationException</span></a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</li>
|
||||
|
||||
<li><div class="notlast"><a href="class-GeoIp2.Exception.HttpException.html"><span>GeoIp2\Exception\HttpException</span></a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<ul>
|
||||
|
||||
<li class="last"><div class="last"><a href="class-GeoIp2.Exception.InvalidRequestException.html"><span>GeoIp2\Exception\InvalidRequestException</span></a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</ul></li>
|
||||
|
||||
<li class="last"><div class="last"><a href="class-GeoIp2.Exception.OutOfQueriesException.html"><span>GeoIp2\Exception\OutOfQueriesException</span></a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</li>
|
||||
</ul></li></ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoIP2 PHP API v0.4.0 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
93
index.md
93
index.md
|
|
@ -2,7 +2,7 @@
|
|||
layout: default
|
||||
title: MaxMind GeoIP2 PHP API
|
||||
language: php
|
||||
version: v0.3.0
|
||||
version: v0.4.0
|
||||
---
|
||||
|
||||
# GeoIP2 PHP API #
|
||||
|
|
@ -20,27 +20,22 @@ To provide feedback or get support during the beta, please see the
|
|||
|
||||
## Description ##
|
||||
|
||||
Currently, this distribution provides an API for the [GeoIP2 web services]
|
||||
(http://dev.maxmind.com/geoip/geoip2/web-services).
|
||||
|
||||
In the future, this distribution will also provide the same API for the
|
||||
GeoIP2 downloadable databases. These databases have not yet been
|
||||
released as a downloadable product.
|
||||
|
||||
See ``GeoIp2\WebService\Client`` for details on the web service client
|
||||
API.
|
||||
This distribution provides an API for the [GeoIP2 web services]
|
||||
(http://dev.maxmind.com/geoip/geoip2/web-services) and the [GeoLite2
|
||||
databases](http://dev.maxmind.com/geoip/geoip2/geolite2/). The commercial
|
||||
GeoIP2 databases have not yet been released as a downloadable product.
|
||||
|
||||
## Installation ##
|
||||
|
||||
### Define Your Dependencies ###
|
||||
|
||||
We recommend installing this package with [Composer](http://getcomposer.org/).
|
||||
To do this, add ```geoip2/geoip2``` to your ```composer.json``` file.
|
||||
To do this, add `geoip2/geoip2` to your `composer.json` file.
|
||||
|
||||
```json
|
||||
{
|
||||
"require": {
|
||||
"geoip2/geoip2": "0.3.*"
|
||||
"geoip2/geoip2": "0.4.*"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
|
@ -67,11 +62,43 @@ You can autoload all dependencies by adding this to your code:
|
|||
```
|
||||
require 'vendor/autoload.php';
|
||||
```
|
||||
## Database Reader ##
|
||||
|
||||
## Usage ##
|
||||
### Usage ###
|
||||
|
||||
To use this API, you must create a new ``\GeoIp2\WebService\Client``
|
||||
object with your ``$userId`` and ``$licenseKey``, then you call the method
|
||||
To use this API, you must create a new `\GeoIp2\Database\Reader` object with
|
||||
the path to the database file as the first argument to the constructor. You
|
||||
may then call the method corresponding to the database you are using.
|
||||
|
||||
If the lookup succeeds, the method call will return a model class for the
|
||||
record in the database. This model in turn contains multiple container
|
||||
classes for the different parts of the data such as the city in which the
|
||||
IP address is located.
|
||||
|
||||
If the record is not found, a `\GeoIp2\Exception\AddressNotFoundException`
|
||||
is returned. If the database is invalid or corrupt, a
|
||||
`\MaxMind\Db\InvalidDatabaseException` will be thrown.
|
||||
|
||||
See the API documentation for more details.
|
||||
|
||||
### Example ###
|
||||
|
||||
```php
|
||||
<?php
|
||||
require_once 'vendor/autoload.php';
|
||||
use \GeoIp2\Database\Reader;
|
||||
|
||||
$reader = new Reader('/usr/local/share/GeoIP2/GeoIP2-City.mmdb');
|
||||
$record = $reader->city('24.24.24.24');
|
||||
print($record->country->isoCode);
|
||||
```
|
||||
|
||||
## Web Service Client ##
|
||||
|
||||
### Usage ###
|
||||
|
||||
To use this API, you must create a new `\GeoIp2\WebService\Client`
|
||||
object with your `$userId` and `$licenseKey`, then you call the method
|
||||
corresponding to a specific end point, passing it the IP address you want to
|
||||
look up.
|
||||
|
||||
|
|
@ -79,9 +106,11 @@ If the request succeeds, the method call will return a model class for the end
|
|||
point you called. This model in turn contains multiple record classes, each of
|
||||
which represents part of the data returned by the web service.
|
||||
|
||||
If there is an error, a structured exception is thrown.
|
||||
|
||||
See the API documentation for more details.
|
||||
|
||||
## Example ##
|
||||
### Example ###
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
|
@ -90,30 +119,10 @@ use \GeoIp2\WebService\Client;
|
|||
|
||||
$client = new Client(42, 'abcdef123456');
|
||||
$omni = $client->omni('24.24.24.24');
|
||||
echo $omni->country->isoCode;
|
||||
print($omni->country->isoCode);
|
||||
```
|
||||
|
||||
## Exceptions ##
|
||||
|
||||
For details on the possible errors returned by the web service itself, see
|
||||
the
|
||||
[GeoIP2 web service docs](http://dev.maxmind.com/geoip2/geoip/web-service).
|
||||
|
||||
If the web service returns an explicit error document, this is thrown as a
|
||||
```\GeoIp2\Exception\WebServiceException```. If some other sort of transport
|
||||
error occurs, this is thrown as a ```\GeoIp2\Exception\HttpException```.
|
||||
The difference is that the web service error includes an error message and
|
||||
error code delivered by the web service. The latter is thrown when some sort
|
||||
of unanticipated error occurs, such as the web service returning a 500 or an
|
||||
invalid error document.
|
||||
|
||||
If the web service returns any status code besides 200, 4xx, or 5xx, this also
|
||||
becomes a ```\GeoIp2\Exception\HttpException```.
|
||||
|
||||
Finally, if the web service returns a 200 but the body is invalid, the client
|
||||
throws a ```\GeoIp2\Exception\GeoIp2Exception```.
|
||||
|
||||
## What data is returned? ##
|
||||
### What data is returned? ###
|
||||
|
||||
While many of the end points return the same basic records, the attributes
|
||||
which can be populated vary between end points. In addition, while an end
|
||||
|
|
@ -127,8 +136,8 @@ See the
|
|||
[GeoIP2 web service docs](http://dev.maxmind.com/geoip/geoip2/web-services)
|
||||
for details on what data each end point may return.
|
||||
|
||||
The only piece of data which is always returned is the ```ipAddress```
|
||||
attribute in the ``GeoIp2\Record\Traits`` record.
|
||||
The only piece of data which is always returned is the `ipAddress`
|
||||
attribute in the `GeoIp2\Record\Traits` record.
|
||||
|
||||
Every record class attribute has a corresponding predicate method so you can
|
||||
check to see if the attribute is set.
|
||||
|
|
@ -138,10 +147,10 @@ check to see if the attribute is set.
|
|||
[GeoNames](http://www.geonames.org/) offers web services and downloadable
|
||||
databases with data on geographical features around the world, including
|
||||
populated places. They offer both free and paid premium data. Each
|
||||
feature is unique identified by a ```geonameId```, which is an integer.
|
||||
feature is unique identified by a `geonameId`, which is an integer.
|
||||
|
||||
Many of the records returned by the GeoIP2 web services and databases
|
||||
include a ```geonameId``` property. This is the ID of a geographical feature
|
||||
include a `geonameId` property. This is the ID of a geographical feature
|
||||
(city, region, country, etc.) in the GeoNames database.
|
||||
|
||||
Some of the data that MaxMind provides is also sourced from GeoNames. We
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user