51Degrees Pipeline for PHP

fiftyone\pipeline\core\Messages Class Reference

Detailed Description

Constants used for messages returned to the user.

These can be error messages, or otherwise. Messages which require formatting will contain format characters e.g. s.

Data Fields

const NO_ELEMENT_DATA = "There is no element data for '%s' against this flow data. Available element data keys are: '%s'"
 Error message thrown when there is no matching element in the FlowData.
const NO_ELEMENT_DATA_NULL = "There is no element data for '%s' against this flow data.'"
const PASS_KEY_VALUE = 'Must pass key and value'
const FLOW_DATA_PROCESSED = 'FlowData already processed'
const CLIENT_SIDE_PROCESSED = 'Pass the FlowData for a client-side response before it is processed, because its ETag is calculated from the Evidence the request supplied.'
 A client-side response was asked for with a FlowData that has been processed, so the Evidence the request supplied cannot be told from the Evidence processing added.
const NO_SEQUENCE = 'The JSON Bundler needs a sequence number. Place a Sequence Element before the JSON Bundler in the Pipeline.'
 The JSON Bundler found no sequence number from a Sequence Element.
const PROPERTY_NOT_SET_HEADER = "Property Name '%s' does not start with 'SetHeader'."
 Property does not start with SetHeader.
const WRONG_PROPERTY_FORMAT = "Property Name '%s' is not in the expected format i.e. SetHeader[Component][HeaderName]. "
 Property Name is not in the valid format.
const ELEMENT_NOT_FOUND = "Element '%s' is not present in the FlowData. "
 Element not found in flowData.
const PROPERTY_NOT_FOUND = "Property '%s' is not present in the FlowData against '%s' ElementData. "
 Property not found in flowData.

Field Documentation

◆ ELEMENT_NOT_FOUND

const fiftyone\pipeline\core\Messages::ELEMENT_NOT_FOUND = "Element '%s' is not present in the FlowData. "

Element not found in flowData.

This takes the element datakey as format argument.

◆ PROPERTY_NOT_FOUND

const fiftyone\pipeline\core\Messages::PROPERTY_NOT_FOUND = "Property '%s' is not present in the FlowData against '%s' ElementData. "

Property not found in flowData.

This takes the element dataKey and property names as format arguments.

◆ PROPERTY_NOT_SET_HEADER

const fiftyone\pipeline\core\Messages::PROPERTY_NOT_SET_HEADER = "Property Name '%s' does not start with 'SetHeader'."

Property does not start with SetHeader.

This takes the name of a property as a format argument.

◆ WRONG_PROPERTY_FORMAT

const fiftyone\pipeline\core\Messages::WRONG_PROPERTY_FORMAT = "Property Name '%s' is not in the expected format i.e. SetHeader[Component][HeaderName]. "

Property Name is not in the valid format.

This takes the property name as format argument.