51Degrees PHP classes. These contain the interfaces and logic of the Pipeline API.
| Nfiftyone | |
| Npipeline | |
| Ncloudrequestengine | |
| CCloudEngine | This is a template for all 51Degrees cloud engines |
| CCloudRequestEngine | |
| CCloudRequestException | Contains details about exceptions that occur when making requests to the cloud service |
| CConstants | |
| CHttpClient | |
| Ncore | |
| CAspectPropertyValue | |
| CBasicListEvidenceKeyFilter | An instance of EvidenceKeyFilter that uses a simple array of keys Evidence not using these keys is filtered out |
| CCallbackUrl | The callback URL the client script posts to for updated JSON |
| CConstants | Class containing project's constants |
| CElementData | Stores information created by a FlowElement based on FlowData |
| CElementDataDictionary | An extension of ElementData with dictionary object storage / lookup |
| CEvidence | Storage of evidence on a FlowData object |
| CEvidenceKeyFilter | |
| CFlowData | |
| CFlowElement | A FlowElement is placed inside a Pipeline It receives Evidence via a FlowData object It uses this to optionally create ElementData on the FlowData It has a unique dataKey which is used to extract data from the FlowData Any errors in processing are caught in the FlowData's errors object |
| CJavascriptBuilderElement | The JavaScriptBuilder aggregates JavaScript properties from FlowElements in the Pipeline |
| CJsonBundlerElement | The JSONBundler aggregates all properties from FlowElements into a JSON object It is used for retrieving via an endpoint from the client side via the JavaScriptBuilder and also used inside the JavaScriptBuilder itself to pass properties to the client side |
| CLogger | Logging for a Pipeline |
| CMessages | Constants used for messages returned to the user |
| CPipeline | Pipeline holding a list of FlowElements for processing, can create FlowData that will be passed through these, collecting ElementData Should be constructed through the PipelineBuilder class |
| CPipelineBuilder | A PipelineBuilder generates a Pipeline object Before construction of the Pipeline, FlowElements are added to it There are also options for how JavaScript is output from the Pipeline |
| CSequenceElement | The SequenceElement stores session data regarding requests for client side JavaScript from the JavaScript created by a Pipeline's JavaScriptBuilder If a Pipeline is constructed with the JavaScript elements enabled this is added automatically along with the JavaScriptBuilder and JSONBundler |
| CSetHeaderElement | Set response headers element class |
| CUtils | |
| Ndevicedetection | |
| CConstants | Constants which may be reused by the API |
| CDeviceDetectionCloud | |
| CDeviceDetectionOnPremise | |
| CDeviceDetectionPipelineBuilder | Extension of pipelineBuilder class that allows for the quick generation of a device detection pipeline |
| CHardwareProfileCloud | |
| CMessages | Messages which may be reused by the API |
| CSwigData | |
| CSwigHelpers | |
| Ndid | |
| CCloudException | The cloud answered with a status the client does not turn into a result |
| CDidClient | Client for every manipulation of a 51Did a server needs against the 51Degrees cloud, so server code never hand-writes HTTP or key handling |
| CFodId | A strongly typed reader for the 51Did (51Degrees Identifier) returned by the 51Degrees Cloud service |
| CFodIdLayout | The byte offsets and lengths of the 51Did payload, for this package and its tests only |
| CFodIdParseResult | What reading a 51Did produced, and why |
| CNotSupportedException | The host answering does not offer the creator context (the redeem endpoint answered 404) |
| CPublicKey | One entry of the 51Did signing key schedule as the cloud publishes it |
| CRedeemResult | The typed answer to { |
| Nengines | |
| CAspectData | |
| CAspectDataDictionary | AspectData class extension that stores content as an array Similar to ElementDataDictionary in the Pipeline core library |
| CCloudEngineBase | Intermediary between Engine and CloudEngine classes |
| CDataKeyedCache | A simple cache class which has a get and set method Can be added to an engine to cache its results for specific evidence This base class needs to be extended to form an actual cache |
| CEngine | An engine is an extension of the Pipeline Core flowElement class It allows for a cache, restricted properties and meaningful errors when a property isn't available via the aspect data missingPropertyService |
| CMissingPropertyMessages | Messages which may be reused for various missing property exceptions |
| CMissingPropertyReason | Enumeration of reasons why a property may be missing from the results of an Engine's processing |
| CMissingPropertyService | A missing property service runs when a property is not available in the aspectData |
| CSessionCache | An extension of the cache class that stores a cache in a user's session if PHP sessions are active |
| CTracker | The tracker class extends the cache class with a track method that checks if a key is in the cache and runs a match method on the result if it is found in the cache |
| Ngeolocation | |
| CGeoLocationCloud | |
| CGeoLocationPipelineBuilder | Extension of pipelineBuilder class that allows for the quick generation of a geolocation pipeline |
| Nipintelligence | |
| Ntranslation | |
| CConstants | |
| CCountriesTranslationEngine | Engine 2: translates the weighted English country names from Engine 1 into the browser language, and builds the complete ordered "All" lists used by the country dropdown |
| CCountriesTranslationEngineBuilder | Builder for CountriesTranslationEngine |
| CCountryCodeTranslationEngine | 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 |
| CCountryCodeTranslationEngineBuilder | Builder for CountryCodeTranslationEngine |
| CTranslationPaths | Locates the country translation YAML files, which ship in the ip-intelligence folder of the data repository, and loads them |
| CConstants | |
| CIpIntelligenceCloud | The IP intelligence cloud engine requires the 51Degrees CloudRequestEngine to be placed in a pipeline before it |
| CIpIntelligenceOnPremise | The on-premise IP intelligence engine uses a local data file (.ipi) to generate a set of properties about an IP address supplied as evidence |
| CIpIntelligenceOnPremisePipelineBuilder | Builds a Pipeline that uses the on-premise IP intelligence engine to look up IP intelligence data from a local data file |
| CIpIntelligencePipelineBuilder | The IpIntelligencePipelineBuilder builds a Pipeline that uses the 51Degrees cloud service to look up IP intelligence data |
| CMessages | |
| CSwigData | Extension of AspectData for retrieving results created by the SWIG wrapper of the on-premise IP intelligence engine |
| CSwigHelpers | |
| Ntranslation | |
| CLanguages | Helpers for parsing an HTTP Accept-Language value and resolving it to one of the locales for which a translation map is available |
| CMissingTranslationBehavior | How a translation engine behaves when there is no translation for a given value |
| CTranslationEngine | Generic translation engine |
| CTranslator | Translates values using a single locale's translation map |
| CYamlMap | Minimal parser for the flat "key: value" YAML maps used by the country translation files |