\r\n

51Degrees Pipeline PHP  4.4

51Degrees Pipeline for PHP
  • fiftyone
  • pipeline
  • engines
  • Engine

fiftyone\pipeline\engines\Engine Class Reference

Detailed Description

An engine is an extension of the Pipeline Core flowElement class It allows for a cache, restricted properties and meaningful errors when a property isn't available via the aspect data missingPropertyService.

Inheritance diagram for fiftyone\pipeline\engines\Engine:

[legend]

Collaboration diagram for fiftyone\pipeline\engines\Engine:

[legend]

Public Member Functions

 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

array  $restrictedProperties

Data Fields inherited from fiftyone\pipeline\core\FlowElement

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

Member Function Documentation

◆ getDataSourceTier()

fiftyone\pipeline\engines\Engine::getDataSourceTier ( )

Get the tier to which the current data source belongs.

For 51Degrees this will usually be one of: Lite Premium Enterprise.

◆ inCache()

fiftyone\pipeline\engines\Engine::inCache ( FlowData   $flowData )

A method to check if a flowData's evidence is in the cache.

Parameters
\fiftyone\pipeline\core\FlowData
$flowData -

◆ process()

fiftyone\pipeline\engines\Engine::process ( FlowData   $flowData )

Engine's core process function.

Calls specific overridden processInternal methods but wraps it in a cache check and a cache put.

◆ setCache()

fiftyone\pipeline\engines\Engine::setCache ( DataKeyedCache   $cache )

Add a cache to an engine.

Parameters
\fiftyone\pipeline\engines\DataKeyedCache
$cache - Cache implementation with get and set methods

◆ setRestrictedProperties()

fiftyone\pipeline\engines\Engine::setRestrictedProperties ( array   $propertiesList )

Add a subset of properties.

Parameters
array<string> - $propertiesList Array of properties to include
On This Page