51Degrees Pipeline for PHP

fiftyone\pipeline\ipintelligence\SwigData Class Reference

Detailed Description

Extension of AspectData for retrieving results created by the SWIG wrapper of the on-premise IP intelligence engine.

Property values (or the lack of one) are returned in an AspectPropertyValue. Weighted properties (for example Mcc) are returned as a list of ['value' => ..., 'rawweighting' => ...] arrays, matching the shape returned by the cloud engine.

Inheritance diagram for fiftyone\pipeline\ipintelligence\SwigData:

[legend]

Collaboration diagram for fiftyone\pipeline\ipintelligence\SwigData:

[legend]

Public Member Functions

 __construct ($engine, $result, ?string $echoIp=null, ?string $echoIpv6=null)
 close ()
 Release the native results, which keep the engine's data in memory while they are held, even after the engine is closed or its data is refreshed.
 get (string $key)
 Get a property value, once the results are known to be open.
 __isset ($key)
 getInternal ($key)

Public Member Functions inherited from fiftyone\pipeline\engines\AspectData

 __construct (Engine $flowElement)
 Constructor for element data Adds default missing property service if not available.

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

 __construct (FlowElement $flowElement)
 __get (string $key)
 asDictionary ()
 Get the values contained in the ElementData instance as a dictionary of keys and values.
 getAsString (string $key)
 Helper method to get property as a string.
 getAsFloat (string $key)
 Helper method to get property as a float.
 getAsInteger (string $key)
 Helper method to get property as an int.

Additional Inherited Members

Data Fields inherited from fiftyone\pipeline\engines\AspectData

MissingPropertyService $missingPropertyService = null

Data Fields inherited from fiftyone\pipeline\core\ElementData

FlowElement $flowElement

Protected Member Functions inherited from fiftyone\pipeline\core\ElementData

 getInternal (string $key)
 Called by the get() method Returns the requested property from the data.

Member Function Documentation

◆ close()

fiftyone\pipeline\ipintelligence\SwigData::close ( )

Release the native results, which keep the engine's data in memory while they are held, even after the engine is closed or its data is refreshed.

Values already read are unaffected, and reading a property afterwards throws an exception. Closing the FlowData closes its results.

◆ get()

fiftyone\pipeline\ipintelligence\SwigData::get ( string $key)

Get a property value, once the results are known to be open.

Checked here, because AspectData::get turns an exception from getInternal into a missing property message.

Exceptions

Exception

Reimplemented from fiftyone\pipeline\engines\AspectData.