51Degrees Pipeline for PHP

fiftyone\pipeline\core\PipelineBuilder Class Reference

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.

Inheritance diagram for fiftyone\pipeline\core\PipelineBuilder:

[legend]

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
 Adds the Sequence, JSON Bundler and JavaScript Builder elements together.
bool $addSequenceElement
bool $addJsonBundlerElement
bool $addJavaScriptBuilderElement
bool $addSetHeaderElement
array $javascriptBuilderSettings = []
bool $useSetHeaderProperties
 Adds the Set Header element.

Protected Attributes

array $flowElements = []
array $settings = []

Constructor & Destructor Documentation

◆ __construct()

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 } }] }.

If an element fails to build, the elements already built from the configuration are closed and the error is thrown.

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

Field Documentation

◆ $addJavaScriptBuilder

bool fiftyone\pipeline\core\PipelineBuilder::$addJavaScriptBuilder

Adds the Sequence, JSON Bundler and JavaScript Builder elements together.

False leaves out all three, whatever their own switches say.

◆ $useSetHeaderProperties

bool fiftyone\pipeline\core\PipelineBuilder::$useSetHeaderProperties

Adds the Set Header element.

False leaves it out, whatever addSetHeaderElement says.