51Degrees Pipeline for PHP

fiftyone\pipeline\cloudrequestengine\Constants Class Reference

Data Fields

const CLOUD_ENDPOINT_VARIABLE = '_51DEGREES_CLOUD_ENDPOINT'
const FOD_CLOUD_API_URL = 'FOD_CLOUD_API_URL'
 Environment variable read for the cloud endpoint when CLOUD_ENDPOINT_VARIABLE is not set or is empty.
const MESSAGE_ENDPOINT_VARIABLE_DEPRECATED
const BASE_URL_DEFAULT = 'https://cloud.51degrees.com/api/v4/'
const MESSAGE_NO_DATA_IN_RESPONSE = 'No data in response from cloud service at %s'
const EXCEPTION_CLOUD_ERRORS_MULTIPLE
const EXCEPTION_CLOUD_ERROR
const MESSAGE_ERROR_CODE_RETURNED = "Cloud service at '%s' returned status code '%s' with content %s"
const MESSAGE_REQUEST_FAILED = "The request to the cloud service at '%s' could not be made: %s"
const RESOURCE_PARAMETER = 'resource'
const LICENSE_PARAMETER = 'license'
const VALUES_PARAMETER = 'values'
const LICENSE_DATA_PATH = 'json'
const MESSAGE_NO_CREDENTIAL
const MESSAGE_LICENSE_KEY_NEEDS_PROPERTIES
const MESSAGE_PROPERTIES_NOT_COVERED
const MESSAGE_NOT_PROPERTIES
const EVIDENCE_SEPERATOR = '.'
const EVIDENCE_HTTPHEADER_PREFIX = 'header'
const EVIDENCE_COOKIE_PREFIX = 'cookie'
const EVIDENCE_QUERY_PREFIX = 'query'
const OTHER_PREFIX_PRECEDENCE = ['server', 'fiftyone', 'location']
const EVIDENCE_OTHER = 'other'
const RESERVED_EVIDENCE_SUFFIXES
const WARNING_MESSAGE = "'%s=>%s' evidence conflicts with "
const EVIDENCE_TAC_SUFFIX = 'tac'
const EVIDENCE_QUERY_TAC_KEY
const EVIDENCE_NATIVE_MODEL_SUFFIX = 'nativemodel'
const EVIDENCE_QUERY_NATIVE_MODEL_KEY
const CLOUDREQUESTENGINE_EXCEPTION_MESSAGE

Field Documentation

◆ CLOUDREQUESTENGINE_EXCEPTION_MESSAGE

const fiftyone\pipeline\cloudrequestengine\Constants::CLOUDREQUESTENGINE_EXCEPTION_MESSAGE
Initial value:
=
'CloudRequestEngine needs to be placed before cloud elements in Pipeline'

◆ EVIDENCE_QUERY_NATIVE_MODEL_KEY

const fiftyone\pipeline\cloudrequestengine\Constants::EVIDENCE_QUERY_NATIVE_MODEL_KEY
Initial value:
=
Constants::EVIDENCE_QUERY_PREFIX .
Constants::EVIDENCE_SEPERATOR .
Constants::EVIDENCE_NATIVE_MODEL_SUFFIX

◆ EVIDENCE_QUERY_TAC_KEY

const fiftyone\pipeline\cloudrequestengine\Constants::EVIDENCE_QUERY_TAC_KEY
Initial value:
=
Constants::EVIDENCE_QUERY_PREFIX .
Constants::EVIDENCE_SEPERATOR .
Constants::EVIDENCE_TAC_SUFFIX

◆ EXCEPTION_CLOUD_ERROR

const fiftyone\pipeline\cloudrequestengine\Constants::EXCEPTION_CLOUD_ERROR
Initial value:
=
"Error returned from 51Degrees cloud service: '%s'"

◆ EXCEPTION_CLOUD_ERRORS_MULTIPLE

const fiftyone\pipeline\cloudrequestengine\Constants::EXCEPTION_CLOUD_ERRORS_MULTIPLE
Initial value:
=
'Multiple errors returned from 51Degrees cloud service. See inner ' .
'exceptions for details.'

◆ FOD_CLOUD_API_URL

const fiftyone\pipeline\cloudrequestengine\Constants::FOD_CLOUD_API_URL = 'FOD_CLOUD_API_URL'

Environment variable read for the cloud endpoint when CLOUD_ENDPOINT_VARIABLE is not set or is empty.

Deprecated
use {
See also
Constants::CLOUD_ENDPOINT_VARIABLE}

◆ MESSAGE_ENDPOINT_VARIABLE_DEPRECATED

const fiftyone\pipeline\cloudrequestengine\Constants::MESSAGE_ENDPOINT_VARIABLE_DEPRECATED
Initial value:
=
'The cloud endpoint was read from the environment variable %s, ' .
'which is deprecated. %s replaces it, so set that to the same ' .
'value.'

◆ MESSAGE_LICENSE_KEY_NEEDS_PROPERTIES

const fiftyone\pipeline\cloudrequestengine\Constants::MESSAGE_LICENSE_KEY_NEEDS_PROPERTIES
Initial value:
=
'CloudRequestEngine has a licenseKey and no resourceKey or ' .
'requestedProperties. A license key names no properties of its own, ' .
'so the cloud service answers 400 to every request made with one ' .
'that does not list the properties it wants. Set ' .
'requestedProperties to the fully qualified names wanted, for ' .
"example ['device.ismobile', 'device.iscrawler']."

◆ MESSAGE_NO_CREDENTIAL

const fiftyone\pipeline\cloudrequestengine\Constants::MESSAGE_NO_CREDENTIAL
Initial value:
=
'CloudRequestEngine needs a resourceKey or a licenseKey to ' .
'authenticate with, as the cloud service answers 401 to a request ' .
'that carries neither. Create a resource key for free at ' .
'https://configure.51degrees.com?utm_source=code&utm_medium=comment&utm_campaign=51degrees-php&utm_content=src-constants.php&utm_term=no-credential'

◆ MESSAGE_NOT_PROPERTIES

const fiftyone\pipeline\cloudrequestengine\Constants::MESSAGE_NOT_PROPERTIES
Initial value:
=
'The cloud service did not return the requested properties %s. ' .
'They are not properties the cloud service knows, so they will be ' .
'missing from every result. Check each name against the property ' .
'dictionary. The other requested properties came back and are ' .
'usable.'

◆ MESSAGE_PROPERTIES_NOT_COVERED

const fiftyone\pipeline\cloudrequestengine\Constants::MESSAGE_PROPERTIES_NOT_COVERED
Initial value:
=
'The cloud service did not return the requested properties %s. ' .
'They are not covered by the keys in use, so they will be missing ' .
'from every result. The other requested properties came back and ' .
'are usable.'

◆ RESERVED_EVIDENCE_SUFFIXES

const fiftyone\pipeline\cloudrequestengine\Constants::RESERVED_EVIDENCE_SUFFIXES
Initial value:
= [
'resource', 'license', 'licence', 'values',
]