Provide custom logging and error handling.
Debugger extends PHP's default error handling and gives simpler to use more powerful interfaces.
arrayRuntime config
boolWhether the config property has already been configured with defaults
arrayHolds current output data when outputFormat is false.
arrayDefault configuration
stringThe current output format.
arrayTemplates used when generating trace or error strings. Can be global or indexed by the format value used in $_outputFormat.
arrayA map of editors to their link templates.
Wraps the highlight_string function in case the server API does not implement the function as it is the case of the HipHop interpreter
Verifies that the application's salt and cipher seed value has been changed from the default value.
Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
Protected export function used to keep track of indentation and recursion.
Export an array type object. Filters out keys used in datasource configuration.
Get the configured export formatter or infer one based on the environment.
Creates an entry in the log file. The log entry will contain a stack trace from where it was called.
Takes a processed array of data from an error and displays it in the chosen format.
Sets configurable masking of debugger output by property name and array key names.
Shortens file paths by replacing the application base path with 'APP', and the CakePHP core path with 'CORE'.
__construct()
Constructor.
_configDelete(string $key)
Deletes a single config key.
string $key Key to delete.
Cake\Core\Exception\Exception_configRead(?string $key)
Reads a config key.
string|null $key Key to read.
mixed_configWrite(mixed $key, mixed $value, mixed $merge)
Writes a config key.
string|array $key Key to write to.
mixed $value Value to write.
bool|string $merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Cake\Core\Exception\Exception_highlight(string $str)
Wraps the highlight_string function in case the server API does not implement the function as it is the case of the HipHop interpreter
string $str The string to convert.
stringaddEditor(string $name, mixed $template)
Add an editor link format
Template strings can use the {file} and {line} placeholders. Closures templates must return a string, and accept two parameters: The file and line.
string $name The name of the editor.
string|\Closure $template The string template or closure
addFormat(string $format, array $strings)
Add an output format or update a format in Debugger.
Debugger::addFormat('custom', $data); Where $data is an array of strings that use Text::insert() variable replacement. The template vars should be in a {:id} style. An error formatter can have the following keys:
id, error, code, description, path, line, links, info
code, context and trace. Will be set with the contents of the other template keys.trace
id, context
code, context, help. See the JS output format for an example.reference, path, line
Alternatively if you want to use a custom callback to do all the formatting, you can use the callback key, and provide a callable:
Debugger::addFormat('custom', ['callback' => [$foo, 'outputError']]; The callback can expect two parameters. The first is an array of all the error data. The second contains the formatted strings generated using the other template strings. Keys like info, links, code, context and trace will be present depending on the other templates in the format type.
string $format Format to use, including 'js' for JavaScript-enhanced HTML, 'html' for straight HTML output, or 'txt' for unformatted text.
array $strings Template strings, or a callback to be used for the output format.
arrayThe resulting format string set.
checkSecurityKeys()
Verifies that the application's salt and cipher seed value has been changed from the default value.
configInstance(mixed $key, mixed $value, bool $merge)
Read or write configuration options for the Debugger instance.
string|array|null $key optional The key to get/set, or a complete array of configs.
mixed|null $value optional The value to set.
bool $merge optional Whether to recursively merge or overwrite existing config, defaults to true.
mixedConfig value being read, or the object itself on write operations.
Cake\Core\Exception\ExceptionconfigShallow(mixed $key, mixed $value)
Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
Setting a specific value:
$this->configShallow('key', $value); Setting a nested value:
$this->configShallow('some.nested.key', $value); Updating multiple config settings at the same time:
$this->configShallow(['one' => 'value', 'another' => 'value']);
string|array $key The key to set, or a complete array of configs.
mixed|null $value optional The value to set.
$thisdump(mixed $var, int $maxDepth)
Recursively formats and outputs the contents of the supplied variable.
mixed $var The variable to dump.
int $maxDepth optional The depth to output to. Defaults to 3.
editorUrl(string $file, int $line)
Get a formatted URL for the active editor.
string $file The file to create a link for.
int $line The line number to create a link for.
stringThe formatted URL.
excerpt(string $file, int $line, int $context)
Grabs an excerpt from a file and highlights a given line of code.
Usage:
Debugger::excerpt('/path/to/file', 100, 4); The above would return an array of 8 items. The 4th item would be the provided line, and would be wrapped in <span class="code-highlight"></span>. All of the lines are processed with highlight_string() as well, so they have basic PHP syntax highlighting applied.
string $file Absolute path to a PHP file.
int $line Line number to highlight.
int $context optional Number of lines of context to extract above and below $line.
arraySet of lines highlighted
export(mixed $var, \Cake\Error\Debug\DebugContext $context)
Protected export function used to keep track of indentation and recursion.
mixed $var The variable to dump.
\Cake\Error\Debug\DebugContext $context Dump context
\Cake\Error\Debug\NodeInterfaceThe dumped variable.
exportArray(array $var, \Cake\Error\Debug\DebugContext $context)
Export an array type object. Filters out keys used in datasource configuration.
The following keys are replaced with ***'s
array $var The array to export.
\Cake\Error\Debug\DebugContext $context The current dump context.
\Cake\Error\Debug\ArrayNodeExported array.
exportObject(object $var, \Cake\Error\Debug\DebugContext $context)
Handles object to node conversion.
object $var Object to convert.
\Cake\Error\Debug\DebugContext $context The dump context.
\Cake\Error\Debug\NodeInterfaceexportVar(mixed $var, int $maxDepth)
Converts a variable to a string for debug output.
Note: The following keys will have their contents replaced with *****:
This is done to protect database credentials, which could be accidentally shown in an error message if CakePHP is deployed in development mode.
mixed $var Variable to convert.
int $maxDepth optional The depth to output to. Defaults to 3.
stringVariable as a formatted string
formatHtmlMessage(string $message)
Format an exception message to be HTML formatted.
Does the following formatting operations:
bool into <code>bool</code>
<br />
string $message The string message to format.
stringFormatted message.
formatTrace(mixed $backtrace, array $options)
Formats a stack trace based on the supplied options.
depth - The number of stack frames to return. Defaults to 999format - The format you want the return. Defaults to the currently selected format. If format is 'array' or 'points' the return will be an array.args - Should arguments for functions be shown? If true, the arguments for each method call will be displayed.start - The stack frame to start generating a trace from. Defaults to 0array|\Throwable $backtrace Trace as array or an exception object.
array $options optional Format for outputting stack trace.
string|arrayFormatted stack trace.
getConfig(?string $key, mixed $default)
Returns the config.
Reading the whole config:
$this->getConfig();
Reading a specific value:
$this->getConfig('key'); Reading a nested value:
$this->getConfig('some.nested.key'); Reading with default value:
$this->getConfig('some-key', 'default-value'); string|null $key optional The key to get or null for the whole config.
mixed $default optional The return value when the key does not exist.
mixedConfiguration data at the named key or null if the key does not exist.
getConfigOrFail(string $key)
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string $key The key to get.
mixedConfiguration data at the named key
InvalidArgumentExceptiongetExportFormatter()
Get the configured export formatter or infer one based on the environment.
\Cake\Error\Debug\FormatterInterfacegetInstance(?string $class)
Returns a reference to the Debugger singleton object instance.
string|null $class optional Class name.
staticgetOutputFormat()
Get the output format for Debugger error rendering.
stringReturns the current format when getting.
getType(mixed $var)
Get the type of the given variable. Will return the class name for objects.
mixed $var The variable to get the type of.
stringThe type of variable.
log(mixed $var, mixed $level, int $maxDepth)
Creates an entry in the log file. The log entry will contain a stack trace from where it was called.
as well as export the variable using exportVar. By default the log is written to the debug log.
mixed $var Variable or content to log.
int|string $level optional Type of log to use. Defaults to 'debug'.
int $maxDepth optional The depth to output to. Defaults to 3.
outputError(array $data)
Takes a processed array of data from an error and displays it in the chosen format.
array $data Data to output.
outputMask()
Reads the current output masking.
arrayprintVar(mixed $var, array $location, ?bool $showHtml)
Prints out debug information about given variable.
mixed $var Variable to show debug information for.
array $location optional If contains keys "file" and "line" their values will be used to show location info.
bool|null $showHtml optional If set to true, the method prints the debug data encoded as HTML. If false, plain text formatting will be used. If null, the format will be chosen based on the configured exportFormatter, or environment conditions.
setConfig(mixed $key, mixed $value, mixed $merge)
Sets the config.
Setting a specific value:
$this->setConfig('key', $value); Setting a nested value:
$this->setConfig('some.nested.key', $value); Updating multiple config settings at the same time:
$this->setConfig(['one' => 'value', 'another' => 'value']);
string|array $key The key to set, or a complete array of configs.
mixed|null $value optional The value to set.
bool $merge optional Whether to recursively merge or overwrite existing config, defaults to true.
$thisCake\Core\Exception\ExceptionsetEditor(string $name)
Choose the editor link style you want to use.
string $name The editor name.
setOutputFormat(string $format)
Set the output format for Debugger error rendering.
string $format The format you want errors to be output as.
InvalidArgumentExceptionsetOutputMask(array $value, bool $merge)
Sets configurable masking of debugger output by property name and array key names.
Debugger::setOutputMask(['password' => '[*****]');
array $value An array where keys are replaced by their values in output.
bool $merge optional Whether to recursively merge or overwrite existing config, defaults to true.
trace(array $options)
Outputs a stack trace based on the supplied options.
depth - The number of stack frames to return. Defaults to 999format - The format you want the return. Defaults to the currently selected format. If format is 'array' or 'points' the return will be an array.args - Should arguments for functions be shown? If true, the arguments for each method call will be displayed.start - The stack frame to start generating a trace from. Defaults to 0array $options optional Format for outputting stack trace.
string|arrayFormatted stack trace.
trimPath(string $path)
Shortens file paths by replacing the application base path with 'APP', and the CakePHP core path with 'CORE'.
string $path Path to shorten.
stringNormalized path
Runtime config
arrayWhether the config property has already been configured with defaults
boolHolds current output data when outputFormat is false.
arrayDefault configuration
arrayThe current output format.
stringTemplates used when generating trace or error strings. Can be global or indexed by the format value used in $_outputFormat.
arrayA map of editors to their link templates.
array
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.Error.Debugger.html