Source for file debug.class.php

<?php
 
require_once HARMONI . "debugHandler/NewWindowDebugHandlerPrinter.class.php";
 
/**
 * The debug class is a static abstract class that holds wrapper functions for the DebugHandler service in Harmoni.
 *
 * @see DebugHandlerInterface
 *
 * @package harmoni.utilities.debugging
 * 
 * @copyright Copyright &copy; 2005, Middlebury College
 * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
 *
 * @version $Id: debug.class.php,v 1.19 2007/09/04 20:25:33 adamfranco Exp $
 *
 * @static
 ***/
class debug {
    /**
     * Sends $text to the DebugHandler with level $level and category $category.
     * @static
     * @access public
     * @return void 
     ***/
    function output( $text, $level = 5, $category = "general") {
        if (!$level) return;
        if (!Services::serviceAvailable("Debug")) 
            return;
        
        $debugHandler = Services::getService("Debug");
        $outputLevel = $debugHandler->getOutputLevel();
 
        if ($level <= $outputLevel)
            $debugHandler->add($text,$level,$category);
    }
    
    /**
     * Sets the DebugHandler service's output level to $level. If not specified will
     * return the current output level.
     * @param optional integer $level
     * @static
     * @access public
     * @return integer The current debug output level.
     ***/
    function level($level=null) {
        if (!Services::serviceAvailable("Debug")) {
            throwError ( new Error("Debug::level($level) called but Debug service isn't available.","debug wrapper",false));
            return;
        }
        
        $debugHandler = Services::getService("Debug");
        if (is_int($level))
            $debugHandler->setOutputLevel($level);
        return $debugHandler->getOutputLevel();
    }
    
    /**
     * Prints current debug output using NewWindowDebugHandlerPrinter
     * @access public
     * @return void 
     */
    function printAll($debugPrinter = null) {
        // ** parameter validation
        $extendsRule = ExtendsValidatorRule::getRule("DebugHandlerPrinterInterface");
        ArgumentValidator::validate($debugPrinter, OptionalRule::getRule($extendsRule), true);
        // ** end of parameter validation
    
        if (is_null($debugPrinter))
            NewWindowDebugHandlerPrinter::printDebugHandler(Services::getService("Debug"));
        else
            $debugPrinter->printDebugHandler(Services::getService("Debug"));
    }
    
    /**
     * Print the MySQL version of a query
     * 
     * @param object Query $query 
     * @return void 
     * @access public
     * @since 3/2/05
     */
    function printQuery ($query) {
        print "\n<pre>";
        print_r(MySQL_SQLGenerator::generateSQLQuery($query));    
        print "\n</pre>";
    }
    
    
}
 
function printpre($array, $return=FALSE) {
    $string = "\n<pre>";
    $string .= print_r($array, TRUE);
    $string .= "\n</pre>";
    
    if ($return)
        return $string;
    else
        print $string;
}
 
/**
 * Printpre an array or object, excluding any children named in the excludes list
 * 
 * @param array $array 
 * @param array $excludes 
 * @return mixed void or string
 * @access public
 * @since 1/18/06
 */
function printpreArrayExcept($array, $excludes = array(), $return=FALSE) {
    $string = "\n<pre>";
    
    foreach ($array as $key => $val) {
        if (!in_array($key, $excludes))
            $string .= "\n\n".$key."\n=> ".print_r($val, TRUE);
    }
    $string .= "\n</pre>";
    
    if ($return)
        return $string;
    else
        print $string;
}
 
 
 
?>