Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401]

(no description)

File Size: 373 lines (12 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Reader:: (10 methods):
  __construct()
  get()
  getWithPrefixLen()
  findAddressInTree()
  ipV4StartNode()
  readNode()
  resolveDataPointer()
  findMetadataStart()
  metadata()
  close()


Class: Reader  - X-Ref

Instances of this class provide a reader for the MaxMind DB format. IP
addresses can be looked up using the get method.

__construct(string $database)   X-Ref
Constructs a Reader for the MaxMind DB format. The file passed to it must
be a valid MaxMind DB file such as a GeoIp2 database file.

param: string $database

get(string $ipAddress)   X-Ref
Retrieves the record for the IP address.

param: string $ipAddress
return: mixed the record for the IP address

getWithPrefixLen(string $ipAddress)   X-Ref
Retrieves the record for the IP address and its associated network prefix length.

param: string $ipAddress
return: array an array where the first element is the record and the

findAddressInTree(string $ipAddress)   X-Ref
No description

ipV4StartNode()   X-Ref
No description

readNode(int $nodeNumber, int $index)   X-Ref
No description

resolveDataPointer(int $pointer)   X-Ref

return: mixed

findMetadataStart(string $filename)   X-Ref
No description

metadata()   X-Ref

return: Metadata object for the database

close()   X-Ref
Closes the MaxMind DB and returns resources to the system.