Class Client
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.
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.
If the web service does not return a particular piece of data for an IP address, the associated attribute is not populated.
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.
Usage
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 <span
class="php-var">$userId</span>
and <span
class="php-var">$licenseKey</span>
, then you call the method
corresponding to a specific end point, passing it the IP address you want to
look up.
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 the request fails, the client class throws an exception.
Exceptions
For details on the possible errors returned by the web service itself, see the GeoIP2 web service docs.
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
.
public
|
#
__construct( integer $userId, string $licenseKey, array $languages = array('en'), string $host = 'geoip.maxmind.com', object $guzzleClient = null )
Constructor. |
public
|
|
public
|
|
public
|
|
public
|