Debugger Class Info:

Class Declaration:

class Debugger extends Object

File name:
cake/libs/debugger.php
Description:

Provide custom logging and error handling.

Debugger overrides PHP's default error handling to provide stack traces and enhanced logging

Class Inheritance

Object

Package
cake
Subpackage
cake.cake.libs
Link
http://book.cakephp.org/view/1191/Using-the-Debugger-Class

Properties:

Show/Hide parent properties

  • _data string

    Holds current output data when outputFormat is false.

  • errors array

    A list of errors generated by the application.

  • helpPath string

    Contains the base URL for error code documentation.

  • _outputFormat string

    The current output format.

  • _templates string

    Templates used when generating trace or error strings. Can be global or indexed by the format value used in $_outputFormat.

Method Summary:

Show/Hide parent methods

cakeError

top

Used to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.

Parameters:
  • string $method required

    Method to be called in the error class (AppError or ErrorHandler classes)

  • array $messages optional array ( )

    Message that is to be displayed by the error class

Method defined in:
cake/libs/object.php on line 187
Return

error message

Access

public

checkSecurityKeys

top

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

Method defined in:
cake/libs/debugger.php on line 682
Access

public

Static

__construct

top

Constructor.

Method defined in:
cake/libs/debugger.php on line 120

dispatchMethod

top

Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array

Parameters:
  • string $method required

    Name of the method to call

  • array $params optional array ( )

    Parameter list to use when calling $method

Method defined in:
cake/libs/object.php on line 107
Return

mixed Returns the result of the method call

Access

public

dump

top

Formats and outputs the contents of the supplied variable.

Parameters:
  • $var required

Method defined in:
cake/libs/debugger.php on line 215
Return

void

See

Debugger::exportVar()

Access

public

Static

Link
http://book.cakephp.org/view/1191/Using-the-Debugger-Class

excerpt

top

Grabs an excerpt from a file and highlights a given line of code

Parameters:
  • string $file required

    Absolute path to a PHP file

  • integer $line required

    Line number to highlight

  • integer $context optional 2

    Number of lines of context to extract above and below $line

Method defined in:
cake/libs/debugger.php on line 450
Return

array Set of lines highlighted

Access

public

Static

Link
http://book.cakephp.org/view/1191/Using-the-Debugger-Class

exportVar

top

Converts a variable to a string for debug output.

Parameters:
  • string $var required

    Variable to convert

  • $recursion optional 0

Method defined in:
cake/libs/debugger.php on line 483
Return

string Variable as a formatted string

Access

public

Static

Link
http://book.cakephp.org/view/1191/Using-the-Debugger-Class

getInstance

top

Returns a reference to the Debugger singleton object instance.

Parameters:
  • $class optional NULL

Method defined in:
cake/libs/debugger.php on line 183
Return

object

Access

public

Static

handleError

top

Overrides PHP's default error handling.

Parameters:
  • integer $code required

    Code of error

  • string $description required

    Error description

  • string $file optional NULL

    File on which error occurred

  • integer $line optional NULL

    Line that triggered the error

  • array $context optional NULL

    Context

Method defined in:
cake/libs/debugger.php on line 247
Return

boolean true if error was handled

Access

public

invoke

top

Invokes the given debugger object as the current error handler, taking over control from the previous handler in a stack-like hierarchy.

Parameters:
  • object $debugger required

    A reference to the Debugger object

Method defined in:
cake/libs/debugger.php on line 701
Access

public

Static

Link
http://book.cakephp.org/view/1191/Using-the-Debugger-Class

log

top

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:
  • $var required

  • $level optional 7

Method defined in:
cake/libs/debugger.php on line 230
Return

void

Static

Link
http://book.cakephp.org/view/1191/Using-the-Debugger-Class

__object

top

Handles object to string conversion.

Parameters:
  • string $var required

    Object to convert

Method defined in:
cake/libs/debugger.php on line 537
Return

string

Access

private

See

Debugger::exportVar()

Object

top

A hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()

Method defined in:
cake/libs/object.php on line 43
Return

Object

__openPersistent

top

Open the persistent class file for reading Used by Object::_persist()

Parameters:
  • string $name required

    Name of persisted class

  • string $type optional NULL

    Type of persistance (e.g: registry)

Method defined in:
cake/libs/object.php on line 268
Return

void

Access

private

_output

top

Renders error messages

Parameters:
  • array $data optional array ( )

    Data about the current error

Method defined in:
cake/libs/debugger.php on line 608
Access

private

output

top

Switches output format, updates format strings

Parameters:
  • string $format optional NULL

    Format to use, including 'js' for JavaScript-enhanced HTML, 'html' for straight HTML output, or 'txt' for unformatted text.

  • array $strings optional array ( )

    Template strings to be used for the output format.

Method defined in:
cake/libs/debugger.php on line 568
Access

protected

_persist

top

Checks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples

Parameters:
  • string $name required

    name of the class to persist

  • $return required

  • string $object required

    the object to persist

  • $type optional NULL

Method defined in:
cake/libs/object.php on line 218
Return

boolean Success

Access

protected

Todo

add examples to manual

requestAction

top

Calls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.

Parameters:
  • mixed $url required

    String or array-based url.

  • array $extra optional array ( )

    if array includes the key "return" it sets the AutoRender to true.

Method defined in:
cake/libs/object.php on line 80
Return

mixed Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.

Access

public

_savePersistent

top

You should choose a unique name for the persistent file

There are many uses for this method, see manual for examples

Parameters:
  • string $name required

    name used for object to cache

  • object $object required

    the object to persist

Method defined in:
cake/libs/object.php on line 247
Return

boolean true on save, throws error if file can not be created

Access

protected

_set

top

Allows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.

Parameters:
  • array $properties optional array ( )

    An associative array containing properties and corresponding values.

Method defined in:
cake/libs/object.php on line 166
Return

void

Access

protected

_stop

top

Stop execution of the current script. Wraps exit() making testing easier.

Parameters:
  • $status optional 0

Method defined in:
cake/libs/object.php on line 135
Return

void

Access

public

toString

top

Object-to-string conversion. Each class can override this method as necessary.

Method defined in:
cake/libs/object.php on line 64
Return

string The name of this class

Access

public

trace

top

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:
  • array $options optional array ( )

    Format for outputting stack trace

Method defined in:
cake/libs/debugger.php on line 338
Return

mixed Formatted stack trace

Access

public

Static

Link
http://book.cakephp.org/view/1191/Using-the-Debugger-Class

trimPath

top

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

Parameters:
  • string $path required

    Path to shorten

Method defined in:
cake/libs/debugger.php on line 417
Return

string Normalized path

Access

public

Static