Detailed Description
Builds a Pipeline that uses the on-premise IP intelligence engine to look up IP intelligence data from a local data file.
Mirrors device-detection-php-onpremise usage and ip-intelligence-dotnet's IpiOnPremisePipelineBuilder.
Inheritance diagram for fiftyone\pipeline\ipintelligence\IpIntelligenceOnPremisePipelineBuilder:
Collaboration diagram for fiftyone\pipeline\ipintelligence\IpIntelligenceOnPremisePipelineBuilder:
Public Member Functions | |
| __construct (array $settings) | |
| The settings are passed straight through to IpIntelligenceOnPremise. | |
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\IpIntelligenceOnPremisePipelineBuilder::__construct | ( | array | $settings | ) |
The settings are passed straight through to IpIntelligenceOnPremise.
- Parameters
-
array<string,mixed> $settings dataFile - (required, unless the global engine is used) path to the .ipi data file. performanceProfile - (optional) one of Constants::PERFORMANCE_PROFILES, defaulting to Constants::DEFAULT_PERFORMANCE_PROFILE. restrictedProperties- (optional) list of properties to populate. concurrency - (optional) expected concurrent accesses.
Omitting "dataFile" reuses the shared global engine when one exists; see IpIntelligenceOnPremise for what that rejects.
- Exceptions
-
Exception
Reimplemented from fiftyone\pipeline\core\PipelineBuilder.