51Degrees Pipeline PHP  4.1

51Degrees Pipeline for PHP

Search

Documentation

• fiftyone
• pipeline
• cloudrequestengine
• CloudRequestEngine

fiftyone\pipeline\cloudrequestengine\CloudRequestEngine Class Reference

Inheritance diagram for fiftyone\pipeline\cloudrequestengine\CloudRequestEngine:

Collaboration diagram for fiftyone\pipeline\cloudrequestengine\CloudRequestEngine:

Public Member Functions

	__construct ($settings) Constructor for CloudRequestEngine. More...
	getEvidenceKeyFilter () Instance of EvidenceKeyFilter based on the evidence keys fetched from the cloud service by the private getEvidenceKeys() method. More...
	processInternal ($flowData) Processing function for the CloudRequestEngine Makes a request to the cloud service with the supplied resource key and evidence and returns a JSON object that is then parsed by cloud engines placed later in the pipeline. More...
Public Member Functions inherited from fiftyone\pipeline\engines\Engine
	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.

Data Fields

	$dataKey = "cloud"
	$baseURL = "https://cloud.51degrees.com/api/v4/"
	$flowElementProperties = array()
Data Fields inherited from fiftyone\pipeline\core\FlowElement
	$dataKey
	$properties = []

Constructor & Destructor Documentation

◆ __construct()

fiftyone\pipeline\cloudrequestengine\CloudRequestEngine::__construct

(

$settings

)

Constructor for CloudRequestEngine.

Parameters

array - settings Settings should contain a resourceKey and optionally a cloudEndPoint to overwrite the default baseurl

Member Function Documentation

◆ getEvidenceKeyFilter()

fiftyone\pipeline\cloudrequestengine\CloudRequestEngine::getEvidenceKeyFilter

(

)

Instance of EvidenceKeyFilter based on the evidence keys fetched from the cloud service by the private getEvidenceKeys() method.

Returns

BasicListEvidenceKeyFilter

◆ processInternal()

fiftyone\pipeline\cloudrequestengine\CloudRequestEngine::processInternal

(

$flowData

)

Processing function for the CloudRequestEngine Makes a request to the cloud service with the supplied resource key and evidence and returns a JSON object that is then parsed by cloud engines placed later in the pipeline.

Parameters

FlowData -

On This Page

• Public Member Functions
• Data Fields

Generated by doxygen 1.8.15