kint-php / kint

src/Renderer/Plain.php

<?php

class Kint_Renderer_Plain extends Kint_Renderer_Text

Kint_Renderer_Plain does not seem to conform to the naming convention (^[A-Z][a-zA-Z0-9]*$).

The property $pre_render_sources is not named in camelCase.

The property $disable_utf8 is not named in camelCase.

The property $been_run is not named in camelCase.

The property $mod_return is not named in camelCase.

The property $file_link_format is not named in camelCase.

{
    public static $pre_render_sources = array(

$pre_render_sources does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        'script' => array(),
        'style' => array(
            array('Kint_Renderer_Plain', 'renderCss'),
        ),
        'raw' => array(),
    );

    /**
     * Path to the CSS file to load by default.
     *
     * @var string
     */
    public static $theme = 'plain.css';

    /**
     * Output htmlentities instead of utf8.
     *
     * @var bool
     */
    public static $disable_utf8 = false;

$disable_utf8 does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    protected static $been_run = false;

$been_run does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    protected $mod_return = false;

$mod_return does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    protected $file_link_format = false;

$file_link_format does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    public function __construct(array $params = array())
    {
        parent::__construct($params);

        if (isset($params['settings']['return'])) {
            $this->mod_return = $params['settings']['return'];
        }

        if (isset($params['settings']['file_link_format'])) {
            $this->file_link_format = $params['settings']['file_link_format'];
        }
    }

    protected function utf8_to_htmlentity($string)

function utf8_to_htmlentity() does not seem to conform to the naming convention (^(?:[a-z]|__)[a-zA-Z0-9]*$).

The return type could not be reliably inferred; please add a @return annotation.

This method seems to be duplicated in your project.

    {
        return str_replace(
            array('┌', '═', '┐', '│', '└', '─', '┘'),
            array('┌', '═', '┐', '│', '└', '─', '┘'),
            $string
        );
    }

    public function colorValue($string)
    {
        return '<i>'.$string.'</i>';
    }

    public function colorType($string)
    {
        return '<b>'.$string.'</b>';
    }

    public function colorTitle($string)
    {
        return '<u>'.$string.'</u>';
    }

    public function renderTitle(Kint_Object $o)

The return type could not be reliably inferred; please add a @return annotation.

Avoid variables with short names like $o. Configured minimum length is 3.

    {
        if (self::$disable_utf8) {
            return $this->utf8_to_htmlentity(parent::renderTitle($o));
        } else {
            return parent::renderTitle($o);
        }
    }

    protected static function renderCss()

This method seems to be duplicated in your project.

    {
        if (file_exists(KINT_DIR.'/resources/compiled/'.self::$theme)) {
            return file_get_contents(KINT_DIR.'/resources/compiled/'.self::$theme);
        } else {
            return file_get_contents(self::$theme);
        }
    }

    public function preRender()

This method seems to be duplicated in your project.

    {
        $output = '';

        if (!self::$been_run || $this->mod_return) {
            foreach (self::$pre_render_sources as $type => $values) {
                $contents = '';
                foreach ($values as $v) {
                    if (is_callable($v)) {
                        $contents .= call_user_func($v, $this);
                    } elseif (is_string($v)) {
                        $contents .= $v;
                    }
                }

                if (!strlen($contents)) {
                    continue;
                }

                switch ($type) {
                    case 'script':
                        $output .= '<script class="kint-script">'.$contents.'</script>';
                        break;
                    case 'style':
                        $output .= '<style class="kint-style">'.$contents.'</style>';
                        break;
                    default:
                        $output .= $contents;
                }
            }

            if (!$this->mod_return) {
                self::$been_run = true;
            }
        }

        return $output.'<div class="kint-plain">';
    }

    public function postRender()
    {
        if (self::$disable_utf8) {
            return $this->utf8_to_htmlentity(parent::postRender()).'</div>';
        } else {
            return parent::postRender().'</div>';
        }
    }

    public function ideLink($file, $line)

The return type could not be reliably inferred; please add a @return annotation.

This method seems to be duplicated in your project.

    {
        $shortenedPath = $this->escape(Kint::shortenPath($file));
        if (!$this->file_link_format) {
            return $shortenedPath.':'.$line;
        }

        $ideLink = Kint::getIdeLink($file, $line);
        $class = (strpos($ideLink, 'http://') === 0) ? 'class="kint-ide-link" ' : '';

        return "<a {$class}href=\"{$ideLink}\">{$shortenedPath}:{$line}</a>";
    }

    public function escape($string, $encoding = false)

This method seems to be duplicated in your project.

    {
        if ($encoding === false) {
            $encoding = Kint_Object_Blob::detectEncoding($string);

Consider using a different name than the parameter $encoding. This often makes code more readable.

        }

        $original_encoding = $encoding;

$original_encoding does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        if ($encoding === false || $encoding === 'ASCII') {
            $encoding = 'UTF-8';

Consider using a different name than the parameter $encoding. This often makes code more readable.

        }

        $string = htmlspecialchars($string, ENT_NOQUOTES, $encoding);

Consider using a different name than the parameter $string. This often makes code more readable.

        // this call converts all non-ASCII characters into numeirc htmlentities
        if (extension_loaded('mbstring') && $original_encoding !== 'ASCII') {

$original_encoding does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            $string = mb_encode_numericentity($string, array(0x80, 0xffff, 0, 0xffff), $encoding);

Consider using a different name than the parameter $string. This often makes code more readable.

        }

        return $string;
    }
}