$locales list of locale codes to use in name property * from most preferred to least preferred * * @throws InvalidDatabaseException if the database is corrupt or invalid */ public function __construct( string $filename, /** @var array */ public readonly array $locales = ['en'] ) { $this->dbReader = new DbReader($filename); $this->dbType = $this->dbReader->metadata()->databaseType; } /** * This method returns a GeoIP City model. * * @param string $ipAddress an IPv4 or IPv6 address as a string * * @throws AddressNotFoundException if the address is not in the database * @throws InvalidDatabaseException if the database is corrupt or invalid * @throws \BadMethodCallException if this database type is not supported */ public function city(string $ipAddress): City { return $this->modelFor(City::class, 'City', $ipAddress); } /** * This method returns a GeoIP Country model. * * @param string $ipAddress an IPv4 or IPv6 address as a string * * @throws AddressNotFoundException if the address is not in the database * @throws InvalidDatabaseException if the database is corrupt or invalid * @throws \BadMethodCallException if this database type is not supported */ public function country(string $ipAddress): Country { return $this->modelFor(Country::class, 'Country', $ipAddress); } /** * This method returns a GeoIP Anonymous IP model. * * @param string $ipAddress an IPv4 or IPv6 address as a string * * @throws AddressNotFoundException if the address is not in the database * @throws InvalidDatabaseException if the database is corrupt or invalid * @throws \BadMethodCallException if this database type is not supported */ public function anonymousIp(string $ipAddress): AnonymousIp { return $this->flatModelFor( AnonymousIp::class, 'GeoIP2-Anonymous-IP', $ipAddress ); } /** * This method returns a GeoIP Anonymous Plus model. * * @param string $ipAddress an IPv4 or IPv6 address as a string * * @throws AddressNotFoundException if the address is not in the database * @throws InvalidDatabaseException if the database is corrupt or invalid * @throws \BadMethodCallException if this database type is not supported */ public function anonymousPlus(string $ipAddress): AnonymousPlus { return $this->flatModelFor( AnonymousPlus::class, 'GeoIP-Anonymous-Plus', $ipAddress ); } /** * This method returns a GeoLite ASN model. * * @param string $ipAddress an IPv4 or IPv6 address as a string * * @throws AddressNotFoundException if the address is not in the database * @throws InvalidDatabaseException if the database is corrupt or invalid * @throws \BadMethodCallException if this database type is not supported */ public function asn(string $ipAddress): Asn { return $this->flatModelFor( Asn::class, 'GeoLite2-ASN', $ipAddress ); } /** * This method returns a GeoIP Connection Type model. * * @param string $ipAddress an IPv4 or IPv6 address as a string * * @throws AddressNotFoundException if the address is not in the database * @throws InvalidDatabaseException if the database is corrupt or invalid * @throws \BadMethodCallException if this database type is not supported */ public function connectionType(string $ipAddress): ConnectionType { return $this->flatModelFor( ConnectionType::class, 'GeoIP2-Connection-Type', $ipAddress ); } /** * This method returns a GeoIP Domain model. * * @param string $ipAddress an IPv4 or IPv6 address as a string * * @throws AddressNotFoundException if the address is not in the database * @throws InvalidDatabaseException if the database is corrupt or invalid * @throws \BadMethodCallException if this database type is not supported */ public function domain(string $ipAddress): Domain { return $this->flatModelFor( Domain::class, 'GeoIP2-Domain', $ipAddress ); } /** * This method returns a GeoIP Enterprise model. * * @param string $ipAddress an IPv4 or IPv6 address as a string * * @throws AddressNotFoundException if the address is not in the database * @throws InvalidDatabaseException if the database is corrupt or invalid * @throws \BadMethodCallException if this database type is not supported */ public function enterprise(string $ipAddress): Enterprise { return $this->modelFor(Enterprise::class, 'Enterprise', $ipAddress); } /** * This method returns a GeoIP ISP model. * * @param string $ipAddress an IPv4 or IPv6 address as a string * * @throws AddressNotFoundException if the address is not in the database * @throws InvalidDatabaseException if the database is corrupt or invalid * @throws \BadMethodCallException if this database type is not supported */ public function isp(string $ipAddress): Isp { return $this->flatModelFor( Isp::class, 'GeoIP2-ISP', $ipAddress ); } private function modelFor(string $class, string $type, string $ipAddress): object { [$record, $prefixLen] = $this->getRecord($class, $type, $ipAddress); $record['traits']['ip_address'] = $ipAddress; $record['traits']['prefix_len'] = $prefixLen; return new $class($record, $this->locales); } private function flatModelFor(string $class, string $type, string $ipAddress): object { [$record, $prefixLen] = $this->getRecord($class, $type, $ipAddress); $record['ip_address'] = $ipAddress; $record['prefix_len'] = $prefixLen; return new $class($record); } /** * @return array{0:array, 1:int} */ private function getRecord(string $class, string $type, string $ipAddress): array { if (!str_contains($this->dbType, $type)) { $method = lcfirst((new \ReflectionClass($class))->getShortName()); throw new \BadMethodCallException( "The $method method cannot be used to open a {$this->dbType} database" ); } [$record, $prefixLen] = $this->dbReader->getWithPrefixLen($ipAddress); if ($record === null) { throw new AddressNotFoundException( "The address $ipAddress is not in the database." ); } if (!\is_array($record)) { throw new InvalidDatabaseException( "Expected an array when looking up $ipAddress but received: " . \gettype($record) ); } return [$record, $prefixLen]; } /** * @throws \InvalidArgumentException if arguments are passed to the method * @throws \BadMethodCallException if the database has been closed * * @return Metadata object for the database */ public function metadata(): Metadata { return $this->dbReader->metadata(); } /** * Closes the GeoIP database and returns the resources to the system. */ public function close(): void { $this->dbReader->close(); } }