Interface ExceptionCodeApi

This interface declares all of the exception codes used by the system. It may be implemented to provide easy access to error code levels for checking or throwing

system compliant exceptions.

If you throwing an exception from a trait, you can reference these definitions like so:

throw new \oroboros\core\utilities\exception\Exception("Some error", \oroboros\core\api::EXCEPTION_CODE_GENERAL);

this will insure that all trait exceptions are handled seamlessly, even if changes to the exception codes themselves happen in the future. If you absolutely must not type that much, put a use/as statement at the head of your file like so:

oroboros\core\interfaces\api\ExceptionCodeApi implements oroboros\OroborosInterface

Direct known implementers

oroboros\core\interfaces\api\ExceptionMessageApi, oroboros\core\interfaces\BaseAbstractInterface, oroboros\core\interfaces\contract\utilities\exception\ExceptionContract, oroboros\core\libraries\api\ExceptionCodes, oroboros\core\libraries\api\ExceptionMessages, oroboros\Oroboros

Indirect known implementers

Namespace: oroboros\core\interfaces\api
Located at core/interfaces/api/ExceptionCodeApi.php

Constants summary

`integer`	`ERROR_UNKNOWN` 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.	# `0`
`integer`	`SAFE_MINIMUM_ERROR_RANGE` Oroboros core (and authorized extensions) will never claim an error code above this number. Oroboros core (and authorized extensions) will never claim an error code above this number. If you want to extend this API with your own codes, they should be higher than this number to avoid system collisions, which might produce really strange bugs or inaccurate error reporting if you are also using the system provided exceptions. Package validation will fail your package build if this occurs. (meaning you have provided custom error codes within the reserved range) Collisions with other 3rd party extensions cannot be guaranteed, so try to pick an error range that you know isn't used elsewhere. Anything above the below value will not collide with the core system.	# `50000`
`integer`	`ERROR_CORE` 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.	# `10000`
`integer`	`ERROR_CORE_LIBRARY_FAILURE`	# `10100`
`integer`	`ERROR_CORE_CONTROLLER_FAILURE`	# `10200`
`integer`	`ERROR_CORE_MODEL_FAILURE`	# `10300`
`integer`	`ERROR_CORE_VIEW_FAILURE`	# `10400`
`integer`	`ERROR_CORE_ADAPTER_FAILURE`	# `10500`
`integer`	`ERROR_CORE_AUTH_FAILURE`	# `10600`
`integer`	`ERROR_CORE_MODULE_FAILURE`	# `10700`
`integer`	`ERROR_CORE_EXTENSION_FAILURE`	# `10800`
`integer`	`ERROR_CORE_PARSER_FAILURE`	# `10900`
`integer`	`ERROR_CORE_RECORD_FAILURE`	# `11000`
`integer`	`ERROR_CORE_STREAM_FAILURE`	# `11100`
`integer`	`ERROR_CORE_SERVICE_FAILURE`	# `11200`
`integer`	`ERROR_CORE_RESPONSE_FAILURE`	# `11300`
`integer`	`ERROR_CORE_REQUEST_FAILURE`	# `11400`
`integer`	`ERROR_CORE_ROUTER_FAILURE`	# `11500`
`integer`	`ERROR_CORE_UTILITY_FAILURE`	# `11600`
`integer`	`ERROR_CORE_JOB_FAILURE`	# `11700`
`integer`	`ERROR_CORE_ENTITY_FAILURE`	# `11800`
`integer`	`ERROR_CORE_PATTERN_FAILURE`	# `11900`
`integer`	`ERROR_CORE_ROUTINE_FAILURE`	# `12000`
`integer`	`ERROR_CORE_EVENT_FAILURE`	# `12100`
`integer`	`ERROR_CORE_FUNCTION_FAILURE`	# `12200`
`integer`	`ERROR_CORE_ERROR_FAILURE`	# `12300`
`integer`	`ERROR_CORE_FLAG_FAILURE`	# `12400`
`integer`	`ERROR_CORE_ENUM_FAILURE`	# `12500`
`integer`	`ERROR_CORE_DATA_OBJECT_FAILURE`	# `12600`
`integer`	`ERROR_CORE_BOOTSTRAP_FAILURE`	# `12700`
`integer`	`ERROR_PHP` PHP Errors Generic or expected errors that can't be handled, PHP Errors Generic or expected errors that can't be handled,	# `11000`
`integer`	`ERROR_PHP_METHOD_FAILURE`	# `11001`
`integer`	`ERROR_PHP_INSTANTIATION_FAILURE`	# `11002`
`integer`	`ERROR_PHP_DESTRUCTOR_FAILURE`	# `11003`
`integer`	`ERROR_PHP_BAD_PARAMETERS`	# `11004`
`integer`	`ERROR_PHP_BAD_METHOD_CALL`	# `11005`
`integer`	`ERROR_PHP_BAD_FUNCTION_CALL`	# `11006`
`integer`	`ERROR_PHP_WRONG_INSTANCE_SUPPLIED`	# `11007`
`integer`	`ERROR_PHP_WRONG_SCHEMA_PROVIDED`	# `11008`
`integer`	`ERROR_PHP_NOT_INITIALIZED`	# `11009`
`integer`	`ERROR_PHP_INVOCATION_FAILURE`	# `11010`
`integer`	`ERROR_PHP_CALL_FAILURE`	# `11011`
`integer`	`ERROR_PHP_CLONE_FAILURE`	# `11012`
`integer`	`ERROR_PHP_SERIALIZATION_FAILURE`	# `11013`
`integer`	`ERROR_PHP_UNSERIALIZATION_FAILURE`	# `11014`
`integer`	`ERROR_PHP_SLEEP_FAILURE`	# `11015`
`integer`	`ERROR_PHP_WAKEUP_FAILURE`	# `11016`
`integer`	`ERROR_PHP_GETTER_FAILURE`	# `11017`
`integer`	`ERROR_PHP_SETTER_FAILURE`	# `11018`
`integer`	`ERROR_PHP_TO_ARRAY_FAILURE`	# `11019`
`integer`	`ERROR_PHP_CALLSTATIC_FAILURE`	# `11020`
`integer`	`ERROR_PHP_IS_SET_FAILURE`	# `11021`
`integer`	`ERROR_PHP_UN_SET_FAILURE`	# `11022`
`integer`	`ERROR_PHP_DEBUG_INFO_FAILURE`	# `11023`
`integer`	`ERROR_PHP_KEY_NOT_FOUND`	# `11024`
`integer`	`ERROR_FILESYSTEM`	# `12000`
`integer`	`ERROR_DATABASE`	# `13000`
`integer`	`ERROR_SESSION`	# `14000`
`integer`	`ERROR_SECURITY`	# `15000`
`integer`	`ERROR_SECURITY_LOCKED_RESOURCE`	# `15100`
`integer`	`ERROR_SECURITY_LOCKED_FILE`	# `15110`
`integer`	`ERROR_SECURITY_LOCKED_TABLE`	# `15120`
`integer`	`ERROR_SECURITY_LOCKED_COLUMN`	# `15121`
`integer`	`ERROR_SECURITY_LOCKED_OBJECT`	# `15122`
`integer`	`ERROR_SECURITY_LOCKED_EVENT`	# `15123`
`integer`	`ERROR_SECURITY_LOCKED_ENTITY`	# `15124`
`integer`	`ERROR_SECURITY_LOCKED_JOB`	# `15125`
`integer`	`ERROR_SECURITY_LOCKED_POLICY`	# `15126`
`integer`	`ERROR_SECURITY_LOCKED_ROUTE`	# `15127`
`integer`	`ERROR_SECURITY_LOCKED_COMMAND`	# `15128`
`integer`	`ERROR_ROUTING`	# `16000`
`integer`	`ERROR_LOGIC`	# `17000`
`integer`	`ERROR_LOGIC_BAD_PARAMETERS`	# `17001`
`integer`	`ERROR_LOGIC_MISSING_PARAMETERS`	# `17002`
`integer`	`ERROR_INITIALIZATION`	# `18000`
`integer`	`ERROR_INSTALLATION`	# `19000`
`integer`	`ERROR_MODEL`	# `20000`
`integer`	`ERROR_VIEW`	# `21000`
`integer`	`ERROR_LIBRARY`	# `22000`
`integer`	`ERROR_CONTROLLER`	# `22000`
`integer`	`ERROR_ADAPTER`	# `23000`
`integer`	`ERROR_MODULE`	# `24000`
`integer`	`ERROR_ROUTINE`	# `25000`
`integer`	`ERROR_SDK`	# `26000`
`integer`	`ERROR_NETWORK`	# `27000`
`integer`	`ERROR_CLUSTER`	# `28000`
`integer`	`ERROR_NODE`	# `29000`

Constants inherited from oroboros\OroborosInterface

OROBOROS_VENDOR_NAMESPACE, OROBOROS_VERSION

Namespaces

Interfaces