51Degrees Pipeline PHP  4.1

51Degrees Pipeline for PHP

Classes

51Degrees Node.js classes. These contain the interfaces and logic of the Pipeline API.
[detail level 1234]
Nfiftyone
Npipeline
Ncloudrequestengine
CCloudEngine
This is a template for all 51Degrees cloud engines
CCloudRequestEngine
Ncore
CAspectPropertyValue
An AspectPropertyValue is a wrapper for a value It lets you check this wrapper has a value inside it If not value is set, a specific no value message is returned
CBasicListEvidenceKeyFilter
An instance of EvidenceKeyFilter that uses a simple array of keys Evidence not using these keys is filtered out
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
An evidence key filter is added to a FlowElement It tells the Pipeline which evidence it is interested in This can be used to determine whether a request can be cached Or to filter out evidence not needed by any element in a Pipeline This base class is always extended for a specific filter type
CFlowData
FlowData is created by a specific Pipeline It collects evidence set by the user It passes evidence to FlowElements in the Pipeline These elements can return ElementData or populate an errors object
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
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
Nengines
CAspectData
AspectData extends elementData by adding the option of a missing property service It also allows properties to be explicitly excluded by a flowElement / engine
CAspectDataDictionary
AspectData class extension that stores content as an array Similar to elementDataDictionary in the Pipeline core library
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
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
CArrayLogger
CAstrologyFlowElement
[class] [declaration]
CExampleFlowElementA
CExampleFlowElementB