\r\n

51Degrees Device Detection On-Premise PHP  4.3

Device detection services for 51Degrees Pipeline

fiftyone\pipeline\devicedetection\DeviceDetectionOnPremise Class Reference

Detailed Description

Examples
hash/failureToMatch.php, hash/gettingstarted.php, hash/manualDataUpdate.php, hash/matchMetrics.php, hash/metadata.php, hash/userAgentClientHints-Web.php, hash/userAgentClientHints.php, and hash/webIntegration.php.

Inheritance diagram for fiftyone\pipeline\devicedetection\DeviceDetectionOnPremise:

[legend]

Collaboration diagram for fiftyone\pipeline\devicedetection\DeviceDetectionOnPremise:

[legend]

Public Member Functions

 getEvidenceKeyFilter ()
Instance of EvidenceKeyFilter based on the evidence keys fetched from the cloud service by the private getEvidenceKeys() method. More...
 processInternal ($flowData)
 setCache ($cache)
Add a cache to an engine. More...
 refreshData ($fileName_or_data=null, $length=null)
Ask the engine to start using the specified data file for detections. More...

Public Member Functions inherited from fiftyone\pipeline\engines\Engine

 getDataSourceTier ()
Get the tier to which the current data source belongs. More...
 setCache ($cache)
Add a cache to an engine. More...
 setRestrictedProperties ($propertiesList)
Add a subset of properties. More...
 inCache ($flowData)
A method to check if a flowData's evidence is in the cache. More...
 process ($flowData)
Engine's core process function. More...

Public Member Functions inherited from fiftyone\pipeline\core\FlowElement

 process ($flowData)
General wrapper function that calls a FlowElement's processInternal method. More...
 getEvidenceKeyFilter ()
Function for getting the FlowElement's EvidenceKeyFilter Used by the filterEvidence method. More...
 filterEvidence ($flowData)
Filter FlowData evidence using the FlowElement's EvidenceKeyFilter. More...
 filterEvidenceKey ($key)
Filter FlowData evidence using the FlowElement's EvidenceKeyFilter. More...
 onRegistration ($pipeline)
Callback called when an engine is added to a pipeline. More...
 processInternal ($flowData)
Process FlowData - this is process function is usually overriden by specific FlowElements to do their core work. More...
 getProperties ()
Get properties is usually overriden by specific FlowElements. More...
 updatePropertyList ()
Update a FlowElement's property list This is used by elements that are only aware of their properites at a later stage, such as cloud request based FlowElements or FlowElements that change their properties later based on new datafiles.
 process ($flowData)
General wrapper function that calls a FlowElement's processInternal method. More...
 getEvidenceKeyFilter ()
Function for getting the FlowElement's EvidenceKeyFilter Used by the filterEvidence method. More...
 filterEvidence ($flowData)
Filter FlowData evidence using the FlowElement's EvidenceKeyFilter. More...
 filterEvidenceKey ($key)
Filter FlowData evidence using the FlowElement's EvidenceKeyFilter. More...
 onRegistration ($pipeline)
Callback called when an engine is added to a pipeline. More...
 processInternal ($flowData)
Process FlowData - this is process function is usually overriden by specific FlowElements to do their core work. More...
 getProperties ()
Get properties is usually overriden by specific FlowElements. More...
 updatePropertyList ()
Update a FlowElement's property list This is used by elements that are only aware of their properites at a later stage, such as cloud request based FlowElements or FlowElements that change their properties later based on new datafiles.

Data Fields

 $dataKey = "device"

Data Fields inherited from fiftyone\pipeline\core\FlowElement

 $dataKey
 $properties = []

Member Function Documentation

◆ getEvidenceKeyFilter()

fiftyone\pipeline\devicedetection\DeviceDetectionOnPremise::getEvidenceKeyFilter ( )

Instance of EvidenceKeyFilter based on the evidence keys fetched from the cloud service by the private getEvidenceKeys() method.

Returns
BasicListEvidenceKeyFilter

◆ refreshData()

fiftyone\pipeline\devicedetection\DeviceDetectionOnPremise::refreshData (   $fileName_or_data = null,
  $length = null  
)

Ask the engine to start using the specified data file for detections.

This can be used in 3 different scenarios:

  1. The data file that was originally used to create the engine has been updated on disk. In this case, no parameters are needed.
  2. A new data file is available, but it is in a different location to the original. In this case, the parameter should be the new data file location.
  3. A new data file is available in memory. The first parameter will be the variable holding the in-memory data file. The second will be the size of the data file in bytes.
    Parameters
    {Object} - data file path or the variable holding the in-memory data file
    {Integer} - length of the in-memory data file in bytes

◆ setCache()

fiftyone\pipeline\devicedetection\DeviceDetectionOnPremise::setCache (   $cache )

Add a cache to an engine.

Parameters
{Cache} - cache with get and set methods