Docs For Class DebugHandler

Description

The DebugHandler keeps track of multiple DebugItems.

version: $Id: DebugHandler.class.php,v 1.10 2007/09/04 20:25:33 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/debugHandler/DebugHandler.class.php (line 107)

Variable Summary

integer $_outputLevel

array $_queue

Method Summary

void DebugHandler ()

void add (mixed $debug, [optional $level = 5], [optional $category = "general"])

void assignConfiguration (object Properties $configuration)

void assignOsidContext (mixed $context, object OsidContext $context )

int getDebugItemCount ()

array getDebugItems ([optional $category = ""])

object OsidContext getOsidContext ()

integer getOutputLevel ()

void setOutputLevel (integer $level)

void _add (object DebugItem $debugItem, optional $debugBacktrace)

Variables

integer $_outputLevel (line 118)

var: The internal output level.
access: private

array $_queue (line 112)

var: The array of DebugItems.
access: private

Methods

Constructor DebugHandler (line 125)

The constructor.

access: public

void DebugHandler ()

add (line 191)

Adds debug text to the handler.

access: public

void add (mixed $debug, [optional $level = 5], [optional $category = "general"])

mixed $debug: Either a string with debug text or a DebugItem object.
optional $level: int $level The detail level of the debug text.
optional $category: string $category The text category.

assignConfiguration (line 150)

Assign the configuration of this Manager. Valid configuration options are as

follows: database_index integer database_name string

access: public
throws: object OsidException An exception with one of the following messages defined in org.osid.OsidException: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT

void assignConfiguration (object Properties $configuration)

object Properties $configuration: (original type: java.util.Properties)

assignOsidContext (line 178)

Assign the context of this OsidManager.

access: public
throws: object OsidException An exception with one of the following messages defined in org.osid.OsidException: NULL_ARGUMENT

void assignOsidContext (mixed $context, object OsidContext $context )

object OsidContext $context

getDebugItemCount (line 221)

Returns the number of DebugItems registered.

return: The DebugItem count.
access: public

int getDebugItemCount ()

getDebugItems (line 232)

Returns an array of DebugItems, optionally limited to category $category.

return: The array of DebugItems.
access: public

array getDebugItems ([optional $category = ""])

optional $category: string $category The category.

getOsidContext (line 163)

Return context of this OsidManager.

access: public
throws: object OsidException

object OsidContext getOsidContext ()

getOutputLevel (line 256)

Returns the internal output level.

access: public

integer getOutputLevel ()

setOutputLevel (line 247)

Sets the internal output level to $level. This can be overridden at output time.

access: public

void setOutputLevel (integer $level)

integer $level

_add (line 209)

Adds a DebugItem to the queue.

access: private

void _add (object DebugItem $debugItem, optional $debugBacktrace)

object DebugItem $debugItem: The DebugItem to add to the queue.
optional $debugBacktrace: array $debugBacktrace A DebugBacktrace array.