\r\n

51Degrees Pipeline PHP  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.

Inheritance diagram for fiftyone\pipeline\core\FlowElement:

[legend]

Public Member Functions

 __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
array  $properties = []
array  $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 to remove parent::__construct() calls, rather add this one as a catch-all.

Member Function Documentation

◆ getProperties()

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

Get properties Usually overridden by specific FlowElements.

Returns
array<string, array<string, mixed>> Key-value array of properties
On This Page

Generated by doxygen 1.8.15