\r\n

51Degrees Pipeline PHP  4.1Newer Version 4.4

51Degrees Pipeline for PHP

fiftyone\pipeline\core\FlowElement Class Reference

Detailed Description

A FlowElement is placed inside a Pipeline It receives Evidence via a FlowData object It uses this to optionally create ElementData on the FlowData It has a unique dataKey which is used to extract data from the FlowData Any errors in processing are caught in the FlowData's errors object.

Examples
CustomFlowElement.php.

Inheritance diagram for fiftyone\pipeline\core\FlowElement:

[legend]

Public Member Functions

 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.
 __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 unfortunately intermediates do not define their own __construct() so the call propagates up to the base class FlowElement and fails. More...

Data Fields

 $dataKey
 $properties = []
 $pipelines = []

Constructor & Destructor Documentation

◆ __construct()

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 unfortunately intermediates do not define their own __construct() so the call propagates up to the base class FlowElement and fails.

Intermediates might define their own __construct() at some point, so we do not want remove parent::__construct() calls, rather add this one as a catch all.

Member Function Documentation

◆ getProperties()

fiftyone\pipeline\core\FlowElement::getProperties ( )

Get properties is usually overriden by specific FlowElements.

Returns
array key value array of properties

◆ onRegistration()

fiftyone\pipeline\core\FlowElement::onRegistration (   $pipeline )

Callback called when an engine is added to a pipeline.

Parameters
Pipeline -
Returns
void

◆ process()

fiftyone\pipeline\core\FlowElement::process (   $flowData )

General wrapper function that calls a FlowElement's processInternal method.

Parameters
FlowData -

◆ processInternal()

fiftyone\pipeline\core\FlowElement::processInternal (   $flowData )

Process FlowData - this is process function is usually overriden by specific FlowElements to do their core work.

Parameters
FlowData -
On This Page

Generated by doxygen 1.8.15