Debug.php

Go to the documentation of this file.

<?php
/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 */

namespace Xmf;

class Debug
{
    private static $times = array();

    private static $timerQueue = array();

    private static $timerLabels = array();


    public static function dump($var, $inline = false)
    {
        $events = \Xoops::getInstance()->events();
        $eventName = 'debug.log';
        if (!$inline && $events->hasListeners($eventName)) {
            $events->triggerEvent($eventName, $var);
            //\Kint::dump(func_get_arg(0));
        } else {
            $config = array(
                'skin' => array('selected' => 'modern'),
                'css'  => array('url' => \XoopsBaseConfig::get('url') . '/modules/xmf/css/krumo/'),
                'display' => array(
                    'show_version' => false,
                    'show_call_info' => false,
                    'sort_arrays' => false,
                    ),
                );
            \krumo::setConfig($config);
            $msg = \krumo::dump($var);
            echo $msg;
        }
    }

    public static function backtrace($inline = false)
    {
        $events = \Xoops::getInstance()->events();
        $eventName = 'debug.log';
        if (!$inline && $events->hasListeners($eventName)) {
            $events->triggerEvent($eventName, debug_backtrace());
        } else {
            return self::dump(debug_backtrace(), $inline);
        }
    }

    public static function startTimer($name, $label = null)
    {
        $events = \Xoops::getInstance()->events();
        $var = array($name);
        $var[] = empty($label) ? $name : $label;
        $eventName = 'debug.timer.start';
        if ($events->hasListeners($eventName)) {
            $events->triggerEvent($eventName, $var);
        } else {
            self::$times[$name] = microtime(true);
        }
    }

    public static function stopTimer($name)
    {
        $events = \Xoops::getInstance()->events();
        $eventName = 'debug.timer.stop';
        if ($events->hasListeners($eventName)) {
            $events->triggerEvent($eventName, $name);
        } else {
            echo $name . ' - ' . intval(microtime(true) - self::$times[$name]) . " \n";
        }
    }

    public static function startQueuedTimer($name, $label = null)
    {
        self::$times[$name] = microtime(true);
        self::$timerLabels[$name] = empty($label) ? $name : $label;
    }

    public static function stopQueuedTimer($name)
    {
        if (isset(self::$timerLabels[$name]) && isset(self::$times[$name])) {
            $queueItem = array(
                'label' => self::$timerLabels[$name],
                'start' => self::$times[$name],
                'elapsed' => microtime(true) - self::$times[$name],
                );
            self::$timerQueue[] = $queueItem;
        }
    }

    public static function dumpQueuedTimers($returnOnly = false)
    {
        $queue = self::$timerQueue;
        self::$timerQueue = array();
        if (!$returnOnly) {
            self::dump($queue);
        }

        return $queue;
    }

    public static function startTrace($tracefile = '', $collect_params = '3', $collect_return = 'On')
    {
        if (function_exists('xdebug_start_trace')) {
            ini_set('xdebug.collect_params', $collect_params);
            ini_set('xdebug.collect_return', $collect_return);
            if ($tracefile == '') {
                $tracefile = \XoopsBaseConfig::get('var-path') . '/logs/php_trace';
            }
            xdebug_start_trace($tracefile);
        }
    }

    public static function stopTrace()
    {
        if (function_exists('xdebug_stop_trace')) {
            xdebug_stop_trace();
        }
    }
}