*/ private $locales; /** * @var WsClient */ private $client; /** * @var string */ private static $basePath = '/geoip/v2.1'; public const VERSION = 'v2.13.0'; /** * Constructor. * * @param int $accountId your MaxMind account 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. To query the GeoLite2 web service * instead of the GeoIP2 web service, set the * host to `geolite.info`. * * `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( int $accountId, string $licenseKey, array $locales = ['en'], array $options = [] ) { $this->locales = $locales; // This is for backwards compatibility. Do not remove except for a // major version bump. // @phpstan-ignore-next-line if (\is_string($options)) { $options = ['host' => $options]; } if (!isset($options['host'])) { $options['host'] = 'geoip.maxmind.com'; } $options['userAgent'] = $this->userAgent(); $this->client = new WsClient($accountId, $licenseKey, $options); } private function userAgent(): string { return 'GeoIP2-API/' . self::VERSION; } /** * This method calls the City Plus 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. * * @throws \WP_Statistics\Dependencies\GeoIp2\Exception\AddressNotFoundException if the address you * provided is not in our database (e.g., a private address). * @throws \WP_Statistics\Dependencies\GeoIp2\Exception\AuthenticationException if there is a problem * with the account ID or license key that you provided * @throws \WP_Statistics\Dependencies\GeoIp2\Exception\OutOfQueriesException if your account is out * of queries * @throws \WP_Statistics\Dependencies\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 \WP_Statistics\Dependencies\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 \WP_Statistics\Dependencies\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(string $ipAddress = 'me'): City { // @phpstan-ignore-next-line return $this->responseFor('city', City::class, $ipAddress); } /** * This method calls the 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. * * @throws \WP_Statistics\Dependencies\GeoIp2\Exception\AddressNotFoundException if the address you provided is not in our database (e.g., * a private address). * @throws \WP_Statistics\Dependencies\GeoIp2\Exception\AuthenticationException if there is a problem * with the account ID or license key that you provided * @throws \WP_Statistics\Dependencies\GeoIp2\Exception\OutOfQueriesException if your account is out of queries * @throws \WP_Statistics\Dependencies\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 \WP_Statistics\Dependencies\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 \WP_Statistics\Dependencies\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(string $ipAddress = 'me'): Country { return $this->responseFor('country', Country::class, $ipAddress); } /** * This method calls the Insights service. Insights is only supported by * the GeoIP2 web service. The GeoLite2 web service does not support it. * * @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. * * @throws \WP_Statistics\Dependencies\GeoIp2\Exception\AddressNotFoundException if the address you * provided is not in our database (e.g., a private address). * @throws \WP_Statistics\Dependencies\GeoIp2\Exception\AuthenticationException if there is a problem * with the account ID or license key that you provided * @throws \WP_Statistics\Dependencies\GeoIp2\Exception\OutOfQueriesException if your account is out * of queries * @throws \WP_Statistics\Dependencies\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 \WP_Statistics\Dependencies\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 \WP_Statistics\Dependencies\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(string $ipAddress = 'me'): Insights { // @phpstan-ignore-next-line return $this->responseFor('insights', Insights::class, $ipAddress); } private function responseFor(string $endpoint, string $class, string $ipAddress): Country { $path = implode('/', [self::$basePath, $endpoint, $ipAddress]); try { $service = (new \ReflectionClass($class))->getShortName(); $body = $this->client->get('GeoIP2 ' . $service, $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 ); } return new $class($body, $this->locales); } }