CoiSA\ErrorHandler\Helper\DebugHelper

Complexity

Total Complexity

10

Size/Duplication

Total Lines	66
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	pre()	0	3	1
A	print_r()	0	6	2
A	dump()	0	13	3
A	export()	0	6	3
A	prettify()	0	5	1

<?php
/**
 * @author Felipe Sayão Lobato Abreu <contato@felipeabreu.com.br>
 * @package CoiSA\ErrorHandler\Helper
 * @since 2017-07-25
 */

namespace CoiSA\ErrorHandler\Helper;

use Throwable;

/**
 * Class DebugHelper
 */
class DebugHelper
{
    /**
     * @param string $dump
     * @return string
     */
    public static function pre(string $dump): string
    {
        return "<pre>{$dump}</pre>";
    }

    /**
     * @param string $dump
     * @return string
     */
    public static function prettify(string $dump)
    {
        // @TODO highlight code

        return self::pre($dump);
    }

    /**
     * @param mixed $mixed
     * @param bool $pretty
     * @return string
     */
    public static function print_r($mixed, bool $pretty = true): string
    {
        $print = (string) print_r($mixed, true);

        return $pretty ? self::prettify($print) :
            $print;
    }

    /**
     * @param mixed $expression
     * @param bool $pretty
     * @return string
     */
    public static function export($expression, bool $pretty = true): string
    {
        $exported = var_export($expression, true) ?: $expression;

        return $pretty ? self::prettify($exported) :

The expression return $pretty ? self::prettify($exported) : $exported could return the type mixed which includes types incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

            $exported;
    }

    /**
     * @param mixed $expression
     * @param bool $pretty
     * @return string
     */
    public static function dump($expression, bool $pretty = true): string
    {
        ob_start();
        try {
            var_dump($expression);

var_dump($expression) looks like debug code. Are you sure you do not want to remove it?

        } catch (\Throwable $exception) {
            // DO NOTHING
        }

        $dump = ob_get_clean();

        return $pretty ? self::prettify($dump) :
            $dump;
    }
}