DolGeoIP Class Reference

Class to manage GeoIP conversion Usage: $geoip=new GeoIP('country',$datfile); $geoip->getCountryCodeFromIP($ip); $geoip->close();. More...

Public Member Functions
	__construct ($type, $datfile)
	Constructor.
	getCountryCodeFromIP ($ip)
	Return in lower case the country code from an ip.
	getCountryCodeFromName ($name)
	Return in lower case the country code from a host name.
	getVersion ()
	Return version of data file.
	close ()
	Close geoip object.

Private Member Functions
	getGeoIp2IsoCode ($ipOrName)
	Return the ISO country code for an IP or a host name using the embedded GeoIP2 reader.

Detailed Description

Class to manage GeoIP conversion Usage: $geoip=new GeoIP('country',$datfile); $geoip->getCountryCodeFromIP($ip); $geoip->close();.

Definition at line 36 of file dolgeoip.class.php.

Constructor & Destructor Documentation

__construct()

DolGeoIP::__construct	(		$type,
			$datfile )

Constructor.

Parameters

	'country'|'city'	$type 'country' or 'city'
string	$datfile	Data file

Definition at line 59 of file dolgeoip.class.php.

References dol_syslog(), and getDolGlobalString().

Member Function Documentation

close()

DolGeoIP::close

(

)

Close geoip object.

Returns

void

Definition at line 254 of file dolgeoip.class.php.

getCountryCodeFromIP()

DolGeoIP::getCountryCodeFromIP

(

$ip

)

Return in lower case the country code from an ip.

Parameters

string

$ip

IP to scan

Returns

string Country code (two letters)

Definition at line 164 of file dolgeoip.class.php.

References getDolGlobalString(), and getGeoIp2IsoCode().

getCountryCodeFromName()

DolGeoIP::getCountryCodeFromName

(

$name

)

Return in lower case the country code from a host name.

Parameters

string

$name

FQN of host (example: myserver.xyz.com)

Returns

string Country code (two letters)

Definition at line 208 of file dolgeoip.class.php.

References getDolGlobalString(), and getGeoIp2IsoCode().

getGeoIp2IsoCode()

DolGeoIP::getGeoIp2IsoCode ( $ipOrName )

private

Return the ISO country code for an IP or a host name using the embedded GeoIP2 reader.

A Country database is read with country(), but a City database (which also embeds the country record) is read with city(), so a City datafile configured as the country datafile still resolves instead of failing with a BadMethodCallException.

Parameters

string

$ipOrName

IP address or host name to look up

Returns

string Country code (two letters, upper case) or '' if not found

Definition at line 138 of file dolgeoip.class.php.

References string.

Referenced by getCountryCodeFromIP(), and getCountryCodeFromName().

getVersion()

DolGeoIP::getVersion

(

)

Return version of data file.

Returns

string Version of datafile

Definition at line 231 of file dolgeoip.class.php.

References getDolGlobalString().

---

The documentation for this class was generated from the following file:

• dolibarr_24.0/htdocs/core/class/dolgeoip.class.php