51Degrees Pipeline for PHP

fiftyone\pipeline\ipintelligence\IpIntelligencePipelineBuilder Class Reference

Detailed Description

The IpIntelligencePipelineBuilder builds a Pipeline that uses the 51Degrees cloud service to look up IP intelligence data.

It wires up a CloudRequestEngine followed by an IpIntelligenceCloud engine.

Mirrors device-detection-php's DeviceDetectionPipelineBuilder and location-php's GeoLocationPipelineBuilder.

Inheritance diagram for fiftyone\pipeline\ipintelligence\IpIntelligencePipelineBuilder:

[legend]

Collaboration diagram for fiftyone\pipeline\ipintelligence\IpIntelligencePipelineBuilder:

[legend]

Public Member Functions

 __construct (array $settings)

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

Additional Inherited Members

Data Fields inherited from fiftyone\pipeline\core\PipelineBuilder

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

Protected Attributes inherited from fiftyone\pipeline\core\PipelineBuilder

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

Constructor & Destructor Documentation

◆ __construct()

fiftyone\pipeline\ipintelligence\IpIntelligencePipelineBuilder::__construct ( array $settings)
Parameters
array<string,mixed>$settings resourceKey - (required) 51Degrees cloud resource key. cloudEndPoint - (optional) override the cloud service base URL. cloudRequestOrigin - (optional) value for the Origin header. restrictedProperties- (optional) list of properties to request. httpClient - (optional) HttpClient instance (used for tests).
Exceptions

Exception

Reimplemented from fiftyone\pipeline\core\PipelineBuilder.