GeoIP2-php/doc/v0.4.0/source-class-GeoIp2.Database.Reader.html
2013-07-16 12:40:45 -07:00

254 lines
23 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<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">&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\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 &lt;code&gt;country&lt;/code&gt;
</span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment"> * and &lt;code&gt;city&lt;/code&gt; methods. We also provide &lt;code&gt;cityIspOrg&lt;/code&gt;
</span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment"> * and &lt;code&gt;omni&lt;/code&gt; 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 &lt;code&gt;null&lt;/code&gt; 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>-&gt;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>-&gt;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>-&gt;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>-&gt;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>-&gt;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>-&gt;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>-&gt;dbReader-&gt;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">&quot;The address </span><span class="php-var">$ipAddress</span><span class="php-quote"> is not in the database.&quot;</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">&quot;GeoIp2\\Model\\&quot;</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>-&gt;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>-&gt;dbReader-&gt;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>