51Degrees Pipeline PHP  4.2

51Degrees Pipeline for PHP

Search

Documentation

• fiftyone
• pipeline
• core
• FlowElement

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:

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.

Data Fields

	$dataKey
	$properties = []

Member Function Documentation

◆ filterEvidence()

fiftyone\pipeline\core\FlowElement::filterEvidence

(

$flowData

)

Filter FlowData evidence using the FlowElement's EvidenceKeyFilter.

Parameters

FlowData -

Returns

mixed

◆ filterEvidenceKey()

fiftyone\pipeline\core\FlowElement::filterEvidenceKey

(

$key

)

Filter FlowData evidence using the FlowElement's EvidenceKeyFilter.

Parameters

FlowData -

Returns

mixed

◆ getEvidenceKeyFilter()

fiftyone\pipeline\core\FlowElement::getEvidenceKeyFilter

(

)

Function for getting the FlowElement's EvidenceKeyFilter Used by the filterEvidence method.

Returns

EvidenceKeyFilter

◆ 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

• Public Member Functions
• Data Fields

Generated by doxygen 1.8.15