51Degrees Pipeline for PHP

fiftyone\pipeline\core\SequenceElement Class Reference

Detailed Description

The SequenceElement stores session data regarding requests for client side JavaScript from the JavaScript created by a Pipeline's JavaScriptBuilder If a Pipeline is constructed with the JavaScript elements enabled this is added automatically along with the JavaScriptBuilder and JSONBundler.

Inheritance diagram for fiftyone\pipeline\core\SequenceElement:

[legend]

Collaboration diagram for fiftyone\pipeline\core\SequenceElement:

[legend]

Public Member Functions

 getEvidenceKeyFilter ()
 The SequenceElement uses query.sequence and query.session-id evidence.
 processInternal (FlowData $flowData)
 The SequenceElement stores session data for requests for JavaScript.

Public Member Functions inherited from fiftyone\pipeline\core\FlowElement

 __construct ()
 A default dummy constructor is needed for there are classes inheriting this class deeper than 1-level of inheritance and calling parent::__construct() in their explicit constructors.
 process (FlowData $flowData)
 General wrapper function that calls a FlowElement's processInternal method.
 filterEvidence (FlowData $flowData)
 Filter FlowData evidence using the FlowElement's EvidenceKeyFilter.
 filterEvidenceKey (string $key)
 Filter FlowData evidence using the FlowElement's EvidenceKeyFilter.
 onRegistration (Pipeline $pipeline)
 Callback called when an engine is added to a pipeline.
 getProperties ()
 Get properties Usually overridden by specific FlowElements.
 updatePropertyList ()
 Update a FlowElement's property list This is used by elements that are only aware of their properties at a later stage, such as cloud request based FlowElements or FlowElements that change their properties later based on new datafiles.

Data Fields

string $dataKey = 'sequence'
array $properties

Data Fields inherited from fiftyone\pipeline\core\FlowElement

string $dataKey
array $properties = []
array $pipelines = []

Member Function Documentation

◆ getEvidenceKeyFilter()

fiftyone\pipeline\core\SequenceElement::getEvidenceKeyFilter ( )

The SequenceElement uses query.sequence and query.session-id evidence.

Reimplemented from fiftyone\pipeline\core\FlowElement.

◆ processInternal()

fiftyone\pipeline\core\SequenceElement::processInternal ( FlowData $flowData)

The SequenceElement stores session data for requests for JavaScript.

It writes the session id and sequence to Evidence, under query.session-id and query.sequence, and to its Element Data, under session-id and sequence.

Reimplemented from fiftyone\pipeline\core\FlowElement.

Field Documentation

◆ $properties

array fiftyone\pipeline\core\SequenceElement::$properties
Initial value:
= [
'session-id' => ['name' => 'session-id', 'type' => 'string'],
'sequence' => ['name' => 'sequence', 'type' => 'int'],
]