51Degrees Pipeline PHP  4.1

51Degrees Pipeline for PHP

fiftyone\pipeline\core\FlowData Class Reference

Detailed Description

FlowData is created by a specific Pipeline It collects evidence set by the user It passes evidence to FlowElements in the Pipeline These elements can return ElementData or populate an errors object.

Public Member Functions

 __construct ($pipeline)
Constructor for FlowData. More...
 process ()
process function runs the process function on every attached FlowElement allowing data to be changed based on evidence This can only be run once per FlowData instance More...
 getFromElement ($flowElement)
Retrieve data by FlowElement object. More...
 get ($flowElementKey)
Retrieve data by FlowElement key. More...
 __get ($flowElementKey)
Magic getter to allow $FlowData->FlowElementKey getting. More...
 setElementData ($data)
Set data (used by FlowElement) More...
 setError ($key, $error)
Set error (should be keyed by FlowElement dataKey) More...
 getEvidenceDataKey ()
Get an array evidence stored in the FlowData, filtered by its FlowElements' EvidenceKeyFilters. More...
 stop ()
Stop processing any subsequent FlowElements. More...
 getWhere ($metaKey, $metaValue)
Get data from FlowElement based on property meta data. More...

Data Fields

 $pipeline
 $stopped = false
 $evidence
 $data
 $processed
 $errors = array()

Constructor & Destructor Documentation

◆ __construct()

fiftyone\pipeline\core\FlowData::__construct (   $pipeline )

Constructor for FlowData.

Parameters
Pipeline - // parent Pipeline

Member Function Documentation

◆ __get()

fiftyone\pipeline\core\FlowData::__get (   $flowElementKey )

Magic getter to allow $FlowData->FlowElementKey getting.

Parameters
string - FlowElementKey
Returns
$ElementData

◆ get()

fiftyone\pipeline\core\FlowData::get (   $flowElementKey )

Retrieve data by FlowElement key.

Parameters
string - FlowElementDataKey
Returns
ElementData

◆ getEvidenceDataKey()

fiftyone\pipeline\core\FlowData::getEvidenceDataKey ( )

Get an array evidence stored in the FlowData, filtered by its FlowElements' EvidenceKeyFilters.

Returns
array

◆ getWhere()

fiftyone\pipeline\core\FlowData::getWhere (   $metaKey,
  $metaValue  
)

Get data from FlowElement based on property meta data.

Parameters
string - metakey
mixed - metavalue
Returns
array

◆ process()

fiftyone\pipeline\core\FlowData::process ( )

process function runs the process function on every attached FlowElement allowing data to be changed based on evidence This can only be run once per FlowData instance

Returns
FlowData

◆ setElementData()

fiftyone\pipeline\core\FlowData::setElementData (   $data )

Set data (used by FlowElement)

Parameters
ElementData -

◆ setError()

fiftyone\pipeline\core\FlowData::setError (   $key,
  $error  
)

Set error (should be keyed by FlowElement dataKey)

Parameters
string - key
string - error message

◆ stop()

fiftyone\pipeline\core\FlowData::stop ( )

Stop processing any subsequent FlowElements.

Returns
void