will/GeoIP2-php
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
gh-pages
GeoIP2-php/doc/v0.1.1/source-class-GeoIP2.Record.Location.html

160 lines
9.3 KiB
HTML
Raw Permalink Normal View History

gh-pages regen
2013-05-24 19:09:48 +00:00
<!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" />
Updated for v0.1.1
2013-05-24 20:39:11 +00:00
<title>File GeoIP2/Record/Location.php | GeoIP2 PHP API v0.1.1</title>
gh-pages regen
2013-05-24 19:09:48 +00:00
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?1245801536"></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.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>
Updated for v0.1.1
2013-05-24 20:39:11 +00:00
<li>
<a href="geoip2-php-api-v0-1-1-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
</li>
gh-pages regen
2013-05-24 19:09:48 +00:00
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?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., &quot;America/New_York&quot;. 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">
Updated for v0.1.1
2013-05-24 20:39:11 +00:00
GeoIP2 PHP API v0.1.1 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
gh-pages regen
2013-05-24 19:09:48 +00:00
</div>
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink