File Source for debug.php

<?php
/**
* Zikula Application Framework
*
* @copyright Robert Gasch
* @link http://www.zikula.org
* @version $Id: debug.php 24342 2008-06-06 12:03:14Z markwest $
* @license GNU/GPL - http://www.gnu.org/copyleft/gpl.html
* @author Robert Gasch rgasch@gmail.com
* @package Zikula_Core
* @subpackage Debug
*/
/**
* log a string to the designated output destination
*
* @param file The file (passed from assertion handler)
* @param line The line (passed from assertion handler)
* @param assert_trigger The assert trigger (passed from assertion handler)
*/
if (!function_exists('pn_assert_callback_function'))
{
function pn_assert_callback_function ($file, $line, $assert_trigger)
{
//pn_exit ('assertion failed', $file, $line, $assert_trigger);
return pn_exit ('assertion failed');
}
}
/**
* Exit the program after displaying the appropriate messages
*
* @param msg The messgage to show
* @param html whether or not to generate HTML (can be turned off for command line execution)
*/
if (!function_exists('pn_exit'))
{
function pn_exit ($msg, $html=true)
{
global $PNConfig;
if (defined('_PNINSTALLVER') && $PNConfig['System']['development']) {
print ("Install Error:" . $msg . ' ');
prayer (debug_backtrace());
return false;
}
//Loader::loadClass('LogUtil');
$msg = "Exit-Handler: $msg\nStacktrace:\n";
$msg2 = str_replace ("\n", ' ', $msg);
$debug = _prayer (debug_backtrace());
LogUtil::log ($msg . $debug, 'FATAL');
global $PNConfig;
if ($PNConfig['System']['development'])
{
print ($msg2 . $debug);
pnShutDown();
}
return LogUtil::registerError ($msg);
}
}
/**
* Serialize the given data in an easily human-readable way for debug purposes
*
* Taken from http://dev.nexen.net/scripts/details.php?scripts=707
*
* @param data The object to serialize
* @param functions whether to show function names for objects (default=false) (optional)
*
* @return string A string containing serialized data
*/
if (!function_exists('_prayer'))
{
function _prayer ($data, $functions=false, $recursionLevel=0)
{
if ($recursionLevel > 5) {
return 'Max recursion level reached.';
return;
}
global $PNConfig;
if (defined('_PNINSTALLVER') && !$PNConfig['System']['development']) {
return;
}
$text = '';
if ($functions != 0) {
$sf = 1;
} else {
$sf = 0 ;
}
if (isset ($data)) {
if (is_array($data) || is_object($data)) {
$datatype = gettype($data);
if (count ($data)) {
$text .= "<ol>\n";
foreach ($data as $key => $value) {
$type = gettype($value);
if ($type == 'array' || ($type == 'object' && get_object_vars($value))) {
$text .= sprintf ("<li>(%s) %s:\n", $type, $key);
$text .= _prayer ($value, $sf, $recursionLevel+1);
$text .= '</li>';
} elseif (eregi ('function', $type)) {
if ($sf) {
$text .= sprintf ("<li>(%s) %s </li>\n", $type, $key, $value);
/* There doesn't seem to be anything traversable inside functions. */
}
} else {
if (!isset($value)) {
$value='(none)';
}
// You cannot do dataUtil::formatForDisplay on an object, so just display object type
if (is_object($value))
$value = gettype($value);
if ($datatype == 'array') {
$text .= sprintf ("<li>(%s) %s = %s</li>\n", $type, $key, dataUtil::formatForDisplay($value));
}
elseif ($datatype == 'object') {
$text .= sprintf ("<li>(%s) %s -> %s</li>\n", $type, $key, dataUtil::formatForDisplay($value));
}
}
}
$text .= "</ol>\n";
} else {
$text .= '(empty)';
}
} else {
$text .= $data;
}
}
return $text;
}
}
/**
* Serialize the given data in an easily human-readable way for debug purposes
*
* Taken from http://dev.nexen.net/scripts/details.php?scripts=707
*
* @param data The object to serialize
* @param functions whether to show function names for objects (default=false) (optional)
*
* @return nothing, the data is directly printed
*/
if (!function_exists('prayer'))
{
function prayer ($data, $functions=false)
{
global $PNConfig;
if (defined('_PNINSTALLVER') && !$PNConfig['System']['development']) {
return;
}
$text = '<div style="text-align:left">';
$text .= _prayer ($data, $functions);
$text .= '</div>';
print ($text);
}
}
/**
* Simple timer class to measure code execution times.
*
* You can take multiple snapshots by calling the snap() function.
* For multiple measurements with 1 Timer, some basic statistics
* are computed.
*
* @package Zikula_Core
* @subpackage Debug
*/
if (!class_exists('Timer'))
{
class Timer
{
var $name;
var $times;
/**
* Constructor
*
* @param name The name of the timer
*/
function Timer ($name='')
{
$this->name = $name;
$this->times = array();
$this->start ();
}
/**
* reset the timer
*
* @param name The name of the timer
*/
function reset ($name='')
{
$this->name = $name;
$this->times = array();
$this->start ();
}
/**
* return the current microtime
*/
function get_microtime()
{
$tmp = split(" ",microtime());
$rt = $tmp[0]+$tmp[1];
return $rt;
}
/**
* start the timer
*/
function start ()
{
$this->times[] = $this->get_microtime();
}
/**
* stop the timer
*/
function stop ($insertNewRecord=true)
{
if ($insertNewRecord)
$this->times[] = $this->get_microtime();
if (count($this->times) <= 2)
return $this->stop_single();
return $this->stop_multiple ();
}
/**
* print the timer results for a single measurement
*/
function stop_single()
{
$start = $this->times[0];
$stop = $this->times[1];
$diff = $stop - $start;
$data['count'] = 1;
$data['start'] = $start;
$data['stop'] = $stop;
$data['diff'] = $diff;
return $data;
}
/**
* print the timer results for multiple measurement
*/
function stop_multiple ()
{
$min = 9999999;
$max = -9999999;
$sum = 0;
$size = count($this->times);
$start = $this->times[0];
$d = 0;
$data = array();
for ($i=1; $i<$size; $i++)
{
$last = $this->times[$i-1];
$stop = $this->times[$i];
$diff = $stop - $last;
if ($diff < $min) {
$min = $diff;
}
if ($diff > $max) {
$max = $diff;
}
$d += $diff;
}
$start = $this->times[0];
$stop = $this->times[$size-1];
$avg = $d/$size;
$data['count'] = $size;
$data['start'] = $start;
$data['stop'] = $stop;
$data['min'] = $min;
$data['max'] = $max;
$data['avg'] = $avg;
$data['diff'] = $d;
//$stats = sprintf ("(%d runs, min=%f, max=%f, avg=%f)\n", $size, $min, $max, $avg);
//print ("PNTimer: $diff $stats $this->name\n");
return $data;
}
/**
* take a snapshot while continuing the timing run
*/
function snap ($doStats=false)
{
$this->times[] = $this->get_microtime();
if ($doStats) {
return $this->stop_multiple();
}
}
}
}

Source for file debug.php