Docs For Class midcom

Description

This is a debugger class.

Helps in debugging your code. It features automatic Prefix Management in a push/pop style management and lets you decide which messages are logged into the logfile by setting loglevels for the debugger and for each message.

There are five loglevel constants you can use when setting the loglevel or when logging messages:

MIDCOM_LOG_DEBUG
MIDCOM_LOG_INFO
MIDCOM_LOG_WARN
MIDCOM_LOG_ERROR
MIDCOM_LOG_CRIT

This snippet does automatically instantiate $midcom_debugger, and it declares shortcuts called debug_add, debug_push and debug_pop (see below).

Note: The Debugger is disabled per default to save performance. You have to explicitly enable it by calling the enable function.

Located in /midcom.core/midcom/debug.php (line 35)

Direct descendents

Class	Description
midcom_helper_replicator_logger

Method Summary

static void log_debug (string $message)

static void log_info (string $message)

static void log_warn (string $message)

midcom_debug midcom_debug ( $filename)

void disable ()

void enable ()

boolean is_enabled ()

void log (string $message, [int $loglevel = MIDCOM_LOG_DEBUG])

void pop_prefix ()

void print_dump_mem (string $message, [int $loglevel = MIDCOM_LOG_DEBUG])

void print_function_stack (string $message, [int $loglevel = MIDCOM_LOG_DEBUG])

void print_r (string $message, mixed &$variable, [int $loglevel = MIDCOM_LOG_DEBUG])

void print_type (string $message, mixed &$variable, [int $loglevel = MIDCOM_LOG_DEBUG])

void push_prefix (string $prefix)

void setLogfile (string $filename)

void setLoglevel (int $loglevel)

Methods

static method log_debug (line 257)

Log a message with debug loglevel

static void log_debug (string $message)

string $message: The message to be logged

static method log_info (line 247)

Log a message with info loglevel

static void log_info (string $message)

string $message: The message to be logged

static method log_warn (line 267)

Log a message with warning loglevel

static void log_warn (string $message)

string $message: The message to be logged

Constructor midcom_debug (line 81)

Standard constructor

midcom_debug midcom_debug ( $filename)

$filename

disable (line 107)

Disable the Debugger

void disable ()

enable (line 100)

Enable the Debugger

void enable ()

is_enabled (line 116)

Is the debugger enabled?

return: Debugger state

boolean is_enabled ()

log (line 199)

Log a message

void log (string $message, [int $loglevel = MIDCOM_LOG_DEBUG])

string $message: The message to be logged
int $loglevel: The log level

pop_prefix (line 166)

Restore the last debug prefix

void pop_prefix ()

print_dump_mem (line 381)

Dump the current memory usage and the delta to the last call of this function.

Useful for tracking memory leaks.

Format will be:

$curmem (delta $delta): $message

void print_dump_mem (string $message, [int $loglevel = MIDCOM_LOG_DEBUG])

string $message: The message to be logged
int $loglevel: The log level

print_function_stack (line 308)

Dump stack trace, only working when XDebug is present.

link: http://www.xdebug.org/ xdebug.org

void print_function_stack (string $message, [int $loglevel = MIDCOM_LOG_DEBUG])

string $message: The message to be logged
int $loglevel: The log level

print_r (line 279)

Dump a variable (by reference)

void print_r (string $message, mixed &$variable, [int $loglevel = MIDCOM_LOG_DEBUG])

string $message: The message to be logged
mixed &$variable: The variable to be logged
int $loglevel: The log level

print_type (line 353)

Dump a variables type (by reference)

void print_type (string $message, mixed &$variable, [int $loglevel = MIDCOM_LOG_DEBUG])

string $message: The message to be logged
mixed &$variable: The variable of which the type should be logged
int $loglevel: The log level

push_prefix (line 143)

Set a new debug prefix

void push_prefix (string $prefix)

string $prefix: The new prefix

setLogfile (line 125)

Set log file name

void setLogfile (string $filename)

string $filename: New logfile name

setLoglevel (line 134)

Set log level

void setLoglevel (int $loglevel)

int $loglevel: New log level

Class midcom_debug