51Degrees Pipeline for PHP

fiftyone\pipeline\devicedetection\DeviceDetectionPipelineBuilder Class Reference

Detailed Description

Extension of pipelineBuilder class that allows for the quick generation of a device detection pipeline.

Inheritance diagram for fiftyone\pipeline\devicedetection\DeviceDetectionPipelineBuilder:

[legend]

Collaboration diagram for fiftyone\pipeline\devicedetection\DeviceDetectionPipelineBuilder:

[legend]

Public Member Functions

 __construct (array $settings)
 settings.resourceKey settings.cloudEndPoint custom endpoint for the cloud service settings.restrictedProperties (list of properties to restrict the results to) settings.cloudRequestOrigin value to use for the Origin header when sending requests to cloud.

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

 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 $restrictedProperties
 $cache
string $resourceKey
string $licenseKey

Data Fields inherited from fiftyone\pipeline\core\PipelineBuilder

array $pipelines
bool $addJavaScriptBuilder
array $javascriptBuilderSettings = []
bool $useSetHeaderProperties

Additional Inherited Members

Protected Attributes inherited from fiftyone\pipeline\core\PipelineBuilder

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

Constructor & Destructor Documentation

◆ __construct()

fiftyone\pipeline\devicedetection\DeviceDetectionPipelineBuilder::__construct ( array $settings)

settings.resourceKey settings.cloudEndPoint custom endpoint for the cloud service settings.restrictedProperties (list of properties to restrict the results to) settings.cloudRequestOrigin value to use for the Origin header when sending requests to cloud.

Parameters
array{resourceKey: string, cloudEndPoint?: string, cloudRequestOrigin?: string, restrictedProperties?: array<string>, javascriptBuilderSettings?: array<string, mixed> } $settings

Reimplemented from fiftyone\pipeline\core\PipelineBuilder.