Skip to content
PHP Ecosystem
Explore

Message

API reference › Yii3 Debug › Exception › Message

enumYii3\Debug\Exception\Message
Backed bystring
Sourcesrc/Exception/Message.php

Exception message templates authored by this package.

Use Message::getMessage() to format a template with sprintf() arguments.

CaseValueDescription
BUILT_IN_PANEL_MISSING'Built-in debug panel "%s" is missing.'Indicates that a built-in panel ID listed by BuiltInPanels::IDS has no panel instance.
BUILT_IN_PANEL_UNKNOWN'Debug panel "%s" is not built in. Built-in panels: %s.'Indicates that a panel was supplied as built-in under an ID BuiltInPanels::IDS does not list.
CAPTURED_MAIL_DIRECTORY_CREATE_FAILED'Unable to create captured mail directory: %s'Indicates that the directory holding the captured .eml files could not be created or given its mode.
CAPTURED_MAIL_EMAIL_CONVERSION_FAILED'Unable to convert captured mail to a Symfony email: %s'Indicates that a captured message could not be converted to the email the Symfony adapter sends.
CAPTURED_MAIL_FILE_PERSIST_FAILED'Unable to persist captured mail file: %s'Indicates that a captured message could not be written as an .eml file or given its mode.
COLLECTOR_ID_MISMATCH'Debug collector registered as "%s" must match its ID "%s".'Indicates that a collector registration key does not match the ID the collector declares.
DEBUG_PANEL_NOT_CAPTURED'Debug panel was not captured.'Indicates that the requested capture holds no payload for the requested panel.
DEBUG_PANEL_UNAVAILABLE'The requested debug panel is not available.'Indicates that the requested panel cannot be served.
DEBUG_SERVICE_UNAVAILABLE'The debug service %s is not available.'Indicates that the container resolved a debugger service to an unexpected type.
DEBUG_SNAPSHOT_NOT_FOUND'Debug snapshot not found.'Indicates that the requested capture is no longer retained.
EXTENSION_COLLECTOR_ENABLED_INVALID'Debug collector option "enabled" for "%s" must be a boolean.'Indicates that a collector entry declares a non-boolean “enabled” option.
EXTENSION_COLLECTOR_OPTION_UNKNOWN'Unknown debug collector option "%s" for "%s". Available option: enabled.'Indicates that a collector entry declares an option other than “enabled”.
EXTENSION_ENTRY_INVALID'Debug registration "%s" must be a class string or an array declaring a "class" string.'Indicates that a registration entry is neither a class string nor an array declaring a class string.
EXTENSION_PANEL_ID_DUPLICATE'Duplicate debug extension panel ID: %s.'Indicates that an extension panel ID is registered more than once.
EXTENSION_PANEL_ID_EMPTY'Debug extension panel ID must not be empty.'Indicates that an extension panel ID is empty.
EXTENSION_PANEL_UNKNOWN'Unknown debug extension panel: %s.'Indicates that the requested extension panel is not registered.
HTTP_REQUEST_EXPECTED'Expected an HTTP request.'Indicates that an event does not provide the expected HTTP request.
HTTP_RESPONSE_EXPECTED'Expected an HTTP response or null.'Indicates that an event provides neither an HTTP response nor null.
PANEL_ID_MISMATCH'Debug panel registered as "%s" must match its ID "%s".'Indicates that a panel registration key does not match the ID the panel declares.
PANEL_METADATA_UNSUPPORTED'Panel %s renders its own title and icon, which configuration cannot override.'Indicates that the configuration overrides the title or icon of a panel rendering its own presentation.
REQUEST_COLLECTOR_NOT_STARTED'The request collector must be started before collecting a request.'Indicates that request capture was attempted before starting the collector.
RESPONSE_COLLECTOR_NOT_STARTED'The request collector must be started before collecting a response.'Indicates that response capture was attempted before starting the collector.
ROUTE_METADATA_INVALID'Captured route metadata must be an array or null.'Indicates that the captured route metadata does not carry the expected shape.
TOOLBAR_ITEM_INVALID'Debug toolbar extension panel %s must return only ToolbarItem instances.'Indicates that an extension panel returned an item other than a ToolbarItem instance.
TOOLBAR_ITEMS_NOT_LIST'Debug toolbar extension panel %s must return a list of items.'Indicates that an extension panel did not return a list of toolbar items.
TOOLBAR_OPTION_INVALID'Debug option "yii3/debug.%s" must be %s.'Indicates that a yii3/debug parameter read by the toolbar options holds a value of the wrong type.
TOOLBAR_PANEL_ID_DUPLICATE'Duplicate debug toolbar extension panel ID: %s.'Indicates that a toolbar extension panel ID is registered more than once.
TOOLBAR_PANEL_ID_EMPTY'Debug toolbar extension panel ID must not be empty.'Indicates that a toolbar extension panel ID is empty.
MethodDescriptionDefined by
getMessage()Formats the message without changing diagnostic argument values.Message
public function getMessage(int|string ...$argument): string

Formats the message without changing diagnostic argument values.

Parameters

ParameterTypeDescription
...$argumentint|stringValues to insert into the message template.

Returns

string: Formatted exception message.