\r\n

51Degrees Pipeline PHP  4.4

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 $pipeline)
Callback called when an engine is added to a pipeline. More...
 processInternal (FlowData $flowData)

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

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

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

 __construct ()
A default dummy constructor is needed for there are classes inheriting this class deeper than 1-level of inheritance and calling parent::__construct() in their explicit constructors. More...
 process (FlowData $flowData)
General wrapper function that calls a FlowElement's processInternal method.
 getEvidenceKeyFilter ()
Function for getting the FlowElement's EvidenceKeyFilter Used by the filterEvidence method.
 filterEvidence (FlowData $flowData)
Filter FlowData evidence using the FlowElement's EvidenceKeyFilter. More...
 filterEvidenceKey (string $key)
Filter FlowData evidence using the FlowElement's EvidenceKeyFilter.
 onRegistration (Pipeline $pipeline)
Callback called when an engine is added to a pipeline.
 processInternal (FlowData $flowData)
Process FlowData - this is process function is usually overridden by specific FlowElements to do their core work.
 getProperties ()
Get properties Usually overridden by specific FlowElements. More...
 updatePropertyList ()
Update a FlowElement's property list This is used by elements that are only aware of their properties at a later stage, such as cloud request based FlowElements or FlowElements that change their properties later based on new datafiles.

Data Fields

string  $dataKey = 'CloudEngineBase'
array  $aspectProperties

Data Fields inherited from fiftyone\pipeline\engines\Engine

array  $restrictedProperties

Data Fields inherited from fiftyone\pipeline\core\FlowElement

string  $dataKey
array  $properties = [] array  $pipelines = []

Member Function Documentation

◆ onRegistration()

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

Callback called when an engine is added to a pipeline.

Exceptions
-
On This Page