Waca\Helpers\DebugHelper

Complexity

Total Complexity

6

Size/Duplication

Total Lines	50
Duplicated Lines	0 %

Test Coverage

Coverage

82.35%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	get_debug_backtrace()	0	3	1
A	getBacktrace()	0	26	5

<?php
/******************************************************************************
 * Wikipedia Account Creation Assistance tool                                 *
 *                                                                            *
 * All code in this file is released into the public domain by the ACC        *
 * Development Team. Please see team.json for a list of contributors.         *
 ******************************************************************************/

namespace Waca\Helpers;

/**
 * DebugHelper provides backtrace utilities for debugging and error logging
 */
class DebugHelper
{
    /**
     * Internal mockable method wrapper for debug_backtrace.
     *
     * As mocking out debug_backtrace uses debug_backtrace internally, we need this in order to not cause a recursive
     * cascade until the runtime explodes.
     *
     * Instead, we mock this method, which allows debug_backtrace to still be called correctly.
     *
     * @return array
     */
    public function get_debug_backtrace()
    {
        return debug_backtrace();
    }

    /**
     * Returns a string representation of the current backtrace for display.
     *
     * Note that this explicitly excludes the top two frames, which will be methods from this class.
     *
     * @return string
     */
    public function getBacktrace()
    {
        $backtrace = $this->get_debug_backtrace();

        $output = "";

        $count = 0;
        foreach ($backtrace as $line) {
            if ($count <= 1) {
                $count++;
                continue;
            }

            $output .= "#{$count}: ";

            if (isset($line['type']) && $line['type'] != "") {
                $output .= $line['class'] . $line['type'];
            }

            $output .= $line['function'] . "(...)";
            $output .= " [{$line['file']}#{$line['line']}\r\n";

            $count++;
        }

        return $output;
    }
}