Detailed Description
A PipelineBuilder generates a Pipeline object Before construction of the Pipeline, FlowElements are added to it There are also options for how JavaScript is output from the Pipeline.
Public Member Functions | |
| __construct (array $settings=[]) | |
| add (FlowElement $flowElement) | |
| Add FlowElement to be used in Pipeline. | |
| build () | |
| Build Pipeline once done. | |
| addLogger (Logger $logger) | |
| Add an instance of the logger class to the Pipeline. | |
| buildFromConfig ($fileOrConfig) | |
Build from a JSON configuration file This JSON file should have the following structure: {
"PipelineOptions": {
"Elements": [
{
"BuilderName": // Name of element as in use statement,
"BuildParameters": {
// An object of parameters passed to the constructor
}
}]
}. | |
Data Fields | |
| array | $pipelines |
| bool | $addJavaScriptBuilder |
| array | $javascriptBuilderSettings = [] |
| bool | $useSetHeaderProperties |
Protected Attributes | |
| array | $flowElements = [] |
| array | $settings = [] |
Constructor & Destructor Documentation
◆ __construct()
| fiftyone\pipeline\core\PipelineBuilder::__construct | ( | array | $settings = [] | ) |
- Parameters
-
array<string,mixed> $settings
Member Function Documentation
◆ add()
| fiftyone\pipeline\core\PipelineBuilder::add | ( | FlowElement | $flowElement | ) |
Add FlowElement to be used in Pipeline.
- Returns
- static
◆ addLogger()
| fiftyone\pipeline\core\PipelineBuilder::addLogger | ( | Logger | $logger | ) |
Add an instance of the logger class to the Pipeline.
- Returns
- static
◆ buildFromConfig()
| fiftyone\pipeline\core\PipelineBuilder::buildFromConfig | ( | $fileOrConfig | ) |
Build from a JSON configuration file This JSON file should have the following structure: {
"PipelineOptions": {
"Elements": [
{
"BuilderName": // Name of element as in use statement,
"BuildParameters": {
// An object of parameters passed to the constructor
}
}]
}.
- Parameters
-
array<string,mixed>|string $fileOrConfig Filename of the config file to load config or associative array of config values
@phpstan-var \fiftyone\pipeline\core\FlowElement $builder