The requested page could not be found.
+You have probably clicked on a link that is outdated and points to a page that does not exist any more or you have made an typing error in the address.
+To continue please try to find requested page in the menu, take a look at the tree view of the whole project or use search field on the top.
+
+ public
+
+
+
+ |
+
+ + |
+ final public
+
+
+
+ |
+
+ + |
+ final public
+
+
+
+ |
+
+ + |
+ final public
+
+
+
+ |
+
+ + |
+ final public
+
+
+
+ |
+
+ + |
+ final public
+
+
+
+ |
+
+ + |
+ final public
+
+
+
+ |
+
+ + |
+ final public
+
+
+
+ |
+
+ + |
+ public
+
+
+
+ |
+
+ + |
+ protected
+ string
+ |
+
+ + $message + | +'' |
+
+ #
+
+
+
+
+
+
+ |
+
+ protected
+ integer
+ |
+
+ + $code + | +0 |
+
+ #
+
+
+
+
+
+
+ |
+
+ protected
+ mixed
+ |
+
+ + $file + | + |
+
+ #
+
+
+
+
+
+
+ |
+
+ protected
+ mixed
+ |
+
+ + $line + | + |
+
+ #
+
+
+
+
+
+
+ |
+
Instances of this class provide a reader for the GeoIP2 database format. IP
+addresses can be looked up using the country and city
+methods. We also provide cityIspOrg and omni methods
+to ease compatibility with the web service client, although we may offer the
+ability to specify additional databases to replicate these web services in the
+future (e.g., the ISP/Org database).
Usage
+ +The basic API for this class is the same for every database. First, you +create a reader object, specifying a file name. You then call the method +corresponding to the specific database, passing it the IP address you want to +look up.
+ +If the request succeeds, the method call will return a model class for the
+method you called. This model in turn contains multiple record classes, each of
+which represents part of the data returned by the database. If the database does
+not contain the requested information, the attributes on the record class will
+have a <span class="php-keyword1">null</span>
+value.
If the address is not in the database, an GeoIp2\Exception\AddressNotFoundException exception will be thrown. If an
+invalid IP address is passed to one of the methods, a SPL \InvalidArgumentException will be thrown. If the database is corrupt or
+invalid, a \MaxMind\Db\Reader\InvalidDatabaseException will be
+thrown.
+ public
+
+
+
+ |
+
+ + |
+ public
+
+ |
+
+ + |
+ public
+
+ |
+
+ + |
+ public
+
+ |
+
+
+ #
+ cityIspOrg( string $ipAddress )
+
+
+
+
+
+
+ This method returns a GeoIP2 City/ISP/Org model. + + |
+
+ public
+
+ |
+
+ + |
+ public
+
+
+
+ |
+
+ + |
This class represents a generic error.
+ +
+ GeoIp2\Exception\GeoIp2Exception
+
+
+
+
+GeoIp2\Exception\AddressNotFoundException
+
+
+
+ __construct(),
+ __toString(),
+ getCode(),
+ getFile(),
+ getLine(),
+ getMessage(),
+ getPrevious(),
+ getTrace(),
+ getTraceAsString()
+ |
+
+ $code,
+ $file,
+ $line,
+ $message
+ |
+
This class represents a generic error.
+ +
+ GeoIp2\Exception\GeoIp2Exception
+
+
+
+
+GeoIp2\Exception\AuthenticationException
+
+
+
+ __construct(),
+ __toString(),
+ getCode(),
+ getFile(),
+ getLine(),
+ getMessage(),
+ getPrevious(),
+ getTrace(),
+ getTraceAsString()
+ |
+
+ $code,
+ $file,
+ $line,
+ $message
+ |
+
This class represents a generic error.
+ +
+GeoIp2\Exception\GeoIp2Exception
+
+
+
+ __construct(),
+ __toString(),
+ getCode(),
+ getFile(),
+ getLine(),
+ getMessage(),
+ getPrevious(),
+ getTrace(),
+ getTraceAsString()
+ |
+
+ $code,
+ $file,
+ $line,
+ $message
+ |
+
This class represents an HTTP transport error.
+ +
+ GeoIp2\Exception\GeoIp2Exception
+
+
+
+
+GeoIp2\Exception\HttpException
+
+
+
+ public
+
+
+
+ |
+
+
+ #
+ __construct( mixed $message, mixed $httpStatus, mixed $uri,
+
+
+
+
+
+
+ |
+
+ __toString(),
+ getCode(),
+ getFile(),
+ getLine(),
+ getMessage(),
+ getPrevious(),
+ getTrace(),
+ getTraceAsString()
+ |
+
+ public
+ mixed
+ |
+
+ + $uri + | + |
+
+ #
+
+
+
+
+
+
+ The URI queried + + |
+
+ $code,
+ $file,
+ $line,
+ $message
+ |
+
This class represents an error returned by MaxMind's GeoIP2 web service.
+ +
+ GeoIp2\Exception\GeoIp2Exception
+
+
+
+
+ GeoIp2\Exception\HttpException
+
+
+
+
+GeoIp2\Exception\InvalidRequestException
+
+
+
+ public
+
+
+
+ |
+
+
+ #
+ __construct( mixed $message, mixed $error, mixed $httpStatus, mixed $uri,
+
+
+
+
+
+
+ |
+
+ __toString(),
+ getCode(),
+ getFile(),
+ getLine(),
+ getMessage(),
+ getPrevious(),
+ getTrace(),
+ getTraceAsString()
+ |
+
+ public
+ mixed
+ |
+
+ + $error + | + |
+
+ #
+
+
+
+
+
+
+ The code returned by the MaxMind web service + + |
+
+ $uri
+ |
+
+ $code,
+ $file,
+ $line,
+ $message
+ |
+
This class represents a generic error.
+ +
+ GeoIp2\Exception\GeoIp2Exception
+
+
+
+
+GeoIp2\Exception\OutOfQueriesException
+
+
+
+ __construct(),
+ __toString(),
+ getCode(),
+ getFile(),
+ getLine(),
+ getMessage(),
+ getPrevious(),
+ getTrace(),
+ getTraceAsString()
+ |
+
+ $code,
+ $file,
+ $line,
+ $message
+ |
+
This class provides a model for the data returned by the GeoIP2 City end +point.
+ +The only difference between the City, City/ISP/Org, and Omni model classes is +which fields in each record may be populated. See http://dev.maxmind.com/geoip/geoip2/web-services +more details.
+ +
+GeoIp2\Model\City
+
+
+
+ public
+ |
+
+ + $city + | +
+ #
+
+
+
+
+
+
+ City data for the requested IP address. + + |
+
+ public
+ |
+
+ + $continent + | +
+ #
+
+
+
+
+
+
+ Continent data for the requested IP address. + + |
+
+ public
+ |
+
+ + $country + | +
+ #
+
+
+
+
+
+
+ Country data for the requested IP address. This object represents the country +where MaxMind believes the end user is located. + + |
+
+ public
+ |
+
+ + $location + | +
+ #
+
+
+
+
+
+
+ Location data for the requested IP address. + + |
+
+ public
+ |
+
+ + $maxmind + | +
+ #
+
+
+
+
+
+
+ Data related to your MaxMind account. + + |
+
+ public
+ |
+
+ + $registeredCountry + | +
+ #
+
+
+
+
+
+
+ Registered country data for the requested IP address. This record represents +the country where the ISP has registered a given IP block and may differ from +the user's country. + + |
+
+ public
+ |
+
+ + $representedCountry + | +
+ #
+
+
+
+
+
+
+ Represented country data for the requested IP address. The represented +country is used for things like military bases or embassies. It is only present +when the represented country differs from the country. + + |
+
+ public
+ array
+ |
+
+ + $subdivisions + | +
+ #
+
+
+
+
+
+
+ An array of |
+
+ public
+ |
+
+ + $mostSpecificSubdivision + | +
+ #
+
+
+
+
+
+
+ An object representing the most specific subdivision returned. If the
+response did not contain any subdivisions, this method returns an empty |
+
+ public
+ |
+
+ + $traits + | +
+ #
+
+
+
+
+
+
+ Data for the traits of the requested IP address. + + |
+
This class provides a model for the data returned by the GeoIP2 City/ISP/Org +end point.
+ +The only difference between the City, City/ISP/Org, and Omni model classes is +which fields in each record may be populated. See http://dev.maxmind.com/geoip/geoip2/web-services +more details.
+ +
+ GeoIp2\Model\City
+
+
+
+
+GeoIp2\Model\CityIspOrg
+
+
+
+ public
+ |
+
+ + $city + | +
+ #
+
+
+
+
+
+
+ City data for the requested IP address. + + |
+
+ public
+ |
+
+ + $continent + | +
+ #
+
+
+
+
+
+
+ Continent data for the requested IP address. + + |
+
+ public
+ |
+
+ + $country + | +
+ #
+
+
+
+
+
+
+ Country data for the requested IP address. This object represents the country +where MaxMind believes the end user is located. + + |
+
+ public
+ |
+
+ + $location + | +
+ #
+
+
+
+
+
+
+ Location data for the requested IP address. + + |
+
+ public
+ |
+
+ + $maxmind + | +
+ #
+
+
+
+
+
+
+ Data related to your MaxMind account. + + |
+
+ public
+ |
+
+ + $registeredCountry + | +
+ #
+
+
+
+
+
+
+ Registered country data for the requested IP address. This record represents +the country where the ISP has registered a given IP block and may differ from +the user's country. + + |
+
+ public
+ |
+
+ + $representedCountry + | +
+ #
+
+
+
+
+
+
+ Represented country data for the requested IP address. The represented +country is used for things like military bases or embassies. It is only present +when the represented country differs from the country. + + |
+
+ public
+ array
+ |
+
+ + $subdivisions + | +
+ #
+
+
+
+
+
+
+ An array of |
+
+ public
+ |
+
+ + $mostSpecificSubdivision + | +
+ #
+
+
+
+
+
+
+ An object representing the most specific subdivision returned. If the
+response did not contain any subdivisions, this method returns an empty |
+
+ public
+ |
+
+ + $traits + | +
+ #
+
+
+
+
+
+
+ Data for the traits of the requested IP address. + + |
+
This class provides a model for the data returned by the GeoIP2 Country end +point.
+ +The only difference between the City, City/ISP/Org, and Omni model classes is +which fields in each record may be populated. See http://dev.maxmind.com/geoip/geoip2/web-services +more details.
+ +
+ public
+ |
+
+ + $continent + | +
+ #
+
+
+
+
+
+
+ Continent data for the requested IP address. + + |
+
+ public
+ |
+
+ + $country + | +
+ #
+
+
+
+
+
+
+ Country data for the requested IP address. This object represents the country +where MaxMind believes the end user is located. + + |
+
+ public
+ |
+
+ + $maxmind + | +
+ #
+
+
+
+
+
+
+ Data related to your MaxMind account. + + |
+
+ public
+ |
+
+ + $registeredCountry + | +
+ #
+
+
+
+
+
+
+ Registered country data for the requested IP address. This record represents +the country where the ISP has registered a given IP block and may differ from +the user's country. + + |
+
+ public
+ |
+
+ + $representedCountry + | +
+ #
+
+
+
+
+
+
+ Represented country data for the requested IP address. The represented +country is used for things like military bases or embassies. It is only present +when the represented country differs from the country. + + |
+
+ public
+ |
+
+ + $traits + | +
+ #
+
+
+
+
+
+
+ Data for the traits of the requested IP address. + + |
+
This class provides a model for the data returned by the GeoIP2 Omni end +point.
+ +The only difference between the City, City/ISP/Org, and Omni model classes is +which fields in each record may be populated. See http://dev.maxmind.com/geoip/geoip2/web-services +more details.
+ +
+ GeoIp2\Model\City
+
+
+
+
+ GeoIp2\Model\CityIspOrg
+
+
+
+
+GeoIp2\Model\Omni
+
+
+
+ public
+ |
+
+ + $city + | +
+ #
+
+
+
+
+
+
+ City data for the requested IP address. + + |
+
+ public
+ |
+
+ + $continent + | +
+ #
+
+
+
+
+
+
+ Continent data for the requested IP address. + + |
+
+ public
+ |
+
+ + $country + | +
+ #
+
+
+
+
+
+
+ Country data for the requested IP address. This object represents the country +where MaxMind believes the end user is located. + + |
+
+ public
+ |
+
+ + $location + | +
+ #
+
+
+
+
+
+
+ Location data for the requested IP address. + + |
+
+ public
+ |
+
+ + $maxmind + | +
+ #
+
+
+
+
+
+
+ Data related to your MaxMind account. + + |
+
+ public
+ |
+
+ + $registeredCountry + | +
+ #
+
+
+
+
+
+
+ Registered country data for the requested IP address. This record represents +the country where the ISP has registered a given IP block and may differ from +the user's country. + + |
+
+ public
+ |
+
+ + $representedCountry + | +
+ #
+
+
+
+
+
+
+ Represented country data for the requested IP address. The represented +country is used for things like military bases or embassies. It is only present +when the represented country differs from the country. + + |
+
+ public
+ array
+ |
+
+ + $subdivisions + | +
+ #
+
+
+
+
+
+
+ An array of |
+
+ public
+ |
+
+ + $mostSpecificSubdivision + | +
+ #
+
+
+
+
+
+
+ An object representing the most specific subdivision returned. If the
+response did not contain any subdivisions, this method returns an empty |
+
+ public
+ |
+
+ + $traits + | +
+ #
+
+
+
+
+
+
+ Data for the traits of the requested IP address. + + |
+
+ public
+
+ |
+
+ + |
+ public
+
+ |
+
+ + |
+ public
+
+ |
+
+ + |
+ public
+
+ |
+
+ + |
+GeoIp2\Record\AbstractPlaceRecord
+
+
+ City-level data associated with an IP address.
+ +This record is returned by all the end points except the Country end +point.
+ +
+ GeoIp2\Record\AbstractPlaceRecord
+
+
+
+
+GeoIp2\Record\City
+
+
+
+ public
+ integer
+ |
+
+ + $confidence + | +
+ #
+
+
+
+
+
+
+ A value from 0-100 indicating MaxMind's confidence that the city is correct. +This attribute is only available from the Omni end point. + + |
+
+ public
+ integer
+ |
+
+ + $geonameId + | +
+ #
+
+
+
+
+
+
+ The GeoName ID for the city. This attribute is returned by all end +points. + + |
+
+ public
+ string
+ |
+
+ + $name + | +
+ #
+
+
+
+
+
+
+ The name of the city based on the locales list passed to the constructor. +This attribute is returned by all end points. + + |
+
+ public
+ array
+ |
+
+ + $names + | +
+ #
+
+
+
+
+
+
+ A array map where the keys are locale codes and the values are names. This +attribute is returned by all end points. + + |
+
Contains data for the continent record associated with an IP address
+ +This record is returned by all the end points.
+ +
+ GeoIp2\Record\AbstractPlaceRecord
+
+
+
+
+GeoIp2\Record\Continent
+
+
+
+ public
+ string
+ |
+
+ + $code + | +
+ #
+
+
+
+
+
+
+ A two character continent code like "NA" (North America) or "OC" (Oceania). +This attribute is returned by all end points. + + |
+
+ public
+ integer
+ |
+
+ + $geonameId + | +
+ #
+
+
+
+
+
+
+ The GeoName ID for the continent. This attribute is returned by all end +points. + + |
+
+ public
+ string
+ |
+
+ + $name + | +
+ #
+
+
+
+
+
+
+ Returns the name of the continent based on the locales list passed to the +constructor. This attribute is returned by all end points. + + |
+
+ public
+ array
+ |
+
+ + $names + | +
+ #
+
+
+
+
+
+
+ An array map where the keys are locale codes and the values are names. This +attribute is returned by all end points. + + |
+
Contains data for the country record associated with an IP address
+ +This record is returned by all the end points.
+ +
+ GeoIp2\Record\AbstractPlaceRecord
+
+
+
+
+GeoIp2\Record\Country
+
+
+
+ public
+ integer
+ |
+
+ + $confidence + | +
+ #
+
+
+
+
+
+
+ A value from 0-100 indicating MaxMind's confidence that the country is +correct. This attribute is only available from the Omni end point. + + |
+
+ public
+ integer
+ |
+
+ + $geonameId + | +
+ #
+
+
+
+
+
+
+ The GeoName ID for the country. This attribute is returned by all end +points. + + |
+
+ public
+ string
+ |
+
+ + $isoCode + | +
+ #
+
+
+
+
+
+
+ The two-character ISO 3166-1 alpha code for the country. This attribute is returned +by all end points. + + |
+
+ public
+ string
+ |
+
+ + $name + | +
+ #
+
+
+
+
+
+
+ The name of the country based on the locales list passed to the constructor. +This attribute is returned by all end points. + + |
+
+ public
+ array
+ |
+
+ + $names + | +
+ #
+
+
+
+
+
+
+ An array map where the keys are locale codes and the values are names. This +attribute is returned by all end points. + + |
+
Contains data for the location record associated with an IP address
+ +This record is returned by all the end points except the Country end +point.
+ +
+GeoIp2\Record\Location
+
+
+
+ public
+ integer
+ |
+
+ + $accuracyRadius + | +
+ #
+
+
+
+
+
+
+ The radius in kilometers around the specified location where the IP address +is likely to be. This attribute is only available from the Omni end point. + + |
+
+ public
+ float
+ |
+
+ + $latitude + | +
+ #
+
+
+
+
+
+
+ The latitude of the location as a floating point number. This attribute is +returned by all end points except the Country end point. + + |
+
+ public
+ float
+ |
+
+ + $longitude + | +
+ #
+
+
+
+
+
+
+ The longitude of the location as a floating point number. This attribute is +returned by all end points except the Country end point. + + |
+
+ public
+ integer
+ |
+
+ + $metroCode + | +
+ #
+
+
+
+
+
+
+ The metro code of the location if the location is in the US. MaxMind returns +the same metro codes as the Google AdWords API. This attribute is returned by all end points except the +Country end point. + + |
+
+ public
+ string
+ |
+
+ + $timeZone + | +
+ #
+
+
+
+
+
+
+ The time zone associated with location, as specified by the IANA +Time Zone Database, e.g., "America/New_York". This attribute is returned by all +end points except the Country end point. + + |
+
Contains data about your account.
+ +This record is returned by all the end points.
+ +
+GeoIp2\Record\MaxMind
+
+
+
+ public
+ integer
+ |
+
+ + $queriesRemaining + | +
+ #
+
+
+
+
+
+
+ The number of remaining queries you have for the end point you are +calling. + + |
+
Contains data for the postal record associated with an IP address
+ +This record is returned by all the end points except the Country end +point.
+ +
+GeoIp2\Record\Postal
+
+
+
+ public
+ string
+ |
+
+ + $code + | +
+ #
+
+
+
+
+
+
+ The postal code of the location. Postal codes are not available for all +countries. In some countries, this will only contain part of the postal code. +This attribute is returned by all end points except the Country end point. + + |
+
+ public
+ integer
+ |
+
+ + $confidence + | +
+ #
+
+
+
+
+
+
+ A value from 0-100 indicating MaxMind's confidence that the postal code is +correct. This attribute is only available from the Omni end point. + + |
+
Contains data for the represented country associated with an IP address
+ +This class contains the country-level data associated with an IP address for +the IP's represented country. The represented country is the country represented +by something like a military base or embassy.
+ +This record is returned by all the end points.
+ +
+ GeoIp2\Record\AbstractPlaceRecord
+
+
+
+
+ GeoIp2\Record\Country
+
+
+
+
+GeoIp2\Record\RepresentedCountry
+
+
+
+ public
+ integer
+ |
+
+ + $confidence + | +
+ #
+
+
+
+
+
+
+ A value from 0-100 indicating MaxMind's confidence that the country is +correct. This attribute is only available from the Omni end point. + + |
+
+ public
+ integer
+ |
+
+ + $geonameId + | +
+ #
+
+
+
+
+
+
+ The GeoName ID for the country. This attribute is returned by all end +points. + + |
+
+ public
+ string
+ |
+
+ + $isoCode + | +
+ #
+
+
+
+
+
+
+ The two-character ISO 3166-1 alpha code for the country. This attribute is returned +by all end points. + + |
+
+ public
+ string
+ |
+
+ + $name + | +
+ #
+
+
+
+
+
+
+ The name of the country based on the locales list passed to the constructor. +This attribute is returned by all end points. + + |
+
+ public
+ array
+ |
+
+ + $names + | +
+ #
+
+
+
+
+
+
+ An array map where the keys are locale codes and the values are names. This +attribute is returned by all end points. + + |
+
+ public
+ string
+ |
+
+ + $type + | +
+ #
+
+
+
+
+
+
+ A string indicating the type of entity that is representing the country.
+Currently we only return |
+
Contains data for the subdivisions associated with an IP address
+ +This record is returned by all the end points except the Country end +point.
+ +
+ GeoIp2\Record\AbstractPlaceRecord
+
+
+
+
+GeoIp2\Record\Subdivision
+
+
+
+ public
+ integer
+ |
+
+ + $confidence + | +
+ #
+
+
+
+
+
+
+ This is a value from 0-100 indicating MaxMind's confidence that the +subdivision is correct. This attribute is only available from the Omni end +point. + + |
+
+ public
+ integer
+ |
+
+ + $geonameId + | +
+ #
+
+
+
+
+
+
+ This is a GeoName ID for the subdivision. This attribute is returned by all +end points except Country. + + |
+
+ public
+ string
+ |
+
+ + $isoCode + | +
+ #
+
+
+
+
+
+
+ This is a string up to three characters long contain the subdivision portion +of the ISO 3166-2 code. This attribute is returned by all end points except +Country. + + |
+
+ public
+ string
+ |
+
+ + $name + | +
+ #
+
+
+
+
+
+
+ The name of the subdivision based on the locales list passed to the +constructor. This attribute is returned by all end points except Country. + + |
+
+ public
+ array
+ |
+
+ + $names + | +
+ #
+
+
+
+
+
+
+ An array map where the keys are locale codes and the values are names. This +attribute is returned by all end points except Country. + + |
+
Contains data for the traits record associated with an IP address
+ +This record is returned by all the end points.
+ +
+GeoIp2\Record\Traits
+
+
+
+ public
+ integer
+ |
+
+ + $autonomousSystemNumber + | +
+ #
+
+
+
+
+
+
+ The autonomous system number associated with the IP address. This attribute is only +available from the City/ISP/Org and Omni end points. + + |
+
+ public
+ string
+ |
+
+ + $autonomousSystemOrganization + | +
+ #
+
+
+
+
+
+
+ The organization associated with the registered autonomous system number for the IP address. This attribute is only available +from the City/ISP/Org and Omni end points. + + |
+
+ public
+ string
+ |
+
+ + $domain + | +
+ #
+
+
+
+
+
+
+ The second level domain associated with the IP address. This will be +something like "example.com" or "example.co.uk", not "foo.example.com". This +attribute is only available from the City/ISP/Org and Omni end points. + + |
+
+ public
+ string
+ |
+
+ + $ipAddress + | +
+ #
+
+
+
+
+
+
+ The IP address that the data in the model is for. If you performed a "me" +lookup against the web service, this will be the externally routable IP address +for the system the code is running on. If the system is behind a NAT, this may +differ from the IP address locally assigned to it. This attribute is returned by +all end points. + + |
+
+ public
+ boolean
+ |
+
+ + $isAnonymousProxy + | +
+ #
+
+
+
+
+
+
+ This is true if the IP is an anonymous proxy. See http://dev.maxmind.com/faq/geoip#anonproxy +for further details. This attribute is returned by all end points. + + |
+
+ public
+ boolean
+ |
+
+ + $isSatelliteProvider + | +
+ #
+
+
+
+
+
+
+ This is true if the IP belongs to a satellite Internet provider. This +attribute is returned by all end points. + + |
+
+ public
+ string
+ |
+
+ + $isp + | +
+ #
+
+
+
+
+
+
+ The name of the ISP associated with the IP address. This attribute is only +available from the City/ISP/Org and Omni end points. + + |
+
+ public
+ string
+ |
+
+ + $organization + | +
+ #
+
+
+
+
+
+
+ The name of the organization associated with the IP address. This attribute +is only available from the City/ISP/Org and Omni end points. + + |
+
+ public
+ string
+ |
+
+ + $userType + | +
+ #
+
+
+
+
+
+
+ The user type associated with the IP address. This can be one of the +following values: + +
This attribute is only available from the Omni end point. + + |
+
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.
+ +
+ public
+
+
+
+ |
+
+
+ #
+ __construct( integer $userId, string $licenseKey, array $locales = array('en'), string $host = 'geoip.maxmind.com', object $guzzleClient = null )
+
+
+
+
+
+
+ Constructor. + + |
+
+ public
+
+ |
+
+ + |
+ public
+
+ |
+
+ + |
+ public
+
+ |
+
+
+ #
+ cityIspOrg( string $ipAddress = 'me' )
+
+
+
+
+
+
+ This method calls the GeoIP2 City/ISP/Org endpoint. + + |
+
+ public
+
+ |
+
+ + |
| GeoIp2 | +
| GeoIp2\Database | +
| GeoIp2\Exception | +
| GeoIp2\Model | +
| GeoIp2\Record | +
| GeoIp2\WebService | +
| PHP | +
| Reader | +Instances of this class provide a reader for the GeoIP2 database format. IP
+addresses can be looked up using the country and city
+methods. We also provide cityIspOrg and omni methods
+to ease compatibility with the web service client, although we may offer the
+ability to specify additional databases to replicate these web services in the
+future (e.g., the ISP/Org database). |
+
| AddressNotFoundException | +This class represents a generic error. | +
| AuthenticationException | +This class represents a generic error. | +
| GeoIp2Exception | +This class represents a generic error. | +
| HttpException | +This class represents an HTTP transport error. | +
| InvalidRequestException | +This class represents an error returned by MaxMind's GeoIP2 web service. | +
| OutOfQueriesException | +This class represents a generic error. | +
| City | +This class provides a model for the data returned by the GeoIP2 City end point. | +
| CityIspOrg | +This class provides a model for the data returned by the GeoIP2 City/ISP/Org end +point. | +
| Country | +This class provides a model for the data returned by the GeoIP2 Country end +point. | +
| Omni | +This class provides a model for the data returned by the GeoIP2 Omni end point. | +
| AbstractPlaceRecord | ++ |
| AbstractRecord | ++ |
| City | +City-level data associated with an IP address. | +
| Continent | +Contains data for the continent record associated with an IP address | +
| Country | +Contains data for the country record associated with an IP address | +
| Location | +Contains data for the location record associated with an IP address | +
| MaxMind | +Contains data about your account. | +
| Postal | +Contains data for the postal record associated with an IP address | +
| RepresentedCountry | +Contains data for the represented country associated with an IP address | +
| Subdivision | ++ |
| Traits | ++ |
| 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. | +
| GeoIp2\Database | +
| GeoIp2\Exception | +
| GeoIp2\Model | +
| GeoIp2\Record | +
| GeoIp2\WebService | +
| ProviderInterface | ++ | +
| Exception | ++ |
| t |
| 's parent ( |
| itself.
+ */
+jQuery.fn.sortElements = (function(){
+
+ var sort = [].sort;
+
+ return function(comparator, getSortable) {
+
+ getSortable = getSortable || function(){return this;};
+
+ var placements = this.map(function(){
+
+ var sortElement = getSortable.call(this),
+ parentNode = sortElement.parentNode,
+
+ // Since the element itself will change position, we have
+ // to have some way of storing it's original position in
+ // the DOM. The easiest way is to have a 'flag' node:
+ nextSibling = parentNode.insertBefore(
+ document.createTextNode(''),
+ sortElement.nextSibling
+ );
+
+ return function() {
+
+ if (parentNode === this) {
+ throw new Error(
+ "You can't sort elements if any one is a descendant of another."
+ );
+ }
+
+ // Insert before flag:
+ parentNode.insertBefore(this, nextSibling);
+ // Remove flag:
+ parentNode.removeChild(nextSibling);
+
+ };
+
+ });
+
+ return sort.call(this, comparator).each(function(i){
+ placements[i].call(getSortable.call(this));
+ });
+
+ };
+
+})();
+/*!
+ * ApiGen 2.8.0 - API documentation generator for PHP 5.3+
+ *
+ * Copyright (c) 2010-2011 David Grudl (http://davidgrudl.com)
+ * Copyright (c) 2011-2012 Jaroslav Hanslík (https://github.com/kukulich)
+ * Copyright (c) 2011-2012 Ondřej Nešpor (https://github.com/Andrewsville)
+ *
+ * For the full copyright and license information, please view
+ * the file LICENSE.md that was distributed with this source code.
+ */
+
+$(function() {
+ var $document = $(document);
+ var $left = $('#left');
+ var $right = $('#right');
+ var $rightInner = $('#rightInner');
+ var $splitter = $('#splitter');
+ var $groups = $('#groups');
+ var $content = $('#content');
+
+ // Menu
+
+ // Hide deep packages and namespaces
+ $('ul span', $groups).click(function(event) {
+ event.preventDefault();
+ event.stopPropagation();
+ $(this)
+ .toggleClass('collapsed')
+ .parent()
+ .next('ul')
+ .toggleClass('collapsed');
+ }).click();
+
+ $active = $('ul li.active', $groups);
+ if ($active.length > 0) {
+ // Open active
+ $('> a > span', $active).click();
+ } else {
+ $main = $('> ul > li.main', $groups);
+ if ($main.length > 0) {
+ // Open first level of the main project
+ $('> a > span', $main).click();
+ } else {
+ // Open first level of all
+ $('> ul > li > a > span', $groups).click();
+ }
+ }
+
+ // Content
+
+ // Search autocompletion
+ var autocompleteFound = false;
+ var autocompleteFiles = {'c': 'class', 'co': 'constant', 'f': 'function', 'm': 'class', 'mm': 'class', 'p': 'class', 'mp': 'class', 'cc': 'class'};
+ var $search = $('#search input[name=q]');
+ $search
+ .autocomplete(ApiGen.elements, {
+ matchContains: true,
+ scrollHeight: 200,
+ max: 20,
+ formatItem: function(data) {
+ return data[1].replace(/^(.+\\)(.+)$/, '$1$2');
+ },
+ formatMatch: function(data) {
+ return data[1];
+ },
+ formatResult: function(data) {
+ return data[1];
+ },
+ show: function($list) {
+ var $items = $('li span', $list);
+ var maxWidth = Math.max.apply(null, $items.map(function() {
+ return $(this).width();
+ }));
+ // 10px padding
+ $list
+ .width(Math.max(maxWidth + 10, $search.innerWidth()))
+ .css('left', $search.offset().left + $search.outerWidth() - $list.outerWidth());
+ }
+ }).result(function(event, data) {
+ autocompleteFound = true;
+ var location = window.location.href.split('/');
+ location.pop();
+ var parts = data[1].split(/::|$/);
+ var file = $.sprintf(ApiGen.config.templates.main[autocompleteFiles[data[0]]].filename, parts[0].replace(/[^\w]/g, '.'));
+ if (parts[1]) {
+ file += '#' + ('mm' === data[0] || 'mp' === data[0] ? 'm' : '') + parts[1].replace(/([\w]+)\(\)/, '_$1');
+ }
+ location.push(file);
+ window.location = location.join('/');
+
+ // Workaround for Opera bug
+ $(this).closest('form').attr('action', location.join('/'));
+ }).closest('form')
+ .submit(function() {
+ var query = $search.val();
+ if ('' === query) {
+ return false;
+ }
+
+ var label = $('#search input[name=more]').val();
+ if (!autocompleteFound && label && -1 === query.indexOf('more:')) {
+ $search.val(query + ' more:' + label);
+ }
+
+ return !autocompleteFound && '' !== $('#search input[name=cx]').val();
+ });
+
+ // Save natural order
+ $('table.summary tr[data-order]', $content).each(function(index) {
+ do {
+ index = '0' + index;
+ } while (index.length < 3);
+ $(this).attr('data-order-natural', index);
+ });
+
+ // Switch between natural and alphabetical order
+ var $caption = $('table.summary', $content)
+ .filter(':has(tr[data-order])')
+ .find('caption');
+ $caption
+ .click(function() {
+ var $this = $(this);
+ var order = $this.data('order') || 'natural';
+ order = 'natural' === order ? 'alphabetical' : 'natural';
+ $this.data('order', order);
+ $.cookie('order', order, {expires: 365});
+ var attr = 'alphabetical' === order ? 'data-order' : 'data-order-natural';
+ $this
+ .closest('table')
+ .find('tr').sortElements(function(a, b) {
+ return $(a).attr(attr) > $(b).attr(attr) ? 1 : -1;
+ });
+ return false;
+ })
+ .addClass('switchable')
+ .attr('title', 'Switch between natural and alphabetical order');
+ if ((null === $.cookie('order') && 'alphabetical' === ApiGen.config.options.elementsOrder) || 'alphabetical' === $.cookie('order')) {
+ $caption.click();
+ }
+
+ // Open details
+ if (ApiGen.config.options.elementDetailsCollapsed) {
+ $('tr', $content).filter(':has(.detailed)')
+ .click(function() {
+ var $this = $(this);
+ $('.short', $this).hide();
+ $('.detailed', $this).show();
+ });
+ }
+
+ // Splitter
+ var splitterWidth = $splitter.width();
+ function setSplitterPosition(position)
+ {
+ $left.width(position);
+ $right.css('margin-left', position + splitterWidth);
+ $splitter.css('left', position);
+ }
+ function setNavigationPosition()
+ {
+ var width = $rightInner.width();
+ $rightInner
+ .toggleClass('medium', width <= 960)
+ .toggleClass('small', width <= 650);
+ }
+ $splitter.mousedown(function() {
+ $splitter.addClass('active');
+
+ $document.mousemove(function(event) {
+ if (event.pageX >= 230 && $document.width() - event.pageX >= 600 + splitterWidth) {
+ setSplitterPosition(event.pageX);
+ setNavigationPosition();
+ }
+ });
+
+ $()
+ .add($splitter)
+ .add($document)
+ .mouseup(function() {
+ $splitter
+ .removeClass('active')
+ .unbind('mouseup');
+ $document
+ .unbind('mousemove')
+ .unbind('mouseup');
+
+ $.cookie('splitter', parseInt($splitter.css('left')), {expires: 365});
+ });
+
+ return false;
+ });
+ var splitterPosition = $.cookie('splitter');
+ if (null !== splitterPosition) {
+ setSplitterPosition(parseInt(splitterPosition));
+ }
+ setNavigationPosition();
+ $(window).resize(setNavigationPosition);
+
+ // Select selected lines
+ var matches = window.location.hash.substr(1).match(/^\d+(?:-\d+)?(?:,\d+(?:-\d+)?)*$/);
+ if (null !== matches) {
+ var lists = matches[0].split(',');
+ for (var i = 0; i < lists.length; i++) {
+ var lines = lists[i].split('-');
+ lines[1] = lines[1] || lines[0];
+ for (var j = lines[0]; j <= lines[1]; j++) {
+ $('#' + j).addClass('selected');
+ }
+ }
+
+ var $firstLine = $('#' + parseInt(matches[0]));
+ if ($firstLine.length > 0) {
+ $right.scrollTop($firstLine.offset().top);
+ }
+ }
+
+ // Save selected lines
+ var lastLine;
+ $('a.l').click(function(event) {
+ event.preventDefault();
+
+ var $selectedLine = $(this).parent();
+ var selectedLine = parseInt($selectedLine.attr('id'));
+
+ if (event.shiftKey) {
+ if (lastLine) {
+ for (var i = Math.min(selectedLine, lastLine); i <= Math.max(selectedLine, lastLine); i++) {
+ $('#' + i).addClass('selected');
+ }
+ } else {
+ $selectedLine.addClass('selected');
+ }
+ } else if (event.ctrlKey) {
+ $selectedLine.toggleClass('selected');
+ } else {
+ var $selected = $('.l.selected')
+ .not($selectedLine)
+ .removeClass('selected');
+ if ($selected.length > 0) {
+ $selectedLine.addClass('selected');
+ } else {
+ $selectedLine.toggleClass('selected');
+ }
+ }
+
+ lastLine = $selectedLine.hasClass('selected') ? selectedLine : null;
+
+ // Update hash
+ var lines = $('.l.selected')
+ .map(function() {
+ return parseInt($(this).attr('id'));
+ })
+ .get()
+ .sort(function(a, b) {
+ return a - b;
+ });
+
+ var hash = [];
+ var list = [];
+ for (var j = 0; j < lines.length; j++) {
+ if (0 === j && j + 1 === lines.length) {
+ hash.push(lines[j]);
+ } else if (0 === j) {
+ list[0] = lines[j];
+ } else if (lines[j - 1] + 1 !== lines[j] && j + 1 === lines.length) {
+ hash.push(list.join('-'));
+ hash.push(lines[j]);
+ } else if (lines[j - 1] + 1 !== lines[j]) {
+ hash.push(list.join('-'));
+ list = [lines[j]];
+ } else if (j + 1 === lines.length) {
+ list[1] = lines[j];
+ hash.push(list.join('-'));
+ } else {
+ list[1] = lines[j];
+ }
+ }
+
+ window.location.hash = hash.join(',');
+ });
+});
+
diff --git a/doc/v0.5.0/resources/footer.png b/doc/v0.5.0/resources/footer.png
new file mode 100644
index 0000000..51f4a7f
Binary files /dev/null and b/doc/v0.5.0/resources/footer.png differ
diff --git a/doc/v0.5.0/resources/inherit.png b/doc/v0.5.0/resources/inherit.png
new file mode 100644
index 0000000..957079b
Binary files /dev/null and b/doc/v0.5.0/resources/inherit.png differ
diff --git a/doc/v0.5.0/resources/resize.png b/doc/v0.5.0/resources/resize.png
new file mode 100644
index 0000000..fb98a7a
Binary files /dev/null and b/doc/v0.5.0/resources/resize.png differ
diff --git a/doc/v0.5.0/resources/sort.png b/doc/v0.5.0/resources/sort.png
new file mode 100644
index 0000000..0d0fea1
Binary files /dev/null and b/doc/v0.5.0/resources/sort.png differ
diff --git a/doc/v0.5.0/resources/style.css b/doc/v0.5.0/resources/style.css
new file mode 100644
index 0000000..f361474
--- /dev/null
+++ b/doc/v0.5.0/resources/style.css
@@ -0,0 +1,608 @@
+/*!
+ * ApiGen 2.8.0 - API documentation generator for PHP 5.3+
+ *
+ * Copyright (c) 2010-2011 David Grudl (http://davidgrudl.com)
+ * Copyright (c) 2011-2012 Jaroslav Hanslík (https://github.com/kukulich)
+ * Copyright (c) 2011-2012 Ondřej Nešpor (https://github.com/Andrewsville)
+ *
+ * For the full copyright and license information, please view
+ * the file LICENSE.md that was distributed with this source code.
+ */
+
+body {
+ font: 13px/1.5 Verdana, 'Geneva CE', lucida, sans-serif;
+ margin: 0;
+ padding: 0;
+ background: #ffffff;
+ color: #333333;
+}
+
+h1, h2, h3, h4, caption {
+ font-family: 'Trebuchet MS', 'Geneva CE', lucida, sans-serif;
+ color: #053368;
+}
+
+h1 {
+ color: #1e5eb6;
+ font-size: 230%;
+ font-weight: normal;
+ margin: .3em 0;
+}
+
+h2 {
+ color: #1e5eb6;
+ font-size: 150%;
+ font-weight: normal;
+ margin: -.3em 0 .3em 0;
+}
+
+h3 {
+ font-size: 1.6em;
+ font-weight: normal;
+ margin-bottom: 2px;
+}
+
+h4 {
+ font-size: 100%;
+ font-weight: bold;
+ padding: 0;
+ margin: 0;
+}
+
+caption {
+ border: 1px solid #cccccc;
+ background: #ecede5;
+ font-weight: bold;
+ font-size: 1.2em;
+ padding: 3px 5px;
+ text-align: left;
+ margin-bottom: 0;
+}
+
+p {
+ margin: .7em 0 1em;
+ padding: 0;
+}
+
+hr {
+ margin: 2em 0 1em;
+ border: none;
+ border-top: 1px solid #cccccc;
+ height: 0;
+}
+
+a {
+ color: #006aeb;
+ padding: 3px 1px;
+ text-decoration: none;
+}
+
+h1 a {
+ color: #1e5eb6;
+}
+
+a:hover, a:active, a:focus, a:hover b, a:hover var {
+ background-color: #006aeb;
+ color: #ffffff !important;
+}
+
+code, var, pre {
+ font-family: monospace;
+}
+
+var {
+ font-weight: bold;
+ font-style: normal;
+ color: #ca8a04;
+}
+
+pre {
+ margin: 0;
+}
+
+code a b {
+ color: #000000;
+}
+
+.deprecated {
+ text-decoration: line-through;
+}
+
+.invalid {
+ color: #e71818;
+}
+
+.hidden {
+ display: none;
+}
+
+/* Left side */
+#left {
+ overflow: auto;
+ width: 270px;
+ height: 100%;
+ position: fixed;
+}
+
+/* Menu */
+#menu {
+ padding: 10px;
+}
+
+#menu ul {
+ list-style: none;
+ padding: 0;
+ margin: 0;
+}
+
+#menu ul ul {
+ padding-left: 10px;
+}
+
+#menu li {
+ white-space: nowrap;
+ position: relative;
+}
+
+#menu a {
+ display: block;
+ padding: 0 2px;
+}
+
+#menu .active > a, #menu > span {
+ color: #333333;
+ background: none;
+ font-weight: bold;
+}
+
+#menu .active > a.invalid {
+ color: #e71818;
+}
+
+#menu .active > a:hover, #menu .active > a:active, #menu .active > a:focus {
+ background-color: #006aeb;
+}
+
+#menu #groups span {
+ position: absolute;
+ top: 4px;
+ right: 2px;
+ cursor: pointer;
+ display: block;
+ width: 12px;
+ height: 12px;
+ background: url('collapsed.png') transparent 0 0 no-repeat;
+}
+
+#menu #groups span:hover {
+ background-position: -12px 0;
+}
+
+#menu #groups span.collapsed {
+ background-position: 0 -12px;
+}
+
+#menu #groups span.collapsed:hover {
+ background-position: -12px -12px;
+}
+
+#menu #groups ul.collapsed {
+ display: none;
+}
+
+/* Right side */
+#right {
+ overflow: auto;
+ margin-left: 275px;
+ height: 100%;
+ position: fixed;
+ left: 0;
+ right: 0;
+}
+
+#rightInner {
+ max-width: 1000px;
+ min-width: 350px;
+}
+
+/* Search */
+#search {
+ float: right;
+ margin: 3px 8px;
+}
+
+#search input.text {
+ padding: 3px 5px;
+ width: 250px;
+}
+
+/* Autocomplete */
+.ac_results {
+ padding: 0;
+ border: 1px solid #cccccc;
+ background-color: #ffffff;
+ overflow: hidden;
+ z-index: 99999;
+}
+
+.ac_results ul {
+ width: 100%;
+ list-style-position: outside;
+ list-style: none;
+ padding: 0;
+ margin: 0;
+}
+
+.ac_results li {
+ margin: 0;
+ padding: 2px 5px;
+ cursor: default;
+ display: block;
+ font: 12px 'Trebuchet MS', 'Geneva CE', lucida, sans-serif;
+ line-height: 16px;
+ overflow: hidden;
+ white-space: nowrap;
+}
+
+.ac_results li strong {
+ color: #000000;
+}
+
+.ac_odd {
+ background-color: #eeeeee;
+}
+
+.ac_over {
+ background-color: #006aeb;
+ color: #ffffff;
+}
+
+.ac_results li.ac_over strong {
+ color: #ffffff;
+}
+
+/* Navigation */
+#navigation {
+ padding: 3px 8px;
+ background-color: #f6f6f4;
+ height: 26px;
+}
+
+#navigation ul {
+ list-style: none;
+ margin: 0 8px 4px 0;
+ padding: 0;
+ overflow: hidden;
+ float: left;
+}
+
+#navigation ul + ul {
+ border-left: 1px solid #000000;
+ padding-left: 8px;
+}
+
+#navigation ul li {
+ float: left;
+ margin: 2px;
+ padding: 0 3px;
+ font-family: Verdana, 'Geneva CE', lucida, sans-serif;
+ color: #808080;
+}
+
+#navigation ul li.active {
+ background-color: #053368;
+ color: #ffffff;
+ font-weight: bold;
+}
+
+#navigation ul li a {
+ color: #000000;
+ font-weight: bold;
+ padding: 0;
+}
+
+#navigation ul li span {
+ float: left;
+ padding: 0 3px;
+}
+
+#navigation ul li a:hover span, #navigation ul li a:active span, #navigation ul li a:focus span {
+ background-color: #006aeb;
+}
+
+/* Content */
+#content {
+ clear: both;
+ padding: 5px 15px;
+}
+
+.description pre {
+ padding: .6em;
+ background: #fcfcf7;
+}
+
+#content > .description {
+ background: #ecede5;
+ padding: 1px 8px;
+ margin: 1.2em 0;
+}
+
+#content > .description pre {
+ margin: .5em 0;
+}
+
+dl.tree {
+ margin: 1.2em 0;
+}
+
+dl.tree dd {
+ margin: 0;
+ padding: 0;
+}
+
+.info {
+ margin: 1.2em 0;
+}
+
+.summary {
+ border: 1px solid #cccccc;
+ border-collapse: collapse;
+ font-size: 1em;
+ width: 100%;
+ margin: 1.2em 0 2.4em;
+}
+
+.summary caption {
+ border-width: 1px 1px 0;
+}
+
+.summary caption.switchable {
+ background: #ecede5 url('sort.png') no-repeat center right;
+ cursor: pointer;
+}
+
+.summary td {
+ border: 1px solid #cccccc;
+ margin: 0;
+ padding: 3px 10px;
+ font-size: 1em;
+ vertical-align: top;
+}
+
+.summary td:first-child {
+ text-align: right;
+}
+
+#packages.summary td:first-child, #namespaces.summary td:first-child, .inherited.summary td:first-child, .used.summary td:first-child {
+ text-align: left;
+}
+
+.summary tr:hover td {
+ background: #f6f6f4;
+}
+
+.summary .description pre {
+ border: .5em solid #ecede5;
+}
+
+.summary .description p {
+ margin: 0;
+}
+
+.summary .description p + p, .summary .description ul {
+ margin: 3px 0 0 0;
+}
+
+.summary .description.detailed h4 {
+ margin-top: 3px;
+}
+
+.summary dl {
+ margin: 0;
+}
+
+.summary dd {
+ margin: 0 0 0 25px;
+}
+
+.name, .attributes {
+ white-space: nowrap;
+}
+
+.value {
+ white-space: pre-wrap;
+}
+
+td.name, td.attributes {
+ width: 1%;
+}
+
+.class #methods .name {
+ width: auto;
+ white-space: normal;
+}
+
+.class #methods .name > div > code {
+ white-space: pre-wrap;
+}
+
+.class #methods .name > div > code span, .function .value > code {
+ white-space: nowrap;
+}
+
+.class #methods td.name > div, .class td.description > div {
+ position: relative;
+ padding-right: 1em;
+}
+
+.anchor {
+ position: absolute;
+ top: 0;
+ right: 0;
+ line-height: 1;
+ font-size: 85%;
+ margin: 0;
+ color: #006aeb !important;
+}
+
+.list {
+ margin: 0 0 5px 25px;
+}
+
+div.invalid {
+ background-color: #fae4e0;
+ padding: 10px;
+}
+
+/* Splitter */
+#splitter {
+ position: fixed;
+ height: 100%;
+ width: 5px;
+ left: 270px;
+ background: #1e5eb6 url('resize.png') left center no-repeat;
+ cursor: e-resize;
+}
+
+#splitter.active {
+ opacity: .5;
+}
+
+/* Footer */
+#footer {
+ border-top: 1px solid #e9eeef;
+ clear: both;
+ color: #a7a7a7;
+ font-size: 8pt;
+ text-align: center;
+ padding: 20px 0 0;
+ margin: 3em 0 0;
+ height: 90px;
+ background: #ffffff url('footer.png') no-repeat center top;
+}
+
+/* Tree */
+div.tree ul {
+ list-style: none;
+ background: url('tree-vertical.png') left repeat-y;
+ padding: 0;
+ margin-left: 20px;
+}
+
+div.tree li {
+ margin: 0;
+ padding: 0;
+}
+
+div.tree div {
+ padding-left: 30px;
+}
+
+div.tree div.notlast {
+ background: url('tree-hasnext.png') left 10px no-repeat;
+}
+
+div.tree div.last {
+ background: url('tree-last.png') left -240px no-repeat;
+}
+
+div.tree li.last {
+ background: url('tree-cleaner.png') left center repeat-y;
+}
+
+div.tree span.padding {
+ padding-left: 15px;
+}
+
+/* Source code */
+.php-keyword1 {
+ color: #e71818;
+ font-weight: bold;
+}
+
+.php-keyword2 {
+ font-weight: bold;
+}
+
+.php-var {
+ color: #d59401;
+ font-weight: bold;
+}
+
+.php-num {
+ color: #cd0673;
+}
+
+.php-quote {
+ color: #008000;
+}
+
+.php-comment {
+ color: #929292;
+}
+
+.xlang {
+ color: #ff0000;
+ font-weight: bold;
+}
+
+span.l {
+ display: block;
+}
+
+span.l.selected {
+ background: #f6f6f4;
+}
+
+span.l a {
+ color: #333333;
+}
+
+span.l a:hover, div.l a:active, div.l a:focus {
+ background: transparent;
+ color: #333333 !important;
+}
+
+span.l .php-var a {
+ color: #d59401;
+}
+
+span.l .php-var a:hover, span.l .php-var a:active, span.l .php-var a:focus {
+ color: #d59401 !important;
+}
+
+span.l a.l {
+ padding-left: 2px;
+ color: #c0c0c0;
+}
+
+span.l a.l:hover, span.l a.l:active, span.l a.l:focus {
+ background: transparent;
+ color: #c0c0c0 !important;
+}
+
+#rightInner.medium #navigation {
+ height: 52px;
+}
+
+#rightInner.medium #navigation ul:first-child + ul {
+ clear: left;
+ border: none;
+ padding: 0;
+}
+
+#rightInner.medium .name, #rightInner.medium .attributes {
+ white-space: normal;
+}
+
+#rightInner.small #search {
+ float: left;
+}
+
+#rightInner.small #navigation {
+ height: 78px;
+}
+
+#rightInner.small #navigation ul:first-child {
+ clear: both;
+}
diff --git a/doc/v0.5.0/resources/tree-cleaner.png b/doc/v0.5.0/resources/tree-cleaner.png
new file mode 100644
index 0000000..2eb9085
Binary files /dev/null and b/doc/v0.5.0/resources/tree-cleaner.png differ
diff --git a/doc/v0.5.0/resources/tree-hasnext.png b/doc/v0.5.0/resources/tree-hasnext.png
new file mode 100644
index 0000000..91d6b79
Binary files /dev/null and b/doc/v0.5.0/resources/tree-hasnext.png differ
diff --git a/doc/v0.5.0/resources/tree-last.png b/doc/v0.5.0/resources/tree-last.png
new file mode 100644
index 0000000..7f319f8
Binary files /dev/null and b/doc/v0.5.0/resources/tree-last.png differ
diff --git a/doc/v0.5.0/resources/tree-vertical.png b/doc/v0.5.0/resources/tree-vertical.png
new file mode 100644
index 0000000..384908b
Binary files /dev/null and b/doc/v0.5.0/resources/tree-vertical.png differ
diff --git a/doc/v0.5.0/source-class-GeoIp2.Database.Reader.html b/doc/v0.5.0/source-class-GeoIp2.Database.Reader.html
new file mode 100644
index 0000000..4bbe339
--- /dev/null
+++ b/doc/v0.5.0/source-class-GeoIp2.Database.Reader.html
@@ -0,0 +1,252 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/v0.5.0/source-class-GeoIp2.Exception.AddressNotFoundException.html b/doc/v0.5.0/source-class-GeoIp2.Exception.AddressNotFoundException.html
new file mode 100644
index 0000000..1659351
--- /dev/null
+++ b/doc/v0.5.0/source-class-GeoIp2.Exception.AddressNotFoundException.html
@@ -0,0 +1,118 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/v0.5.0/source-class-GeoIp2.Exception.AuthenticationException.html b/doc/v0.5.0/source-class-GeoIp2.Exception.AuthenticationException.html
new file mode 100644
index 0000000..982eb39
--- /dev/null
+++ b/doc/v0.5.0/source-class-GeoIp2.Exception.AuthenticationException.html
@@ -0,0 +1,118 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/v0.5.0/source-class-GeoIp2.Exception.GeoIp2Exception.html b/doc/v0.5.0/source-class-GeoIp2.Exception.GeoIp2Exception.html
new file mode 100644
index 0000000..01bbd5d
--- /dev/null
+++ b/doc/v0.5.0/source-class-GeoIp2.Exception.GeoIp2Exception.html
@@ -0,0 +1,118 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/v0.5.0/source-class-GeoIp2.Exception.HttpException.html b/doc/v0.5.0/source-class-GeoIp2.Exception.HttpException.html
new file mode 100644
index 0000000..0b519de
--- /dev/null
+++ b/doc/v0.5.0/source-class-GeoIp2.Exception.HttpException.html
@@ -0,0 +1,133 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/v0.5.0/source-class-GeoIp2.Exception.InvalidRequestException.html b/doc/v0.5.0/source-class-GeoIp2.Exception.InvalidRequestException.html
new file mode 100644
index 0000000..7d044eb
--- /dev/null
+++ b/doc/v0.5.0/source-class-GeoIp2.Exception.InvalidRequestException.html
@@ -0,0 +1,134 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/v0.5.0/source-class-GeoIp2.Exception.OutOfQueriesException.html b/doc/v0.5.0/source-class-GeoIp2.Exception.OutOfQueriesException.html
new file mode 100644
index 0000000..8e92fad
--- /dev/null
+++ b/doc/v0.5.0/source-class-GeoIp2.Exception.OutOfQueriesException.html
@@ -0,0 +1,118 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/v0.5.0/source-class-GeoIp2.Model.City.html b/doc/v0.5.0/source-class-GeoIp2.Model.City.html
new file mode 100644
index 0000000..631ce1a
--- /dev/null
+++ b/doc/v0.5.0/source-class-GeoIp2.Model.City.html
@@ -0,0 +1,226 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/v0.5.0/source-class-GeoIp2.Model.CityIspOrg.html b/doc/v0.5.0/source-class-GeoIp2.Model.CityIspOrg.html
new file mode 100644
index 0000000..a3899f6
--- /dev/null
+++ b/doc/v0.5.0/source-class-GeoIp2.Model.CityIspOrg.html
@@ -0,0 +1,163 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/v0.5.0/source-class-GeoIp2.Model.Country.html b/doc/v0.5.0/source-class-GeoIp2.Model.Country.html
new file mode 100644
index 0000000..171358f
--- /dev/null
+++ b/doc/v0.5.0/source-class-GeoIp2.Model.Country.html
@@ -0,0 +1,201 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/v0.5.0/source-class-GeoIp2.Model.Omni.html b/doc/v0.5.0/source-class-GeoIp2.Model.Omni.html
new file mode 100644
index 0000000..af822a7
--- /dev/null
+++ b/doc/v0.5.0/source-class-GeoIp2.Model.Omni.html
@@ -0,0 +1,163 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/v0.5.0/source-class-GeoIp2.ProviderInterface.html b/doc/v0.5.0/source-class-GeoIp2.ProviderInterface.html
new file mode 100644
index 0000000..9550f06
--- /dev/null
+++ b/doc/v0.5.0/source-class-GeoIp2.ProviderInterface.html
@@ -0,0 +1,137 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/v0.5.0/source-class-GeoIp2.Record.AbstractPlaceRecord.html b/doc/v0.5.0/source-class-GeoIp2.Record.AbstractPlaceRecord.html
new file mode 100644
index 0000000..bdf8d8f
--- /dev/null
+++ b/doc/v0.5.0/source-class-GeoIp2.Record.AbstractPlaceRecord.html
@@ -0,0 +1,151 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/v0.5.0/source-class-GeoIp2.Record.AbstractRecord.html b/doc/v0.5.0/source-class-GeoIp2.Record.AbstractRecord.html
new file mode 100644
index 0000000..f6114bd
--- /dev/null
+++ b/doc/v0.5.0/source-class-GeoIp2.Record.AbstractRecord.html
@@ -0,0 +1,147 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/v0.5.0/source-class-GeoIp2.Record.City.html b/doc/v0.5.0/source-class-GeoIp2.Record.City.html
new file mode 100644
index 0000000..0d7dbd2
--- /dev/null
+++ b/doc/v0.5.0/source-class-GeoIp2.Record.City.html
@@ -0,0 +1,142 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/v0.5.0/source-class-GeoIp2.Record.Continent.html b/doc/v0.5.0/source-class-GeoIp2.Record.Continent.html
new file mode 100644
index 0000000..758824d
--- /dev/null
+++ b/doc/v0.5.0/source-class-GeoIp2.Record.Continent.html
@@ -0,0 +1,146 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/v0.5.0/source-class-GeoIp2.Record.Country.html b/doc/v0.5.0/source-class-GeoIp2.Record.Country.html
new file mode 100644
index 0000000..9453129
--- /dev/null
+++ b/doc/v0.5.0/source-class-GeoIp2.Record.Country.html
@@ -0,0 +1,151 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/v0.5.0/source-class-GeoIp2.Record.Location.html b/doc/v0.5.0/source-class-GeoIp2.Record.Location.html
new file mode 100644
index 0000000..dbe2911
--- /dev/null
+++ b/doc/v0.5.0/source-class-GeoIp2.Record.Location.html
@@ -0,0 +1,161 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/v0.5.0/source-class-GeoIp2.Record.MaxMind.html b/doc/v0.5.0/source-class-GeoIp2.Record.MaxMind.html
new file mode 100644
index 0000000..04ae906
--- /dev/null
+++ b/doc/v0.5.0/source-class-GeoIp2.Record.MaxMind.html
@@ -0,0 +1,132 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/v0.5.0/source-class-GeoIp2.Record.Postal.html b/doc/v0.5.0/source-class-GeoIp2.Record.Postal.html
new file mode 100644
index 0000000..dacbbef
--- /dev/null
+++ b/doc/v0.5.0/source-class-GeoIp2.Record.Postal.html
@@ -0,0 +1,138 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/v0.5.0/source-class-GeoIp2.Record.RepresentedCountry.html b/doc/v0.5.0/source-class-GeoIp2.Record.RepresentedCountry.html
new file mode 100644
index 0000000..49a8844
--- /dev/null
+++ b/doc/v0.5.0/source-class-GeoIp2.Record.RepresentedCountry.html
@@ -0,0 +1,158 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/v0.5.0/source-class-GeoIp2.Record.Subdivision.html b/doc/v0.5.0/source-class-GeoIp2.Record.Subdivision.html
new file mode 100644
index 0000000..2ba0b19
--- /dev/null
+++ b/doc/v0.5.0/source-class-GeoIp2.Record.Subdivision.html
@@ -0,0 +1,155 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/v0.5.0/source-class-GeoIp2.Record.Traits.html b/doc/v0.5.0/source-class-GeoIp2.Record.Traits.html
new file mode 100644
index 0000000..e0c3e7a
--- /dev/null
+++ b/doc/v0.5.0/source-class-GeoIp2.Record.Traits.html
@@ -0,0 +1,200 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/v0.5.0/source-class-GeoIp2.WebService.Client.html b/doc/v0.5.0/source-class-GeoIp2.WebService.Client.html
new file mode 100644
index 0000000..8c8084a
--- /dev/null
+++ b/doc/v0.5.0/source-class-GeoIp2.WebService.Client.html
@@ -0,0 +1,462 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/v0.5.0/tree.html b/doc/v0.5.0/tree.html
new file mode 100644
index 0000000..16db321
--- /dev/null
+++ b/doc/v0.5.0/tree.html
@@ -0,0 +1,332 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/index.md b/index.md
index 80d954c..8c08e5b 100644
--- a/index.md
+++ b/index.md
@@ -2,7 +2,7 @@
layout: default
title: MaxMind GeoIP2 PHP API
language: php
-version: v0.4.0
+version: v0.5.0
---
# GeoIP2 PHP API #
@@ -32,7 +32,7 @@ To do this, add `geoip2/geoip2` to your `composer.json` file.
```json
{
"require": {
- "geoip2/geoip2": "0.4.*"
+ "geoip2/geoip2": "0.5.*"
}
}
```
@@ -59,6 +59,16 @@ You can autoload all dependencies by adding this to your code:
```
require 'vendor/autoload.php';
```
+
+### Optional C Extension ###
+
+The [MaxMind DB API](https://github.com/maxmind/MaxMind-DB-Reader-php)
+includes an optional C extension that you may install to dramatically increase
+the performance of lookups in GeoIP2 or GeoLite2 databases. To install, please
+follow the instructions included with that API.
+
+The extension has no effect on web-service lookups.
+
## Database Reader ##
### Usage ###
@@ -83,11 +93,30 @@ See the API documentation for more details.
```php
city('128.101.101.101');
+
+print($record->country->isoCode . "\n"); // 'US'
+print($record->country->name . "\n"); // 'United States'
+print($record->country->names['zh-CN'] . "\n"); // '美国'
+
+print($record->mostSpecificSubdivision->name . "\n"); // 'Minnesota'
+print($record->mostSpecificSubdivision->isoCode . "\n"); // 'MN'
+
+print($record->city->name . "\n"); // 'Minneapolis'
+
+print($record->postal->code . "\n"); // '55455'
+
+print($record->location->latitude . "\n"); // 44.9733
+print($record->location->longitude . "\n"); // -93.2323
-$reader = new Reader('/usr/local/share/GeoIP2/GeoIP2-City.mmdb');
-$record = $reader->city('24.24.24.24');
-print($record->country->isoCode);
```
## Web Service Client ##
@@ -112,11 +141,31 @@ See the API documentation for more details.
```php
omni('24.24.24.24');
-print($omni->country->isoCode);
+
+// Replace "city" with the method corresponding to the web service that
+// you are using, e.g., "country", "cityIspOrg", "omni".
+$record = $client->city('128.101.101.101');
+
+print($record->country->isoCode . "\n"); // 'US'
+print($record->country->name . "\n"); // 'United States'
+print($record->country->names['zh-CN'] . "\n"); // '美国'
+
+print($record->mostSpecificSubdivision->name . "\n"); // 'Minnesota'
+print($record->mostSpecificSubdivision->isoCode . "\n"); // 'MN'
+
+print($record->city->name . "\n"); // 'Minneapolis'
+
+print($record->postal->code . "\n"); // '55455'
+
+print($record->location->latitude . "\n"); // 44.9733
+print($record->location->longitude . "\n"); // -93.2323
+
```
### What data is returned? ###
+
+
+
+
+
+
+
+
+
+Tree+ +Classes+
+
+
+
Interfaces+
+
+
+
+
Exceptions+
+
+
|