DeviceApi Configurations. To change the default configs of the DeviceAtlas DeviceApi create an instance of this class, set your preferred configs and pass the instance to the constructor of a DeviceApi or DeviceApiWeb. Note that you may change the configs even after the Config instance has been passed to the DeviceApi.
DEFAULT_COOKIE_NAME = "DAPROPS"
The default cookie name that the client side properties would be set to.
When using getProperties() in a web application, the detection would automatically use the contents of this cookie if it exists. If you want the client side properties to be used add the DeviceAtlas client side component (JS lib) to your web-site pages.
setCookieName( $cookieName)
To change the cookie name that the client side properties would be set to.
When using getProperties() in a web application, the detection would
automatically use the contents of this cookie if it exists. If you want
the client side properties to be used add the DeviceAtlas client side
component (JS lib) to your web-site pages.
When the user-agent or HTTP headers are set manually to getProperties()
the client side properties (probably the value set to the cookie) can be
manually passed to this methods as the second argument, note that this
config is only used for getProperties(REQUEST-OBJECT). If you set the
cookie-name to null then the client-side properties cookie will be ignored.
| $cookieName |
getCookieName() : string
Get the cookie name that the client side properties would be set to.
When using getProperties() in a web application, the detection would
automatically use the contents of this cookie if it exists. If you want
the client side properties to be used add the DeviceAtlas client side
component (JS lib) to your web-site pages.
When the user-agent or HTTP headers are set manually to getProperties()
the client side properties (probably the value set to the cookie)
can be manually passed to this methods as the second argument, note that
this config is only used for getProperties(REQUEST-OBJECT).
The cookie name which the client side properties are set to
setIncludeUaProps( $includeUaProps)
To disable or enable getProperties(HEADERS) or getProperties(REQUEST) including language and locale properties. To check the Accept-Language header and include properties to the property set for getting client's language and locale preferences set to true.
If you do not use this properties you can set this config to false to make the detection marginally faster.
| $includeUaProps |
setIncludeLangProps( $includeLangProps)
To disable or enable getProperties(HEADERS) or getProperties(REQUEST) including language and locale properties. To check the Accept-Language header and include properties to the property set for getting client's language and locale preferences set to true.
If you do not use this properties you can set this config to false to make the detection marginally faster.
| $includeLangProps |
setReturnNullWhenNoProperties( $returnNullWhenNoProperties)
Set if the value returned by the getProperties() method should be null when there are no properties to return or whether an empty Properties object should be returned instead.
| $returnNullWhenNoProperties |
getReturnNullWhenNoProperties() : boolean
Get if the value returned by getProperties() should be null when there are no properties to return or an instance of Properties that has no Property inside it should be returned.
true=return null instead of empty array
setUseTreeOptimizer( $useTreeOptimizer)
To optimize data. Optimizing the data file will dramatically reduce the memory foot print and data file loading speed. It is highly recommend to turn this config on when detecting devices in real-time using DeviceAtlasWeb.<br/> When this config is on, the API will automatically divide the data file into smaller pieces and cache them on the disk, the cached data will be used for lookups afterwards. The API detects data file updates and will update the cache.
| $useTreeOptimizer |
getUseTreeOptimizer() : boolean
To get data optimization status. Optimizing the data file will dramatically reduce the memory foot print and data file loading speed. It is highly recommend to turn this config on when detecting devices in real-time using DeviceAtlasWeb.<br/> When this config is on, the API will automatically divide the data file into smaller pieces and cache them on the disk, the cached data will be used for lookups afterwards. The API detects data file updates and will update the cache.
true=data optimizer is on
setCacheProvider(\Mobi_Mtld_DA_CacheProvider_CacheProviderInterface $cacheProvider)
Set a cache provider to the API to cache the lookup results. This will dramatically increase the lookup performance in most situations. It is highly recommend to use this config when detecting devices in real-time using DeviceAtlasWeb.
| \Mobi_Mtld_DA_CacheProvider_CacheProviderInterface | $cacheProvider |
getCacheProvider() : \Mobi_Mtld_DA_CacheProvider_CacheProviderInterface
Get the cache provider instance being used by the API to cache the lookup results.
null is returned when a cache provider is not used.
cacheProvider a cache provider instance or null
setIgnoreDataFileChanges( $ignoreDataFileChanges)
When data file optimizer is set to true using the "setUseTreeOptimizer()" config, the API will try to use a batch of optimized cached files instead of the original data file, the API will do several checks to pick between the cached data file or the passed data file. While this makes the API automatically sense and update the cached files. However if you manually update the optimizer caches using the provided CLI tool (ExtraTools/DeviceApi/data-file-optimizer.php) the checking is redundant and unnecessary, using this setting you can turn this checking off.
| $ignoreDataFileChanges |