Documentation

DeviceApiWeb extends DeviceApi

in package

• DeviceAtlas
• Device

The DeviceAtlas device detection API provides a way to detect devices based on the HTTP headers. Using the headers, the API returns device properties such as screen width, screen height, is mobile, vendor, model etc.<br/><br/>

Tags

version

3.0.0-beta

author

DeviceAtlas Limited

copyright

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

Table of Contents

Constants

API_ID  = 1

API_VERSION  = '3.1.2'

LOOKUP_SOURCE_CACHE  = 'cache'

LOOKUP_SOURCE_TREE  = 'tree'

MIN_PHP_VERSION  = '7.0'

XMSG_FILE_NOT_FOUND  = 'Unable to read "%s" file, make sure file exists and has read permissions.'

XMSG_MISSING_DATA  = "The device instance failed to initialize: data file should be loaded first"

XMSG_PROBLEM_READING_FROM_STRING  = "Problem reading JSON data from string."

Properties

$config  : mixed

$ACCEPT_LANGUAGE_HEADER  : mixed

$cacheEnabled  : mixed

$cacheRootJsonFilePath  : mixed

$cacheService  : mixed

$componentDetector  : mixed

$deviceData  : mixed

$optimizerTempDir  : mixed

$propertiesCollector  : mixed

$propertyMappingsRunner  : mixed

Methods

__construct()  : mixed

Constructs a DeviceApiWeb instance with default or custom config.

buildDataFile()  : mixed

downloadAndLoadDataFile()  : mixed

downloadAndLoadDataFileFromUrl()  : mixed

Load the DeviceAtlas data file data from a URL.

getApiVersion()  : string

The version of this API.

getDataCreationIso8601()  : string

The creation date/time of the loaded data file in ISO 8601 format.

getDataCreationTimestamp()  : int

The creation date/time of the loaded data file as a Unix timestamp.

getDataVersion()  : string

The version of the data file.

getProperties()  : Properties

Get the Device properties for the current request. The most suitable request headers are extracted and used for detection and property lookup.

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

Get a set of all possible property names. Note that the client side properties are not included in this set.

loadDataFromFile()  : mixed

loadDataFromString()  : mixed

Load the DeviceAtlas device detection data into the API from a string.

reload()  : mixed

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

saveDataToCache()  : mixed

scheduleReloadAndFinishRequest()  : mixed

A secondary register_shutdown_call to make sure the reload method is called as the last one; when available call fastcgi_finish_request() too, to make sure there is no delay for a visitor/client.

cacheGet()  : mixed

cachePut()  : mixed

callFailureCallback()  : mixed

Call user defined callback if set.

checkIsDataLoaded()  : mixed

checkReloadSchedule()  : mixed

detectProperties()  : mixed

extractClientSideInputs()  : mixed

The client side string may contain identifiers that can be used for component detection. This method adds these identifiers to the headers map.

extractLanguageProperties()  : mixed

getAcceptLanguage()  : mixed

getDataFromFile()  : mixed

getPropertiesFromHeaders()  : mixed

getPropertiesFromIdentifier()  : Properties

Get the properties for a User-Agent merged with the client-side properties (when provided by the DeviceAtlas client side component).

loadCachedTreeRoot()  : mixed

loadDataFromCache()  : mixed

normaliseHeaders()  : mixed

Performs the following on header keys: lowercase, replaces "_" with "-" and strips prefixed "http-" if present.

postLoadDataInitialization()  : mixed