Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
- Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
- PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/lib/maxmind/GeoIp2/Database/ -> Reader.php (source)
Differences Between: [Versions 310 and 311] [Versions 310 and 400] [Versions 310 and 401] [Versions 310 and 402] [Versions 310 and 403]
(no description)
| File Size: | 287 lines (10 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
Reader:: (14 methods):
__construct()
city()
country()
anonymousIp()
asn()
connectionType()
domain()
enterprise()
isp()
modelFor()
flatModelFor()
getRecord()
metadata()
close()
Instances of this class provide a reader for the GeoIP2 database format.
IP addresses can be looked up using the database specific methods.
## 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 `null` value.
If the address is not in the database, an
{@link \GeoIp2\Exception\AddressNotFoundException} exception will be
thrown. If an invalid IP address is passed to one of the methods, a
SPL {@link \InvalidArgumentException} will be thrown. If the database is
corrupt or invalid, a {@link \MaxMind\Db\Reader\InvalidDatabaseException}
will be thrown.
IP addresses can be looked up using the database specific methods.
## 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 `null` value.
If the address is not in the database, an
{@link \GeoIp2\Exception\AddressNotFoundException} exception will be
thrown. If an invalid IP address is passed to one of the methods, a
SPL {@link \InvalidArgumentException} will be thrown. If the database is
corrupt or invalid, a {@link \MaxMind\Db\Reader\InvalidDatabaseException}
will be thrown.
| __construct($filename,$locales = ['en']) X-Ref |
| Constructor. param: string $filename the path to the GeoIP2 database file param: array $locales list of locale codes to use in name property |
| city($ipAddress) X-Ref |
| This method returns a GeoIP2 City model. param: string $ipAddress an IPv4 or IPv6 address as a string return: \GeoIp2\Model\City |
| country($ipAddress) X-Ref |
| This method returns a GeoIP2 Country model. param: string $ipAddress an IPv4 or IPv6 address as a string return: \GeoIp2\Model\Country |
| anonymousIp($ipAddress) X-Ref |
| This method returns a GeoIP2 Anonymous IP model. param: string $ipAddress an IPv4 or IPv6 address as a string return: \GeoIp2\Model\AnonymousIp |
| asn($ipAddress) X-Ref |
| This method returns a GeoLite2 ASN model. param: string $ipAddress an IPv4 or IPv6 address as a string return: \GeoIp2\Model\Asn |
| connectionType($ipAddress) X-Ref |
| This method returns a GeoIP2 Connection Type model. param: string $ipAddress an IPv4 or IPv6 address as a string return: \GeoIp2\Model\ConnectionType |
| domain($ipAddress) X-Ref |
| This method returns a GeoIP2 Domain model. param: string $ipAddress an IPv4 or IPv6 address as a string return: \GeoIp2\Model\Domain |
| enterprise($ipAddress) X-Ref |
| This method returns a GeoIP2 Enterprise model. param: string $ipAddress an IPv4 or IPv6 address as a string return: \GeoIp2\Model\Enterprise |
| isp($ipAddress) X-Ref |
| This method returns a GeoIP2 ISP model. param: string $ipAddress an IPv4 or IPv6 address as a string return: \GeoIp2\Model\Isp |
| modelFor($class, $type, $ipAddress) X-Ref |
| No description |
| flatModelFor($class, $type, $ipAddress) X-Ref |
| No description |
| getRecord($class, $type, $ipAddress) X-Ref |
| No description |
| metadata() X-Ref |
return: \MaxMind\Db\Reader\Metadata object for the database |
| close() X-Ref |
| Closes the GeoIP2 database and returns the resources to the system. |
