\midcom_debug

This is a debugger class.

Helps in debugging your code. It 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 file declares shortcuts like debug_add (see below).

Summary

Methods

Properties

Constants

__construct()
set_loglevel()
get_loglevel()
log_php_error()
log()
print_r()
print_function_stack()
print_type()
print_dump_mem()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

check_level()
_get_caller()

$_filename
$_loglevel
$_loglevels

N/A

File: lib/midcom/debug.php
Package: midcom
Class hierarchy: \midcom_debug

Properties

$_filename

$_filename : string

Logfile name

Type

string

$_loglevel

$_loglevel : integer

Current loglevel

Type

integer

$_loglevels

$_loglevels : array

All available loglevels

Type

array

Methods

__construct()

__construct(  $filename = null)

Standard constructor

Parameters

$filename

set_loglevel()

set_loglevel(integer  $loglevel)

Set log level

Parameters

integer

$loglevel

New log level

get_loglevel()

get_loglevel() : integer

Get log level

Returns

integer

log_php_error()

log_php_error(  $loglevel = MIDCOM_LOG_DEBUG)

Parameters

$loglevel

log()

log(string  $message, integer  $loglevel = MIDCOM_LOG_DEBUG)

Log a message

Parameters

string	$message	The message to be logged
integer	$loglevel	The log level

print_r()

print_r(string  $message, mixed  $variable, integer  $loglevel = MIDCOM_LOG_DEBUG)

Dump a variable

Parameters

string	$message	The message to be logged
mixed	$variable	The variable to be logged
integer	$loglevel	The log level

print_function_stack()

print_function_stack(string  $message, integer  $loglevel = MIDCOM_LOG_DEBUG)

Dump stack trace, only working when XDebug is present.

Parameters

string	$message	The message to be logged
integer	$loglevel	The log level

print_type()

print_type(string  $message, mixed  $variable, integer  $loglevel = MIDCOM_LOG_DEBUG)

Dump a variable's type

Parameters

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

print_dump_mem()

print_dump_mem(string  $message, integer  $loglevel = MIDCOM_LOG_DEBUG)

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

Parameters

string	$message	The message to be logged
integer	$loglevel	The log level

check_level()

check_level(  $loglevel)

Parameters

$loglevel

_get_caller()

_get_caller()