Class Debugger

__construct()

Constructor.

_array(array $var, int $depth, int $indent): string

Export an array type object. Filters out keys used in datasource configuration.

The following keys are replaced with ***'s

• password
• login
• host
• database
• port
• prefix
• schema

Parameters

Returns

_export(mixed $var, int $depth, int $indent): string

Protected export function used to keep track of indentation and recursion.

Parameters

Returns

_highlight(string $str): string

Wraps the highlight_string function in case the server API does not implement the function as it is the case of the HipHop interpreter

Parameters

Returns

_object(string $var, int $depth, int $indent): string

Handles object to string conversion.

Parameters

Returns

See Also

addFormat(string $format, array $strings): array

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:

• 'error' - Used for the container for the error message. Gets the following template variables: id, error, code, description, path, line, links, info
• 'info' - A combination of code, context and trace. Will be set with the contents of the other template keys.
• 'trace' - The container for a stack trace. Gets the following template variables: trace
• 'context' - The container element for the context variables. Gets the following templates: id, context
• 'links' - An array of HTML links that are used for creating links to other resources. Typically this is used to create javascript links to open other sections. Link keys, are: code, context, help. See the js output format for an example.
• 'traceLine' - Used for creating lines in the stacktrace. Gets the following template variables: 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.

Parameters

Returns

checkSecurityKeys(): void

Verifies that the application's salt and cipher seed value has been changed from the default value.

Returns

dump(mixed $var, int $depth = 3): void

Recursively formats and outputs the contents of the supplied variable.

Parameters

Returns

See Also

Links

excerpt(string $file, int $line, int $context = 2): array

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.

Parameters

Returns

See Also

Links

exportVar(string $var, int $depth = 3): string

Converts a variable to a string for debug output.

Note: The following keys will have their contents replaced with *****:

• password
  • login
  • host
  • database
  • port
  • prefix
  • schema

This is done to protect database credentials, which could be accidentally shown in an error message if CakePHP is deployed in development mode.

Parameters

Returns

formatTrace(arrayException $backtrace, array $options = []): mixed

Formats a stack trace based on the supplied options.

Options

• depth - The number of stack frames to return. Defaults to 999
• format - 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 0

Parameters

Returns

Links

getInstance(string|null $class = null): object

Returns a reference to the Debugger singleton object instance.

Parameters

Returns

getType(mixed $var): string

Get the type of the given variable. Will return the class name for objects.

Parameters

Returns

log(mixed $var, int|string $level = 'debug', int $depth = 3): void

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.

Parameters

Returns

outputAs(string|null $format = null): string|null

Get/Set the output format for Debugger error rendering.

Parameters

Returns

Throws

outputError(string $data): void

Takes a processed array of data from an error and displays it in the chosen format.

Parameters

Returns

trace(array $options = []): mixed

Outputs a stack trace based on the supplied options.

Options

• depth - The number of stack frames to return. Defaults to 999
• format - 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 0

Parameters

Returns

Links

trimPath(string $path): string

Shortens file paths by replacing the application base path with 'APP', and the CakePHP core path with 'CORE'.

Parameters

Returns