51Degrees Pipeline for PHP

fiftyone\pipeline\geolocation\GeoLocationCloud Class Reference

Inheritance diagram for fiftyone\pipeline\geolocation\GeoLocationCloud:

[legend]

Collaboration diagram for fiftyone\pipeline\geolocation\GeoLocationCloud:

[legend]

Public Member Functions

 __construct (array $settings=['locationProvider'=> 'fiftyonedegrees'])
 Constructor for GeolocationCloud If property not found, call the attached missing property service.
 processInternal (FlowData $flowData)
 Process FlowData - this is process function is usually overridden by specific FlowElements to do their core work.

Public Member Functions inherited from fiftyone\pipeline\cloudrequestengine\CloudEngine

 onRegistration (Pipeline $pipeline)
 Callback called when an engine is added to a pipeline.

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

 getDataSourceTier ()
 Get the tier to which the current data source belongs.
 setCache (DataKeyedCache $cache)
 Add a cache to an engine.
 setRestrictedProperties (array $propertiesList)
 Add a subset of properties.
 inCache (FlowData $flowData)
 A method to check if a flowData's evidence is in the cache.
 process (FlowData $flowData)
 Engine's core process function.

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

 __construct ()
 A default dummy constructor is needed for there are classes inheriting this class deeper than 1-level of inheritance and calling parent::__construct() in their explicit constructors.
 getEvidenceKeyFilter ()
 Function for getting the FlowElement's EvidenceKeyFilter Used by the filterEvidence method.
 filterEvidence (FlowData $flowData)
 Filter FlowData evidence using the FlowElement's EvidenceKeyFilter.
 filterEvidenceKey (string $key)
 Filter FlowData evidence using the FlowElement's EvidenceKeyFilter.
 getProperties ()
 Get properties Usually overridden by specific FlowElements.
 updatePropertyList ()
 Update a FlowElement's property list This is used by elements that are only aware of their properties at a later stage, such as cloud request based FlowElements or FlowElements that change their properties later based on new datafiles.

Additional Inherited Members

Data Fields inherited from fiftyone\pipeline\cloudrequestengine\CloudEngine

string $dataKey = 'CloudEngineBase'
array $aspectProperties

Data Fields inherited from fiftyone\pipeline\engines\Engine

array $restrictedProperties

Data Fields inherited from fiftyone\pipeline\core\FlowElement

string $dataKey
array $properties = []
array $pipelines = []

Constructor & Destructor Documentation

◆ __construct()

fiftyone\pipeline\geolocation\GeoLocationCloud::__construct ( array $settings = ['locationProvider' => 'fiftyonedegrees'])

Constructor for GeolocationCloud If property not found, call the attached missing property service.

Parameters
array<string,string|array<string>>$settings
Exceptions

Exception

Member Function Documentation

◆ processInternal()

fiftyone\pipeline\geolocation\GeoLocationCloud::processInternal ( FlowData $flowData)

Process FlowData - this is process function is usually overridden by specific FlowElements to do their core work.

Reimplemented from fiftyone\pipeline\cloudrequestengine\CloudEngine.