Kint_Renderer_Rich::getPlugin() - Code Metrics - kint-php/kint - Measure and Improve Code Quality continuously with Scrutinizer

Kint_Renderer_Rich::getPlugin() A
last analyzed 2018-01-09 18:54 UTC

↳ Parent: Kint_Renderer_Rich

Complexity

Conditions	3
Paths	3

Size

Total Lines	12
Code Lines	6

Duplication

Lines	12
Ratio	100 %

Importance

Changes

Metric	Value
cc	3
eloc	6
nc	3
nop	2
dl	12
loc	12
rs	9.4285
c	0
b	0
f	0

<?php

class Kint_Renderer_Rich extends Kint_Renderer

{
    public static $object_renderers = array(

        'blacklist' => 'Kint_Renderer_Rich_Blacklist',
        'callable' => 'Kint_Renderer_Rich_Callable',
        'closure' => 'Kint_Renderer_Rich_Closure',
        'color' => 'Kint_Renderer_Rich_Color',
        'depth_limit' => 'Kint_Renderer_Rich_DepthLimit',
        'nothing' => 'Kint_Renderer_Rich_Nothing',
        'recursion' => 'Kint_Renderer_Rich_Recursion',
        'simplexml_element' => 'Kint_Renderer_Rich_SimpleXMLElement',
        'trace_frame' => 'Kint_Renderer_Rich_TraceFrame',
    );
    public static $tab_renderers = array(

        'binary' => 'Kint_Renderer_Rich_Binary',
        'color' => 'Kint_Renderer_Rich_ColorDetails',
        'docstring' => 'Kint_Renderer_Rich_Docstring',
        'microtime' => 'Kint_Renderer_Rich_Microtime',
        'source' => 'Kint_Renderer_Rich_Source',
        'table' => 'Kint_Renderer_Rich_Table',
        'timestamp' => 'Kint_Renderer_Rich_Timestamp',
    );
    public static $pre_render_sources = array(

        'script' => array(
            array('Kint_Renderer_Rich', 'renderJs'),
            array('Kint_Renderer_Rich_Microtime', 'renderJs'),
        ),
        'style' => array(
            array('Kint_Renderer_Rich', 'renderCss'),
        ),
        'raw' => array(),
    );

    /**
     * Whether or not to render access paths.
     *
     * Access paths can become incredibly heavy with very deep and wide
     * structures. Given mostly public variables it will typically make
     * up one quarter of the output HTML size.
     *
     * If this is an unacceptably large amount and your browser is groaning
     * under the weight of the access paths - your first order of buisiness
     * should be to get a new browser. Failing that, use this to turn them off.
     *
     * @var bool
     */
    public static $access_paths = true;


    /**
     * The maximum length of a string before it is truncated.
     *
     * Falsey to disable
     *
     * @var int
     */
    public static $strlen_max = 80;


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

    /**
     * Assume types and sizes don't need to be escaped.
     *
     * Turn this off if you use anything but ascii in your class names,
     * but it'll cause a slowdown of around 10%
     *
     * @var bool
     */
    public static $escape_types = false;


    protected static $been_run = false;


    protected $plugin_objs = array();

    protected $mod_return = false;

    protected $callee;
    protected $mini_trace;

    protected $previous_caller;

    protected $file_link_format = false;

    protected $show_minitrace = true;

    protected $auto_expand = false;


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

        $params += array(
            'modifiers' => array(),
            'minitrace' => array(),
            'callee' => null,
            'caller' => null,
        );

        $this->callee = $params['callee'];
        $this->mini_trace = $params['minitrace'];
        $this->previous_caller = $params['caller'];

        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'];
        }

        if (empty($params['settings']['display_called_from'])) {
            $this->show_minitrace = false;
        }

        if (!empty($params['settings']['expanded'])) {
            $this->auto_expand = true;
        }
    }

    public function render(Kint_Object $o)

    {
        if ($plugin = $this->getPlugin(self::$object_renderers, $o->hints)) {

            if (strlen($output = $plugin->render($o))) {
                return $output;
            }
        }

        $children = $this->renderChildren($o);
        $header = $this->renderHeaderWrapper($o, (bool) strlen($children), $this->renderHeader($o));

        return '<dl>'.$header.$children.'</dl>';
    }

    public function renderHeaderWrapper(Kint_Object $o, $has_children, $contents)

    {
        $out = '<dt';

        if ($has_children) {

            $out .= ' class="kint-parent';

            if ($this->auto_expand) {
                $out .= ' kint-show';
            }

            $out .= '"';
        }

        $out .= '>';

        if (self::$access_paths && $o->depth > 0 && $ap = $o->getAccessPath()) {

            $out .= '<span class="kint-access-path-trigger" title="Show access path">&rlarr;</span>';
        }

        if ($has_children) {

            $out .= '<span class="kint-popup-trigger" title="Open in new window">&rarr;</span><nav></nav>';
        }

        $out .= $contents;

        if (!empty($ap)) {
            $out .= '<div class="access-path">'.$this->escape($ap).'</div>';
        }

        return $out.'</dt>';
    }

    public function renderHeader(Kint_Object $o)

    {
        $output = '';

        if (($s = $o->getModifiers()) !== null) {

            $output .= '<var>'.$s.'</var> ';
        }

        if (($s = $o->getName()) !== null) {
            $output .= '<dfn>'.$this->escape($s).'</dfn> ';

            if ($s = $o->getOperator()) {
                $output .= $this->escape($s, 'ASCII').' ';
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            }
        }

        if (($s = $o->getType()) !== null) {
            if (self::$escape_types) {
                $s = $this->escape($s);
            }

            if ($o->reference) {
                $s = '&amp;'.$s;
            }

            $output .= '<var>'.$s.'</var> ';
        }

        if (($s = $o->getSize()) !== null) {
            if (self::$escape_types) {
                $s = $this->escape($s);
            }
            $output .= '('.$s.') ';
        }

        if (($s = $o->getValueShort()) !== null) {
            $s = preg_replace('/\s+/', ' ', $s);

            if (self::$strlen_max && Kint_Object_Blob::strlen($s) > self::$strlen_max) {
                $s = substr($s, 0, self::$strlen_max).'...';
            }
            $output .= $this->escape($s);
        }

        return trim($output);
    }

    public function renderChildren(Kint_Object $o)

    {
        $contents = array();
        $tabs = array();

        foreach ($o->getRepresentations() as $rep) {
            $result = $this->renderTab($o, $rep);
            if (strlen($result)) {
                $contents[] = $result;
                $tabs[] = $rep;
            }
        }

        if (empty($tabs)) {
            return '';
        }

        $output = '<dd>';

        if (count($tabs) === 1 && $tabs[0]->labelIsImplicit()) {
            $output .= reset($contents);
        } else {
            $output .= '<ul class="kint-tabs">';

            foreach ($tabs as $i => $tab) {
                if ($i === 0) {
                    $output .= '<li class="kint-active-tab">';
                } else {
                    $output .= '<li>';
                }

                $output .= $this->escape($tab->getLabel()).'</li>';
            }

            $output .= '</ul><ul>';

            foreach ($contents as $tab) {
                $output .= '<li>'.$tab.'</li>';
            }

            $output .= '</ul>';
        }

        return $output.'</dd>';
    }

    protected function renderTab(Kint_Object $o, Kint_Object_Representation $rep)

    {
        if ($plugin = $this->getPlugin(self::$tab_renderers, $rep->hints)) {

            if (strlen($output = $plugin->render($rep))) {
                return $output;
            }
        }

        if (is_array($rep->contents)) {
            $output = '';
            foreach ($rep->contents as $obj) {
                $output .= $this->render($obj);
            }

            return $output;
        } elseif (is_string($rep->contents)) {
            $show_contents = false;


            // If it is the value representation of a string and its whitespace
            // was truncated in the header, always display the full string
            if ($o->type !== 'string' || $o->value !== $rep) {
                $show_contents = true;

            } elseif (preg_match('/(:?[\r\n\t\f\v]| {2})/', $rep->contents)) {
                $show_contents = true;

            } elseif (self::$strlen_max && Kint_Object_Blob::strlen($rep->contents) > self::$strlen_max) {
                $show_contents = true;

            }

            if ($o->type === 'string' && $o->value === $rep && $o->encoding === false) {

                $show_contents = false;

            }

            if ($show_contents) {

                return '<pre>'.$this->escape($rep->contents)."\n</pre>";
            }
        } elseif ($rep->contents instanceof Kint_Object) {
            return $this->render($rep->contents);
        }

        return;
    }

    protected static function renderJs()
    {
        return file_get_contents(KINT_DIR.'/resources/compiled/rich.js');
    }

    protected static function renderCss()

    {
        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()

    {
        $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-rich">';
    }

    public function postRender()
    {
        if (!$this->show_minitrace) {
            return '</div>';
        }

        $output = '<footer>';
        $output .= '<span class="kint-popup-trigger" title="Open in new window">&rarr;</span> ';

        if (isset($this->callee['file'])) {
            if (!empty($this->mini_trace)) {
                $output .= '<nav></nav>';
            }

            $output .= 'Called from '.$this->ideLink($this->callee['file'], $this->callee['line']);
        }

        $caller = '';

        if (isset($this->previous_caller['class'])) {
            $caller .= $this->previous_caller['class'];
        }
        if (isset($this->previous_caller['type'])) {
            $caller .= $this->previous_caller['type'];
        }
        if (isset($this->previous_caller['function'])

            && !in_array($this->previous_caller['function'], array('include', 'include_once', 'require', 'require_once'))
        ) {
            $caller .= $this->previous_caller['function'].'()';
        }

        if ($caller) {
            $output .= ' ['.$caller.']';
        }

        if (!empty($this->mini_trace)) {
            $output .= '<ol>';
            foreach ($this->mini_trace as $step) {
                $output .= '<li>'.$this->ideLink($step['file'], $step['line']); // closing tag not required
                if (isset($step['function'])
                    && !in_array($step['function'], array('include', 'include_once', 'require', 'require_once'))
                ) {
                    $output .= ' [';
                    if (isset($step['class'])) {
                        $output .= $step['class'];
                    }
                    if (isset($step['type'])) {
                        $output .= $step['type'];
                    }
                    $output .= $step['function'].'()]';
                }
            }
            $output .= '</ol>';
        }

        $output .= '</footer></div>';

        return $output;
    }

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

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

        }

        $original_encoding = $encoding;


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

        }

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


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

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

        }

        return $string;
    }

    protected function getPlugin(array $plugins, array $hints)

    {
        if ($plugins = $this->matchPlugins($plugins, $hints)) {

            $plugin = end($plugins);

            if (!isset($this->plugin_objs[$plugin])) {
                $this->plugin_objs[$plugin] = new $plugin($this);
            }

            return $this->plugin_objs[$plugin];
        }
    }

    protected function ideLink($file, $line)

    {
        $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>";
    }
}


1			<?php
2
3			class Kint_Renderer_Rich extends Kint_Renderer
			0 ignored issues – show Coding Style introduced 2018-01-09 18:53 UTC by Report Bug Copy Issue Report `Kint_Renderer_Rich` does not seem to conform to the naming convention (`^[A-Z][a-zA-Z0-9]$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history... Coding Style introduced 2018-01-09 18:54 UTC by Report Bug Copy Issue Report The property $object_renderers is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string* becomes `databaseConnectionString`. Loading history... Coding Style introduced 2018-01-09 18:54 UTC by Report Bug Copy Issue Report The property $tab_renderers is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2018-01-09 18:54 UTC by Report Bug Copy Issue Report The property $pre_render_sources is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2018-01-09 18:54 UTC by Report Bug Copy Issue Report The property $access_paths is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2018-01-09 18:54 UTC by Report Bug Copy Issue Report The property $strlen_max is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2018-01-09 18:54 UTC by Report Bug Copy Issue Report The property $escape_types is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2018-01-09 18:54 UTC by Report Bug Copy Issue Report The property $been_run is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2018-01-09 18:54 UTC by Report Bug Copy Issue Report The property $plugin_objs is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2018-01-09 18:54 UTC by Report Bug Copy Issue Report The property $mod_return is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2018-01-09 18:54 UTC by Report Bug Copy Issue Report The property $mini_trace is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2018-01-09 18:54 UTC by Report Bug Copy Issue Report The property $previous_caller is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2018-01-09 18:54 UTC by Report Bug Copy Issue Report The property $file_link_format is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2018-01-09 18:54 UTC by Report Bug Copy Issue Report The property $show_minitrace is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2018-01-09 18:54 UTC by Report Bug Copy Issue Report The property $auto_expand is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history...
4			{
5			public static $object_renderers = array(
			0 ignored issues – show Coding Style introduced 2018-01-09 18:53 UTC by Report Bug Copy Issue Report `$object_renderers` does not seem to conform to the naming convention (`^[a-z][a-zA-Z0-9]*$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
6			'blacklist' => 'Kint_Renderer_Rich_Blacklist',
7			'callable' => 'Kint_Renderer_Rich_Callable',
8			'closure' => 'Kint_Renderer_Rich_Closure',
9			'color' => 'Kint_Renderer_Rich_Color',
10			'depth_limit' => 'Kint_Renderer_Rich_DepthLimit',
11			'nothing' => 'Kint_Renderer_Rich_Nothing',
12			'recursion' => 'Kint_Renderer_Rich_Recursion',
13			'simplexml_element' => 'Kint_Renderer_Rich_SimpleXMLElement',
14			'trace_frame' => 'Kint_Renderer_Rich_TraceFrame',
15			);
16			public static $tab_renderers = array(
			0 ignored issues – show Coding Style introduced 2018-01-09 18:53 UTC by Report Bug Copy Issue Report `$tab_renderers` does not seem to conform to the naming convention (`^[a-z][a-zA-Z0-9]*$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
17			'binary' => 'Kint_Renderer_Rich_Binary',
18			'color' => 'Kint_Renderer_Rich_ColorDetails',
19			'docstring' => 'Kint_Renderer_Rich_Docstring',
20			'microtime' => 'Kint_Renderer_Rich_Microtime',
21			'source' => 'Kint_Renderer_Rich_Source',
22			'table' => 'Kint_Renderer_Rich_Table',
23			'timestamp' => 'Kint_Renderer_Rich_Timestamp',
24			);
25			public static $pre_render_sources = array(
			0 ignored issues – show Coding Style introduced 2018-01-09 18:53 UTC by Report Bug Copy Issue Report `$pre_render_sources` does not seem to conform to the naming convention (`^[a-z][a-zA-Z0-9]*$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
26			'script' => array(
27			array('Kint_Renderer_Rich', 'renderJs'),
28			array('Kint_Renderer_Rich_Microtime', 'renderJs'),
29			),
30			'style' => array(
31			array('Kint_Renderer_Rich', 'renderCss'),
32			),
33			'raw' => array(),
34			);
35
36			/**

kint-php / kint

Kint_Renderer_Rich::getPlugin() A last analyzed 2018-01-09 18:54 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Kint_Renderer_Rich::getPlugin() A
last analyzed 2018-01-09 18:54 UTC