Interface ExceptionMessageApi

Provides default message bodies for error messages.

These are intended to be used in conjunction with sprintf to inject values.

These will be updated to provide a default that corresponds to each system error code.

oroboros\core\interfaces\api\ExceptionMessageApi implements oroboros\core\interfaces\api\ExceptionCodeApi

Direct known implementers

oroboros\core\interfaces\contract\utilities\exception\ExceptionContract

Indirect known implementers

Namespace: oroboros\core\interfaces\api
Author: Brian Dayhoff mopsyd@me.com
See: oroboros\core\interfaces\api\ExceptionCodeApi
Located at core/interfaces/api/ExceptionMessageApi.php

Constants summary

`string`	`DEFAULT_EXCEPTION_MESSAGE_SUFFIX` If suffix is enabled, this will be appended to the end of all messages. Thrown at [LINE, FUNCTION, METHOD] of [FILE, CLASS, TRAIT] If suffix is enabled, this will be appended to the end of all messages. Thrown at [LINE, FUNCTION, METHOD] of [FILE, CLASS, TRAIT]	# `' Thrown at [%s] of [%s].'`
`string`	`DEFAULT_EXCEPTION_MESSAGE_PREFIX` If prefix is enabled, this will be prepended to the exception message. 1) [$code] -Error code passed with the exception 2) [$severity] -error, warning, info, debug, alert, critical, etc (See Psr-3 spec) 3) [$class\|$trait\|$file] -\some\namespace\classOrTrait::method OR /fully/qualified/filepath.php 4) [$request_uri\|$cli_command] -console command OR http://example.com/path/to/page/ 5) [$request_type] -cgi, get, post, put, delete, etc. If prefix is enabled, this will be prepended to the exception message. 1) [$code] -Error code passed with the exception 2) [$severity] -error, warning, info, debug, alert, critical, etc (See Psr-3 spec) 3) [$class\|$trait\|$file] -\some\namespace\classOrTrait::method OR /fully/qualified/filepath.php 4) [$request_uri\|$cli_command] -console command OR http://example.com/path/to/page/ 5) [$request_type] -cgi, get, post, put, delete, etc.	# `' [%s][%s][%s][%s][%s] '`
`string`	`ERROR_UNKNOWN_MESSAGE` This is the default \Exception code, so it maps to unknown error. The system will treat all uncaught exceptions with status code 0 as FATAL ERRORS. This is the default \Exception code, so it maps to unknown error. The system will treat all uncaught exceptions with status code 0 as FATAL ERRORS.	# `'An unknown error has occurred.'`
`string`	`ERROR_CORE_MESSAGE` Generic Oroboros core errors. These represent errors in the oroboros core class structure. Generic Oroboros core errors. These represent errors in the oroboros core class structure.	# `'An unknown error has occured with an oroboros class.'`
`string`	`ERROR_CORE_LIBRARY_FAILURE_MESSAGE`	# `'Library [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_CONTROLLER_FAILURE_MESSAGE`	# `'Controller [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_MODEL_FAILURE_MESSAGE`	# `'Model [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_VIEW_FAILURE_MESSAGE`	# `'View [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_ADAPTER_FAILURE_MESSAGE`	# `'Adapter [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_AUTH_FAILURE_MESSAGE`	# `'Authorization [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_MODULE_FAILURE_MESSAGE`	# `'Module [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_EXTENSION_FAILURE_MESSAGE`	# `'Extension [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_PARSER_FAILURE_MESSAGE`	# `'Parser [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_RECORD_FAILURE_MESSAGE`	# `'Record [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_STREAM_FAILURE_MESSAGE`	# `'Stream [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_SERVICE_FAILURE_MESSAGE`	# `'Service [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_RESPONSE_FAILURE_MESSAGE`	# `'Response object [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_REQUEST_FAILURE_MESSAGE`	# `'Request object [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_ROUTER_FAILURE_MESSAGE`	# `'Router object [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_UTILITY_FAILURE_MESSAGE`	# `'Utility [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_JOB_FAILURE_MESSAGE`	# `'Job [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_ENTITY_FAILURE_MESSAGE`	# `'Entity object [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_PATTERN_FAILURE_MESSAGE`	# `'Pattern [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_ROUTINE_FAILURE_MESSAGE`	# `'Routine [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_EVENT_FAILURE_MESSAGE`	# `'Event object [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_FUNCTION_FAILURE_MESSAGE`	# `'Function [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_ERROR_FAILURE_MESSAGE`	# `'Error object [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_FLAG_FAILURE_MESSAGE`	# `'Flag object [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_ENUM_FAILURE_MESSAGE`	# `'Enum object [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_DATA_OBJECT_FAILURE_MESSAGE`	# `'Data object [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_CORE_BOOTSTRAP_FAILURE_MESSAGE`	# `'Bootstrap object [%s] has failed, due to an irrecoverable condition: [%s].'`
`string`	`ERROR_PHP_MESSAGE` PHP Errors Generic or expected errors that can't be handled, PHP Errors Generic or expected errors that can't be handled,	# `'A generic PHP exception has occurred: [%s].'`
`string`	`ERROR_PHP_METHOD_FAILURE_MESSAGE`	# `'Method [%s] has failed in class [%s].'`
`string`	`ERROR_PHP_INSTANTIATION_FAILURE_MESSAGE`	# `'Could not complete instantiation due to an unexpected condition [%s].'`
`string`	`ERROR_PHP_DESTRUCTOR_FAILURE_MESSAGE`	# `'Destructor failed to fire in [%s].'`
`string`	`ERROR_PHP_BAD_PARAMETERS_MESSAGE`	# `'Invalid parameters passed. Expected [%s], but received [%s].'`
`string`	`ERROR_PHP_BAD_METHOD_CALL_MESSAGE`	# `'Method [%s] does not exist in [%s].'`
`string`	`ERROR_PHP_BAD_FUNCTION_CALL_MESSAGE`	# `'Function [%s] does not exist.'`
`string`	`ERROR_PHP_WRONG_INSTANCE_SUPPLIED_MESSAGE`	# `'Invalid instance passed. Expected instanceof [%s], but received [%s].'`
`string`	`ERROR_PHP_WRONG_SCHEMA_PROVIDED_MESSAGE`	# `'Invalid argument schema provided. Expected keys [%s], received [%s].'`
`string`	`ERROR_PHP_NOT_INITIALIZED_MESSAGE`	# `'Could not complete operation because [%s] is not initialized. Please call the initialization method [%s] before referencing this method.'`
`string`	`ERROR_PHP_INVOCATION_FAILURE_MESSAGE`	# `'Magic method [__invoke] failed to resolve in [%s].'`
`string`	`ERROR_PHP_CALL_FAILURE_MESSAGE`	# `'Magic method [__call] failed to resolve in [%s].'`
`string`	`ERROR_PHP_CLONE_FAILURE_MESSAGE`	# `'Magic method [__clone] failed to resolve in [%s].'`
`string`	`ERROR_PHP_SERIALIZATION_FAILURE_MESSAGE`	# `'Magic method [__serialize] failed to resolve in [%s].'`
`string`	`ERROR_PHP_UNSERIALIZATION_FAILURE_MESSAGE`	# `'Magic method [__unserialize] failed to resolve in [%s].'`
`string`	`ERROR_PHP_SLEEP_FAILURE_MESSAGE`	# `'Magic method [__sleep] failed to resolve in [%s].'`
`string`	`ERROR_PHP_WAKEUP_FAILURE_MESSAGE`	# `'Magic method [__wakeup] failed to resolve in [%s].'`
`string`	`ERROR_PHP_GETTER_FAILURE_MESSAGE`	# `'Magic method [__get] failed to resolve in [%s].'`
`string`	`ERROR_PHP_SETTER_FAILURE_MESSAGE`	# `'Magic method [__set] failed to resolve in [%s].'`
`string`	`ERROR_PHP_TO_ARRAY_FAILURE_MESSAGE`	# `'Magic method [__toArray] failed to resolve in [%s].'`
`string`	`ERROR_PHP_CALLSTATIC_FAILURE_MESSAGE`	# `'Magic method [__callStatic] failed to resolve in [%s].'`
`string`	`ERROR_PHP_IS_SET_FAILURE_MESSAGE`	# `'Magic method [__toArray] failed to resolve in [%s].'`
`string`	`ERROR_PHP_UN_SET_FAILURE_MESSAGE`	# `'Magic method [__unSet] failed to resolve in [%s].'`
`string`	`ERROR_PHP_DEBUG_INFO_FAILURE_MESSAGE`	# `'Magic method [__debugInfo] failed to resolve in [%s].'`
`string`	`ERROR_PHP_KEY_NOT_FOUND_MESSAGE`	# `'Requested key [%s] does not exist in [%s].'`
`string`	`ERROR_FILESYSTEM_MESSAGE`	# `'Filesystem operation failed for [%s], because [%s].'`
`string`	`ERROR_DATABASE_MESSAGE`	# `'A database error occurred in [%s]. Error message: [%s].'`
`string`	`ERROR_SESSION_MESSAGE`	# `'A session error occurred in [%s]. Error message: [%s].'`
`string`	`ERROR_SECURITY_MESSAGE`	# `'A security error occurred in [%s]. Error message: [%s].'`
`string`	`ERROR_SECURITY_LOCKED_RESOURCE_MESSAGE`	# `'Your request could not be resolved because resource [%s] is locked.'`
`string`	`ERROR_SECURITY_LOCKED_FILE_MESSAGE`	# `'Your request could not be resolved because file [%s] is locked.'`
`string`	`ERROR_SECURITY_LOCKED_TABLE_MESSAGE`	# `'Your request could not be resolved because table [%s] is locked.'`
`string`	`ERROR_SECURITY_LOCKED_COLUMN_MESSAGE`	# `'Your request could not be resolved because column [%s] is locked.'`
`string`	`ERROR_SECURITY_LOCKED_OBJECT_MESSAGE`	# `'Your request could not be resolved because object [%s] is locked.'`
`string`	`ERROR_SECURITY_LOCKED_EVENT_MESSAGE`	# `'Your request could not be resolved because event [%s] is locked.'`
`string`	`ERROR_SECURITY_LOCKED_ENTITY_MESSAGE`	# `'Your request could not be resolved because entity [%s] is locked.'`
`string`	`ERROR_SECURITY_LOCKED_JOB_MESSAGE`	# `'Your request could not be resolved because job [%s] is locked.'`
`string`	`ERROR_SECURITY_LOCKED_POLICY_MESSAGE`	# `'Your request could not be resolved because policy [%s] is locked.'`
`string`	`ERROR_SECURITY_LOCKED_ROUTE_MESSAGE`	# `'Your request could not be resolved because route [%s] is locked.'`
`string`	`ERROR_SECURITY_LOCKED_COMMAND_MESSAGE`	# `'Your request could not be resolved because command [%s] is locked.'`
`string`	`ERROR_ROUTING_MESSAGE`	# `'An error occurred with routing at [%s]. Message: [%s].'`
`string`	`ERROR_LOGIC_MESSAGE`	# `'A logic error occurred at [%s]. Message: [%s].'`
`string`	`ERROR_LOGIC_BAD_PARAMETERS_MESSAGE`	# `'A logic error occurred at [%s] due to bad parameters. Expected [%s] but received [%s].'`
`string`	`ERROR_LOGIC_MISSING_PARAMETERS_MESSAGE`	# `'A logic error occurred at [%s] due to missing required parameters [%s].'`
`string`	`ERROR_INITIALIZATION_MESSAGE`	# `'A generic initialization error occurred in [%s]. Message [%s].'`
`string`	`ERROR_INSTALLATION_MESSAGE`	# `'A generic installation error occurred in [%s]. Message [%s].'`
`string`	`ERROR_MODEL_MESSAGE`	# `'A generic model error occurred in [%s]. Message [%s].'`
`string`	`ERROR_VIEW_MESSAGE`	# `'A generic view error occurred in [%s]. Message [%s].'`
`string`	`ERROR_LIBRARY_MESSAGE`	# `'A generic library error occurred in [%s]. Message [%s].'`
`string`	`ERROR_CONTROLLER_MESSAGE`	# `'A generic controller error occurred in [%s]. Message [%s].'`
`string`	`ERROR_ADAPTER_MESSAGE`	# `'A generic adapter error occurred in [%s]. Message [%s].'`
`string`	`ERROR_MODULE_MESSAGE`	# `'A generic module error occurred in [%s]. Message [%s].'`
`string`	`ERROR_ROUTINE_MESSAGE`	# `'A generic initialization error occurred in [%s]. Message [%s].'`
`string`	`ERROR_SDK_MESSAGE`	# `'A generic SDK error occurred in [%s]. Message [%s].'`
`string`	`ERROR_NETWORK_MESSAGE`	# `'A generic network error occurred in [%s]. Message [%s].'`
`string`	`ERROR_CLUSTER_MESSAGE`	# `'A generic cluster error occurred in [%s]. Message [%s].'`
`string`	`ERROR_NODE_MESSAGE`	# `'A generic error occurred in node [%s]. Message [%s].'`

Constants inherited from oroboros\core\interfaces\api\ExceptionCodeApi

Constants inherited from oroboros\OroborosInterface

OROBOROS_VENDOR_NAMESPACE, OROBOROS_VERSION

Namespaces

Interfaces