Documentation

CarrierApiWeb extends CarrierApi

in package

• Application

A small extension to the core CarrierApi to get IP from $_SERVER for current client.

$carrierApi = new CarrierApiWeb();
// loading data can be slow - it is recommended wrap the API in a Singleton.
$carrierApi->loadDataFromFile('/path/to/sample.dat');

// get all properties for current client
Properties props = carrierApi.GetProperties(request);

// .... use the properties ....
if (props.ContainsKey("networkOperator") {
   string operatorName = props.Get("networkOperator").AsString();
}

// get a single property
Property countryProp = carrierApi.GetProperty("countryCode");
if (countryProp != null) {
  string countryCode = countryProp.AsString();
}

Tags

copyright

Copyright (c) DeviceAtlas Limited 2023. All Rights Reserved.

author

DeviceAtlas Limited

Table of Contents

Constants

API_VERSION  = '1.2.1'

Carrier API version

MIN_PHP_VERSION  = '5.2.3'

Min PHP version required for this API to work

Properties

$HEADERS_TO_CHECK  : mixed

A list of HTTP headers to choose the original client IP address from. In addition to these the RemoteAddr (REMOTE_ADDR) is also used as a final fallback.

$data  : mixed

Data loaded from the data file

$INVALID_PROP_EX  : mixed

Error messages

$MISSING_DATA_EX  : mixed

Error messages

Methods

__construct()  : mixed

Construct a Carrier API object and load the data file (if path is provided).

buildDataFile()  : mixed

downloadAndLoadDataFile()  : mixed

downloadAndLoadDataFileFromUrl()  : mixed

Load the DeviceAtlas data file data from a URL.

getDataFileCopyright()  : string

Returns the data file copyright text.

getDataFileCreationDate()  : string

Returns the data file creation date in ISO8601 format.

getDataFileVersion()  : string

Returns the version of the data file.

getDeviceAtlasApiVersion()  : string

getIp()  : string

Get the most suitable IP address from the given keyVals set of HTTP headers. This function checks the headers defined in HEADERS_TO_CHECK.

getProperties()  : Properties

Get the Carrier properties for the current client.

getProperty()  : mixed

Get a specific Property from the current client IP found.

getPropertyNames()  : array<string|int, mixed>

A set of all the possible property names. The Set contains PropertyName objects that each have a name and an associated data type.

isPublicIp()  : bool

An IP address is considered public if it is not in any of the following ranges: <pre> 1) any local address IP: 0

loadDataFromFile()  : mixed

reload()  : mixed

Downloads a new data file if the existing one is stale.

scheduleReloadAndFinishRequest()  : mixed

A secondary register_shutdown_call to make sure the reload method is called as the last one.

dataLoaded()  : mixed

Check if the given propertyName is not null and exists in the data file.

extractIp()  : mixed

Extracts and cleans an IP address from the headerValue. Some headers such as "X-Forwarded-For" can contain multiple IP addresses such as: clientIP, proxy1, proxy2... This method splits up the headerValue and takes the most appropriate value as the IP.

propertyNameExists()  : mixed

Check if the given propertyName is not null and exists in the data file. Calls to this method must be sure that the data object is already loaded.

callFailureCallback()  : mixed

Call user defined callback if set.

checkReloadSchedule()  : mixed

getIpFromServer()  : string

Get the most suitable IP address from the given request. This function checks the headers defined in CarrierApi::HEADERS_TO_CHECK.