Detailed Description
The JSONBundler aggregates all properties from FlowElements into a JSON object It is used for retrieving via an endpoint from the client side via the JavaScriptBuilder and also used inside the JavaScriptBuilder itself to pass properties to the client side.
Both this and the JavaScriptBuilder element are automatically added to a Pipeline unless specifically omitted in the PipelineBuilder.
Inheritance diagram for fiftyone\pipeline\core\JsonBundlerElement:
Collaboration diagram for fiftyone\pipeline\core\JsonBundlerElement:
Public Member Functions | |
| processInternal (FlowData $flowData) | |
| The JSONBundler extracts all properties from a FlowData and serializes them into JSON. | |
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. | |
| getEvidenceKeyFilter () | |
| Function for getting the FlowElement's EvidenceKeyFilter Used by the filterEvidence 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 = 'jsonbundler' |
| array | $json |
Data Fields inherited from fiftyone\pipeline\core\FlowElement | |
| string | $dataKey |
| array | $properties = [] |
| array | $pipelines = [] |
Member Function Documentation
◆ processInternal()
| fiftyone\pipeline\core\JsonBundlerElement::processInternal | ( | FlowData | $flowData | ) |
The JSONBundler extracts all properties from a FlowData and serializes them into JSON.
@phpstan-var null|\fiftyone\pipeline\core\AspectPropertyValue $valueContainer
Reimplemented from fiftyone\pipeline\core\FlowElement.