class Client in Smart IP 6.2

This class provides a client API for all the GeoIP2 Precision web services. The services are Country, City, and Insights. Each service returns a different set of data about an IP address, with Country returning the least data and Insights the most.

Each web service 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 `$userId` and `$licenseKey`, 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 service 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.

Hierarchy

• class \GeoIp2\WebService\Client implements ProviderInterface

File

includes/vendor/geoip2/geoip2/src/WebService/Client.php, line 45

Namespace

GeoIp2\WebService

class Client implements ProviderInterface {
  private $locales;
  private $client;
  private static $basePath = '/geoip/v2.1';
  const VERSION = 'v2.4.1';

  /**
   * Constructor.
   *
   * @param int $userId     Your MaxMind user ID
   * @param string $licenseKey Your MaxMind license key
   * @param array $locales  List of locale codes to use in name property
   * from most preferred to least preferred.
   * @param array $options Array of options. Valid options include:
   *      * `host` - The host to use when querying the web service.
   *      * `timeout` - Timeout in seconds.
   *      * `connectTimeout` - Initial connection timeout in seconds.
   *      * `proxy` - The HTTP proxy to use. May include a schema, port,
   *        username, and password, e.g.,
   *        `http://username:password@127.0.0.1:10`.
   */
  public function __construct($userId, $licenseKey, $locales = array(
    'en',
  ), $options = array()) {
    $this->locales = $locales;

    // This is for backwards compatibility. Do not remove except for a
    // major version bump.
    if (is_string($options)) {
      $options = array(
        'host' => $options,
      );
    }
    if (!isset($options['host'])) {
      $options['host'] = 'geoip.maxmind.com';
    }
    $options['userAgent'] = $this
      ->userAgent();
    $this->client = new WsClient($userId, $licenseKey, $options);
  }
  private function userAgent() {
    return 'GeoIP2-API/' . Client::VERSION;
  }

  /**
   * This method calls the GeoIP2 Precision: City service.
   *
   * @param string $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.
   *
   * @return \GeoIp2\Model\City
   *
   * @throws \GeoIp2\Exception\AddressNotFoundException if the address you
   *   provided is not in our database (e.g., a private address).
   * @throws \GeoIp2\Exception\AuthenticationException if there is a problem
   *   with the user ID or license key that you provided.
   * @throws \GeoIp2\Exception\OutOfQueriesException if your account is out
   *   of queries.
   * @throws \GeoIp2\Exception\InvalidRequestException} 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.
   * @throws \GeoIp2\Exception\HttpException 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.
   * @throws \GeoIp2\Exception\GeoIp2Exception 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.
   */
  public function city($ipAddress = 'me') {
    return $this
      ->responseFor('city', 'City', $ipAddress);
  }

  /**
   * This method calls the GeoIP2 Precision: Country service.
   *
   * @param string $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.
   *
   * @return \GeoIp2\Model\Country
   *
   * @throws \GeoIp2\Exception\AddressNotFoundException if the address you
   *   provided is not in our database (e.g., a private address).
   * @throws \GeoIp2\Exception\AuthenticationException if there is a problem
   *   with the user ID or license key that you provided.
   * @throws \GeoIp2\Exception\OutOfQueriesException if your account is out
   *   of queries.
   * @throws \GeoIp2\Exception\InvalidRequestException} 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.
   * @throws \GeoIp2\Exception\HttpException 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.
   * @throws \GeoIp2\Exception\GeoIp2Exception 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.
   */
  public function country($ipAddress = 'me') {
    return $this
      ->responseFor('country', 'Country', $ipAddress);
  }

  /**
   * This method calls the GeoIP2 Precision: Insights service.
   *
   * @param string $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.
   *
   * @return \GeoIp2\Model\Insights
   *
   * @throws \GeoIp2\Exception\AddressNotFoundException if the address you
   *   provided is not in our database (e.g., a private address).
   * @throws \GeoIp2\Exception\AuthenticationException if there is a problem
   *   with the user ID or license key that you provided.
   * @throws \GeoIp2\Exception\OutOfQueriesException if your account is out
   *   of queries.
   * @throws \GeoIp2\Exception\InvalidRequestException} 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.
   * @throws \GeoIp2\Exception\HttpException 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.
   * @throws \GeoIp2\Exception\GeoIp2Exception 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.
   */
  public function insights($ipAddress = 'me') {
    return $this
      ->responseFor('insights', 'Insights', $ipAddress);
  }
  private function responseFor($endpoint, $class, $ipAddress) {
    $path = implode('/', array(
      self::$basePath,
      $endpoint,
      $ipAddress,
    ));
    try {
      $body = $this->client
        ->get('GeoIP2 ' . $class, $path);
    } catch (\MaxMind\Exception\IpAddressNotFoundException $ex) {
      throw new AddressNotFoundException($ex
        ->getMessage(), $ex
        ->getStatusCode(), $ex);
    } catch (\MaxMind\Exception\AuthenticationException $ex) {
      throw new AuthenticationException($ex
        ->getMessage(), $ex
        ->getStatusCode(), $ex);
    } catch (\MaxMind\Exception\InsufficientFundsException $ex) {
      throw new OutOfQueriesException($ex
        ->getMessage(), $ex
        ->getStatusCode(), $ex);
    } catch (\MaxMind\Exception\InvalidRequestException $ex) {
      throw new InvalidRequestException($ex
        ->getMessage(), $ex
        ->getErrorCode(), $ex
        ->getStatusCode(), $ex
        ->getUri(), $ex);
    } catch (\MaxMind\Exception\HttpException $ex) {
      throw new HttpException($ex
        ->getMessage(), $ex
        ->getStatusCode(), $ex
        ->getUri(), $ex);
    } catch (\MaxMind\Exception\WebServiceException $ex) {
      throw new GeoIp2Exception($ex
        ->getMessage(), $ex
        ->getCode(), $ex);
    }
    $class = "GeoIp2\\Model\\" . $class;
    return new $class($body, $this->locales);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Client::$basePath	private static	property
Client::$client	private	property
Client::$locales	private	property
Client::city	public	function	This method calls the GeoIP2 Precision: City service. Overrides ProviderInterface::city
Client::country	public	function	This method calls the GeoIP2 Precision: Country service. Overrides ProviderInterface::country
Client::insights	public	function	This method calls the GeoIP2 Precision: Insights service.
Client::responseFor	private	function
Client::userAgent	private	function
Client::VERSION		constant
Client::__construct	public	function	Constructor.