\r\n

51Degrees Pipeline PHP  4.4

51Degrees Pipeline for PHP

fiftyone\pipeline\core\FlowData Class Reference

Collaboration diagram for fiftyone\pipeline\core\FlowData:

[legend]

Public Member Functions

 __construct (Pipeline $pipeline)
Constructor for FlowData. More...
 __get (string $flowElementKey)
Magic getter to allow $FlowData->FlowElementKey getting.
 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 $flowElement)
Retrieve data by FlowElement object.
 get (string $flowElementKey)
Retrieve data by FlowElement key. More...
 setElementData (ElementData $data)
Set data (used by FlowElement).
 setError (string $key, \Throwable $error)
Set error (should be keyed by FlowElement dataKey).
 getEvidenceDataKey ()
Get an array evidence stored in the FlowData, filtered by its FlowElements' EvidenceKeyFilters. More...
 stop ()
Stop processing any subsequent FlowElements.
 getWhere (string $metaKey, $metaValue)
Get data from FlowElement based on property metadata. More...

Data Fields

Pipeline  $pipeline
bool  $stopped = false
Evidence  $evidence
array  $data = []
bool  $processed = false
array  $errors = []

Constructor & Destructor Documentation

◆ __construct()

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

Constructor for FlowData.

Parameters
\fiftyone\pipeline\core\Pipeline
$pipeline - Parent Pipeline

Member Function Documentation

◆ get()

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

Retrieve data by FlowElement key.

Exceptions
-

◆ getEvidenceDataKey()

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

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

Returns
array<string, int|string>

◆ getWhere()

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

Get data from FlowElement based on property metadata.

Parameters
mixed
$metaValue -
Returns
array<string, mixed>

◆ 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
static
On This Page