will/GeoIP2-php
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
76ccab7e12
GeoIP2-php/doc/v0.1.1/source-class-GeoIP2.WebService.Client.html

414 lines
47 KiB
HTML
Raw 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/WebService/Client.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><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>
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\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\WebServiceException;
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-keyword1">use</span> GeoIP2\Model\City;
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">use</span> GeoIP2\Model\CityIspOrg;
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-keyword1">use</span> GeoIP2\Model\Country;
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-keyword1">use</span> GeoIP2\Model\Omni;
</span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-keyword1">use</span> Guzzle\Http\Client <span class="php-keyword1">as</span> GuzzleClient;
</span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-keyword1">use</span> Guzzle\Common\Exception\RuntimeException;
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-keyword1">use</span> Guzzle\Http\Exception\ClientErrorResponseException;
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-keyword1">use</span> Guzzle\Http\Exception\ServerErrorResponseException;
</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"> * This class provides a client API for all the GeoIP2 web service's
</span></span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-comment"> * end points. The end points are Country, City, City/ISP/Org, and Omni. Each
</span></span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-comment"> * end point returns a different set of data about an IP address, with Country
</span></span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment"> * returning the least data and Omni the most.
</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"> * Each web service end point is represented by a different model class, and
</span></span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-comment"> * these model classes in turn contain multiple Record classes. The record
</span></span><span id="25" class="l"><a class="l" href="#25"> 25: </a><span class="php-comment"> * classes have attributes which contain data about the IP address.
</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 web service does not return a particular piece of data for an IP
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> * address, the associated attribute is not populated.
</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"> * The web service may not return any information for an entire record, in
</span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment"> * which case all of the attributes for that record class will be empty.
</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"> * **Usage**
</span></span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-comment"> *
</span></span><span id="35" class="l"><a class="l" href="#35"> 35: </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="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment"> * points. First you create a web service object with your MaxMind
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * &lt;code&gt;$userId&lt;/code&gt; and &lt;code&gt;$licenseKey&lt;/code&gt;, then you call the method
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> * corresponding to a specific end point, passing it the IP address you want
</span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment"> * to look up.
</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-comment"> * If the request succeeds, the method call will return a model class for
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * the end point you called. This model in turn contains multiple record
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> * classes, each of which represents part of the data returned by the web
</span></span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-comment"> * service.
</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"> * If the request fails, the client class throws an exception.
</span></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"> * **Exceptions**
</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"> * For details on the possible errors returned by the web service itself, see
</span></span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment"> * {@link http://dev.maxmind.com/geoip2/geoip/web-services the GeoIP2 web
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * service docs}.
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> *
</span></span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-comment"> * If the web service returns an explicit error document, this is thrown as a
</span></span><span id="55" class="l"><a class="l" href="#55"> 55: </a><span class="php-comment"> * {@link \GeoIP2\Exception\WebServiceException}. If some other sort of
</span></span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment"> * transport error occurs, this is thrown as a {@link
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * \GeoIP2\Exception\HttpException}. The difference is that the web service
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> * error includes an error message and error code delivered by the web
</span></span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-comment"> * service. The latter is thrown when some sort of unanticipated error occurs,
</span></span><span id="60" class="l"><a class="l" href="#60"> 60: </a><span class="php-comment"> * such as the web service returning a 500 or an invalid error document.
</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"> * If the web service returns any status code besides 200, 4xx, or 5xx, this
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> * also becomes a {@link \GeoIP2\Exception\HttpException}.
</span></span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-comment"> *
</span></span><span id="65" class="l"><a class="l" href="#65"> 65: </a><span class="php-comment"> * Finally, if the web service returns a 200 but the body is invalid, the
</span></span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment"> * client throws a {@link \GeoIP2\Exception\GeoIP2Exception}.
</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">class</span> <a id="Client" href="#Client">Client</a>
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a>{
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$userId" href="#$userId">$userId</a></span>;
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$licenseKey" href="#$licenseKey">$licenseKey</a></span>;
</span><span id="72" class="l"><a class="l" href="#72"> 72: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$languages" href="#$languages">$languages</a></span>;
</span><span id="73" class="l"><a class="l" href="#73"> 73: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$host" href="#$host">$host</a></span>;
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$guzzleClient" href="#$guzzleClient">$guzzleClient</a></span>;
</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"> * Constructor.
</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-comment"> * @param int $userId Your MaxMind user ID
</span></span><span id="80" class="l"><a class="l" href="#80"> 80: </a><span class="php-comment"> * @param string $licenseKey Your MaxMind license key
</span></span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment"> * @param array $languages List of language codes to use in name property
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * from most preferred to least preferred.
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> * @param string $host Optional host parameter
</span></span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-comment"> * @param object $guzzleClient Optional Guzzle client to use (to facilitate
</span></span><span id="85" class="l"><a class="l" href="#85"> 85: </a><span class="php-comment"> * unit testing).
</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="___construct" href="#___construct">__construct</a>(
</span><span id="88" class="l"><a class="l" href="#88"> 88: </a> <span class="php-var">$userId</span>,
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a> <span class="php-var">$licenseKey</span>,
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a> <span class="php-var">$languages</span> = <span class="php-keyword1">array</span>(<span class="php-quote">'en'</span>),
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a> <span class="php-var">$host</span> = <span class="php-quote">'geoip.maxmind.com'</span>,
</span><span id="92" class="l"><a class="l" href="#92"> 92: </a> <span class="php-var">$guzzleClient</span> = <span class="php-keyword1">null</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 class="php-var">$this</span>-&gt;userId = <span class="php-var">$userId</span>;
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a> <span class="php-var">$this</span>-&gt;licenseKey = <span class="php-var">$licenseKey</span>;
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a> <span class="php-var">$this</span>-&gt;languages = <span class="php-var">$languages</span>;
</span><span id="97" class="l"><a class="l" href="#97"> 97: </a> <span class="php-var">$this</span>-&gt;host = <span class="php-var">$host</span>;
</span><span id="98" class="l"><a class="l" href="#98"> 98: </a> <span class="php-comment">// To enable unit testing</span>
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a> <span class="php-var">$this</span>-&gt;guzzleClient = <span class="php-var">$guzzleClient</span>;
</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"> * This method calls the GeoIP2 City endpoint.
</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-comment"> * @param string $ipAddress IPv4 or IPv6 address as a string. If no
</span></span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment"> * address is provided, the address that the web service is called
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * from will be used.
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> *
</span></span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-comment"> * @return \GeoIP2\Model\City
</span></span><span id="110" class="l"><a class="l" href="#110">110: </a><span class="php-comment"> *
</span></span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment"> * @throws \GeoIP2\Exception\GeoIP2Exception if there was a generic
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * error processing your request.
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> * @throws \GeoIP2\Exception\HttpException if there was an HTTP transport
</span></span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-comment"> * error.
</span></span><span id="115" class="l"><a class="l" href="#115">115: </a><span class="php-comment"> * @throws \GeoIP2\Exception\WebServiceException if an error was returned
</span></span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment"> * by MaxMind's GeoIP2 web service.
</span></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-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="119" class="l"><a class="l" href="#119">119: </a> {
</span><span id="120" class="l"><a class="l" href="#120">120: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;responseFor(<span class="php-quote">'city'</span>, <span class="php-quote">'City'</span>, <span class="php-var">$ipAddress</span>);
</span><span id="121" class="l"><a class="l" href="#121">121: </a> }
</span><span id="122" class="l"><a class="l" href="#122">122: </a>
</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"> * This method calls the GeoIP2 Country endpoint.
</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"> * @param string $ipAddress IPv4 or IPv6 address as a string. If no
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * address is provided, the address that the web service is called
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> * from will be used.
</span></span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-comment"> *
</span></span><span id="130" class="l"><a class="l" href="#130">130: </a><span class="php-comment"> * @return \GeoIP2\Model\Country
</span></span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment"> *
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * @throws \GeoIP2\Exception\GeoIP2Exception if there was a generic
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> * error processing your request.
</span></span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-comment"> * @throws \GeoIP2\Exception\HttpException if there was an HTTP transport
</span></span><span id="135" class="l"><a class="l" href="#135">135: </a><span class="php-comment"> * error.
</span></span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment"> * @throws \GeoIP2\Exception\WebServiceException if an error was returned
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * by MaxMind's GeoIP2 web service.
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> */</span>
</span><span id="139" class="l"><a class="l" href="#139">139: </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="140" class="l"><a class="l" href="#140">140: </a> {
</span><span id="141" class="l"><a class="l" href="#141">141: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;responseFor(<span class="php-quote">'country'</span>, <span class="php-quote">'Country'</span>, <span class="php-var">$ipAddress</span>);
</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><span id="144" class="l"><a class="l" href="#144">144: </a> <span class="php-comment">/**
</span></span><span id="145" class="l"><a class="l" href="#145">145: </a><span class="php-comment"> * This method calls the GeoIP2 City/ISP/Org endpoint.
</span></span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment"> *
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> * @param string $ipAddress IPv4 or IPv6 address as a string. If no
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> * address is provided, the address that the web service is called
</span></span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-comment"> * from will be used.
</span></span><span id="150" class="l"><a class="l" href="#150">150: </a><span class="php-comment"> *
</span></span><span id="151" class="l"><a class="l" href="#151">151: </a><span class="php-comment"> * @return \GeoIP2\Model\CityIspOrg
</span></span><span id="152" class="l"><a class="l" href="#152">152: </a><span class="php-comment"> *
</span></span><span id="153" class="l"><a class="l" href="#153">153: </a><span class="php-comment"> * @throws \GeoIP2\Exception\GeoIP2Exception if there was a generic
</span></span><span id="154" class="l"><a class="l" href="#154">154: </a><span class="php-comment"> * error processing your request.
</span></span><span id="155" class="l"><a class="l" href="#155">155: </a><span class="php-comment"> * @throws \GeoIP2\Exception\HttpException if there was an HTTP transport
</span></span><span id="156" class="l"><a class="l" href="#156">156: </a><span class="php-comment"> * error.
</span></span><span id="157" class="l"><a class="l" href="#157">157: </a><span class="php-comment"> * @throws \GeoIP2\Exception\WebServiceException if an error was returned
</span></span><span id="158" class="l"><a class="l" href="#158">158: </a><span class="php-comment"> * by MaxMind's GeoIP2 web service.
</span></span><span id="159" class="l"><a class="l" href="#159">159: </a><span class="php-comment"> */</span>
</span><span id="160" class="l"><a class="l" href="#160">160: </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="161" class="l"><a class="l" href="#161">161: </a> {
</span><span id="162" class="l"><a class="l" href="#162">162: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;responseFor(<span class="php-quote">'city_isp_org'</span>, <span class="php-quote">'CityIspOrg'</span>, <span class="php-var">$ipAddress</span>);
</span><span id="163" class="l"><a class="l" href="#163">163: </a> }
</span><span id="164" class="l"><a class="l" href="#164">164: </a>
</span><span id="165" class="l"><a class="l" href="#165">165: </a> <span class="php-comment">/**
</span></span><span id="166" class="l"><a class="l" href="#166">166: </a><span class="php-comment"> * This method calls the GeoIP2 Omni endpoint.
</span></span><span id="167" class="l"><a class="l" href="#167">167: </a><span class="php-comment"> *
</span></span><span id="168" class="l"><a class="l" href="#168">168: </a><span class="php-comment"> * @param string $ipAddress IPv4 or IPv6 address as a string. If no
</span></span><span id="169" class="l"><a class="l" href="#169">169: </a><span class="php-comment"> * address is provided, the address that the web service is called
</span></span><span id="170" class="l"><a class="l" href="#170">170: </a><span class="php-comment"> * from will be used.
</span></span><span id="171" class="l"><a class="l" href="#171">171: </a><span class="php-comment"> *
</span></span><span id="172" class="l"><a class="l" href="#172">172: </a><span class="php-comment"> * @return \GeoIP2\Model\Omni
</span></span><span id="173" class="l"><a class="l" href="#173">173: </a><span class="php-comment"> *
</span></span><span id="174" class="l"><a class="l" href="#174">174: </a><span class="php-comment"> * @throws \GeoIP2\Exception\GeoIP2Exception if there was a generic
</span></span><span id="175" class="l"><a class="l" href="#175">175: </a><span class="php-comment"> * error processing your request.
</span></span><span id="176" class="l"><a class="l" href="#176">176: </a><span class="php-comment"> * @throws \GeoIP2\Exception\HttpException if there was an HTTP transport
</span></span><span id="177" class="l"><a class="l" href="#177">177: </a><span class="php-comment"> * error.
</span></span><span id="178" class="l"><a class="l" href="#178">178: </a><span class="php-comment"> * @throws \GeoIP2\Exception\WebServiceException if an error was returned
</span></span><span id="179" class="l"><a class="l" href="#179">179: </a><span class="php-comment"> * by MaxMind's GeoIP2 web service.
</span></span><span id="180" class="l"><a class="l" href="#180">180: </a><span class="php-comment"> */</span>
</span><span id="181" class="l"><a class="l" href="#181">181: </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="182" class="l"><a class="l" href="#182">182: </a> {
</span><span id="183" class="l"><a class="l" href="#183">183: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;responseFor(<span class="php-quote">'omni'</span>, <span class="php-quote">'Omni'</span>, <span class="php-var">$ipAddress</span>);
</span><span id="184" class="l"><a class="l" href="#184">184: </a> }
</span><span id="185" class="l"><a class="l" href="#185">185: </a>
</span><span id="186" class="l"><a class="l" href="#186">186: </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="187" class="l"><a class="l" href="#187">187: </a> {
</span><span id="188" class="l"><a class="l" href="#188">188: </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>-&gt;baseUri(), <span class="php-var">$endpoint</span>, <span class="php-var">$ipAddress</span>));
</span><span id="189" class="l"><a class="l" href="#189">189: </a>
</span><span id="190" class="l"><a class="l" href="#190">190: </a> <span class="php-var">$client</span> = <span class="php-var">$this</span>-&gt;guzzleClient ?
</span><span id="191" class="l"><a class="l" href="#191">191: </a> <span class="php-var">$this</span>-&gt;guzzleClient : <span class="php-keyword1">new</span> GuzzleClient();
</span><span id="192" class="l"><a class="l" href="#192">192: </a> <span class="php-var">$request</span> = <span class="php-var">$client</span>-&gt;get(<span class="php-var">$uri</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'Accept'</span> =&gt; <span class="php-quote">'application/json'</span>));
</span><span id="193" class="l"><a class="l" href="#193">193: </a> <span class="php-var">$request</span>-&gt;setAuth(<span class="php-var">$this</span>-&gt;userId, <span class="php-var">$this</span>-&gt;licenseKey);
</span><span id="194" class="l"><a class="l" href="#194">194: </a> <span class="php-var">$ua</span> = <span class="php-var">$request</span>-&gt;getHeader(<span class="php-quote">'User-Agent'</span>);
</span><span id="195" class="l"><a class="l" href="#195">195: </a> <span class="php-var">$ua</span> = <span class="php-quote">&quot;GeoIP2 PHP API (</span><span class="php-var">$ua</span><span class="php-quote">)&quot;</span>;
</span><span id="196" class="l"><a class="l" href="#196">196: </a> <span class="php-var">$request</span>-&gt;setHeader(<span class="php-quote">'User-Agent'</span>, <span class="php-var">$ua</span>);
</span><span id="197" class="l"><a class="l" href="#197">197: </a>
</span><span id="198" class="l"><a class="l" href="#198">198: </a> <span class="php-var">$response</span> = <span class="php-keyword1">null</span>;
</span><span id="199" class="l"><a class="l" href="#199">199: </a> <span class="php-keyword1">try</span> {
</span><span id="200" class="l"><a class="l" href="#200">200: </a> <span class="php-var">$response</span> = <span class="php-var">$request</span>-&gt;send();
</span><span id="201" class="l"><a class="l" href="#201">201: </a> } <span class="php-keyword1">catch</span> (ClientErrorResponseException <span class="php-var">$e</span>) {
</span><span id="202" class="l"><a class="l" href="#202">202: </a> <span class="php-var">$this</span>-&gt;handle4xx(<span class="php-var">$e</span>-&gt;getResponse(), <span class="php-var">$uri</span>);
</span><span id="203" class="l"><a class="l" href="#203">203: </a> } <span class="php-keyword1">catch</span> (ServerErrorResponseException <span class="php-var">$e</span>) {
</span><span id="204" class="l"><a class="l" href="#204">204: </a> <span class="php-var">$this</span>-&gt;handle5xx(<span class="php-var">$e</span>-&gt;getResponse(), <span class="php-var">$uri</span>);
</span><span id="205" class="l"><a class="l" href="#205">205: </a> }
</span><span id="206" class="l"><a class="l" href="#206">206: </a>
</span><span id="207" class="l"><a class="l" href="#207">207: </a> <span class="php-keyword1">if</span> (<span class="php-var">$response</span> &amp;&amp; <span class="php-var">$response</span>-&gt;isSuccessful()) {
</span><span id="208" class="l"><a class="l" href="#208">208: </a> <span class="php-var">$body</span> = <span class="php-var">$this</span>-&gt;handleSuccess(<span class="php-var">$response</span>, <span class="php-var">$uri</span>);
</span><span id="209" class="l"><a class="l" href="#209">209: </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="210" class="l"><a class="l" href="#210">210: </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>-&gt;languages);
</span><span id="211" class="l"><a class="l" href="#211">211: </a> } <span class="php-keyword1">else</span> {
</span><span id="212" class="l"><a class="l" href="#212">212: </a> <span class="php-var">$this</span>-&gt;handleNon200(<span class="php-var">$response</span>, <span class="php-var">$uri</span>);
</span><span id="213" class="l"><a class="l" href="#213">213: </a> }
</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><span id="216" class="l"><a class="l" href="#216">216: </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="217" class="l"><a class="l" href="#217">217: </a> {
</span><span id="218" class="l"><a class="l" href="#218">218: </a> <span class="php-keyword1">if</span> (<span class="php-var">$response</span>-&gt;getContentLength() == <span class="php-num">0</span>) {
</span><span id="219" class="l"><a class="l" href="#219">219: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> GeoIP2Exception(
</span><span id="220" class="l"><a class="l" href="#220">220: </a> <span class="php-quote">&quot;Received a 200 response for </span><span class="php-var">$uri</span><span class="php-quote"> but did not &quot;</span> .
</span><span id="221" class="l"><a class="l" href="#221">221: </a> <span class="php-quote">&quot;receive a HTTP body.&quot;</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><span id="224" class="l"><a class="l" href="#224">224: </a>
</span><span id="225" class="l"><a class="l" href="#225">225: </a> <span class="php-keyword1">try</span> {
</span><span id="226" class="l"><a class="l" href="#226">226: </a> <span class="php-keyword1">return</span> <span class="php-var">$response</span>-&gt;json();
</span><span id="227" class="l"><a class="l" href="#227">227: </a> } <span class="php-keyword1">catch</span> (RuntimeException <span class="php-var">$e</span>) {
</span><span id="228" class="l"><a class="l" href="#228">228: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> GeoIP2Exception(
</span><span id="229" class="l"><a class="l" href="#229">229: </a> <span class="php-quote">&quot;Received a 200 response for </span><span class="php-var">$uri</span><span class="php-quote"> but could not decode &quot;</span> .
</span><span id="230" class="l"><a class="l" href="#230">230: </a> <span class="php-quote">&quot;the response as JSON: &quot;</span> . <span class="php-var">$e</span>-&gt;getMessage()
</span><span id="231" class="l"><a class="l" href="#231">231: </a> );
</span><span id="232" class="l"><a class="l" href="#232">232: </a>
</span><span id="233" class="l"><a class="l" href="#233">233: </a> }
</span><span id="234" class="l"><a class="l" href="#234">234: </a> }
</span><span id="235" class="l"><a class="l" href="#235">235: </a>
</span><span id="236" class="l"><a class="l" href="#236">236: </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="237" class="l"><a class="l" href="#237">237: </a> {
</span><span id="238" class="l"><a class="l" href="#238">238: </a> <span class="php-var">$status</span> = <span class="php-var">$response</span>-&gt;getStatusCode();
</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-var">$body</span> = <span class="php-keyword1">array</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>-&gt;getContentLength() &gt; <span class="php-num">0</span>) {
</span><span id="243" class="l"><a class="l" href="#243">243: </a> <span class="php-keyword1">if</span> (<span class="php-keyword2">strstr</span>(<span class="php-var">$response</span>-&gt;getContentType(), <span class="php-quote">'json'</span>)) {
</span><span id="244" class="l"><a class="l" href="#244">244: </a> <span class="php-keyword1">try</span> {
</span><span id="245" class="l"><a class="l" href="#245">245: </a> <span class="php-var">$body</span> = <span class="php-var">$response</span>-&gt;json();
</span><span id="246" class="l"><a class="l" href="#246">246: </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="247" class="l"><a class="l" href="#247">247: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> GeoIP2Exception(
</span><span id="248" class="l"><a class="l" href="#248">248: </a> <span class="php-quote">'Response contains JSON but it does not specify '</span> .
</span><span id="249" class="l"><a class="l" href="#249">249: </a> <span class="php-quote">'code or error keys: '</span> . <span class="php-var">$response</span>-&gt;getBody()
</span><span id="250" class="l"><a class="l" href="#250">250: </a> );
</span><span id="251" class="l"><a class="l" href="#251">251: </a> }
</span><span id="252" class="l"><a class="l" href="#252">252: </a> } <span class="php-keyword1">catch</span> (RuntimeException <span class="php-var">$e</span>) {
</span><span id="253" class="l"><a class="l" href="#253">253: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> HttpException(
</span><span id="254" class="l"><a class="l" href="#254">254: </a> <span class="php-quote">&quot;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 &quot;</span> .
</span><span id="255" class="l"><a class="l" href="#255">255: </a> <span class="php-quote">&quot;include the expected JSON body: &quot;</span> .
</span><span id="256" class="l"><a class="l" href="#256">256: </a> <span class="php-var">$e</span>-&gt;getMessage(),
</span><span id="257" class="l"><a class="l" href="#257">257: </a> <span class="php-var">$status</span>,
</span><span id="258" class="l"><a class="l" href="#258">258: </a> <span class="php-var">$uri</span>
</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><span id="261" class="l"><a class="l" href="#261">261: </a> } <span class="php-keyword1">else</span> {
</span><span id="262" class="l"><a class="l" href="#262">262: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> HttpException(
</span><span id="263" class="l"><a class="l" href="#263">263: </a> <span class="php-quote">&quot;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 &quot;</span> .
</span><span id="264" class="l"><a class="l" href="#264">264: </a> <span class="php-quote">&quot;following body: &quot;</span> . <span class="php-var">$response</span>-&gt;getBody(),
</span><span id="265" class="l"><a class="l" href="#265">265: </a> <span class="php-var">$status</span>,
</span><span id="266" class="l"><a class="l" href="#266">266: </a> <span class="php-var">$uri</span>
</span><span id="267" class="l"><a class="l" href="#267">267: </a> );
</span><span id="268" class="l"><a class="l" href="#268">268: </a> }
</span><span id="269" class="l"><a class="l" href="#269">269: </a> } <span class="php-keyword1">else</span> {
</span><span id="270" class="l"><a class="l" href="#270">270: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> HttpException(
</span><span id="271" class="l"><a class="l" href="#271">271: </a> <span class="php-quote">&quot;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&quot;</span>,
</span><span id="272" class="l"><a class="l" href="#272">272: </a> <span class="php-var">$status</span>,
</span><span id="273" class="l"><a class="l" href="#273">273: </a> <span class="php-var">$uri</span>
</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><span id="277" class="l"><a class="l" href="#277">277: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> WebServiceException(
</span><span id="278" class="l"><a class="l" href="#278">278: </a> <span class="php-var">$body</span>[<span class="php-quote">'error'</span>],
</span><span id="279" class="l"><a class="l" href="#279">279: </a> <span class="php-var">$body</span>[<span class="php-quote">'code'</span>],
</span><span id="280" class="l"><a class="l" href="#280">280: </a> <span class="php-var">$status</span>,
</span><span id="281" class="l"><a class="l" href="#281">281: </a> <span class="php-var">$uri</span>
</span><span id="282" class="l"><a class="l" href="#282">282: </a> );
</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">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="286" class="l"><a class="l" href="#286">286: </a> {
</span><span id="287" class="l"><a class="l" href="#287">287: </a> <span class="php-var">$status</span> = <span class="php-var">$response</span>-&gt;getStatusCode();
</span><span id="288" class="l"><a class="l" href="#288">288: </a>
</span><span id="289" class="l"><a class="l" href="#289">289: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> HttpException(
</span><span id="290" class="l"><a class="l" href="#290">290: </a> <span class="php-quote">&quot;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">&quot;</span>,
</span><span id="291" class="l"><a class="l" href="#291">291: </a> <span class="php-var">$status</span>,
</span><span id="292" class="l"><a class="l" href="#292">292: </a> <span class="php-var">$uri</span>
</span><span id="293" class="l"><a class="l" href="#293">293: </a> );
</span><span id="294" class="l"><a class="l" href="#294">294: </a> }
</span><span id="295" class="l"><a class="l" href="#295">295: </a>
</span><span id="296" class="l"><a class="l" href="#296">296: </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="297" class="l"><a class="l" href="#297">297: </a> {
</span><span id="298" class="l"><a class="l" href="#298">298: </a> <span class="php-var">$status</span> = <span class="php-var">$response</span>-&gt;getStatusCode();
</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-keyword1">throw</span> <span class="php-keyword1">new</span> HttpException(
</span><span id="301" class="l"><a class="l" href="#301">301: </a> <span class="php-quote">&quot;Received a very surprising HTTP status &quot;</span> .
</span><span id="302" class="l"><a class="l" href="#302">302: </a> <span class="php-quote">&quot;(</span><span class="php-var">$status</span><span class="php-quote">) for </span><span class="php-var">$uri</span><span class="php-quote">&quot;</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="_baseUri" href="#_baseUri">baseUri</a>()
</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">return</span> <span class="php-quote">'https://'</span> . <span class="php-var">$this</span>-&gt;host . <span class="php-quote">'/geoip/v2.0'</span>;
</span><span id="311" class="l"><a class="l" href="#311">311: </a> }
</span><span id="312" class="l"><a class="l" href="#312">312: </a>}
</span><span id="313" class="l"><a class="l" href="#313">313: </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