51Degrees Pipeline for PHP

fiftyone\pipeline\ipintelligence\translation\CountryCodeTranslationEngine Class Reference

Detailed Description

Engine 1: translates the weighted ISO country codes emitted by the IP intelligence engine (CountryCodesGeographical / CountryCodesPopulation) into weighted English country names (CountryNamesGeographical / CountryNamesPopulation), using countrycodes.en_GB.yml.

Mirrors ip-intelligence-dotnet's CountryCodeTranslationEngine: it is just the property map below passed to the base translation engine with a fixed en_GB language and the Original missing behaviour.

Inheritance diagram for fiftyone\pipeline\ipintelligence\translation\CountryCodeTranslationEngine:

[legend]

Collaboration diagram for fiftyone\pipeline\ipintelligence\translation\CountryCodeTranslationEngine:

[legend]

Public Member Functions

 __construct (?string $translationsDir=null)

Public Member Functions inherited from fiftyone\pipeline\translation\TranslationEngine

 __construct (string $elementDataKey, string $sourceElementDataKey, array $propertyMap, array $localeMaps, ?string $fixedLanguage=null, string $behavior=MissingTranslationBehavior::ORIGINAL)
 getEvidenceKeyFilter ()
 Function for getting the FlowElement's EvidenceKeyFilter Used by the filterEvidence method.
 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\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.
 filterEvidence (FlowData $flowData)
 Filter FlowData evidence using the FlowElement's EvidenceKeyFilter.
 filterEvidenceKey (string $key)
 Filter FlowData evidence using the FlowElement's EvidenceKeyFilter.
 onRegistration (Pipeline $pipeline)
 Callback called when an engine is added to a pipeline.
 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\translation\TranslationEngine

string $dataKey
const EVIDENCE_KEYS

Data Fields inherited from fiftyone\pipeline\engines\Engine

array $restrictedProperties

Data Fields inherited from fiftyone\pipeline\core\FlowElement

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

Protected Member Functions inherited from fiftyone\pipeline\translation\TranslationEngine

 buildTranslatedProperties (FlowData $flowData, Translator $translator)
 Translate every mapped property and return the result keyed by lower-cased destination property name.
 resolveTranslator (FlowData $flowData)
 Resolve the translator and locale to use for this request.
 getEvidenceValue (FlowData $flowData)
 Read the first non-blank translation evidence value, in precedence order.

Protected Attributes inherited from fiftyone\pipeline\translation\TranslationEngine

array $propertyMap
string $sourceElementDataKey
string $fixedLanguage
string $behavior
array $translators = []
array $availableLocales = []
Translator $emptyTranslator