51Degrees Pipeline PHP  4.1

51Degrees Pipeline for PHP

fiftyone\pipeline\cloudrequestengine\CloudEngine Class Reference

Detailed Description

This is a template for all 51Degrees cloud engines.

It requires the 51Degrees cloudRequestEngine to be placed in a pipeline before it. It takes that raw JSON response and parses it to extract the device part. It also uses this data to generate a list of properties and an evidence key filter

Inheritance diagram for fiftyone\pipeline\cloudrequestengine\CloudEngine:

[legend]

Collaboration diagram for fiftyone\pipeline\cloudrequestengine\CloudEngine:

[legend]

Public Member Functions

 onRegistration ($pipeline)
Callback called when an engine is added to a pipeline In this case sets up the properties list for the element from data in the CloudRequestEngine. More...
 processInternal ($flowData)

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

 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.

Data Fields

 $dataKey = "CloudEngineBase"

Data Fields inherited from fiftyone\pipeline\core\FlowElement

 $dataKey
 $properties = []

Member Function Documentation

◆ onRegistration()

fiftyone\pipeline\cloudrequestengine\CloudEngine::onRegistration (   $pipeline )

Callback called when an engine is added to a pipeline In this case sets up the properties list for the element from data in the CloudRequestEngine.

Parameters
Pipeline -
Returns
void