Documentation

Mobi_Mtld_DA_Device_TreeOptimized extends Mobi_Mtld_DA_Device_Tree

in package

• Mobi
• Mtld
• DA
• Device

This class is used by the main API class and should not be used directly.

Tags

author

DeviceAtlas Limited

copyright

Copyright (c) DeviceAtlas Limited 2021. All Rights Reserved. https://deviceatlas.com

Table of Contents

API_ID  = '1'

CACHED_JSON_HISTORY_FILE_NAME  = 'da-cache-history'

Name of the file that keeps a history of the cached data file directories.

CACHED_JSON_INFO_FILE_NAME  = 'da-cached-info'

Name of the file that stores the cached data file's file-size and file-modification-time.

$config  : mixed

$lookupValue  : mixed

$stockUaHeaders  : mixed

$tree  : mixed

$cachedBooleanPropertyFalse  : mixed

$cachedBooleanPropertyTrue  : mixed

$clientProps  : mixed

$dataIsLoaded  : mixed

$deviceIdPropNameId  : mixed

$jsonBatchDir  : mixed

the directory in which the json fragments are put

$jsonTempDir  : mixed

the directory in which the the api puts it's temp and cache files

$lookupPropType  : mixed

$lookupSource  : mixed

$MIN_JSON_VERSION  : mixed

$nicePropName  : mixed

$treeRegexes  : mixed

$uaProps  : mixed

$XMSG_CLIENT_PROPERTIES_NOT_SUPPORTED  : mixed

$XMSG_FILE_NOT_FOUND  : mixed

$XMSG_JSON_INVALID  : mixed

$XMSG_JSON_LOAD  : mixed

$XMSG_JSON_MISSING_REGEX_RULES  : mixed

$XMSG_JSON_VERSION  : mixed

$batchId  : mixed

recursive pointer

$cacheKeySuffix  : mixed

$cacheProvider  : mixed

$cacheRootJsonFilePath  : mixed

path to the root json file 0.serialized

$defaultLookupSource  : mixed

$jsonDataFilePath  : mixed

path to the json file passed to the api

$MAX_CACHE_JSON_FILES  : mixed

max number of JSON files to keep in cache, older JSON files will be deleted.

$MIN_BATCH_SIZE  : mixed

batch config

$treeValueDict  : mixed

tree 'v' node

$useTreeOptimizer  : mixed

__construct()  : mixed

Create the JSON tree handler.

clearCache()  : mixed

Remove all tree optimization cache files

getDataCreationTimestamp()  : mixed

Get data file creation timestamp

getDataRevision()  : mixed

getDataVersion()  : mixed

Get data file version

getLookupSource()  : string

Get the source properties fetch source to be used for debugging.

getPropertyNames()  : mixed

Get the list of all available property names from the tree (not contains client side props)

loadTreeFromFile()  : mixed

Load the JSON tree file into the handler.

loadTreeFromString()  : mixed

Load the JSON tree into the handler.

populateCache()  : bool

Break down the DeviceAtlas JSON data file into smaller files and save the batch into "/da-api-temp-dir/batch-cache-dir".

putProperties()  : mixed

Get properties from tree walk/ua/client-side and put them in the tree.properties use cached properties if exists.

putTreeWalkProperties()  : mixed

Get properties from tree walk/ua and put them in the tree.properties

setConfig()  : mixed

Set new config settings via a new Config object.

sanitizeTree()  : mixed

__loadTreeFromFile()  : mixed

__populateCache()  : mixed

for internal cache populations usages

cacheTree()  : mixed

Break down tree and save to files.

cleanup()  : mixed

Remove the old batches and create the new root json.

fixValues()  : mixed

Swap value ids with values in a tree node

getFileId()  : mixed

Get a unique identifier a json-file e.g. (filetime, filesize), to know when the file is changed

loadCachedTreeRoot()  : mixed

try to load the root cached json file, if not exists try to load and populate the original

rmdir()  : mixed

Recursively remove files and dirs.

seekProperties()  : mixed

Seek properties for a user agent within a node. This is designed to be recursed, and only externally called with the node representing the top of the tree

throwFileWrite()  : mixed

Throw a file/directory write exception