Decoder.php
3 years ago
InvalidDatabaseException.php
3 years ago
Metadata.php
3 years ago
Util.php
3 years ago
Metadata.php
105 lines
| 1 | <?php |
| 2 | |
| 3 | declare (strict_types=1); |
| 4 | namespace IAWP\MaxMind\Db\Reader; |
| 5 | |
| 6 | use ArgumentCountError; |
| 7 | /** |
| 8 | * This class provides the metadata for the MaxMind DB file. |
| 9 | */ |
| 10 | class Metadata |
| 11 | { |
| 12 | /** |
| 13 | * This is an unsigned 16-bit integer indicating the major version number |
| 14 | * for the database's binary format. |
| 15 | * |
| 16 | * @var int |
| 17 | */ |
| 18 | public $binaryFormatMajorVersion; |
| 19 | /** |
| 20 | * This is an unsigned 16-bit integer indicating the minor version number |
| 21 | * for the database's binary format. |
| 22 | * |
| 23 | * @var int |
| 24 | */ |
| 25 | public $binaryFormatMinorVersion; |
| 26 | /** |
| 27 | * This is an unsigned 64-bit integer that contains the database build |
| 28 | * timestamp as a Unix epoch value. |
| 29 | * |
| 30 | * @var int |
| 31 | */ |
| 32 | public $buildEpoch; |
| 33 | /** |
| 34 | * This is a string that indicates the structure of each data record |
| 35 | * associated with an IP address. The actual definition of these |
| 36 | * structures is left up to the database creator. |
| 37 | * |
| 38 | * @var string |
| 39 | */ |
| 40 | public $databaseType; |
| 41 | /** |
| 42 | * This key will always point to a map (associative array). The keys of |
| 43 | * that map will be language codes, and the values will be a description |
| 44 | * in that language as a UTF-8 string. May be undefined for some |
| 45 | * databases. |
| 46 | * |
| 47 | * @var array |
| 48 | */ |
| 49 | public $description; |
| 50 | /** |
| 51 | * This is an unsigned 16-bit integer which is always 4 or 6. It indicates |
| 52 | * whether the database contains IPv4 or IPv6 address data. |
| 53 | * |
| 54 | * @var int |
| 55 | */ |
| 56 | public $ipVersion; |
| 57 | /** |
| 58 | * An array of strings, each of which is a language code. A given record |
| 59 | * may contain data items that have been localized to some or all of |
| 60 | * these languages. This may be undefined. |
| 61 | * |
| 62 | * @var array |
| 63 | */ |
| 64 | public $languages; |
| 65 | /** |
| 66 | * @var int |
| 67 | */ |
| 68 | public $nodeByteSize; |
| 69 | /** |
| 70 | * This is an unsigned 32-bit integer indicating the number of nodes in |
| 71 | * the search tree. |
| 72 | * |
| 73 | * @var int |
| 74 | */ |
| 75 | public $nodeCount; |
| 76 | /** |
| 77 | * This is an unsigned 16-bit integer. It indicates the number of bits in a |
| 78 | * record in the search tree. Note that each node consists of two records. |
| 79 | * |
| 80 | * @var int |
| 81 | */ |
| 82 | public $recordSize; |
| 83 | /** |
| 84 | * @var int |
| 85 | */ |
| 86 | public $searchTreeSize; |
| 87 | public function __construct(array $metadata) |
| 88 | { |
| 89 | if (\func_num_args() !== 1) { |
| 90 | throw new ArgumentCountError(\sprintf('%s() expects exactly 1 parameter, %d given', __METHOD__, \func_num_args())); |
| 91 | } |
| 92 | $this->binaryFormatMajorVersion = $metadata['binary_format_major_version']; |
| 93 | $this->binaryFormatMinorVersion = $metadata['binary_format_minor_version']; |
| 94 | $this->buildEpoch = $metadata['build_epoch']; |
| 95 | $this->databaseType = $metadata['database_type']; |
| 96 | $this->languages = $metadata['languages']; |
| 97 | $this->description = $metadata['description']; |
| 98 | $this->ipVersion = $metadata['ip_version']; |
| 99 | $this->nodeCount = $metadata['node_count']; |
| 100 | $this->recordSize = $metadata['record_size']; |
| 101 | $this->nodeByteSize = $this->recordSize / 4; |
| 102 | $this->searchTreeSize = $this->nodeCount * $this->nodeByteSize; |
| 103 | } |
| 104 | } |
| 105 |