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

	setCache ($cache) Add a cache to an engine. More...
	setRestrictedProperties ($propertiesList) Add a subset of properties. More...
	inCache ($flowData) A method to check if a flowData's evidence is in the cache. More...
	process ($flowData) Engine's core process function. More...
Public Member Functions inherited from fiftyone\pipeline\core\FlowElement
	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.

Member Function Documentation

◆ inCache()

fiftyone\pipeline\engines\Engine::inCache

(

$flowData

)

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

Parameters: FlowData -

◆ process()

fiftyone\pipeline\engines\Engine::process

(

$flowData

)

Engine's core process function.

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

Parameters: FlowData -

◆ setCache()

fiftyone\pipeline\engines\Engine::setCache

(

$cache

)

Add a cache to an engine.

Parameters: Cache - (cache with get and set methods)

◆ setRestrictedProperties()

fiftyone\pipeline\engines\Engine::setRestrictedProperties

(

$propertiesList

)

Add a subset of properties.

Parameters: string[] - an array of properties to include

51Degrees Pipeline PHP 4.1

fiftyone\pipeline\engines\Engine Class Reference