Instances of this class provide a reader for the GeoIP2 database format.
IP addresses can be looked up using the database specific methods.
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 null value.
If the address is not in the database, an {@link} exception will be thrown. If an invalid IP address is passed to one of the methods, a SPL {@link} will be thrown. If the database is corrupt or invalid, a {@link} will be thrown.
__construct(string $filename, array $locales = ['en']) : mixed
Constructor.
| string | $filename | the path to the GeoIP2 database file |
| array | $locales | list of locale codes to use in name property from most preferred to least preferred |
if the database is corrupt or invalid
city(string $ipAddress) : \GeoIp2\Model\City
This method returns a GeoIP2 City model.
| string | $ipAddress | an IPv4 or IPv6 address as a string |
if the address is not in the database
if the database is corrupt or invalid
a City model for the requested IP address
country(string $ipAddress) : \GeoIp2\Model\Country
This method returns a GeoIP2 Country model.
| string | $ipAddress | an IPv4 or IPv6 address as a string |
if the address is not in the database
if the database is corrupt or invalid
a Country model for the requested IP address
anonymousIp(string $ipAddress) : \GeoIp2\Model\AnonymousIp
This method returns a GeoIP2 Anonymous IP model.
| string | $ipAddress | an IPv4 or IPv6 address as a string |
if the address is not in the database
if the database is corrupt or invalid
asn(string $ipAddress) : \GeoIp2\Model\Asn
This method returns a GeoLite2 ASN model.
| string | $ipAddress | an IPv4 or IPv6 address as a string |
if the address is not in the database
if the database is corrupt or invalid
connectionType(string $ipAddress) : \GeoIp2\Model\ConnectionType
This method returns a GeoIP2 Connection Type model.
| string | $ipAddress | an IPv4 or IPv6 address as a string |
if the address is not in the database
if the database is corrupt or invalid
domain(string $ipAddress) : \GeoIp2\Model\Domain
This method returns a GeoIP2 Domain model.
| string | $ipAddress | an IPv4 or IPv6 address as a string |
if the address is not in the database
if the database is corrupt or invalid
enterprise(string $ipAddress) : \GeoIp2\Model\Enterprise
This method returns a GeoIP2 Enterprise model.
| string | $ipAddress | an IPv4 or IPv6 address as a string |
if the address is not in the database
if the database is corrupt or invalid
isp(string $ipAddress) : \GeoIp2\Model\Isp
This method returns a GeoIP2 ISP model.
| string | $ipAddress | an IPv4 or IPv6 address as a string |
if the address is not in the database
if the database is corrupt or invalid