51Degrees Pipeline for PHP

fiftyone\pipeline\engines\MissingPropertyMessages Class Reference

Detailed Description

Messages which may be reused for various missing property exceptions.

Data Fields

const PREFIX = "Property '%s' not found in data for element '%s'. "
 String to prefix all messages with.
const DATA_UPGRADE_REQUIRED
 A data upgrade is required (e.g.
const PROPERTY_EXCLUDED = 'This is because the property has been excluded when configuring the engine.'
 The property was excluded from the engine's configuration.
const PRODUCT_NOT_IN_CLOUD_RESOURCE
 The engine was a cloud engine, and the resource key does not contain the required product (e.g.
const PROPERTY_NOT_IN_CLOUD_RESOURCE
 The engine was a cloud engine, and the resource key does not contain the required property (e.g.
const UNKNOWN
 The reason for the missing property is none of the above.

Field Documentation

◆ DATA_UPGRADE_REQUIRED

const fiftyone\pipeline\engines\MissingPropertyMessages::DATA_UPGRADE_REQUIRED
Initial value:
=
'This is because your license and/or data file ' .
'does not include this property. The property is available ' .
'with the %s license/data for the %s'

A data upgrade is required (e.g.

free to paid). This takes the data tier name which contains the property and the name of the product as format arguments.

◆ PREFIX

const fiftyone\pipeline\engines\MissingPropertyMessages::PREFIX = "Property '%s' not found in data for element '%s'. "

String to prefix all messages with.

This takes the name of a property and the name of the element as format arguments.

◆ PRODUCT_NOT_IN_CLOUD_RESOURCE

const fiftyone\pipeline\engines\MissingPropertyMessages::PRODUCT_NOT_IN_CLOUD_RESOURCE
Initial value:
=
'This is because your resource key does not include access to ' .
"any properties under '%s'. For more details on resource keys, " .
'see our explainer: ' .
'/documentation/_info__resource_keys.html?utm_source=code&utm_medium=comment&utm_campaign=pipeline-php-engines&utm_content=src-missingpropertymessages.php&utm_term=product_not_in_cloud_resource'

The engine was a cloud engine, and the resource key does not contain the required product (e.g.

device). This takes the name of the product as a format argument.

◆ PROPERTY_EXCLUDED

const fiftyone\pipeline\engines\MissingPropertyMessages::PROPERTY_EXCLUDED = 'This is because the property has been excluded when configuring the engine.'

The property was excluded from the engine's configuration.

This takes no format arguments.

◆ PROPERTY_NOT_IN_CLOUD_RESOURCE

const fiftyone\pipeline\engines\MissingPropertyMessages::PROPERTY_NOT_IN_CLOUD_RESOURCE
Initial value:
=
'This is because your resource key does not include access to ' .
'this property. Properties that are included for this key under ' .
"'%s' are %s. For more details on resource keys, see our " .
'explainer: ' .
'/documentation/_info__resource_keys.html?utm_source=code&utm_medium=comment&utm_campaign=pipeline-php-engines&utm_content=src-missingpropertymessages.php&utm_term=property_not_in_cloud_resource'

The engine was a cloud engine, and the resource key does not contain the required property (e.g.

hardwarename). This takes the name of the product and the properties the resource contains as format arguments.

◆ UNKNOWN

const fiftyone\pipeline\engines\MissingPropertyMessages::UNKNOWN
Initial value:
=
'The reason for this is unknown. Please check that the aspect ' .
'and property name are correct.'

The reason for the missing property is none of the above.

This takes no format arguments.

Have a data or code question? Get in touch and explore subscription options.